feat: Add Resources as optional to ModuleTemplate (#1910)

* feat: Add Resources as optional to ModuleTempalte * add api compatibility esception * add docs
kyma-project · Oct 4, 2024 · c54809c · c54809c
1 parent af53cf5
commit c54809c
Show file tree

Hide file tree

Showing 5 changed files with 59 additions and 0 deletions.
diff --git a/api-version-compatibility-config.yaml b/api-version-compatibility-config.yaml
@@ -24,3 +24,4 @@ operator.kyma-project.io_moduletemplates.yaml:
       - .spec.properties.version
       - .spec.properties.moduleName
       - .spec.properties.customStateCheck.description
+      - .spec.properties.resources
diff --git a/api/v1beta2/moduletemplate_types.go b/api/v1beta2/moduletemplate_types.go
@@ -126,6 +126,12 @@ type ModuleTemplateSpec struct {
 
 	// CustomStateCheck is deprecated.
 	CustomStateCheck []*CustomStateCheck `json:"customStateCheck,omitempty"`
+
+	// Resources is a list of additional resources of the module that can be fetched, e.g., the raw manifest.
+	// +optional
+	// +listType=map
+	// +listMapKey=name
+	Resources []Resource `json:"resources,omitempty"`
 }
 
 type CustomStateCheck struct {
@@ -148,6 +154,14 @@ type ModuleTemplateList struct {
 	Items              []ModuleTemplate `json:"items"`
 }
 
+type Resource struct {
+	// Name is the name of the resource.
+	Name string `json:"name"`
+	// Link is the URL to the resource.
+	// +kubebuilder:validation:Format=uri
+	Link string `json:"link"`
+}
+
 //nolint:gochecknoinits // registers ModuleTemplate CRD on startup
 func init() {
 	SchemeBuilder.Register(&ModuleTemplate{}, &ModuleTemplateList{}, &Descriptor{})

diff --git a/api/v1beta2/zz_generated.deepcopy.go b/api/v1beta2/zz_generated.deepcopy.go
diff --git a/config/crd/bases/operator.kyma-project.io_moduletemplates.yaml b/config/crd/bases/operator.kyma-project.io_moduletemplates.yaml
@@ -230,6 +230,26 @@ spec:
                 maxLength: 64
                 pattern: ^([a-z]{3,}(-[a-z]{3,})*)?$
                 type: string
+              resources:
+                description: Resources is a list of additional resources of the module
+                  that can be fetched, e.g., the raw manifest.
+                items:
+                  properties:
+                    link:
+                      description: Link is the URL to the resource.
+                      format: uri
+                      type: string
+                    name:
+                      description: Name is the name of the resource.
+                      type: string
+                  required:
+                  - link
+                  - name
+                  type: object
+                type: array
+                x-kubernetes-list-map-keys:
+                - name
+                x-kubernetes-list-type: map
               version:
                 description: Version identifies the version of the Module. Can be
                   empty, or a semantic version.

diff --git a/docs/contributor/resources/03-moduletemplate.md b/docs/contributor/resources/03-moduletemplate.md
@@ -106,6 +106,10 @@ By default, it will most likely be easiest to use [Kyma CLI](https://github.com/
 The `mandatory` field indicates whether the module is installed in all runtime clusters without any interaction from the user.
 Mandatory modules do not appear in the Kyma CR `.status` and `.spec.modules`, furthermore they have the same configuration across all runtime clusters.
 
+### **.spec.resources**
+
+The `resources` field is a list of additional resources of the module that can be fetched. As of now, the primary expected use case is for module teams to add a link to the raw manifest of the module.
+
 ## `operator.kyma-project.io` Labels
 
 These are the synchronization labels available on the ModuleTemplate CR: