Kymactl

Overview

A command line tool to support developers of and with Kyma

Available Commands

• version: Shows the kyma cluster version and the kymactl version. The kymactl version is set at compile time passing it to the go linker as a flag:

  go build -o ./bin/kymactl -ldflags “-X github.com/kyma-incubator/kymactl/pkg/kymactl/cmd.Version=1.5.0” ./cmd/kymactl.go

• install cluster minikube: Initializes minikube with a new cluster (replaces the minikube.sh script)

• install kyma: Installs kyma to a cluster based on a release (replaces the ìnstaller.sh and is-installed.sh script)

• uninstall kyma: Uninstalls all kyma related resources from a cluster

• completion: Output shell completion code for bash.

• help: Displays usage for the given command (e.g. kymactl help, kymactl help status, etc...)

Usage

Installation of kyma with minikube on Mac:

kymactl install cluster minikube
kymactl install kyma

Installation of kyma with minikube on Windows:

kymactl install cluster minikube --vm-driver hyper-v
# follow instructions to add hosts

kymactl install kyma

Kymactl as a Kubectl plugin

To follow this section a kubectl version of 1.12.0 or later is required.

A plugin is nothing more than a standalone executable file, whose name begins with kubectl- . To install a plugin, simply move this executable file to anywhere on your PATH.

Rename a kymactl binary to kubectl-kyma and place it anywhere in your PATH:

sudo mv ./kymactl /usr/local/bin/kubectl-kyma

Run kubectl plugin list command and you will see your plugin in the list of available plugins.

You may now invoke your plugin as a kubectl command:

$ kubectl kyma status
Kyma is running!

To know more about extending kubectl with plugins read kubernetes documentation.

Roadmap

• adding minikube domain to hosts file on windows
• use latest release automically
• install optional kyma module (ark, logging)
• uninstall optional kyma module
• update kyma to newer release
• list available releases
• install gke cluster
• execute acceptance tests against kyma cluster
• connect application to kyma
• use log framework with log levels and have verbose modes
• support merging custom configuration from file