[ws-manager] Introduce workspace classes

Author: csweichel

components/ws-manager-api/core.proto

@@ -307,6 +307,9 @@ message WorkspaceSpec {
 
     // ide_image is the name of the Docker image used as IDE
     IDEImage ide_image = 8;
+
+    // class names the class of this workspace
+    string class = 9;
 }
 
 // PortSpec describes a networking port exposed on a workspace
@@ -493,6 +496,9 @@ message StartWorkspaceSpec {
 
     // ide_image is the Docker image name of the IDE image
     IDEImage ide_image = 12;
+
+    // Class denotes the class of the workspace we ought to start
+    string class = 13;
 }
 
 // WorkspaceFeatureFlag enable non-standard behaviour in workspaces

components/ws-manager-api/go/config/config.go

@@ -69,15 +69,11 @@ type Configuration struct {
 	SchedulerName string `json:"schedulerName"`
 	// SeccompProfile names the seccomp profile workspaces will use
 	SeccompProfile string `json:"seccompProfile"`
-	// Container configures all three workspace containers
-	Container AllContainerConfiguration `json:"container"`
 	// Timeouts configures how long workspaces can be without activity before they're shut down.
 	// All values in here must be valid time.Duration
 	Timeouts WorkspaceTimeoutConfiguration `json:"timeouts"`
 	// InitProbe configures the ready-probe of workspaces which signal when the initialization is finished
 	InitProbe InitProbeConfiguration `json:"initProbe"`
-	// WorkspacePodTemplate is a path to a workspace pod template YAML file
-	WorkspacePodTemplate WorkspacePodTemplateConfiguration `json:"podTemplate,omitempty"`
 	// WorkspaceCACertSecret optionally names a secret which is mounted in `/etc/ssl/certs/gp-custom.crt`
 	// in all workspace pods.
 	WorkspaceCACertSecret string `json:"caCertSecret,omitempty"`
@@ -113,6 +109,13 @@ type Configuration struct {
 	RegistryFacadeHost string `json:"registryFacadeHost"`
 	// Cluster host under which workspaces are served, e.g. ws-eu11.gitpod.io
 	WorkspaceClusterHost string `json:"workspaceClusterHost"`
+	// WorkspaceClasses provide different resource classes for workspaces
+	WorkspaceClasses map[string]*WorkspaceClass `json:"workspaceClass"`
+}
+
+type WorkspaceClass struct {
+	Container ContainerConfiguration            `json:"container"`
+	Templates WorkspacePodTemplateConfiguration `json:"templates"`
 }
 
 // AllContainerConfiguration contains the configuration for all container in a workspace pod
@@ -185,10 +188,6 @@ type WorkspaceDaemonConfiguration struct {
 
 // Validate validates the configuration to catch issues during startup and not at runtime
 func (c *Configuration) Validate() error {
-	if err := c.Container.Workspace.Validate(); err != nil {
-		return xerrors.Errorf("container.workspace: %w", err)
-	}
-
 	err := validation.ValidateStruct(&c.Timeouts,
 		validation.Field(&c.Timeouts.AfterClose, validation.Required),
 		validation.Field(&c.Timeouts.HeadlessWorkspace, validation.Required),
@@ -206,23 +205,33 @@ func (c *Configuration) Validate() error {
 		return xerrors.Errorf("stopping timeout must be greater than content finalization timeout")
 	}
 
-	err = validation.ValidateStruct(&c.WorkspacePodTemplate,
-		validation.Field(&c.WorkspacePodTemplate.DefaultPath, validPodTemplate),
-		validation.Field(&c.WorkspacePodTemplate.PrebuildPath, validPodTemplate),
-		validation.Field(&c.WorkspacePodTemplate.ProbePath, validPodTemplate),
-		validation.Field(&c.WorkspacePodTemplate.RegularPath, validPodTemplate),
-	)
-	if err != nil {
-		return xerrors.Errorf("workspacePodTemplate: %w", err)
-	}
-
 	err = validation.ValidateStruct(c,
 		validation.Field(&c.WorkspaceURLTemplate, validation.Required, validWorkspaceURLTemplate),
 		validation.Field(&c.WorkspaceHostPath, validation.Required),
 		validation.Field(&c.HeartbeatInterval, validation.Required),
 		validation.Field(&c.GitpodHostURL, validation.Required, is.URL),
 		validation.Field(&c.ReconnectionInterval, validation.Required),
 	)
+	if err != nil {
+		return err
+	}
+
+	for name, class := range c.WorkspaceClasses {
+		if err := class.Container.Validate(); err != nil {
+			return xerrors.Errorf("workspace class %s: %w", name, err)
+		}
+
+		err = validation.ValidateStruct(&class.Templates,
+			validation.Field(&class.Templates.DefaultPath, validPodTemplate),
+			validation.Field(&class.Templates.PrebuildPath, validPodTemplate),
+			validation.Field(&class.Templates.ProbePath, validPodTemplate),
+			validation.Field(&class.Templates.RegularPath, validPodTemplate),
+		)
+		if err != nil {
+			return xerrors.Errorf("workspace class %s: %w", name, err)
+		}
+	}
+
 	return err
 }
 
@@ -256,15 +265,13 @@ var validWorkspaceURLTemplate = validation.By(func(o interface{}) error {
 
 // ContainerConfiguration configures properties of workspace pod container
 type ContainerConfiguration struct {
-	Image    string                `json:"image"`
-	Requests ResourceConfiguration `json:"requests"`
-	Limits   ResourceConfiguration `json:"limits"`
+	Requests *ResourceConfiguration `json:"requests,omitempty"`
+	Limits   *ResourceConfiguration `json:"limits,omitempty"`
 }
 
 // Validate validates a container configuration
 func (c *ContainerConfiguration) Validate() error {
 	return validation.ValidateStruct(c,
-		validation.Field(&c.Image, validation.Required),
 		validation.Field(&c.Requests, validResourceConfig),
 		validation.Field(&c.Limits, validResourceConfig),
 	)
@@ -298,6 +305,9 @@ var validResourceConfig = validation.By(func(o interface{}) error {
 
 // ResourceList parses the quantities in the resource config
 func (r *ResourceConfiguration) ResourceList() (corev1.ResourceList, error) {
+	if r == nil {
+		return corev1.ResourceList{}, nil
+	}
 	res := map[corev1.ResourceName]string{
 		corev1.ResourceCPU:              r.CPU,
 		corev1.ResourceMemory:           r.Memory,