Merge pull request #940 from Vafilor/feat/full.node.resources

feat: add optional logic to capture the entire node

Author: Vafilor

api/api.swagger.json

@@ -3305,6 +3305,9 @@
           "items": {
             "$ref": "#/definitions/KeyValue"
           }
+        },
+        "captureNode": {
+          "type": "boolean"
         }
       }
     },

api/gen/workspace.pb.go

@@ -121,6 +121,7 @@ message CreateWorkspaceBody {
 
 	repeated Parameter parameters = 3;
 	repeated KeyValue labels = 4;
+	bool captureNode = 5;
 }
 
 message CreateWorkspaceRequest {

api/proto/workspace.proto

@@ -0,0 +1,7 @@
+-- +goose Up
+-- SQL in this section is executed when the migration is applied.
+ALTER TABLE workspaces ADD COLUMN capture_node boolean;
+UPDATE workspaces SET capture_node = false;
+
+-- +goose Down
+ALTER TABLE workspaces DROP COLUMN capture_node;

db/sql/20210802222820_configurable_capture_workspace_node.sql

@@ -275,6 +275,7 @@ func (c *Client) createWorkspace(namespace string, parameters []byte, workspace
 			"workspace_template_id":      workspace.WorkspaceTemplate.ID,
 			"workspace_template_version": workspace.WorkspaceTemplate.Version,
 			"labels":                     workspace.Labels,
+			"capture_node":               workspace.CaptureNode,
 		}).
 		Suffix("RETURNING id, created_at").
 		RunWith(c.DB).
@@ -311,9 +312,9 @@ func (c *Client) addRuntimeFieldsToWorkspaceTemplate(t wfv1.Template, workspace
 	if !ok {
 		return nil, errors.New("unable to type check statefulset manifest")
 	}
-	extraContainer := generateNodeCaptureContainer(workspace, config)
 
-	if extraContainer != nil {
+	if workspace.CaptureNode {
+		extraContainer := generateNodeCaptureContainer(workspace, config)
 		containers, ok := templateSpec["containers"].([]interface{})
 		if !ok {
 			return nil, errors.New("unable to type check statefulset manifest")

pkg/workspace.go

@@ -52,6 +52,7 @@ type Workspace struct {
 	WorkspaceTemplateID      uint64                   `db:"workspace_template_id"`
 	WorkspaceTemplateVersion uint64                   `db:"workspace_template_version"`
 	WorkflowTemplateVersion  *WorkflowTemplateVersion `db:"workflow_template_version"` // helper to store data from workflow template version
+	CaptureNode              bool                     `db:"capture_node"`
 }
 
 type WorkspaceSpec struct {
@@ -102,7 +103,7 @@ func GenerateWorkspaceUID(name string) (string, error) {
 // getWorkspaceColumns returns all of the columns for workspace modified by alias, destination.
 // see formatColumnSelect
 func getWorkspaceColumns(aliasAndDestination ...string) []string {
-	columns := []string{"id", "created_at", "modified_at", "uid", "name", "namespace", "parameters", "workspace_template_id", "workspace_template_version", "labels"}
+	columns := []string{"id", "created_at", "modified_at", "uid", "name", "namespace", "parameters", "workspace_template_id", "workspace_template_version", "labels", "capture_node"}
 	return sql.FormatColumnSelect(columns, aliasAndDestination...)
 }
 
@@ -145,9 +146,11 @@ func getWorkspaceColumnsMap(camelCase bool) map[string]string {
 	if camelCase {
 		result["createdAt"] = "created_at"
 		result["modifiedAt"] = "modified_at"
+		result["captureNode"] = "capture_node"
 	} else {
 		result["created_at"] = "created_at"
 		result["modified_at"] = "modified_at"
+		result["capture_node"] = "capture_node"
 	}
 
 	return result

pkg/workspace_types.go

@@ -138,7 +138,8 @@ func (s *WorkspaceServer) CreateWorkspace(ctx context.Context, req *api.CreateWo
 			UID:     req.Body.WorkspaceTemplateUid,
 			Version: req.Body.WorkspaceTemplateVersion,
 		},
-		Labels: converter.APIKeyValueToLabel(req.Body.Labels),
+		Labels:      converter.APIKeyValueToLabel(req.Body.Labels),
+		CaptureNode: req.Body.CaptureNode,
 	}
 
 	for _, param := range req.Body.Parameters {