# CLI Usage

This document demonstrates how to use the KUTTL CLI

Setup the KUTTL Kubectl Plugin
- Requirements
- Installation
Commands
Flags
Examples
- KUTTL Test

# Setup the KUTTL Kubectl Plugin

# Requirements

kubectl version 1.13.0 or newer

# Installation

You can either download CLI binaries for linux or MacOS from our release page (opens new window), or install the CLI plugin using brew:

brew tap kudobuilder/tap
brew install kuttl-cli

or you can compile and install the plugin from your $GOPATH/src/github.com/kudobuilder/kuttl root folder via:

make cli-install

Another alternative is krew (opens new window), the package manager for kubectl plugins.

kubectl krew install kuttl

# Commands

kubectl kuttl help [command] [flags]

Provides general help or help on a specific command

kubectl kuttl version

Print the current KUTTL version.

kubectl kuttl test

Run KUTTL test harness.

# Flags

Usage

kubectl kuttl test <name> [flags]

-h, --help

Help for test

--artifacts-dir (string)

Directory to output kind logs to (if not specified, the current working directory).

--config (string)

Path to file to load test settings from. This is usually the kuttl-test.yaml file.

--crd-dir (string)

Directory to load CustomResourceDefinitions from prior to running the tests.

--kind-config (string)

Specify the KIND configuration file path (implies --start-kind, cannot be used with --start-control-plane).

--kind-context (string)

Specify the KIND context name to use (default: kind).

--manifest-dir (stringArray)

One or more directories containing manifests to apply before running the tests.

--parallel (int)

The maximum number of tests to run at once. (default 8)

--skip-cluster-delete (bool)

If set, do not delete the mocked control plane or kind cluster.

--skip-delete (bool)

If set, do not delete resources created during tests (helpful for debugging test failures, implies --skip-cluster-delete).

--start-control-plane (bool)

Start a local Kubernetes control plane for the tests (requires etcd and kube-apiserver binaries, cannot be used with --start-kind).

--start-kind (bool)

Start a KIND cluster for the tests (cannot be used with --start-control-plane).

--test (string)

If set, the specific test case to run.

-v or -vv (int)

Logging verbosity level. 0=normal, 1=verbose, 2=detailed, 3 or more =trace.

# Examples

# KUTTL Test

KUTTL test command is the heart of the test harness. It requires a kuttl-test.yaml which defines the test setup.

apiVersion: kuttl.dev/v1beta1
kind: TestSuite
testDirs:
- ./test/integration
parallel: 4

The default can be run as follows:

kubectl kuttl test  pkg/test/test_data/

When running with no defined test environment, the default is a preconfigured cluster defined in $KUBECONFIG.

To run with the mocked control plane run:

kubectl kuttl test --start-control-plane pkg/test/test_data/

In order to run with the full kind cluster stack, run:

kubectl kuttl test --start-kind pkg/test/test_data/

← KUTTL Test Harness API Integration →