Install, uninstall and upgrade a Kyma module

Learn how to install, uninstall and upgrade a Kyma module. To see the list of all available and planned Kyma modules, go to Overview.

Install a Kyma module

To install a module, deploy its module manager and apply the module configuration. See the already available Kyma modules with their quick installation steps and links to their GitHub repositories:

Prerequisites

  • kubectl
  • Kubernetes cluster, or k3d for local installation

Steps

Keda

Click to copy
kubectl create ns kyma-system
kubectl apply -f https://github.com/kyma-project/keda-manager/releases/latest/download/keda-manager.yaml
kubectl apply -f https://github.com/kyma-project/keda-manager/releases/latest/download/keda-default-cr.yaml -n kyma-system

For more details see, the keda-manager repository in GitHub.

BTP Operator

Click to copy
kubectl apply -f https://github.com/kyma-project/btp-manager/releases/latest/download/btp-manager.yaml
kubectl apply -f https://github.com/kyma-project/btp-manager/releases/latest/download/btp-operator-default-cr.yaml

CAUTION: The CR is in the Warning state and the message is Secret resource not found reason: MissingSecret. To create a Secret, follow the instructions in the btp-manager repository.

Uninstall a Kyma module

You uninstall a Kyma module with the kubectl delete command.

  1. Find out the paths for the module you want to uninstall; for example, from the Install a Kyma module section.

  2. Delete the module configuration:

    Click to copy
    kubectl delete {PATH_TO_THE_MODULE_CUSTOM_RESOURCE}
  3. To avoid leaving some resources behind, wait for the module custom resource deletion to be complete.

  4. Delete the module manager:

    Click to copy
    kubectl delete {PATH_TO_THE_MODULE_MANAGER_YAML_FILE}

Upgrade a Kyma module

To upgrade a Kyma module to the latest version, run the same kubectl commands used for its installation.