From dc4bcf7890bf1235b49d53078790be8dbb3dc47c Mon Sep 17 00:00:00 2001 From: Ian Buse <57817326+ian-buse@users.noreply.github.com> Date: Wed, 15 May 2024 00:17:48 -0700 Subject: [PATCH] docs: Remove old CLI commands (#760) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Quick fix for #742. Related to #756. That PR has added documentation for development webhooks. Co-authored-by: Christoph Bühler --- src/KubeOps.Cli/README.md | 21 +++++++-------------- 1 file changed, 7 insertions(+), 14 deletions(-) diff --git a/src/KubeOps.Cli/README.md b/src/KubeOps.Cli/README.md index 7d806ee4..48d7d873 100644 --- a/src/KubeOps.Cli/README.md +++ b/src/KubeOps.Cli/README.md @@ -7,11 +7,13 @@ as well as managing resources in your Kubernetes cluster. ## Installation To install the CLI into your solution / project, first create a new tool manifest: + ```bash dotnet new tool-manifest ``` Then install the CLI: + ```bash dotnet tool install KubeOps.Cli ``` @@ -23,20 +25,11 @@ This allows you to use the CLI with `dotnet kubeops`. Here is a brief overview over the available commands (for all options and descriptions, use `-h` or `--help`): -- `version`: prints the version information for the actual connected Kubernetes cluster -- `install`: install the CRDs for the given solution into the cluster -- `uninstall`: uninstall the CRDs for the given solution from the cluster -- `generator`: entry command for generator commands (i.e. has subcommands), all commands - output their result to the stdout or the given output path - - `cert`: generate a CA & server certificate for usage with webhooks - - `crd`: generate the CRDs - - `docker`: generate the dockerfile - - `installer`: generate the installer files (i.e. kustomization yaml) for the operator - - `operator`: generate the deployment for the operator - - `rbac`: generate the needed rbac roles / role bindings for the operator -- `webhook`: entry command for webhook related operations - - `install`: generate the server certificate and install the service / webhook registration - - `register`: register the currently implemented webhooks to the currently selected cluster +- `api-version`, `av`: Prints the version information for the actual connected Kubernetes cluster +- `install`, `i`: Install the CRDs for the given solution into the cluster +- `uninstall`, `u`: Uninstall the CRDs for the given solution from the cluster +- `generate`, `gen`, `g`: Generates elements related to the operator + - `operator`, `op`: Generate the all files necessary for deployment for the operator, including any webhooks ### Example