From 971008e1c8f3634527093bd418119aaa2a3c3b5a Mon Sep 17 00:00:00 2001 From: shravan Date: Mon, 17 Feb 2020 10:20:02 +0530 Subject: [PATCH 1/4] 696_add_documentation --- README.md | 1 + documentation/cli-usage.md | 54 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 55 insertions(+) create mode 100644 documentation/cli-usage.md diff --git a/README.md b/README.md index dee9298ba0..f5ccde2cdf 100644 --- a/README.md +++ b/README.md @@ -129,6 +129,7 @@ Refer to a list of curated of ***[sample policies](/samples/README.md)*** that c * [Background Processing](documentation/writing-policies-background.md) * [Testing Policies](documentation/testing-policies.md) * [Policy Violations](documentation/policy-violations.md) +* [Kubectl plugin usage](documentation/cli-usage.md) * [Sample Policies](/samples/README.md) ## License diff --git a/documentation/cli-usage.md b/documentation/cli-usage.md new file mode 100644 index 0000000000..c5043aa682 --- /dev/null +++ b/documentation/cli-usage.md @@ -0,0 +1,54 @@ +*[documentation](/README.md#documentation) / kyverno-cli* + + +# [kyverno CLI](https://github.com/nirmata/kyverno/releases) - kubectl plugin to deal with kyverno policies +Used to validate policies and apply policies on resources. + +##Installation +You can get the installation package of the cli for your os in the releases page [here](https://github.com/nirmata/kyverno/releases). + +or + +If you have installed the kubectl plugin manager `krew` you can install the cli using the command + +``` +kubectl krew install kyverno +``` + +## Commands + +#### Version +Prints the version of kyverno used by the CLI. + +Example: +``` +kubectl kyverno version +``` + + +#### Validate +Validates a policy, can validate multiple files or even an entire folder containing files. Currently supports files files +with resource description in yaml. + +Example: +``` +kubectl kyverno validate /path/to/policy1.yaml /path/to/policy2.yaml /path/to/folderFullOfPolicies +``` + +#### Apply +Applies policies on resources, supports applying multiple policies on multiple resources in a single command. +Also supports applying the given policies to an entire cluster. Will return output to stdout. You may want to redirect +output to a file in case you applied a policy to a cluster. + +Apply to a resource: +``` +kubectl kyverno apply /path/to/policy.yaml --resource /path/to/resource.yaml +``` +Apply to a cluster: +``` +kubectl kyverno apply /path/to/policy.yaml --cluster +``` +Valid command with further complexity: +``` +kubectl kyverno apply /path/to/policy1.yaml /path/to/folderFullOfPolicies --resource /path/to/resource1.yaml --resource /path/to/resource2.yaml --cluster +``` From 5ba1fe66816634f16dd2a5ae01e2cc8c9aedeecb Mon Sep 17 00:00:00 2001 From: shravan Date: Mon, 17 Feb 2020 10:26:29 +0530 Subject: [PATCH 2/4] 696 removed instruction to download from krew --- documentation/cli-usage.md | 8 -------- 1 file changed, 8 deletions(-) diff --git a/documentation/cli-usage.md b/documentation/cli-usage.md index c5043aa682..a3ee2108e6 100644 --- a/documentation/cli-usage.md +++ b/documentation/cli-usage.md @@ -7,14 +7,6 @@ Used to validate policies and apply policies on resources. ##Installation You can get the installation package of the cli for your os in the releases page [here](https://github.com/nirmata/kyverno/releases). -or - -If you have installed the kubectl plugin manager `krew` you can install the cli using the command - -``` -kubectl krew install kyverno -``` - ## Commands #### Version From c60b4a5100a4828890763fed2c811f9bec9499c6 Mon Sep 17 00:00:00 2001 From: shravan Date: Mon, 17 Feb 2020 10:35:33 +0530 Subject: [PATCH 3/4] 696 fixes after further proof reading --- documentation/cli-usage.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/cli-usage.md b/documentation/cli-usage.md index a3ee2108e6..985b4384aa 100644 --- a/documentation/cli-usage.md +++ b/documentation/cli-usage.md @@ -19,8 +19,8 @@ kubectl kyverno version #### Validate -Validates a policy, can validate multiple files or even an entire folder containing files. Currently supports files files -with resource description in yaml. +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: ``` From 90a5e18b1c9cd3bba4d188aec96a496f77f1413c Mon Sep 17 00:00:00 2001 From: shravan Date: Wed, 19 Feb 2020 21:47:15 +0530 Subject: [PATCH 4/4] 696 documentatino fixes --- README.md | 2 +- documentation/{cli-usage.md => kyverno-cli.md} | 12 ++++++------ 2 files changed, 7 insertions(+), 7 deletions(-) rename documentation/{cli-usage.md => kyverno-cli.md} (67%) diff --git a/README.md b/README.md index f5ccde2cdf..41f1a63ac5 100644 --- a/README.md +++ b/README.md @@ -129,7 +129,7 @@ Refer to a list of curated of ***[sample policies](/samples/README.md)*** that c * [Background Processing](documentation/writing-policies-background.md) * [Testing Policies](documentation/testing-policies.md) * [Policy Violations](documentation/policy-violations.md) -* [Kubectl plugin usage](documentation/cli-usage.md) +* [Kyverno CLI](documentation/cli-usage.md) * [Sample Policies](/samples/README.md) ## License diff --git a/documentation/cli-usage.md b/documentation/kyverno-cli.md similarity index 67% rename from documentation/cli-usage.md rename to documentation/kyverno-cli.md index 985b4384aa..6cc0757e03 100644 --- a/documentation/cli-usage.md +++ b/documentation/kyverno-cli.md @@ -2,7 +2,7 @@ # [kyverno CLI](https://github.com/nirmata/kyverno/releases) - kubectl plugin to deal with kyverno policies -Used to validate policies and apply policies on resources. +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. ##Installation You can get the installation package of the cli for your os in the releases page [here](https://github.com/nirmata/kyverno/releases). @@ -28,17 +28,17 @@ kubectl kyverno validate /path/to/policy1.yaml /path/to/policy2.yaml /path/to/fo ``` #### Apply -Applies policies on resources, supports applying multiple policies on multiple resources in a single command. -Also supports applying the given policies to an entire cluster. Will return output to stdout. You may want to redirect -output to a file in case you applied a policy to a cluster. +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. + Will return results to stdout. Apply to a resource: ``` kubectl kyverno apply /path/to/policy.yaml --resource /path/to/resource.yaml ``` -Apply to a cluster: +Apply to all matching resources in a cluster: ``` -kubectl kyverno apply /path/to/policy.yaml --cluster +kubectl kyverno apply /path/to/policy.yaml --cluster > policy-results.txt ``` Valid command with further complexity: ```