Skip to content

README.md

Latest commit

 

History

History
80 lines (49 loc) · 2.78 KB

README.md

File metadata and controls

80 lines (49 loc) · 2.78 KB

Community Modules

Overview

Community modules are modules provided by the Kyma community. Use them to enhance your Kyma experience with additional features and capabilities. You can install community modules alongside managed modules.

Note

Key Distinction: Community modules differ fundamentally from managed SAP BTP, Kyma runtime modules:

  • Community modules are NOT handled in the Kyma custom resource (CR): They are managed independently and are not part of the Kyma resource specification.
  • Community modules are NOT managed by Kyma Control Plane: The control plane does not automatically manage their lifecycle, update them, or monitor their health.
  • You must perform all the necessary actions: Installation, updates, and removal require manual intervention.

Unlike managed modules, community modules aren't automatically updated or maintained. You are fully responsible for managing community modules, including keeping them updated, monitoring their health, and handling any issues that arise.

Warning

In SAP BTP, Kyma runtime community modules aren't subject to the Service Level Agreement (SLA).

Quick Install

Kyma Dashboard

  1. Go to your Kyma dashboard and select Modify Modules.

  2. In the Community Modules section, select Add and mark the modules you want to install.

  3. Select Add.

Your module is installed once its status changes to Ready.

Next Steps

To delete a community module, select the trash icon next to the module's name.

Kyma CLI

  1. Check the list of modules that you can add:

    kyma module catalog

  2. Pull the ModuleTemplate:

    kyma module pull {MODULE_NAME} --version {module version}

    This command pulls the ModuleTemplate for the given module. You can specify the namespace where the ModuleTemplate should be stored using the --namespace flag (by default, the default namespace is used). If there are multiple versions available in the catalog, you can specify the version with --version.

  3. Install the module by pointing to the pulled ModuleTemplate using the --origin flag:

    kyma module add {MODULE_NAME} --origin {NAMESPACE}/{MODULE_NAME}-{VERSION} --default-cr

  4. See if your module is added:

    kyma module list

    You should see your module in the list of modules.

Next Steps

To delete a community module, use the following command:

kyma module delete {MODULE_NAME} --community

Update Community Modules

Community modules are not automatically updated. For more information on how to keep your modules up-to-date with the latest security patches, bug fixes, and new features, see Update Community Modules.