chore: Deprecate .spec.channel field in ModuleTemplate API (#1932)

* chore: deprecate .spec.channel field in ModuleTemplate API * chore: update manifests * fix: match moduletemplate api versions * fix: match moduletemplate api versions --------- Co-authored-by: Jeremy Harisch <[email protected]>
kyma-project · Oct 11, 2024 · 01eb24e · 01eb24e
1 parent e508ff7
commit 01eb24e
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 10 deletions.
diff --git a/api/v1beta1/moduletemplate_types.go b/api/v1beta1/moduletemplate_types.go
@@ -45,6 +45,9 @@ type ModuleTemplate struct {
 type ModuleTemplateSpec struct {
 	// Channel is the targeted channel of the ModuleTemplate. It will be used to directly assign a Template
 	// to a target channel. It has to be provided at any given time.
+	// Deprecated: This field is deprecated and will be removed in a future release.
+	// +optional
+	// +kubebuilder:deprecatedversion
 	// +kubebuilder:validation:Pattern:=^[a-z]+$
 	// +kubebuilder:validation:MaxLength:=32
 	// +kubebuilder:validation:MinLength:=3

diff --git a/api/v1beta2/moduletemplate_types.go b/api/v1beta2/moduletemplate_types.go
@@ -76,6 +76,9 @@ func (d *Descriptor) DeepCopyObject() machineryruntime.Object {
 type ModuleTemplateSpec struct {
 	// Channel is the targeted channel of the ModuleTemplate. It will be used to directly assign a Template
 	// to a target channel. It has to be provided at any given time.
+	// Deprecated: This field is deprecated and will be removed in a future release.
+	// +optional
+	// +kubebuilder:deprecatedversion
 	// +kubebuilder:validation:Pattern:=^[a-z]+$
 	// +kubebuilder:validation:MaxLength:=32
 	// +kubebuilder:validation:MinLength:=3

diff --git a/config/crd/bases/operator.kyma-project.io_moduletemplates.yaml b/config/crd/bases/operator.kyma-project.io_moduletemplates.yaml
@@ -49,6 +49,7 @@ spec:
                 description: |-
                   Channel is the targeted channel of the ModuleTemplate. It will be used to directly assign a Template
                   to a target channel. It has to be provided at any given time.
+                  Deprecated: This field is deprecated and will be removed in a future release.
                 maxLength: 32
                 minLength: 3
                 pattern: ^[a-z]+$
@@ -119,7 +120,6 @@ spec:
                 - remote
                 type: string
             required:
-            - channel
             - descriptor
             - target
             type: object
@@ -180,6 +180,7 @@ spec:
                 description: |-
                   Channel is the targeted channel of the ModuleTemplate. It will be used to directly assign a Template
                   to a target channel. It has to be provided at any given time.
+                  Deprecated: This field is deprecated and will be removed in a future release.
                 maxLength: 32
                 minLength: 3
                 pattern: ^[a-z]+$
@@ -259,19 +260,19 @@ spec:
                           description: Name is the name of the icon.
                           type: string
                       required:
-                        - link
-                        - name
+                      - link
+                      - name
                       type: object
                     type: array
                     x-kubernetes-list-map-keys:
-                      - name
+                    - name
                     x-kubernetes-list-type: map
                   repository:
                     description: Repository is the link to the repository of the module.
                     type: string
                 required:
-                  - documentation
-                  - repository
+                - documentation
+                - repository
                 type: object
               mandatory:
                 description: |-
@@ -310,7 +311,6 @@ spec:
                 pattern: ^((0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(-[a-zA-Z-][0-9a-zA-Z-]*)?)?$
                 type: string
             required:
-            - channel
             - descriptor
             type: object
         type: object

diff --git a/docs/contributor/resources/03-moduletemplate.md b/docs/contributor/resources/03-moduletemplate.md
@@ -12,9 +12,11 @@ kubectl get crd moduletemplates.operator.kyma-project.io -o yaml
 
 ## Configuration
 
-### **.spec.channel**
+### **.spec.channel** (Deprecated)
 
-The channel that a ModuleTemplate CR is registered in. It is used alongside the channel attributes of the Kyma CR to match up a module and a channel.
+The `channel` field previously indicated the channel in which a ModuleTemplate CR was registered. It was used alongside the channel attributes of the Kyma CR to match a module with a specific channel.
+
+**Note:** This field is now deprecated and will be removed in a future release. It has been decided that ModuleTemplates are now tied directly to versions, rather than being associated with channels.
 
 For the following ModuleTemplate CR:
 
@@ -27,7 +29,7 @@ spec:
   channel: regular
 ```
 
-the module will be referenced by any Kyma CR asking for it in the `regular` channel.
+the module was referenced by any Kyma CR asking for it in the `regular` channel.
 
 ### **.spec.data**