Branch: master
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
cmd/operator
deploy/installer
hack
pkg
scripts
.gitignore
Gopkg.lock
Gopkg.toml
Makefile
README.md
before-commit.sh

README.md

Installer

Overview

Installer is a tool for installing all Kyma components. The project is based on the Kubernetes operator pattern. It tracks changes of the Installation type instance of the custom resource. It also installs, uninstalls, and updates Kyma accordingly.

Prerequisites

  • Minikube 0.26.1
  • kubectl 1.9.0
  • Docker
  • jq

Development

Before each commit, use the before-commit.sh script to test your changes:

./before-commit.sh

Build a Docker image

Run the build.sh script to build a Docker image:

./scripts/build.sh

Run on Minikube

Run with local Kyma resources

export KYMA_PATH={PATH_TO_KYMA_SOURCES}

This environment variable is used to trigger shell scripts located in Kyma.

./scripts/run.sh --local --cr {PATH_TO_CR}

It will run Minikube, set up the installer, and install Kyma from local sources. If Minikube was started before, it will be restarted.

See the Custom resource file section in this document to learn how to generate a custom resource file.

To track progress of the installation, run:

../../installation/scripts/is-installed.sh

Rerun without restarting Minikube

This scenario is useful when you want to reuse cached Docker images.

Run the following script to clear running Minikube:

../../installation/scripts/clean-up.sh

Execute the run.sh script with the --skip-minikube-start flag to rerun Kyma installation without stopping your Minikube:

./scripts/run.sh --skip-minikube-start

Update the Kyma cluster

Connect to the cluster that hosts your Kyma installation. Prepare the URL to the updated Kyma tar.gz package. Run the following command to edit the installation CR:

kubectl edit installation/{CR_NAME}

Change the url property in spec to {URL TO KYMA TAR GZ}. Trigger the update by overriding the action label in CR:

kubectl label installation/{CR_NAME} action=install --overwrite

Uninstall Kyma

Run the following command to completely uninstall Kyma:

kubectl label installation/kyma-installation action=uninstall

Custom resource file

The custom resource file for installer provides the basic information for Kyma installation.

The required properties iclude:

  • url which is the URL address to a Kyma charts package. Only tar.gz is supported and it is required for non-local installations only.
  • version which is the version of Kyma.
  • components which is the list of Kyma components.

Generate the custom resource file for installer

Generate a custom resource file using the create-cr.sh script. It accepts the following arguments:

  • --output is a mandatory parameter which indicates the location of the custom resource output file.
  • --url is the URL to the Kyma package.
  • --version is the version of Kyma.

Example:

../../installation/scripts/create-cr.sh --output installer-cr.yaml --url {URL TO KYMA TAR GZ} --version 0.0.1

Static overrides for cluster installations

You can define cluster-specific overrides for each root chart. In the cluster deployment scenario, the installer reads the cluster.yaml file in each root chart and appends its content to the overrides applied during the Helm installation.