docs: Move beta/internal description from ModuleTemplate to Modul…

…eReleaseMeta (#2134) * docs: Move 'beta'/'internal' description from ModuleTemplate to ModuleReleaseMeta * Apply suggestions from code review Co-authored-by: Małgorzata Świeca <[email protected]> --------- Co-authored-by: Małgorzata Świeca <[email protected]>
kyma-project · Dec 18, 2024 · a43e82e · a43e82e
1 parent dc24a99
commit a43e82e
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 2 deletions.
diff --git a/docs/contributor/resources/03-moduletemplate.md b/docs/contributor/resources/03-moduletemplate.md
@@ -166,5 +166,3 @@ The list is purely informational and does not introduce functional changes to th
 These are the synchronization labels available on the ModuleTemplate CR:
 
 * `operator.kyma-project.io/sync`: A boolean value. If set to `false`, this ModuleTemplate CR is not synchronized with any remote cluster. The default value is `true`.
-* `operator.kyma-project.io/internal`: A boolean value. If set to `true`, marks the ModuleTemplate CR as an `internal` module. It is then synchronized only for these remote clusters which are managed by the Kyma CR with the same `operator.kyma-project.io/internal` label explicitly set to `true`. The default value is `false`.
-* `operator.kyma-project.io/beta` A boolean value. If set to `true`, marks the ModuleTemplate CR as a `beta` module. It is then synchronized only for these remote clusters which are managed by the Kyma CR with the same `operator.kyma-project.io/beta` label explicitly set to `true`. The default value is `false`.
diff --git a/docs/contributor/resources/05-modulereleasemeta.md b/docs/contributor/resources/05-modulereleasemeta.md
@@ -16,6 +16,18 @@ kubectl get crd modulereleasemetas.operator.kyma-project.io -o yaml
 
 The **moduleName** defines the name of the module for which the channel assignments are listed.
 
+### **.spec.beta**
+
+The **beta** flag defines if the module is a `beta` module. If marked as `beta`, it is only synced to SKRs where the Kyma CR is marked with the `"operator.kyma-project.io/beta": "true"` label. This includes the ModuleTemplates related to this module.
+
+The default value is `false`.
+
+### **.spec.internal**
+
+The **internal** flag defines if the module is an `internal` module. If marked as `internal`, it is only synced to SKRs where the Kyma CR is marked with the `"operator.kyma-project.io/internal": "true"` label. This includes the ModuleTemplates related to this module.
+
+The default value is `false`.
+
 ### **.spec.channels**
 
 The **channels** define each module channel with its corresponding version. Each channel can only have one version assigned.
@@ -24,6 +36,8 @@ See the following example:
 ```yaml
 spec:
   moduleName: keda
+  beta: false
+  internal: false
   channels:
     - channel: regular
       version: 1.0.0