From 1eb3b572ab25b2478dcb70b235f53421c7c1f4f8 Mon Sep 17 00:00:00 2001 From: Nesma Badr Date: Thu, 11 Jan 2024 11:33:04 +0100 Subject: [PATCH] Add mandatory documentation (#1904) --- cmd/kyma/alpha/create/module/module.go | 1 + docs/gen-docs/kyma_alpha_create_module.md | 1 + 2 files changed, 2 insertions(+) diff --git a/cmd/kyma/alpha/create/module/module.go b/cmd/kyma/alpha/create/module/module.go index 11187fe09..1fb59e563 100644 --- 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 index d0d417619..d9c39f7fd 100644 --- 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