Skip to content

Commit

Permalink
docs: Remove old CLI commands (#760)
Browse files Browse the repository at this point in the history
Quick fix for #742.

Related to #756. That PR has added documentation for development
webhooks.

Co-authored-by: Christoph Bühler <buehler@users.noreply.github.com>
  • Loading branch information
ian-buse and buehler committed May 15, 2024
1 parent 9072312 commit dc4bcf7
Showing 1 changed file with 7 additions and 14 deletions.
21 changes: 7 additions & 14 deletions src/KubeOps.Cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand All @@ -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

Expand Down

0 comments on commit dc4bcf7

Please sign in to comment.