Skip to content

fix(docs): Remove old CLI commands #760

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 15, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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