Skip to content

Add karmadactl addons subcommand docs #172

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.

Sign up for GitHub

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

Closed
ONE7live wants to merge 2 commits into from
Closed

Add karmadactl addons subcommand docs #172

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f0f274f
Add karmadactl addons subcommand docs
ONE7live Sep 14, 2022
4c816e7
Merge branch 'karmada-io:main' into main
ONE7live Sep 23, 2022
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
39 changes: 39 additions & 0 deletions docs/installation/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,45 @@ Use `--karmada-apiserver-replicas` and `--etcd-replicas` flags to specify the nu
kubectl karmada init --karmada-apiserver-replicas 3 --etcd-replicas 3
```

### Manage Karmada Addons by Karmada command-line tool

After using `kubectl karmada init` to deploy Karmada, you can use a subcommand `kubectl karmada addons`
to manage deployed Addons.

#### Enable Karmada Addons

You can use the available command `enable` to enable Karmada Addons from Kubernetes.

E.g. Enable Karmada search to the kubernetes cluster and specify the Karmada control plane kubeconfig:
```bash
kubectl karmada addons enable karmada-search --karmada-kubeconfig /etc/karmada/karmada-apiserver.config
```

#### Disable Karmada Addons

You can use the available command `disable` to disable Karmada Addons from Kubernetes.

E.g. Disable Karmada search and descheduler on your Kubernetes cluster:
```bash
kubectl karmada addons disable karmada-search karmada-descheduler
```

#### List Karmada Addons

You can view the results of enable and disable through the log, or use the available command `list` to list Karmada Addons from Kubernetes.

E.g. List Karmada all addons installed in Kubernetes cluster.
```bash
kubectl-karmada addons list
|-----------------------------|----------|
| ADDON NAME | STATUS |
|-----------------------------|----------|
| karmada-descheduler | disabled |
| karmada-scheduler-estimator | disabled |
| karmada-search | enabled |
|-----------------------------|----------|
```

### Install Karmada in Kind cluster

> kind is a tool for running local Kubernetes clusters using Docker container "nodes".
Expand Down