gen docs

regenerate

regenerate 2

add completion

apply suggestions

rename files

apply suggestions

docs/user/gen-docs/kyma.md

@@ -0,0 +1,30 @@
+# kyma
+
+A simple set of commands to manage a Kyma cluster.
+
+## Synopsis
+
+Use this command to manage Kyma modules and resources on a cluster.
+
+```bash
+kyma <command> [flags]
+```
+
+## Available Commands
+
+```text
+  alpha      - Groups command prototypes for which the API may still change
+  completion - Generate the autocompletion script for the specified shell
+  help       - Help about any command
+```
+
+## Flags
+
+```text
+  -h, --help   Help for the command
+```
+
+## See also
+
+* [kyma alpha](kyma_alpha.md)           - Groups command prototypes for which the API may still change
+* [kyma completion](kyma_completion.md) - Generate the autocompletion script for the specified shell

docs/user/gen-docs/kyma_alpha.md

@@ -0,0 +1,43 @@
+# kyma alpha
+
+Groups command prototypes for which the API may still change.
+
+## Synopsis
+
+A set of alpha prototypes that may still change. Use them in automation at your own risk.
+
+```bash
+kyma alpha <command> [flags]
+```
+
+## Available Commands
+
+```text
+  access             - Produces a kubeconfig with a Service Account-based token and certificate
+  app                - Manages applications on the Kubernetes cluster
+  hana               - Manages an SAP HANA instance in the Kyma cluster
+  help               - Help about any command
+  module             - Manages kyma modules
+  oidc               - Creates kubeconfig with an OIDC token
+  provision          - Provisions a Kyma cluster on SAP BTP
+  reference-instance - Adds an instance reference to a shared service instance
+```
+
+## Flags
+
+```text
+      --kubeconfig string       Path to the Kyma kubeconfig file
+      --show-extensions-error   Prints a possible error when fetching extensions fails
+  -h, --help                    Help for the command
+```
+
+## See also
+
+* [kyma](kyma.md)                                                   - A simple set of commands to manage a Kyma cluster
+* [kyma alpha access](kyma_alpha_access.md)                         - Produces a kubeconfig with a Service Account-based token and certificate
+* [kyma alpha app](kyma_alpha_app.md)                               - Manages applications on the Kubernetes cluster
+* [kyma alpha hana](kyma_alpha_hana.md)                             - Manages an SAP HANA instance in the Kyma cluster
+* [kyma alpha module](kyma_alpha_module.md)                         - Manages kyma modules
+* [kyma alpha oidc](kyma_alpha_oidc.md)                             - Creates kubeconfig with an OIDC token
+* [kyma alpha provision](kyma_alpha_provision.md)                   - Provisions a Kyma cluster on SAP BTP
+* [kyma alpha reference-instance](kyma_alpha_reference-instance.md) - Adds an instance reference to a shared service instance

docs/user/gen-docs/kyma_alpha_access.md

@@ -0,0 +1,29 @@
+# kyma alpha access
+
+Produces a kubeconfig with a Service Account-based token and certificate.
+
+## Synopsis
+
+Use this command to produce a kubeconfig with a Service Account-based token and certificate that is valid for a specified time or indefinitely.
+
+```bash
+kyma alpha access [flags]
+```
+
+## Flags
+
+```text
+      --clusterrole string      Name of the cluster role to bind the Service Account to
+      --name string             Name of the Service Account to be created
+      --namespace string        Namespace in which the resource is created (default "default")
+      --output string           Path to the kubeconfig file output. If not provided, the kubeconfig will be printed
+      --permanent               Determines if the token is valid indefinitely
+      --time string             Determines how long the token should be valid, by default 1h (use h for hours and d for days) (default "1h")
+  -h, --help                    Help for the command
+      --kubeconfig string       Path to the Kyma kubeconfig file
+      --show-extensions-error   Prints a possible error when fetching extensions fails
+```
+
+## See also
+
+* [kyma alpha](kyma_alpha.md) - Groups command prototypes for which the API may still change

docs/user/gen-docs/kyma_alpha_app.md

@@ -0,0 +1,31 @@
+# kyma alpha app
+
+Manages applications on the Kubernetes cluster.
+
+## Synopsis
+
+Use this command to manage applications on the Kubernetes cluster.
+
+```bash
+kyma alpha app <command> [flags]
+```
+
+## Available Commands
+
+```text
+  help - Help about any command
+  push - Push the application to the Kubernetes cluster
+```
+
+## Flags
+
+```text
+  -h, --help                    Help for the command
+      --kubeconfig string       Path to the Kyma kubeconfig file
+      --show-extensions-error   Prints a possible error when fetching extensions fails
+```
+
+## See also
+
+* [kyma alpha](kyma_alpha.md)                   - Groups command prototypes for which the API may still change
+* [kyma alpha app push](kyma_alpha_app_push.md) - Push the application to the Kubernetes cluster

docs/user/gen-docs/kyma_alpha_app_push.md

@@ -0,0 +1,35 @@
+# kyma alpha app push
+
+Push the application to the Kubernetes cluster.
+
+## Synopsis
+
+Use this command to push the application to the Kubernetes cluster.
+
+```bash
+kyma alpha app push [flags]
+```
+
+## Flags
+
+```text
+      --code-path string                   Path to the application source code directory
+      --container-port int                 Port on which the application is exposed
+      --dockerfile string                  Path to the Dockerfile
+      --dockerfile-build-arg stringArray   Variables used while building an application from Dockerfile as args
+      --dockerfile-context string          Context path for building Dockerfile (defaults to the current working directory)
+      --expose                             Creates an APIRule for the app
+      --image string                       Name of the image to deploy
+      --istio-inject                       Enables Istio for the app
+      --mount-config stringArray           Mounts ConfigMap content to the /bindings/configmap-<CONFIGMAP_NAME> path (default "[]")
+      --mount-secret stringArray           Mounts Secret content to the /bindings/secret-<SECRET_NAME> path (default "[]")
+      --name string                        Name of the app
+      --namespace string                   Namespace where the app is deployed (default "default")
+  -h, --help                               Help for the command
+      --kubeconfig string                  Path to the Kyma kubeconfig file
+      --show-extensions-error              Prints a possible error when fetching extensions fails
+```
+
+## See also
+
+* [kyma alpha app](kyma_alpha_app.md) - Manages applications on the Kubernetes cluster

docs/user/gen-docs/kyma_alpha_hana.md

@@ -0,0 +1,31 @@
+# kyma alpha hana
+
+Manages an SAP HANA instance in the Kyma cluster.
+
+## Synopsis
+
+Use this command to manage an SAP HANA instance in the Kyma cluster.
+
+```bash
+kyma alpha hana <command> [flags]
+```
+
+## Available Commands
+
+```text
+  help - Help about any command
+  map  - Maps an SAP HANA instance to the Kyma cluster
+```
+
+## Flags
+
+```text
+  -h, --help                    Help for the command
+      --kubeconfig string       Path to the Kyma kubeconfig file
+      --show-extensions-error   Prints a possible error when fetching extensions fails
+```
+
+## See also
+
+* [kyma alpha](kyma_alpha.md)                   - Groups command prototypes for which the API may still change
+* [kyma alpha hana map](kyma_alpha_hana_map.md) - Maps an SAP HANA instance to the Kyma cluster

docs/user/gen-docs/kyma_alpha_hana_map.md

@@ -0,0 +1,25 @@
+# kyma alpha hana map
+
+Maps an SAP HANA instance to the Kyma cluster.
+
+## Synopsis
+
+Use this command to map an SAP HANA instance to the Kyma cluster.
+
+```bash
+kyma alpha hana map [flags]
+```
+
+## Flags
+
+```text
+      --credentials-path string   Path to the credentials json file
+      --hana-id string            SAP HANA instance ID
+  -h, --help                      Help for the command
+      --kubeconfig string         Path to the Kyma kubeconfig file
+      --show-extensions-error     Prints a possible error when fetching extensions fails
+```
+
+## See also
+
+* [kyma alpha hana](kyma_alpha_hana.md) - Manages an SAP HANA instance in the Kyma cluster

docs/user/gen-docs/kyma_alpha_module.md

@@ -0,0 +1,41 @@
+# kyma alpha module
+
+Manages kyma modules.
+
+## Synopsis
+
+Use this command to manage modules in the Kyma cluster.
+
+```bash
+kyma alpha module <command> [flags]
+```
+
+## Available Commands
+
+```text
+  add      - Add a module
+  catalog  - Lists modules catalog
+  delete   - Deletes a module
+  help     - Help about any command
+  list     - Lists the installed modules
+  manage   - Sets the module to the managed state
+  unmanage - Sets a module to the unmanaged state
+```
+
+## Flags
+
+```text
+  -h, --help                    Help for the command
+      --kubeconfig string       Path to the Kyma kubeconfig file
+      --show-extensions-error   Prints a possible error when fetching extensions fails
+```
+
+## See also
+
+* [kyma alpha](kyma_alpha.md)                                 - Groups command prototypes for which the API may still change
+* [kyma alpha module add](kyma_alpha_module_add.md)           - Add a module
+* [kyma alpha module catalog](kyma_alpha_module_catalog.md)   - Lists modules catalog
+* [kyma alpha module delete](kyma_alpha_module_delete.md)     - Deletes a module
+* [kyma alpha module list](kyma_alpha_module_list.md)         - Lists the installed modules
+* [kyma alpha module manage](kyma_alpha_module_manage.md)     - Sets the module to the managed state
+* [kyma alpha module unmanage](kyma_alpha_module_unmanage.md) - Sets a module to the unmanaged state

docs/user/gen-docs/kyma_alpha_module_add.md

@@ -0,0 +1,26 @@
+# kyma alpha module add
+
+Add a module.
+
+## Synopsis
+
+Use this command to add a module.
+
+```bash
+kyma alpha module add <module> [flags]
+```
+
+## Flags
+
+```text
+  -c, --channel string          Name of the Kyma channel to use for the module
+      --cr-path string          Path to the custom resource file
+      --default-cr              Deploys the module with the default CR
+  -h, --help                    Help for the command
+      --kubeconfig string       Path to the Kyma kubeconfig file
+      --show-extensions-error   Prints a possible error when fetching extensions fails
+```
+
+## See also
+
+* [kyma alpha module](kyma_alpha_module.md) - Manages kyma modules

docs/user/gen-docs/kyma_alpha_module_catalog.md

@@ -0,0 +1,23 @@
+# kyma alpha module catalog
+
+Lists modules catalog.
+
+## Synopsis
+
+Use this command to list all available Kyma modules.
+
+```bash
+kyma alpha module catalog [flags]
+```
+
+## Flags
+
+```text
+  -h, --help                    Help for the command
+      --kubeconfig string       Path to the Kyma kubeconfig file
+      --show-extensions-error   Prints a possible error when fetching extensions fails
+```
+
+## See also
+
+* [kyma alpha module](kyma_alpha_module.md) - Manages kyma modules

docs/user/gen-docs/kyma_alpha_module_delete.md

@@ -0,0 +1,23 @@
+# kyma alpha module delete
+
+Deletes a module.
+
+## Synopsis
+
+Use this command to delete a module.
+
+```bash
+kyma alpha module delete <module> [flags]
+```
+
+## Flags
+
+```text
+  -h, --help                    Help for the command
+      --kubeconfig string       Path to the Kyma kubeconfig file
+      --show-extensions-error   Prints a possible error when fetching extensions fails
+```
+
+## See also
+
+* [kyma alpha module](kyma_alpha_module.md) - Manages kyma modules

docs/user/gen-docs/kyma_alpha_module_list.md

@@ -0,0 +1,23 @@
+# kyma alpha module list
+
+Lists the installed modules.
+
+## Synopsis
+
+Use this command to list the installed Kyma modules.
+
+```bash
+kyma alpha module list [flags]
+```
+
+## Flags
+
+```text
+  -h, --help                    Help for the command
+      --kubeconfig string       Path to the Kyma kubeconfig file
+      --show-extensions-error   Prints a possible error when fetching extensions fails
+```
+
+## See also
+
+* [kyma alpha module](kyma_alpha_module.md) - Manages kyma modules

docs/user/gen-docs/kyma_alpha_module_manage.md

@@ -0,0 +1,24 @@
+# kyma alpha module manage
+
+Sets the module to the managed state.
+
+## Synopsis
+
+Use this command to set an existing module to the managed state.
+
+```bash
+kyma alpha module manage <module> [flags]
+```
+
+## Flags
+
+```text
+      --policy string           Sets a custom resource policy (Possible values: CreateAndDelete, Ignore) (default "CreateAndDelete")
+  -h, --help                    Help for the command
+      --kubeconfig string       Path to the Kyma kubeconfig file
+      --show-extensions-error   Prints a possible error when fetching extensions fails
+```
+
+## See also
+
+* [kyma alpha module](kyma_alpha_module.md) - Manages kyma modules