Add mandatory documentation (#1904)

kyma-project · Jan 11, 2024 · 1eb3b57 · 1eb3b57
1 parent b669761
commit 1eb3b57
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/cmd/kyma/alpha/create/module/module.go b/cmd/kyma/alpha/create/module/module.go
@@ -65,6 +65,7 @@ The module config file is a YAML file used to configure the following attributes
 - name:             a string, required, the name of the module
 - version:          a string, required, the version of the module
 - channel:          a string, required, channel that should be used in the ModuleTemplate CR
+- mandatory:        a boolean, optional, default=false, indicates whether the module is mandatory to be installed on all clusters
 - manifest:         a string, required, reference to the manifest, must be a relative file name
 - defaultCR:        a string, optional, reference to a YAML file containing the default CR for the module, must be a relative file name
 - resourceName:     a string, optional, default={NAME}-{CHANNEL}, the name for the ModuleTemplate CR that will be created

diff --git a/docs/gen-docs/kyma_alpha_create_module.md b/docs/gen-docs/kyma_alpha_create_module.md
@@ -28,6 +28,7 @@ The module config file is a YAML file used to configure the following attributes
 - name:             a string, required, the name of the module
 - version:          a string, required, the version of the module
 - channel:          a string, required, channel that should be used in the ModuleTemplate CR
+- mandatory:        a boolean, optional, default=false, indicates whether the module is mandatory to be installed on all clusters
 - manifest:         a string, required, reference to the manifest, must be a relative file name
 - defaultCR:        a string, optional, reference to a YAML file containing the default CR for the module, must be a relative file name
 - resourceName:     a string, optional, default={NAME}-{CHANNEL}, the name for the ModuleTemplate CR that will be created