Skip to content

Commit

Permalink
Merge pull request #1437 from inteon/update_cmctl_docs
Browse files Browse the repository at this point in the history
Update cmctl docs in preparation for v2 release
  • Loading branch information
jetstack-bot committed Mar 11, 2024
2 parents 142fbe4 + 2c8be7b commit 6414591
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions content/docs/reference/cmctl.md
Expand Up @@ -34,20 +34,26 @@ 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
```

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
Expand Down Expand Up @@ -350,8 +356,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.

0 comments on commit 6414591

Please sign in to comment.