Merge pull request #387 from Danil-Grigorev/plugin-install-doc

📖 🐛 Document plugin installation, and fix template binary path
kubernetes-sigs · Jan 11, 2024 · 0f9401a · 0f9401a
2 parents 8fc9605 + c7e4d6d
commit 0f9401a
Show file tree

Hide file tree

Showing 4 changed files with 47 additions and 10 deletions.
diff --git a/.krew.yaml b/.krew.yaml
@@ -14,29 +14,29 @@ spec:
         os: darwin
         arch: amd64
     {{addURIAndSha "https://github.com/kubernetes-sigs/cluster-api-operator/releases/download/{{ .TagName }}/clusterctl-operator_{{ .TagName }}_darwin_amd64.tar.gz" .TagName }}
-    bin: clusterctl-operator
+    bin: bin/clusterctl-operator
   - selector:
       matchLabels:
         os: darwin
         arch: arm64
     {{addURIAndSha "https://github.com/kubernetes-sigs/cluster-api-operator/releases/download/{{ .TagName }}/clusterctl-operator_{{ .TagName }}_darwin_arm64.tar.gz" .TagName }}
-    bin: clusterctl-operator
+    bin: bin/clusterctl-operator
   - selector:
       matchLabels:
         os: linux
         arch: amd64
     {{addURIAndSha "https://github.com/kubernetes-sigs/cluster-api-operator/releases/download/{{ .TagName }}/clusterctl-operator_{{ .TagName }}_linux_amd64.tar.gz" .TagName }}
-    bin: clusterctl-operator
+    bin: bin/clusterctl-operator
   - selector:
       matchLabels:
         os: linux
         arch: arm64
     {{addURIAndSha "https://github.com/kubernetes-sigs/cluster-api-operator/releases/download/{{ .TagName }}/clusterctl-operator_{{ .TagName }}_linux_arm64.tar.gz" .TagName }}
-    bin: clusterctl-operator
+    bin: bin/clusterctl-operator
   - selector:
       matchLabels:
         os: windows
         arch: amd64
     {{addURIAndSha "https://github.com/kubernetes-sigs/cluster-api-operator/releases/download/{{ .TagName }}/clusterctl-operator_{{ .TagName }}_windows_amd64.tar.gz" .TagName }}
-    bin: clusterctl-operator.exe
+    bin: bin/clusterctl-operator.exe
 
diff --git a/docs/book/src/02_installation/00.md b/docs/book/src/02_installation/00.md
@@ -0,0 +1,7 @@
+# Installation
+
+This section describes `cluster-api-operator` components installation instructions.
+
+## [Plugin](./01_plugin.md)
+
+This document describes the plugin installation steps and prerequisites.
diff --git a/docs/book/src/02_installation/01_plugin.md b/docs/book/src/02_installation/01_plugin.md
@@ -0,0 +1,30 @@
+# Plugin installation
+
+The `cluster-api-operator` plugin can be installed using krew, the kubectl plugin manager.
+
+## Prerequisites
+
+[krew][] installed on your system. See the krew installation guide for instructions.
+
+[krew]: [https://krew.sigs.k8s.io/docs/user-guide/setup/install/]
+
+## Steps
+
+1. Add the cluster-api-operator plugin index to krew:
+```bash
+clusterctl krew index add operator https://github.com/kubernetes-sigs/cluster-api-operator.git
+```
+
+2. Install the cluster-api-operator plugin:
+```bash
+clusterctl krew install operator/operator
+```
+
+3. Verify the installation:
+```bash
+clusterctl operator
+```
+
+This should print help information for the clusterctl operator plugin.
+
+The `cluster-api-operator` plugin is now installed and ready to use with both `kubectl` and `clusterctl`.
diff --git a/plugins/clusterctl-operator.yaml b/plugins/clusterctl-operator.yaml
@@ -15,34 +15,34 @@ spec:
         arch: amd64
     uri: https://github.com/kubernetes-sigs/cluster-api-operator/releases/download/v0.8.0/clusterctl-operator_v0.8.0_darwin_amd64.tar.gz
     sha256: 98c1a85ff35cc0df1208c30fa2059cbc5a881d58ca13a4af5ca7f49e25fcb121
-    bin: clusterctl-operator
+    bin: bin/clusterctl-operator
   - selector:
       matchLabels:
         os: darwin
         arch: arm64
     uri: https://github.com/kubernetes-sigs/cluster-api-operator/releases/download/v0.8.0/clusterctl-operator_v0.8.0_darwin_arm64.tar.gz
     sha256: 93e7f0e3a0fbd30f132b167eff8f4b5f30e2a0dcc4efdd638eeeb98cb2eb6038
-    bin: clusterctl-operator
+    bin: bin/clusterctl-operator
   - selector:
       matchLabels:
         os: linux
         arch: amd64
     uri: https://github.com/kubernetes-sigs/cluster-api-operator/releases/download/v0.8.0/clusterctl-operator_v0.8.0_linux_amd64.tar.gz
     sha256: fe78cc5f7ca675b5d865e5fcea0176152e93044b40677814911e7d5546af227f
-    bin: clusterctl-operator
+    bin: bin/clusterctl-operator
   - selector:
       matchLabels:
         os: linux
         arch: arm64
     uri: https://github.com/kubernetes-sigs/cluster-api-operator/releases/download/v0.8.0/clusterctl-operator_v0.8.0_linux_arm64.tar.gz
     sha256: 47e6fb9d9490baf4fe05506f3ba5c7c0905c34813e949a24484885771c36c66c
-    bin: clusterctl-operator
+    bin: bin/clusterctl-operator
   - selector:
       matchLabels:
         os: windows
         arch: amd64
     uri: https://github.com/kubernetes-sigs/cluster-api-operator/releases/download/v0.8.0/clusterctl-operator_v0.8.0_windows_amd64.tar.gz
     sha256: 96e1a0bba6ccc61a7de15ec8c1c0a39c87510ed8a33c093c20e11923258f8668
-    bin: clusterctl-operator.exe
+    bin: bin/clusterctl-operator.exe