From 83be17ce9ed6332481b121940259b5891ec6b07b Mon Sep 17 00:00:00 2001 From: Shuting Zhao Date: Wed, 19 Feb 2020 19:13:05 -0800 Subject: [PATCH 1/3] update cli doc / makefile --- Makefile | 4 ++-- documentation/kyverno-cli.md | 11 +++++++++-- 2 files changed, 11 insertions(+), 4 deletions(-) diff --git a/Makefile b/Makefile index b68507b4c2..824f8b92e4 100644 --- a/Makefile +++ b/Makefile @@ -73,9 +73,9 @@ docker-push-kyverno: ################################## # CLI ################################## -CLI_PATH := cmd/cli +CLI_PATH := cmd/cli/kubectl-kyverno cli: - GOOS=$(GOOS) go build -o $(PWD)/$(CLI_PATH)/kyvernocli -ldflags=$(LD_FLAGS) $(PWD)/$(CLI_PATH)/main.go + GOOS=$(GOOS) go build -o $(PWD)/$(CLI_PATH)/kyverno -ldflags=$(LD_FLAGS) $(PWD)/$(CLI_PATH)/main.go ################################## diff --git a/documentation/kyverno-cli.md b/documentation/kyverno-cli.md index 4888744271..cbc7e9e1d0 100644 --- a/documentation/kyverno-cli.md +++ b/documentation/kyverno-cli.md @@ -5,9 +5,16 @@ 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 +## Build the CLI -You can download the CLI binary for your OS from the releases page [here](https://github.com/nirmata/kyverno/releases). +You can build the CLI binary for your OS by running the command: + +```bash +git clone https://github.com/nirmata/kyverno.git +cd github.com/nirmata/kyverno +make cli +cd ./cmd/cli/kubectl-kyverno/ +``` ## Commands From dd07942fb7cf3f4e10dfc67e128f2e5ebb5c0984 Mon Sep 17 00:00:00 2001 From: Shuting Zhao Date: Wed, 19 Feb 2020 19:24:11 -0800 Subject: [PATCH 2/3] update doc --- documentation/kyverno-cli.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/kyverno-cli.md b/documentation/kyverno-cli.md index cbc7e9e1d0..f75fc23c58 100644 --- a/documentation/kyverno-cli.md +++ b/documentation/kyverno-cli.md @@ -7,13 +7,13 @@ The Kyverno Command Line Interface (CLI) is designed to validate policies and te ## Build the CLI -You can build the CLI binary for your OS by running the command: +You can build the CLI binary locally, then move the binary into a directory in your PATH. ```bash git clone https://github.com/nirmata/kyverno.git cd github.com/nirmata/kyverno make cli -cd ./cmd/cli/kubectl-kyverno/ +mv ./cmd/cli/kubectl-kyverno/kyverno /usr/local/bin/nctl ``` ## Commands From 8e6e8fb6630c43710c4a93f5d8439f9e7fb55751 Mon Sep 17 00:00:00 2001 From: Shuting Zhao Date: Wed, 19 Feb 2020 19:24:55 -0800 Subject: [PATCH 3/3] fix typo --- documentation/kyverno-cli.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/kyverno-cli.md b/documentation/kyverno-cli.md index f75fc23c58..6901de2384 100644 --- a/documentation/kyverno-cli.md +++ b/documentation/kyverno-cli.md @@ -13,7 +13,7 @@ You can build the CLI binary locally, then move the binary into a directory in y git clone https://github.com/nirmata/kyverno.git cd github.com/nirmata/kyverno make cli -mv ./cmd/cli/kubectl-kyverno/kyverno /usr/local/bin/nctl +mv ./cmd/cli/kubectl-kyverno/kyverno /usr/local/bin/kyverno ``` ## Commands