Add configuration to pipeline stanza of DSC to enable InstructLab pip…

…eline
opendatahub-io · Jan 9, 2025 · cb45a5e · cb45a5e
1 parent 35dcacc
commit cb45a5e
Show file tree

Hide file tree

Showing 8 changed files with 36 additions and 17 deletions.
diff --git a/apis/components/v1alpha1/datasciencepipelines/types.go b/apis/components/v1alpha1/datasciencepipelines/types.go
@@ -6,14 +6,16 @@ package datasciencepipelines
 import operatorv1 "github.com/openshift/api/operator/v1"
 
 type PreloadedPipelinesSpec struct {
-	InstructLab InstructLabPipelineSpec `json:"instructLab,omitempty"`
+	// Configure whether to auto import the InstructLab pipeline pon any new pipeline server (or DSPA) creation.
+	// Please note that the pipeline requires that trainingoperator be enabled in the DSC to run.
+	InstructLab PreloadedPipelineOptions `json:"instructLab,omitempty"`
 }
 
-type InstructLabPipelineSpec struct {
+type PreloadedPipelineOptions struct {
 	// Set to one of the following values:
 	//
-	// - "Managed" : TODO
-	// - "Removed" : TODO
+	// - "Managed" : Upon any new pipeline server (or DSPA) creation this pipeline is auto imported
+	// - "Removed" : Upon any new pipeline server (or DSPA) creation this pipeline is not auto imported
 	//
 	// +kubebuilder:validation:Enum=Managed;Removed
 	// +kubebuilder:default=Removed

diff --git a/apis/components/v1alpha1/datasciencepipelines/zz_generated.deepcopy.go b/apis/components/v1alpha1/datasciencepipelines/zz_generated.deepcopy.go
diff --git a/bundle/manifests/components.platform.opendatahub.io_datasciencepipelines.yaml b/bundle/manifests/components.platform.opendatahub.io_datasciencepipelines.yaml
@@ -78,14 +78,17 @@ spec:
               preloadedPipelines:
                 properties:
                   instructLab:
+                    description: |-
+                      Configure whether to auto import the InstructLab pipeline pon any new pipeline server (or DSPA) creation.
+                      Please note that the pipeline requires that trainingoperator be enabled in the DSC to run.
                     properties:
                       state:
                         default: Removed
                         description: |-
                           Set to one of the following values:
 
-                          - "Managed" : TODO
-                          - "Removed" : TODO
+                          - "Managed" : Upon any new pipeline server (or DSPA) creation this pipeline is auto imported
+                          - "Removed" : Upon any new pipeline server (or DSPA) creation this pipeline is not auto imported
                         enum:
                         - Managed
                         - Removed

diff --git a/bundle/manifests/datasciencecluster.opendatahub.io_datascienceclusters.yaml b/bundle/manifests/datasciencecluster.opendatahub.io_datascienceclusters.yaml
@@ -189,14 +189,17 @@ spec:
                       preloadedPipelines:
                         properties:
                           instructLab:
+                            description: |-
+                              Configure whether to auto import the InstructLab pipeline pon any new pipeline server (or DSPA) creation.
+                              Please note that the pipeline requires that trainingoperator be enabled in the DSC to run.
                             properties:
                               state:
                                 default: Removed
                                 description: |-
                                   Set to one of the following values:
 
-                                  - "Managed" : TODO
-                                  - "Removed" : TODO
+                                  - "Managed" : Upon any new pipeline server (or DSPA) creation this pipeline is auto imported
+                                  - "Removed" : Upon any new pipeline server (or DSPA) creation this pipeline is not auto imported
                                 enum:
                                 - Managed
                                 - Removed

diff --git a/config/crd/bases/components.platform.opendatahub.io_datasciencepipelines.yaml b/config/crd/bases/components.platform.opendatahub.io_datasciencepipelines.yaml
@@ -78,14 +78,17 @@ spec:
               preloadedPipelines:
                 properties:
                   instructLab:
+                    description: |-
+                      Configure whether to auto import the InstructLab pipeline pon any new pipeline server (or DSPA) creation.
+                      Please note that the pipeline requires that trainingoperator be enabled in the DSC to run.
                     properties:
                       state:
                         default: Removed
                         description: |-
                           Set to one of the following values:
 
-                          - "Managed" : TODO
-                          - "Removed" : TODO
+                          - "Managed" : Upon any new pipeline server (or DSPA) creation this pipeline is auto imported
+                          - "Removed" : Upon any new pipeline server (or DSPA) creation this pipeline is not auto imported
                         enum:
                         - Managed
                         - Removed

diff --git a/config/crd/bases/datasciencecluster.opendatahub.io_datascienceclusters.yaml b/config/crd/bases/datasciencecluster.opendatahub.io_datascienceclusters.yaml
@@ -189,14 +189,17 @@ spec:
                       preloadedPipelines:
                         properties:
                           instructLab:
+                            description: |-
+                              Configure whether to auto import the InstructLab pipeline pon any new pipeline server (or DSPA) creation.
+                              Please note that the pipeline requires that trainingoperator be enabled in the DSC to run.
                             properties:
                               state:
                                 default: Removed
                                 description: |-
                                   Set to one of the following values:
 
-                                  - "Managed" : TODO
-                                  - "Removed" : TODO
+                                  - "Managed" : Upon any new pipeline server (or DSPA) creation this pipeline is auto imported
+                                  - "Removed" : Upon any new pipeline server (or DSPA) creation this pipeline is not auto imported
                                 enum:
                                 - Managed
                                 - Removed

diff --git a/controllers/components/datasciencepipelines/datasciencepipelines_controller_actions.go b/controllers/components/datasciencepipelines/datasciencepipelines_controller_actions.go
@@ -83,6 +83,11 @@ func initialize(_ context.Context, rr *odhtypes.ReconciliationRequest) error {
 		return fmt.Errorf("marshalling preloaded pipelines failed: %w", err)
 	}
 
+	data, err = json.Marshal(string(data))
+	if err != nil {
+		return fmt.Errorf("marshalling preloaded pipelines failed: %w", err)
+	}
+
 	extraParamsMap := map[string]string{
 		"PREINSTALLEDPIPELINES": string(data),
 	}

diff --git a/tests/e2e/helper_test.go b/tests/e2e/helper_test.go
@@ -158,7 +158,7 @@ func setupDSCInstance(name string) *dscv1.DataScienceCluster {
 					},
 					DataSciencePipelinesCommonSpec: componentApi.DataSciencePipelinesCommonSpec{
 						PreloadedPipelines: datasciencepipelines.PreloadedPipelinesSpec{
-							InstructLab: datasciencepipelines.InstructLabPipelineSpec{
+							InstructLab: datasciencepipelines.PreloadedPipelineOptions{
 								State: operatorv1.Removed,
 							},
 						},