Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update CLI Enable Module Command #1250

Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/test-smoke.yml
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ jobs:
kubectl apply -f https://raw.githubusercontent.com/prometheus-community/helm-charts/kube-prometheus-stack-47.0.0/charts/kube-prometheus-stack/crds/crd-servicemonitors.yaml
- name: Deploy lifecycle manager with Kyma CLI
run: kyma --ci alpha deploy -k config/${{ matrix.target }}
- name: Deploy template operator module template and enable module
- name: Deploy template operator module template and add module
if: ${{ matrix.target == 'default' }}
run: |
cat << EOF | kubectl apply -f -
Expand All @@ -138,4 +138,4 @@ jobs:
namespace: kcp-system
EOF
kubectl apply -f tests/moduletemplates/moduletemplate_template_operator_v1_regular.yaml
kyma alpha enable module template-operator -c regular -n kyma-system -k default-kyma
kyma alpha add module template-operator -c regular -n kyma-system -k default-kyma
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ For the worklow details, read the [Architecture](docs/technical-reference/archit

## Quick Start

Follow this quick start guide to set up the environment and use Lifecycle Manager to enable modules.
Follow this quick start guide to set up the environment and use Lifecycle Manager to add modules.

### Prerequisites

Expand Down Expand Up @@ -51,7 +51,7 @@ To use Lifecycle Manager in a local setup, install the following:
3. Enable a module. Run:

```bash
kyma alpha enable module {MODULE_NAME}
kyma alpha add module {MODULE_NAME}
```

**TIP:** Check the [modular Kyma interactive tutorial](https://killercoda.com/kyma-project/scenario/modular-kyma) to play with enabling and disabling Kyma modules in both terminal and Busola.
Expand Down
2 changes: 1 addition & 1 deletion docs/modularization.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Modules are the next generation of components in Kyma that are available for loc

Modules are no longer represented by a single helm-chart, but instead are bundled and released within channels through a [ModuleTemplate custom resource (CR)](/api/v1beta2/moduletemplate_types.go), a unique link of a module, and its desired state of resources and configuration, and a channel.

Lifecycle Manager manages clusters using the [Kyma CR](/api/v1beta2/kyma_types.go). The CR defines the desired state of modules in a cluster. With the CR you can enable and disable modules with domain-specific functionality with additional configuration.
Lifecycle Manager manages clusters using the [Kyma CR](/api/v1beta2/kyma_types.go). The CR defines the desired state of modules in a cluster. With the CR you can add and delete modules with domain-specific functionality with additional configuration.

The modules themselves are built and distributed as OCI artifacts. The internal structure of the artifact conforms to the [Open Component Model](https://ocm.software/) scheme version 3. Modules contain an immutable layer set of a module operator deployment description and its configuration.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@ To address this issue, we propose a CustomResourcePolicy feature that allows use

## Procedure

With Kyma CLI, enable a module with the [`kyma alpha enable`](https://github.com/kyma-project/cli/blob/main/docs/gen-docs/kyma_alpha_enable.md) command. Using the CLI, you can manage the CustomResourcePolicy for each module individually.
With Kyma CLI, enable a module with the [`kyma alpha add`](https://github.com/kyma-project/cli/blob/main/docs/gen-docs/kyma_alpha_add.md) command. Using the CLI, you can manage the CustomResourcePolicy for each module individually.

By default, the CustomResourcePolicy of the enabled module is `CreateAndDelete`. With the default, you let the Lifecycle Manager take full control over the module enablement.

For example, to enable the Keda module with the default policy for the `default-kyma` Kyma CR, run:

```bash
kyma alpha enable module keda -n kyma-system -k default-kyma
kyma alpha add module keda -n kyma-system -k default-kyma
```

This will result in the `default-kyma` Kyma CR spec like this:
Expand Down
Loading