Skip to content

Commit c89c2d7

Browse files
Update plugin installation doc to have correct sequence of steps
Signed-off-by: Danil Grigorev <[email protected]>
1 parent 6e878a2 commit c89c2d7

File tree

2 files changed

+25
-5
lines changed

2 files changed

+25
-5
lines changed

Makefile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -499,6 +499,7 @@ upload-staging-artifacts: ## Upload release artifacts to the staging bucket
499499
update-helm-plugin-repo:
500500
./hack/update-plugin-yaml.sh $(RELEASE_TAG)
501501
./hack/update-helm-repo.sh $(RELEASE_TAG)
502+
./hack/publish-index-changes.sh $(RELEASE_TAG)
502503

503504
.PHONY: promote-images
504505
promote-images: $(KPROMO)

docs/book/src/02_installation/01_plugin.md

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,38 @@ The `cluster-api-operator` plugin can be installed using krew, the kubectl plugi
1212

1313
1. Add the cluster-api-operator plugin index to krew:
1414
```bash
15-
clusterctl krew index add operator https://github.com/kubernetes-sigs/cluster-api-operator.git
15+
kubectl krew index add operator https://github.com/kubernetes-sigs/cluster-api-operator.git
1616
```
1717

1818
2. Install the cluster-api-operator plugin:
1919
```bash
20-
clusterctl krew install operator/operator
20+
kubectl krew install operator/clusterctl-operator
2121
```
2222

2323
3. Verify the installation:
2424
```bash
25-
clusterctl operator
25+
kubectl operator
2626
```
2727

28-
This should print help information for the clusterctl operator plugin.
28+
This should print help information for the kubectl operator plugin.
2929

30-
The `cluster-api-operator` plugin is now installed and ready to use with both `kubectl` and `clusterctl`.
30+
The `cluster-api-operator` plugin is now installed and ready to use with `kubectl`.
31+
32+
### Optionally: installing as a `clusterctl` plugin
33+
Typically the plugin is installed under `~/.krew/bin/kubectl-operator`, which would be present under your `$PATH` after correct `krew` installation. If you want to use plugin with `clusterctl`, you need to rename this file to be prefixed with `clusterctl-` instead, like so:
34+
```bash
35+
cp ~/.krew/bin/kubectl-operator ~/.krew/bin/clusterctl-operator
36+
```
37+
38+
After that plugin is available to use as a `clusterctl` plugin:
39+
```bash
40+
clusterctl operator --help
41+
```
42+
43+
## Upgrade
44+
45+
To upgrade your plugin with the new release of `cluster-api-operator` you will need to run:
46+
47+
```bash
48+
kubectl krew upgrade
49+
```

0 commit comments

Comments
 (0)