From 168b9c4e8f3b4bb42962c2cc2eb3214ca113e2b4 Mon Sep 17 00:00:00 2001 From: Tim Ramlot <42113979+inteon@users.noreply.github.com> Date: Thu, 7 Mar 2024 11:19:19 +0100 Subject: [PATCH 1/2] update cmctl docs for v2 Signed-off-by: Tim Ramlot <42113979+inteon@users.noreply.github.com> --- content/docs/reference/cmctl.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/content/docs/reference/cmctl.md b/content/docs/reference/cmctl.md index a50911894a..e4a1855cf2 100644 --- a/content/docs/reference/cmctl.md +++ b/content/docs/reference/cmctl.md @@ -34,17 +34,17 @@ This will also install shell completion. ### Manual Installation -You need the `cmctl.tar.gz` file for the platform you're using, these can be +You need the `cmctl` file for the platform you're using, these can be found on our -[GitHub releases page](https://github.com/cert-manager/cert-manager/releases). +[cmctl GitHub releases page](https://github.com/cert-manager/cmctl/releases). In order to use `cmctl` you need its binary to be accessible under the name `cmctl` in your `$PATH`. Run the following commands to set up the CLI. Replace OS and ARCH with your systems equivalents: ```console -OS=$(go env GOOS); ARCH=$(go env GOARCH); curl -fsSL -o cmctl.tar.gz https://github.com/cert-manager/cert-manager/releases/latest/download/cmctl-$OS-$ARCH.tar.gz -tar xzf cmctl.tar.gz +OS=$(go env GOOS); ARCH=$(go env GOARCH); curl -fsSL -o cmctl https://github.com/cert-manager/cmctl/releases/latest/download/cmctl_${OS}_${ARCH} +chmod +x cmctl sudo mv cmctl /usr/local/bin ``` @@ -350,8 +350,8 @@ $ cmctl upgrade migrate-api-version --qps 5 --burst 10 While the kubectl plugin is supported, it is recommended to use `cmctl` as this enables a better experience via tab auto-completion. -To install the plugin you need the `kubectl-cert-manager.tar.gz` file for the platform you're using, -these can be found on our [GitHub releases page](https://github.com/cert-manager/cert-manager/releases). +To install the plugin you need the `kubectl_cert-manager` file for the platform you're using, +these can be found on our [cmctl GitHub releases page](https://github.com/cert-manager/cmctl/releases). In order to use the kubectl plugin you need its binary to be accessible under the name `kubectl-cert_manager` in your `$PATH`. You can run `kubectl cert-manager help` to test that the plugin is set up properly. From 2c8be7bac6d2ef0bd33e477313f6c5e638651c50 Mon Sep 17 00:00:00 2001 From: Tim Ramlot <42113979+inteon@users.noreply.github.com> Date: Mon, 11 Mar 2024 13:40:26 +0100 Subject: [PATCH 2/2] Add "install using go" option MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Maƫl Valais Signed-off-by: Tim Ramlot <42113979+inteon@users.noreply.github.com> --- content/docs/reference/cmctl.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/content/docs/reference/cmctl.md b/content/docs/reference/cmctl.md index e4a1855cf2..53ef2cd051 100644 --- a/content/docs/reference/cmctl.md +++ b/content/docs/reference/cmctl.md @@ -48,6 +48,12 @@ chmod +x cmctl sudo mv cmctl /usr/local/bin ``` +Alternatively, you can install `cmctl` using `go`: + +```bash +go install github.com/cert-manager/cmctl/v2@latest +``` + You can run `cmctl help` to test the CLI is set up properly: ```console