Add UserRuntimes

Author: David Festal

pkg/apis/workspaces/v1alpha1/devworkspace_types.go

@@ -15,11 +15,22 @@ type DevWorkspaceSpec struct {
 	Template DevWorkspaceTemplateSpec `json:"template,omitempty"`
 }
 
-// This schema describes the structure of the devfile object
+// Structure of the workspace. This is also the specification of a workspace template.
 type DevWorkspaceTemplateSpec struct {
-	Commands          []Command   `json:"commands,omitempty"` // Description of the predefined commands to be available in workspace
-	Projects          []Project   `json:"projects,omitempty"` // Description of the projects, containing names and sources locations
-	Components        []Component `json:"components"`         // Description of the workspace components, such as editor and plugins
+	// Predefined, ready-to-use, workspace-related commands
+	Commands          []Command      `json:"commands,omitempty"`
+	
+	// Projects worked on in the workspace, containing names and sources locations
+	Projects          []Project      `json:"projects,omitempty"`
+	
+	// List of runtimes the developer wants to add into his workspace
+	// +optional
+	// +patchMergeKey=name
+	// +patchStrategy=merge,retainKeys
+	DeveloperRuntimes      []DeveloperRuntime  `json:"userRuntimes,omitempty" patchStrategy:"merge,retainKeys" patchMergeKey:"name"`
+
+	// Description of the workspace components, such as editor and plugins
+	Components        []Component `json:"components,omitempty"`
 }
 
 // DevWorkspaceStatus defines the observed state of DevWorkspace
@@ -31,8 +42,8 @@ type DevWorkspaceStatus struct {
 
 	// Id of the workspace
 	WorkspaceId string `json:"workspaceId"`
-	// URL at which the Editor can be joined
-	IdeUrl string `json:"ideUrl,omitempty"`
+	// URL at which the Worksace Editor can be joined
+	MainIdeUrl string `json:"mainIdeUrl,omitempty"`
 	// AdditionalInfo
 	AdditionalInfo map[string]string `json:"additionalInfo,omitempty"`
 }

pkg/apis/workspaces/v1alpha1/model.go

@@ -26,8 +26,49 @@ type ProjectSource struct {
 	Type     string `json:"type"`     // Project's source type.
 }
 
-// Describes a workspace component
+// Workspace component: Anything that will bring additional features / tooling / behaviour / context
+// to the workspace, in order to make working in it easier.
 type Component struct {
-	Name           string `json:"name"`
-	MemoryLimit    string `json:"memoryLimit"`
+	Name string `json:"name"`
 }
+
+// Component that allows the developer to add a configured container into his workspace
+type DeveloperRuntime struct {
+	Component
+	MemoryLimit string `json:"memoryLimit,omitempty"`
+	Endpoints []Endpoint `json:"endpoints,omitempty"`
+	Container
+}
+
+type Endpoint struct {
+	Name          string                 `json:"name"`
+	TargetPort    int                    `json:"targetPort"`
+	Configuration *EndpointConfiguration `json:"configuration,omitEmpty"`
+	attributes    map[string]string      `json:"attributes,omitempty"`
+}
+
+type EndpointConfiguration struct {
+	Public             bool   `json:"public"`
+	Discoverable       bool   `json:"discoverable"`
+	Protocol           string `json:"protocol,omitmepty"`
+	Schema             string `json:"schema,omitmepty"`
+	Secure             bool   `json:"secure"`
+	CookiesAuthEnabled bool   `json:"public"`
+	Path               string `json:"path",omitempty`
+
+	// +kubebuilder:validation:Enum=ide,terminal
+	Type string `json:"type,omitmepty"`
+}
+
+
+type Container struct {
+	Name           string          `json:"name" yaml:"name"`
+	Image          string          `json:"image" yaml:"image"`
+//	Env            []EnvVar        `json:"env" yaml:"env"`
+//	EditorCommands []EditorCommand `json:"editorCommands" yaml:"editorCommands"`
+//	Volumes        []Volume        `json:"volumes" yaml:"volumes"`
+//	Ports          []ExposedPort   `json:"ports" yaml:"ports"`
+	MemoryLimit    string          `json:"memoryLimit" yaml:"memoryLimit"`
+	MountSources   bool            `json:"mountSources" yaml:"mountSources"`
+}
+