Commands

kyma

Controls a Kyma cluster.

Synopsis

Kyma is a flexible and easy way to connect and extend enterprise applications in a cloud-native world. Kyma CLI allows you to install, test, and manage Kyma.

Options

Click to copy
--ci Enables the CI mode to run on CI/CD systems.
-h, --help Displays help for the command.
--kubeconfig string Specifies the path to the kubeconfig file. By default, Kyma CLI uses the KUBECONFIG environment variable or "/$HOME/.kube/config" if the variable is not set.
--non-interactive Enables the non-interactive shell mode.
-v, --verbose Displays details of actions triggered by the command.

See also

kyma completion

Generates bash or zsh completion scripts.

Synopsis

Use this command to display the shell completion code used for interactive command completion. To configure your shell to load completions, add . <(kyma completion bash) to your bash profile or . <(kyma completion zsh) to your zsh profile.

Click to copy
kyma completion bash|zsh [flags]

Options inherited from parent commands

Click to copy
--ci Enables the CI mode to run on CI/CD systems.
-h, --help Displays help for the command.
--kubeconfig string Specifies the path to the kubeconfig file. By default, Kyma CLI uses the KUBECONFIG environment variable or "/$HOME/.kube/config" if the variable is not set.
--non-interactive Enables the non-interactive shell mode.
-v, --verbose Displays details of actions triggered by the command.

See also

  • kyma - Controls a Kyma cluster.

kyma console

Opens the Kyma Console in a web browser.

Synopsis

Use this command to open the Kyma Console in a web browser.

Click to copy
kyma console [flags]

Options inherited from parent commands

Click to copy
--ci Enables the CI mode to run on CI/CD systems.
-h, --help Displays help for the command.
--kubeconfig string Specifies the path to the kubeconfig file. By default, Kyma CLI uses the KUBECONFIG environment variable or "/$HOME/.kube/config" if the variable is not set.
--non-interactive Enables the non-interactive shell mode.
-v, --verbose Displays details of actions triggered by the command.

See also

  • kyma - Controls a Kyma cluster.

kyma install

Installs Kyma on a running Kubernetes cluster.

Synopsis

Use this command to install Kyma on a running Kubernetes cluster.

Detailed description

Before you use the command, make sure your setup meets the following prerequisites:

  • Kyma is not installed.
  • Kubernetes cluster is available with your kubeconfig file already pointing to it.

Here are the installation steps:

The standard installation uses the minimal configuration. The system performs the following steps:

  1. Deploys and configures the Kyma Installer. At this point, steps differ depending on the installation type.

    When you install Kyma locally from release, the system:

    1. Fetches the latest or specified release along with configuration.
    2. Deploys the Kyma Installer on the cluster.
    3. Applies downloaded or defined configuration.
    4. Applies overrides, if applicable.
    5. Sets the admin password.
    6. Patches the Minikube IP.

    When you install Kyma locally from sources, the system:

    1. Fetches the configuration yaml files from the local sources.
    2. Builds the Kyma Installer image.
    3. Deploys the Kyma Installer and applies the fetched configuration.
    4. Applies overrides, if applicable.
    5. Sets the admin password.
    6. Patches the Minikube IP.

  2. Runs Kyma installation until the installed status confirms the successful installation. You can override the standard installation settings using the --override flag.

Click to copy
kyma install [flags]

Options

Click to copy
-c, --components string Path to a YAML file with component list to override.
--custom-image string Full image name including the registry and the tag. Required for installation from local sources to a remote cluster.
-d, --domain string Domain used for installation. (default "kyma.local")
--fallbackLevel int If "source=latest-published", defines the number of commits from master branch taken into account if artifacts for newer commits do not exist yet (default 5)
-n, --noWait Flag that determines if the command should wait for Kyma installation to complete.
-o, --override stringArray Path to a YAML file with parameters to override.
-p, --password string Predefined cluster password.
-s, --source string Installation source.
- To use the specific release, write "kyma install --source=1.3.0".
- To use the latest master, write "kyma install --source=latest".
- To use the latest published master, which is the latest commit with released images, write "kyma install --source=latest-published".
- To use a commit, write "kyma install --source=34edf09a".
- To use the local sources, write "kyma install --source=local".
- To use a custom installer image, write kyma "install --source=user/my-kyma-installer:v1.4.0".
--src-path string Absolute path to local sources.
--timeout duration Time-out after which CLI stops watching the installation progress. (default 1h0m0s)
--tlsCert string TLS certificate for the domain used for installation. The certificate must be a base64-encoded value.
--tlsKey string TLS key for the domain used for installation. The key must be a base64-encoded value.

Options inherited from parent commands

Click to copy
--ci Enables the CI mode to run on CI/CD systems.
-h, --help Displays help for the command.
--kubeconfig string Specifies the path to the kubeconfig file. By default, Kyma CLI uses the KUBECONFIG environment variable or "/$HOME/.kube/config" if the variable is not set.
--non-interactive Enables the non-interactive shell mode.
-v, --verbose Displays details of actions triggered by the command.

See also

  • kyma - Controls a Kyma cluster.

kyma provision

Provisions a cluster for Kyma installation.

Synopsis

Provisions a cluster for Kyma installation.

Options inherited from parent commands

Click to copy
--ci Enables the CI mode to run on CI/CD systems.
-h, --help Displays help for the command.
--kubeconfig string Specifies the path to the kubeconfig file. By default, Kyma CLI uses the KUBECONFIG environment variable or "/$HOME/.kube/config" if the variable is not set.
--non-interactive Enables the non-interactive shell mode.
-v, --verbose Displays details of actions triggered by the command.

See also

kyma provision aks

Provisions an Azure Kubernetes Service (AKS) cluster on Azure.

Synopsis

Use this command to provision an AKS cluster on Azure for Kyma installation. Use the flags to specify cluster details. NOTE: To provision and access the provisioned cluster, make sure you get authenticated by using the Azure CLI. To do so,run az login and log in with your Azure credentials.

Click to copy
kyma provision aks [flags]

Options

Click to copy
-c, --credentials string Path to the TOML file containing the Azure Subscription ID (SUBSCRIPTION_ID), Tenant ID (TENANT_ID), Client ID (CLIENT_ID) and Client Secret (CLIENT_SECRET). (required)
--disk-size int Disk size (in GB) of the cluster. (default 50)
-k, --kube-version string Kubernetes version of the cluster. (default "1.16.10")
-l, --location string Location of the cluster. (default "westeurope")
-n, --name string Name of the AKS cluster to provision. (required)
--nodes int Number of cluster nodes. (default 3)
-p, --project string Name of the Azure Resource Group where you provision the AKS cluster. (required)
-t, --type string Machine type used for the cluster. (default "Standard_D4_v3")

Options inherited from parent commands

Click to copy
--ci Enables the CI mode to run on CI/CD systems.
-h, --help Displays help for the command.
--kubeconfig string Specifies the path to the kubeconfig file. By default, Kyma CLI uses the KUBECONFIG environment variable or "/$HOME/.kube/config" if the variable is not set.
--non-interactive Enables the non-interactive shell mode.
-v, --verbose Displays details of actions triggered by the command.

See also

kyma provision gardener

Provisions a cluster using Gardener on GCP, Azure, or AWS.

Synopsis

Provisions a cluster using Gardener on GCP, Azure, or AWS.

Options inherited from parent commands

Click to copy
--ci Enables the CI mode to run on CI/CD systems.
-h, --help Displays help for the command.
--kubeconfig string Specifies the path to the kubeconfig file. By default, Kyma CLI uses the KUBECONFIG environment variable or "/$HOME/.kube/config" if the variable is not set.
--non-interactive Enables the non-interactive shell mode.
-v, --verbose Displays details of actions triggered by the command.

See also

kyma provision gardener aws

Provisions a Kubernetes cluster using Gardener on Amazon Web Services (AWS).

Synopsis

Use this command to provision Kubernetes clusters with Gardener on AWS for Kyma installation. To successfully provision a cluster on AWS, you must first create a service account to pass its details as one of the command parameters. Check the roles and create a service account using instructions at https://gardener.cloud/050-tutorials/content/howto/gardener_aws/. Use service account details to create a Secret and store it in Gardener.

Click to copy
kyma provision gardener aws [flags]

Options

Click to copy
-c, --credentials string Path to the kubeconfig file of the Gardener service account for AWS. (required)
--disk-size int Disk size (in GB) of the cluster. (default 50)
--disk-type string Type of disk to use on AWS. (default "gp2")
-e, --extra NAME=VALUE One or more arguments provided as the NAME=VALUE key-value pairs to configure additional cluster settings. You can use this flag multiple times or enter the key-value pairs as a comma-separated list.
-k, --kube-version string Kubernetes version of the cluster. (default "1.16")
-n, --name string Name of the cluster to provision. (required)
-p, --project string Name of the Gardener project where you provision the cluster. (required)
-r, --region string Region of the cluster. (default "eu-west-3")
--scaler-max int Maximum autoscale value of the cluster. (default 3)
--scaler-min int Minimum autoscale value of the cluster. (default 2)
-s, --secret string Name of the Gardener secret used to access AWS. (required)
-t, --type string Machine type used for the cluster. (default "m5.xlarge")
-z, --zones strings Zones specify availability zones that are used to evenly distribute the worker pool. eg. --zones="europe-west3-a,europe-west3-b" (default [eu-west-3a])

Options inherited from parent commands

Click to copy
--ci Enables the CI mode to run on CI/CD systems.
-h, --help Displays help for the command.
--kubeconfig string Specifies the path to the kubeconfig file. By default, Kyma CLI uses the KUBECONFIG environment variable or "/$HOME/.kube/config" if the variable is not set.
--non-interactive Enables the non-interactive shell mode.
-v, --verbose Displays details of actions triggered by the command.

See also

kyma provision gardener az

Provisions a Kubernetes cluster using Gardener on Azure.

Synopsis

Use this command to provision Kubernetes clusters with Gardener on Azure for Kyma installation. To successfully provision a cluster on Azure, you must first create a service account to pass its details as one of the command parameters. Create a service account with the contributor role. Use service account details to create a Secret and store it in Gardener.

Click to copy
kyma provision gardener az [flags]

Options

Click to copy
-c, --credentials string Path to the kubeconfig file of the Gardener service account for Azure. (required)
--disk-size int Disk size (in GB) of the cluster. (default 50)
--disk-type string Type of disk to use on Azure. (default "Standard_LRS")
-e, --extra NAME=VALUE One or more arguments provided as the NAME=VALUE key-value pairs to configure additional cluster settings. You can use this flag multiple times or enter the key-value pairs as a comma-separated list.
-k, --kube-version string Kubernetes version of the cluster. (default "1.16")
-n, --name string Name of the cluster to provision. (required)
-p, --project string Name of the Gardener project where you provision the cluster. (required)
-r, --region string Region of the cluster. (default "westeurope")
--scaler-max int Maximum autoscale value of the cluster. (default 3)
--scaler-min int Minimum autoscale value of the cluster. (default 2)
-s, --secret string Name of the Gardener secret used to access Azure. (required)
-t, --type string Machine type used for the cluster. (default "Standard_D4_v3")
-z, --zones strings Zones specify availability zones that are used to evenly distribute the worker pool. eg. --zones="europe-west3-a,europe-west3-b" (default [1])

Options inherited from parent commands

Click to copy
--ci Enables the CI mode to run on CI/CD systems.
-h, --help Displays help for the command.
--kubeconfig string Specifies the path to the kubeconfig file. By default, Kyma CLI uses the KUBECONFIG environment variable or "/$HOME/.kube/config" if the variable is not set.
--non-interactive Enables the non-interactive shell mode.
-v, --verbose Displays details of actions triggered by the command.

See also

kyma provision gardener gcp

Provisions a Kubernetes cluster using Gardener on Google Cloud Platform (GCP).

Synopsis

Use this command to provision Kubernetes clusters with Gardener on GCP for Kyma installation. To successfully provision a cluster on GCP, you must first create a service account to pass its details as one of the command parameters. Check the roles and create a service account using instructions at https://gardener.cloud/050-tutorials/content/howto/gardener_gcp/. Use service account details to create a Secret and store it in Gardener.

Click to copy
kyma provision gardener gcp [flags]

Options

Click to copy
-c, --credentials string Path to the kubeconfig file of the Gardener service account for GCP. (required)
--disk-size int Disk size (in GB) of the cluster. (default 50)
--disk-type string Type of disk to use on GCP. (default "pd-standard")
-e, --extra NAME=VALUE One or more arguments provided as the NAME=VALUE key-value pairs to configure additional cluster settings. You can use this flag multiple times or enter the key-value pairs as a comma-separated list.
-k, --kube-version string Kubernetes version of the cluster. (default "1.16")
-n, --name string Name of the cluster to provision. (required)
-p, --project string Name of the Gardener project where you provision the cluster. (required)
-r, --region string Region of the cluster. (default "europe-west3")
--scaler-max int Maximum autoscale value of the cluster. (default 3)
--scaler-min int Minimum autoscale value of the cluster. (default 2)
-s, --secret string Name of the Gardener secret used to access GCP. (required)
-t, --type string Machine type used for the cluster. (default "n1-standard-4")
-z, --zones strings Zones specify availability zones that are used to evenly distribute the worker pool. eg. --zones="europe-west3-a,europe-west3-b" (default [europe-west3-a])

Options inherited from parent commands

Click to copy
--ci Enables the CI mode to run on CI/CD systems.
-h, --help Displays help for the command.
--kubeconfig string Specifies the path to the kubeconfig file. By default, Kyma CLI uses the KUBECONFIG environment variable or "/$HOME/.kube/config" if the variable is not set.
--non-interactive Enables the non-interactive shell mode.
-v, --verbose Displays details of actions triggered by the command.

See also

kyma provision gke

Provisions a Google Kubernetes Engine (GKE) cluster on Google Cloud Platform (GCP).

Synopsis

Use this command to provision a GKE cluster on GCP for Kyma installation. Use the flags to specify cluster details. NOTE: To access the provisioned cluster, make sure you get authenticated by Google Cloud SDK. To do so,run gcloud auth application-default login and log in with your Google Cloud credentials.

Click to copy
kyma provision gke [flags]

Options

Click to copy
-c, --credentials string Path to the GCP service account key file. (required)
--disk-size int Disk size (in GB) of the cluster. (default 50)
-k, --kube-version string Kubernetes version of the cluster. (default "1.15")
-l, --location string Location of the cluster. (default "europe-west3-a")
-n, --name string Name of the GKE cluster to provision. (required)
--nodes int Number of cluster nodes. (default 3)
-p, --project string Name of the GCP Project where you provision the GKE cluster. (required)
-t, --type string Machine type used for the cluster. (default "n1-standard-4")

Options inherited from parent commands

Click to copy
--ci Enables the CI mode to run on CI/CD systems.
-h, --help Displays help for the command.
--kubeconfig string Specifies the path to the kubeconfig file. By default, Kyma CLI uses the KUBECONFIG environment variable or "/$HOME/.kube/config" if the variable is not set.
--non-interactive Enables the non-interactive shell mode.
-v, --verbose Displays details of actions triggered by the command.

See also

kyma provision minikube

Provisions Minikube.

Synopsis

Use this command to provision a Minikube cluster for Kyma installation. It requires to have Minikube installed upfront, see also https://github.com/kubernetes/minikube

Click to copy
kyma provision minikube [flags]

Options

Click to copy
--cpus string Specifies the number of CPUs used for installation. (default "4")
--disk-size string Specifies the disk size used for installation. (default "30g")
--hypervVirtualSwitch string Specifies the Hyper-V switch version if you choose Hyper-V as the driver.
--memory string Specifies RAM reserved for installation. (default "8192")
--profile string Specifies the Minikube profile.
--timeout duration Maximum time during which the provisioning takes place, where "0" means "infinite". Valid time units are "ns", "us" (or "¬Ķs"), "ms", "s", "m", "h". (default 5m0s)
--vm-driver string Specifies the VM driver. Possible values: vmwarefusion,kvm,xhyve,hyperv,hyperkit,virtualbox,kvm2,none (default "hyperkit")

Options inherited from parent commands

Click to copy
--ci Enables the CI mode to run on CI/CD systems.
-h, --help Displays help for the command.
--kubeconfig string Specifies the path to the kubeconfig file. By default, Kyma CLI uses the KUBECONFIG environment variable or "/$HOME/.kube/config" if the variable is not set.
--non-interactive Enables the non-interactive shell mode.
-v, --verbose Displays details of actions triggered by the command.

See also

kyma test

Runs tests on a provisioned Kyma cluster.

Synopsis

Use this command to run tests on a provisioned Kyma cluster.

Options inherited from parent commands

Click to copy
--ci Enables the CI mode to run on CI/CD systems.
-h, --help Displays help for the command.
--kubeconfig string Specifies the path to the kubeconfig file. By default, Kyma CLI uses the KUBECONFIG environment variable or "/$HOME/.kube/config" if the variable is not set.
--non-interactive Enables the non-interactive shell mode.
-v, --verbose Displays details of actions triggered by the command.

See also

kyma test definitions

Shows test definitions available for a provisioned Kyma cluster.

Synopsis

Use this command to list test definitions available for a provisioned Kyma cluster.

Click to copy
kyma test definitions [flags]

Options inherited from parent commands

Click to copy
--ci Enables the CI mode to run on CI/CD systems.
-h, --help Displays help for the command.
--kubeconfig string Specifies the path to the kubeconfig file. By default, Kyma CLI uses the KUBECONFIG environment variable or "/$HOME/.kube/config" if the variable is not set.
--non-interactive Enables the non-interactive shell mode.
-v, --verbose Displays details of actions triggered by the command.

See also

  • kyma test - Runs tests on a provisioned Kyma cluster.

kyma test delete

Deletes test suites available for a provisioned Kyma cluster.

Synopsis

Use this command to delete test suites available for a provisioned Kyma cluster.

Provide at least one test suite name.

Click to copy
kyma test delete <test-suite-1> <test-suite-2> ... <test-suite-N> [flags]

Options inherited from parent commands

Click to copy
--ci Enables the CI mode to run on CI/CD systems.
-h, --help Displays help for the command.
--kubeconfig string Specifies the path to the kubeconfig file. By default, Kyma CLI uses the KUBECONFIG environment variable or "/$HOME/.kube/config" if the variable is not set.
--non-interactive Enables the non-interactive shell mode.
-v, --verbose Displays details of actions triggered by the command.

See also

  • kyma test - Runs tests on a provisioned Kyma cluster.

kyma test list

Lists test suites available for a provisioned Kyma cluster.

Synopsis

Use this command to list test suites available for a provisioned Kyma cluster.

Click to copy
kyma test list [flags]

Options inherited from parent commands

Click to copy
--ci Enables the CI mode to run on CI/CD systems.
-h, --help Displays help for the command.
--kubeconfig string Specifies the path to the kubeconfig file. By default, Kyma CLI uses the KUBECONFIG environment variable or "/$HOME/.kube/config" if the variable is not set.
--non-interactive Enables the non-interactive shell mode.
-v, --verbose Displays details of actions triggered by the command.

See also

  • kyma test - Runs tests on a provisioned Kyma cluster.

kyma test logs

Shows the logs of tests Pods for a given test suite.

Synopsis

Use this command to display logs of a test executed for a given test suite. By default, the command displays logs for failed tests, but you can change this behavior using the "test-status" flag.

To print the status of specific test cases, run kyma test logs testSuiteOne testSuiteTwo. Provide at least one test suite name.

Click to copy
kyma test logs <test-suite-1> <test-suite-2> ... <test-suite-N> [flags]

Options

Click to copy
--ignored-containers strings Container names which are ignored when fetching logs from testing Pods. Takes comma-separated list. (default [istio-init,istio-proxy,manager])
--test-status string Displays logs coming only from testing Pods with a given status. (default "Failed")

Options inherited from parent commands

Click to copy
--ci Enables the CI mode to run on CI/CD systems.
-h, --help Displays help for the command.
--kubeconfig string Specifies the path to the kubeconfig file. By default, Kyma CLI uses the KUBECONFIG environment variable or "/$HOME/.kube/config" if the variable is not set.
--non-interactive Enables the non-interactive shell mode.
-v, --verbose Displays details of actions triggered by the command.

See also

  • kyma test - Runs tests on a provisioned Kyma cluster.

kyma test run

Runs tests on a Kyma cluster.

Synopsis

Use this command to run tests on a Kyma cluster.

Remarks: If you don't provide any specific test definitions, all available test definitions will be added to the newly created test suite. To execute all test defintions, run kyma test run -n example-test.

Click to copy
kyma test run <test-definition-1> <test-definition-2> ... <test-definition-N> [flags]

Options

Click to copy
--concurrency int Number of tests to be executed in parallel. (default 5)
-c, --count int Number of times every test should be executed. "count" and "max-retries" flags are mutually exclusive. (default 1)
--max-retries int Number of times a given test is retried when it fails. A suite is marked with a "succeeded" status even if some tests failed at first and then finally succeeded. The default value of 0 means that there are no retries of a given test.
-n, --name string Name of the new test suite. If you don't specify the value for the "-n" flag, the name of the test suite will be autogenerated.
--timeout duration Maximum time during which the test suite is being watched, where "0" means "infinite". Valid time units are "ns", "us" (or "¬Ķs"), "ms", "s", "m", "h".
-w, --watch Watches the status of the test suite until the tests finish or the defined "--timeout" occurs.

Options inherited from parent commands

Click to copy
--ci Enables the CI mode to run on CI/CD systems.
-h, --help Displays help for the command.
--kubeconfig string Specifies the path to the kubeconfig file. By default, Kyma CLI uses the KUBECONFIG environment variable or "/$HOME/.kube/config" if the variable is not set.
--non-interactive Enables the non-interactive shell mode.
-v, --verbose Displays details of actions triggered by the command.

See also

  • kyma test - Runs tests on a provisioned Kyma cluster.

kyma test status

Shows the status of a test suite and related test executions.

Synopsis

Use this command to display the status of a test suite and related test executions.

If you don't provide any arguments, the status of all test suites will be printed. To print the status of all test suites, run kyma test status. To print the status of specific test cases, run kyma test status testSuiteOne testSuiteTwo.

Click to copy
kyma test status <test-suite-1> <test-suite-2> ... <test-suite-N> [flags]

Options

Click to copy
-o, --output string Output format. One of: json|yaml|wide|junit

Options inherited from parent commands

Click to copy
--ci Enables the CI mode to run on CI/CD systems.
-h, --help Displays help for the command.
--kubeconfig string Specifies the path to the kubeconfig file. By default, Kyma CLI uses the KUBECONFIG environment variable or "/$HOME/.kube/config" if the variable is not set.
--non-interactive Enables the non-interactive shell mode.
-v, --verbose Displays details of actions triggered by the command.

See also

  • kyma test - Runs tests on a provisioned Kyma cluster.

kyma upgrade

Upgrades Kyma to match the CLI version.

Synopsis

Use this command to upgrade the Kyma version on a cluster so that it matches the CLI version

Click to copy
kyma upgrade [flags]

Options

Click to copy
-c, --components string Path to a YAML file with a component list to override.
-d, --domain string Domain used for the upgrade. (default "kyma.local")
-n, --noWait Determines if the command should wait for the Kyma upgrade to complete.
-o, --override stringArray Path to a YAML file with parameters to override.
-p, --password string Predefined cluster password.
--timeout duration Timeout after which CLI stops watching the upgrade progress. (default 1h0m0s)
--tlsCert string TLS certificate for the domain used for the upgrade. The certificate must be a base64-encoded value.
--tlsKey string TLS key for the domain used for the upgrade. The key must be a base64-encoded value.

Options inherited from parent commands

Click to copy
--ci Enables the CI mode to run on CI/CD systems.
-h, --help Displays help for the command.
--kubeconfig string Specifies the path to the kubeconfig file. By default, Kyma CLI uses the KUBECONFIG environment variable or "/$HOME/.kube/config" if the variable is not set.
--non-interactive Enables the non-interactive shell mode.
-v, --verbose Displays details of actions triggered by the command.

See also

  • kyma - Controls a Kyma cluster.

kyma version

Displays the version of Kyma CLI and the connected Kyma cluster.

Synopsis

Use this command to print the version of Kyma CLI and the version of the Kyma cluster the current kubeconfig points to.

Click to copy
kyma version [flags]

Options

Click to copy
-c, --client Client version only (no server required)

Options inherited from parent commands

Click to copy
--ci Enables the CI mode to run on CI/CD systems.
-h, --help Displays help for the command.
--kubeconfig string Specifies the path to the kubeconfig file. By default, Kyma CLI uses the KUBECONFIG environment variable or "/$HOME/.kube/config" if the variable is not set.
--non-interactive Enables the non-interactive shell mode.
-v, --verbose Displays details of actions triggered by the command.

See also

  • kyma - Controls a Kyma cluster.