feat: Add spec.requiresDowntime (#2132)

* add spec.requiresDowntime and update documentation * update crd bases with requiresDowntime * add spec.RequiresDowntime to v1beta2 * Update docs/contributor/resources/03-moduletemplate.md Co-authored-by: Małgorzata Świeca <[email protected]> --------- Co-authored-by: Tomasz Smelcerz <[email protected]> Co-authored-by: Małgorzata Świeca <[email protected]>
kyma-project · Dec 20, 2024 · 4210b9e · 4210b9e
1 parent 67aceb4
commit 4210b9e
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 0 deletions.
diff --git a/api/v1beta1/moduletemplate_types.go b/api/v1beta1/moduletemplate_types.go
@@ -85,6 +85,10 @@ type ModuleTemplateSpec struct {
 	Target Target `json:"target"`
 
 	CustomStateCheck []*v1beta2.CustomStateCheck `json:"customStateCheck,omitempty"`
+
+	// RequiresDowntime indicates whether the module requires downtime in support of maintenance windows during module upgrades.
+	// +optional
+	RequiresDowntime bool `json:"requiresDowntime,omitempty"`
 }
 
 // +kubebuilder:object:root=true

diff --git a/api/v1beta2/moduletemplate_types.go b/api/v1beta2/moduletemplate_types.go
@@ -119,6 +119,10 @@ type ModuleTemplateSpec struct {
 	// Manager contains information for identifying a module's resource that can be used as indicator for the installation readiness of the module. Typically, this is the manager Deployment of the module. In exceptional cases, it may also be another resource.
 	// +optional
 	Manager *Manager `json:"manager,omitempty"`
+
+	// RequiresDowntime indicates whether the module requires downtime in support of maintenance windows during module upgrades.
+	// +optional
+	RequiresDowntime bool `json:"requiresDowntime,omitempty"`
 }
 
 // Manager defines the structure for the manager field in ModuleTemplateSpec.

diff --git a/config/crd/bases/operator.kyma-project.io_moduletemplates.yaml b/config/crd/bases/operator.kyma-project.io_moduletemplates.yaml
@@ -110,6 +110,10 @@ spec:
                   Mandatory indicates whether the module is mandatory. It is used to enforce the installation of the module with
                   its configuration in all runtime clusters.
                 type: boolean
+              requiresDowntime:
+                description: RequiresDowntime indicates whether the module requires
+                  downtime in support of maintenance windows during module upgrades.
+                type: boolean
               target:
                 description: |-
                   Target describes where the Module should later on be installed if parsed correctly. It is used as installation
@@ -307,6 +311,10 @@ spec:
                 maxLength: 64
                 pattern: ^([a-z]{3,}(-[a-z]{3,})*)?$
                 type: string
+              requiresDowntime:
+                description: RequiresDowntime indicates whether the module requires
+                  downtime in support of maintenance windows during module upgrades.
+                type: boolean
               resources:
                 description: Resources is a list of additional resources of the module
                   that can be fetched, e.g., the raw manifest.

diff --git a/docs/contributor/resources/03-moduletemplate.md b/docs/contributor/resources/03-moduletemplate.md
@@ -161,6 +161,10 @@ The `resources` field is a list of additional resources of the module that can b
 The `associatedResources` field is a list of module-related custom resource definitions (CRDs) that should be cleaned up during module deletion.
 The list is purely informational and does not introduce functional changes to the module.
 
+### **.spec.requiresDowntime**
+
+The `requiresDowntime` field indicates whether the module requires downtime to support maintenance windows during module upgrades. It is optional and defaults to `false`, meaning the module version upgrades don't require downtime.
+
 ## `operator.kyma-project.io` Labels
 
 These are the synchronization labels available on the ModuleTemplate CR: