kyverno/documentation/kyverno-cli.md

documentation / kyverno-cli

Kyverno CLI

The Kyverno Command Line Interface (CLI) is designed to validate policies and test the behavior of applying policies to resources before adding the policy to a cluster. It can be used as a kubectl plugin and as a standalone CLI.

Build the CLI

You can build the CLI binary locally, then move the binary into a directory in your PATH.

git clone https://github.com/nirmata/kyverno.git
cd github.com/nirmata/kyverno
make cli
mv ./cmd/cli/kubectl-kyverno/kyverno /usr/local/bin/kyverno

You can also use Krew

# Install kyverno using krew plugin manager
kubectl krew install kyverno 

#example 
kubectl kyverno version  

Install via AUR (archlinux)

You can install the kyverno cli via your favourite AUR helper (e.g. yay)

yay -S kyverno-git

Commands

Version

Prints the version of kyverno used by the CLI.

Example:

kyverno version

Validate

Validates a policy, can validate multiple policy resource description files or even an entire folder containing policy resource description files. Currently supports files with resource description in yaml.

Example:

kyverno validate /path/to/policy1.yaml /path/to/policy2.yaml /path/to/folderFullOfPolicies

Use the -o <yaml/json> flag to display the mutated policy.

Example:

kyverno validate /path/to/policy1.yaml /path/to/policy2.yaml /path/to/folderFullOfPolicies -o yaml

Apply

Applies policies on resources, and supports applying multiple policies on multiple resources in a single command. Also supports applying the given policies to an entire cluster. The current kubectl context will be used to access the cluster.

Displays mutate results to stdout, by default. Use the -o flag to save mutated resources to a file or directory.

Apply to a resource:

kyverno apply /path/to/policy.yaml --resource /path/to/resource.yaml

Apply to all matching resources in a cluster:

kyverno apply /path/to/policy.yaml --cluster > policy-results.txt

Apply multiple policies to multiple resources:

kyverno apply /path/to/policy1.yaml /path/to/folderFullOfPolicies --resource /path/to/resource1.yaml --resource /path/to/resource2.yaml --cluster

Saving the mutated resource in a file/directory:

kyverno apply /path/to/policy.yaml --resource /path/to/resource.yaml -o <file path/directory path>

Read Next >> Sample Policies