update and cleanup of book docs (#1194)

Signed-off-by: Prajyot-Parab <[email protected]>

Author: Prajyot-Parab

README.md

@@ -18,10 +18,10 @@ The [Cluster API](https://github.com/kubernetes-sigs/cluster-api) brings declara
 
 Please see our [book](https://cluster-api-ibmcloud.sigs.k8s.io) for in-depth documentation.
 
-## Launching a Kubernetes cluster on IBMCloud
+## Launching a Kubernetes cluster on IBM Cloud
 
-Check out the [Cluster API IBMCloud Quick Start](https://cluster-api-ibmcloud.sigs.k8s.io/getting-started.html) for launching a
-cluster on IBMCloud.
+Check out the [Cluster API IBM Cloud Quick Start](https://cluster-api-ibmcloud.sigs.k8s.io/getting-started.html) for launching a
+cluster on IBM Cloud.
 
 ## Compatibility with Cluster API and Kubernetes Versions
 

docs/book/book.toml

@@ -1,9 +1,9 @@
 [book]
-authors = ["The Cluster API Provider IBMCloud Maintainers"]
+authors = ["The Cluster API Provider IBM Cloud Maintainers"]
 language = "en"
 multilingual = false
 src = "src"
-title = "Kubernetes Cluster API Provider IBMCloud"
+title = "Kubernetes Cluster API Provider IBM Cloud"
 
 [output.html]
 curly-quotes = true

docs/book/src/SUMMARY.md

@@ -4,21 +4,21 @@
 - [Getting Started](./getting-started.md)
 - [Images](./machine-images/index.md)
   - [VPC](./machine-images/vpc.md)
-  - [Power VS](./machine-images/powervs.md)
+  - [PowerVS](./machine-images/powervs.md)
 - [Topics](./topics/index.md)
   - [VPC Cluster](./topics/vpc/index.md)
     - [Prerequisites](./topics/vpc/prerequisites.md)
     - [Uploading an image](topics/vpc/uploading-an-image.md)
     - [Creating a cluster](./topics/vpc/creating-a-cluster.md)
     - [Creating a cluster with Load Balancer and External Cloud Provider](./topics/vpc/load-balancer.md)
-  - [Power VS Cluster](./topics/powervs/index.md)
+  - [PowerVS Cluster](./topics/powervs/index.md)
     - [Prerequisites](./topics/powervs/prerequisites.md)
     - [Creating a cluster](./topics/powervs/creating-a-cluster.md)
     - [Creating a cluster with External Cloud Provider](./topics/powervs/external-cloud-provider.md)
     - [Creating a cluster from ClusterClass](./topics/powervs/clusterclass-cluster.md)
     - [Using autoscaler with scaling from 0 machine](./topics/powervs/autoscaler-scalling-from-0.md)
 - [capibmadm CLI](./topics/capibmadm/index.md)
-  - [Power VS Commands](./topics/capibmadm/powervs/index.md)
+  - [PowerVS Commands](./topics/capibmadm/powervs/index.md)
     - [Image Commands](./topics/capibmadm/powervs/image.md)
     - [Network Commands](./topics/capibmadm/powervs/network.md)
     - [Port Commands](./topics/capibmadm/powervs/port.md)

docs/book/src/developer/tilt.md

@@ -47,17 +47,17 @@ kustomize_substitutions:
   IBMCLOUD_API_KEY: "XXXXXXXXXXXXXXXXXX"
 ```
 
-Add following extra_args to log Power VS REST API Requests/Responses
+Add following extra_args to log PowerVS REST API Requests/Responses
 
 ```yaml
 extra_args:
   ibmcloud:
     - '-v=5'
 ```
 
-### 1.  Configuration to deploy Power VS workload cluster with external cloud controller manager
+### 1.  Configuration to deploy PowerVS workload cluster with external cloud controller manager
 
-To deploy workload cluster with [Power VS cloud controller manager](/topics/powervs/external-cloud-provider.html) which is currently in experimental stage, Set `POWERVS_PROVIDER_ID_FORMAT` to `v2` and enable cluster resourceset feature gate under kustomize_substitutions.
+To deploy workload cluster with [PowerVS cloud controller manager](/topics/powervs/external-cloud-provider.html) which is currently in experimental stage, Set `POWERVS_PROVIDER_ID_FORMAT` to `v2` and enable cluster resourceset feature gate under kustomize_substitutions.
 Currently, [ClusterResourceset](https://cluster-api.sigs.k8s.io/tasks/experimental-features/cluster-resource-set.html) is experimental feature so we need to enable the feature gate by setting `EXP_CLUSTER_RESOURCE_SET` variable under kustomize_substitutions.
 
 ```yaml

docs/book/src/getting-started.md

@@ -55,13 +55,13 @@ it into a management cluster using `clusterctl`.
        export EXP_CLUSTER_RESOURCE_SET=true
      ```
 
-    > Note: To deploy workload cluster with [Power VS cloud controller manager](/topics/powervs/external-cloud-provider.html) which is currently in experimental stage. Set the `POWERVS_PROVIDER_ID_FORMAT` environmental variable.
+    > Note: To deploy workload cluster with [PowerVS cloud controller manager](/topics/powervs/external-cloud-provider.html) which is currently in experimental stage. Set the `POWERVS_PROVIDER_ID_FORMAT` environmental variable.
     Currently, [ClusterResourceset](https://cluster-api.sigs.k8s.io/tasks/experimental-features/cluster-resource-set.html) is experimental feature so we need to enable the feature gate by setting `EXP_CLUSTER_RESOURCE_SET` environmental variables.
     ```console
        export POWERVS_PROVIDER_ID_FORMAT=v2
        export EXP_CLUSTER_RESOURCE_SET=true
      ```
-    > Note: To deploy workload cluster with [Power VS clusterclass-template](/topics/powervs/clusterclass-cluster.html). Set the `POWERVS_PROVIDER_ID_FORMAT` environmental variable.
+    > Note: To deploy workload cluster with [PowerVS clusterclass-template](/topics/powervs/clusterclass-cluster.html). Set the `POWERVS_PROVIDER_ID_FORMAT` environmental variable.
       Currently, both [ClusterClass](https://cluster-api.sigs.k8s.io/tasks/experimental-features/cluster-class/index.html) and [ClusterResourceset](https://cluster-api.sigs.k8s.io/tasks/experimental-features/cluster-resource-set.html) are experimental feature so we need to enable the feature gate by setting `EXP_CLUSTER_RESOURCE_SET`, `CLUSTER_TOPOLOGY` environmental variables.
      ```console
         export POWERVS_PROVIDER_ID_FORMAT=v2

docs/book/src/introduction.md

@@ -58,7 +58,7 @@ This repository uses the Kubernetes bots.  See a full list of the commands [here
 
 ### Join us
 
-The community holds a weekly meeting every Friday at 09:00 (IST) / 03:30 (UTC) on [Zoom](https://zoom.us/j/9392903494). Subscribe to the [SIG Cluster Lifecycle](https://groups.google.com/g/kubernetes-sig-cluster-lifecycle) Google Group for access to documents and calendars
+The community holds a bi-weekly meeting every Friday at 09:00 (IST) / 03:30 (UTC) on [Zoom](https://zoom.us/j/9392903494). Subscribe to the [SIG Cluster Lifecycle](https://groups.google.com/g/kubernetes-sig-cluster-lifecycle) Google Group for access to documents and calendars
 
 
 ### Other ways to communicate with the contributors

docs/book/src/topics/capibmadm/index.md

@@ -2,5 +2,84 @@
 
 Kubernetes Cluster API Provider IBM Cloud Management Utility
 
-## [1. Power VS commands](./powervs/index.md)
+## Install capibmadm
+
+#### Install capibmadm binary with curl on Linux
+If you are unsure you can determine your computers architecture by running `uname -a`
+
+Download for AMD64:
+```bash
+curl -L https://github.com/kubernetes-sigs/cluster-api-provider-ibmcloud/releases/download/v0.5.0-alpha.1/capibmadm-linux-amd64 -o capibmadm
+```
+
+Download for ARM64:
+```bash
+curl -L https://github.com/kubernetes-sigs/cluster-api-provider-ibmcloud/releases/download/v0.5.0-alpha.1/capibmadm-linux-arm64 -o capibmadm
+```
+
+Download for PPC64LE:
+```bash
+curl -L https://github.com/kubernetes-sigs/cluster-api-provider-ibmcloud/releases/download/v0.5.0-alpha.1/capibmadm-linux-ppc64le -o capibmadm
+```
+
+Make the capibmadm binary executable.
+```bash
+chmod +x ./capibmadm
+```
+Move the binary in to your PATH.
+```bash
+sudo mv ./capibmadm /usr/local/bin/capibmadm
+```
+Test to ensure the version you installed is up-to-date:
+```bash
+capibmadm version -o short
+```
+
+#### Install capibmadm binary with curl on macOS
+If you are unsure you can determine your computers architecture by running `uname -a`
+
+Download for AMD64:
+```bash
+curl -L https://github.com/kubernetes-sigs/cluster-api-provider-ibmcloud/releases/download/v0.5.0-alpha.1/capibmadm-darwin-amd64 -o capibmadm
+```
+
+Download for M1 CPU ("Apple Silicon") / ARM64:
+```bash
+curl -L https://github.com/kubernetes-sigs/cluster-api-provider-ibmcloud/releases/download/v0.5.0-alpha.1/capibmadm-darwin-arm64 -o capibmadm
+```
+
+Make the capibmadm binary executable.
+```bash
+chmod +x ./capibmadm
+```
+Move the binary in to your PATH.
+```bash
+sudo mv ./capibmadm /usr/local/bin/capibmadm
+```
+Test to ensure the version you installed is up-to-date:
+```bash
+capibmadm version -o short
+```
+
+#### Install capibmadm binary with curl on Windows using PowerShell
+Go to the working directory where you want capibmadm downloaded.
+
+Download the latest release on AMD64; on Windows, type:
+```powershell
+curl.exe -L https://github.com/kubernetes-sigs/cluster-api-provider-ibmcloud/releases/download/v0.5.0-alpha.1/capibmadm-windows-amd64.exe -o capibmadm.exe
+```
+Append or prepend the path of that directory to the `PATH` environment variable.
+
+Download the latest release on ARM64; on Windows, type:
+```powershell
+curl.exe -L https://github.com/kubernetes-sigs/cluster-api-provider-ibmcloud/releases/download/v0.5.0-alpha.1/capibmadm-windows-arm64.exe -o capibmadm.exe
+```
+Append or prepend the path of that directory to the `PATH` environment variable.
+
+Test to ensure the version you installed is up-to-date:
+```powershell
+capibmadm.exe version -o short
+```
+
+## [1. PowerVS commands](./powervs/index.md)
 ## [2. VPC commands](./vpc/index.md)

docs/book/src/topics/capibmadm/powervs/index.md

@@ -15,5 +15,4 @@
     - [delete](/topics/capibmadm/powervs/port.html#2-capibmadm-powervs-port-delete)
     - [list](/topics/capibmadm/powervs/port.html#3-capibmadm-powervs-port-list)
 - [image](./image.md)
-    - [list] (/topics/capibmadm/powervs/image.html#1-capibmadm-powervs-image-list))
-
+    - [list](/topics/capibmadm/powervs/image.html#1-capibmadm-powervs-image-list)

docs/book/src/topics/powervs/clusterclass-cluster.md

@@ -1,26 +1,26 @@
-# Create IBM Power VS Cluster Using ClusterClass
+# Create IBM PowerVS Cluster Using ClusterClass
 ## Steps
 
-- To deploy Power VS workload cluster using [ClusterClass](https://cluster-api.sigs.k8s.io/tasks/experimental-features/cluster-class/index.html), create a cluster configuration from the [clusterclass-template](https://github.com/kubernetes-sigs/cluster-api-provider-ibmcloud/blob/main/templates/cluster-template-simple-powervs-clusterclass.yaml)
-- The Power VS cluster will use [external cloud provider](https://kubernetes.io/docs/concepts/architecture/cloud-controller/). As a prerequisite set the `powervs-provider-id-fmt` [flag](https://github.com/kubernetes-sigs/cluster-api-provider-ibmcloud/blob/64c9e1d17f1733c721f45a559edba3f4b712bcb0/main.go#L220) with value v2
+- To deploy PowerVS workload cluster using [ClusterClass](https://cluster-api.sigs.k8s.io/tasks/experimental-features/cluster-class/index.html), create a cluster configuration from the [clusterclass-template](https://github.com/kubernetes-sigs/cluster-api-provider-ibmcloud/blob/main/templates/cluster-template-simple-powervs-clusterclass.yaml)
+- The PowerVS cluster will use [external cloud provider](https://kubernetes.io/docs/concepts/architecture/cloud-controller/). As a prerequisite set the `powervs-provider-id-fmt` [flag](https://github.com/kubernetes-sigs/cluster-api-provider-ibmcloud/blob/64c9e1d17f1733c721f45a559edba3f4b712bcb0/main.go#L220) with value v2
 - The [clusterclass-template](https://github.com/kubernetes-sigs/cluster-api-provider-ibmcloud/blob/main/templates/cluster-template-simple-powervs-clusterclass.yaml) will use [clusterresourceset](https://cluster-api.sigs.k8s.io/tasks/experimental-features/cluster-resource-set.html) and will create the necessary config map, secret and roles to run the cloud controller manager
 
-### Deploy Power VS cluster with IBM Power VS cloud provider
+### Deploy PowerVS cluster with IBM PowerVS cloud provider
 
   ```
   IBMPOWERVS_CLUSTER_CLASS_NAME="powervs-cc" \
   IBMPOWERVS_SSHKEY_NAME="my-pub-key" \
-  IBMPOWERVS_VIP="192.168.151.22" \
-  IBMPOWERVS_VIP_EXTERNAL="158.175.162.22" \
+  IBMPOWERVS_VIP="192.168.167.6" \
+  IBMPOWERVS_VIP_EXTERNAL="163.68.65.6" \
   IBMPOWERVS_VIP_CIDR="29" \
-  IBMPOWERVS_IMAGE_NAME="capibm-powervs-centos-8-1-22-4" \
-  IBMPOWERVS_SERVICE_INSTANCE_ID="7845d372-d4e1-46b8-91fc-41051c984601" \
-  IBMPOWERVS_NETWORK_NAME="capi-test-3" \
+  IBMPOWERVS_IMAGE_NAME="capibm-powervs-centos-streams8-1-26-2" \
+  IBMPOWERVS_SERVICE_INSTANCE_ID="3229a94c-af54-4212-bf60-6202b6fd0a07" \
+  IBMPOWERVS_NETWORK_NAME="capi-test" \
   IBMACCOUNT_ID="ibm-accountid" \
-  IBMPOWERVS_REGION="powervs-region" \
-  IBMPOWERVS_ZONE="powervs-zone" \
+  IBMPOWERVS_REGION="osa" \
+  IBMPOWERVS_ZONE="osa21" \
   BASE64_API_KEY=$(echo -n $IBMCLOUD_API_KEY | base64) \
-  clusterctl generate cluster ibm-powervs-1 --kubernetes-version v1.22.4 \
+  clusterctl generate cluster ibm-powervs-1 --kubernetes-version v1.26.2 \
   --target-namespace default \
   --control-plane-machine-count=3 \
   --worker-machine-count=1 \

docs/book/src/topics/powervs/creating-a-cluster.md

@@ -6,47 +6,44 @@ following the steps below.
 1. Create PowerVS network port 
 
     ```console
-    ~ pvsadm create port --description "capi-port" --network <NETWORK_NAME> --instance-id <SERVICE_INSTANCE_ID>
+    ~ export IBMCLOUD_API_KEY=<API_KEY>
+    ~ capibmadm powervs port create --network capi-test --description capi-test-port --service-instance-id 3229a94c-af54-4212-bf60-6202b6fd0a07 --zone osa21
     ```
 
     Output:
     ```console
-    I1125 15:24:20.581757 1548881 port.go:89] Successfully created a port, id: ac18ef17-8517-40e3-889d-4f246e9bd17e
-    +---------------------+------------+------+-----------------+-------------------+--------------------------------------+-------------+--------+
-    |     DESCRIPTION     | EXTERNALIP | HREF |    IPADDRESS    |    MACADDRESS     |                PORTID                | PVMINSTANCE | STATUS |
-    +---------------------+------------+------+-----------------+-------------------+--------------------------------------+-------------+--------+
-    | capi-port |            |      | 192.168.151.125 | fa:16:3e:34:2c:ef | 7eff02b5-040c-4934-957a-18209e65eca4 |             | DOWN   |
-    +---------------------+------------+------+-----------------+-------------------+--------------------------------------+-------------+--------+
+    Creating Port  Network ID/Name="capi-test" IP Address="" Description="capi-test-port" service-instance-id="3229a94c-af54-4212-bf60-6202b6fd0a07" zone="osa21"
+    Successfully created a port portID="c7e7b6e0-0b0d-4a11-a90b-6ea293deb5ac"
+    DESCRIPTION      EXTERNAL IP   IP ADDRESS      MAC ADDRESS         PORT ID                                STATUS
+    capi-test-port                 192.168.167.6   fa:16:3e:89:c8:80   c7e7b6e0-0b0d-4a11-a90b-6ea293deb5ac   DOWN
     ```
 
     ```console
-    ~ pvsadm get ports --instance-id <SERVICE_INSTANCE_ID> --network <NETWORK_NAME>
+    ~ capibmadm powervs port list --network capi-test --service-instance-id 3229a94c-af54-4212-bf60-6202b6fd0a07 --zone osa21
     ```
 
     Output:
     ```console
-    +-------------------+-----------------+-----------------+-------------------+--------------------------------------+--------+
-    |    DESCRIPTION    |   EXTERNALIP    |    IPADDRESS    |    MACADDRESS     |                PORTID                | STATUS |
-    +-------------------+-----------------+-----------------+-------------------+--------------------------------------+--------+
-    | capi-port         | 158.175.162.125 | 192.168.151.125 | fa:16:3e:34:2c:ef | 7eff02b5-040c-4934-957a-18209e65eca4 | DOWN   |
-    +-------------------+-----------------+-----------------+-------------------+--------------------------------------+--------+
+    Listing PowerVS ports service-instance-id="3229a94c-af54-4212-bf60-6202b6fd0a07" network="capi-test"
+    DESCRIPTION      EXTERNAL IP   IP ADDRESS      MAC ADDRESS         PORT ID                                STATUS
+    capi-test-port   163.68.65.6   192.168.167.6   fa:16:3e:89:c8:80   c7e7b6e0-0b0d-4a11-a90b-6ea293deb5ac   DOWN
     ```
 
 2. Use clusterctl to render the yaml through templates and deploy the cluster
 
-    **Note:** To deploy workload cluster with Power VS cloud controller manager which is currently in experimental stage follow [these](/topics/powervs/external-cloud-provider.html) steps.
+    **Note:** To deploy workload cluster with PowerVS cloud controller manager which is currently in experimental stage follow [these](/topics/powervs/external-cloud-provider.html) steps.
 
     **Note:** the `IBMPOWERVS_IMAGE_ID` value below should reflect the ID of the custom qcow2 image, the `kubernetes-version` value below should reflect the kubernetes version of the custom qcow2 image.
 
     ```console
     IBMPOWERVS_SSHKEY_NAME="my-pub-key" \
-    IBMPOWERVS_VIP="192.168.151.22" \
-    IBMPOWERVS_VIP_EXTERNAL="158.175.162.22" \
+    IBMPOWERVS_VIP="192.168.167.6" \
+    IBMPOWERVS_VIP_EXTERNAL="163.68.65.6" \
     IBMPOWERVS_VIP_CIDR="29" \
-    IBMPOWERVS_IMAGE_NAME="capibm-powervs-centos-8-1-22-4" \
-    IBMPOWERVS_SERVICE_INSTANCE_ID="7845d372-d4e1-46b8-91fc-41051c984601" \
-    IBMPOWERVS_NETWORK_NAME="capi-test-3" \
-    clusterctl generate cluster ibm-powervs-1 --kubernetes-version v1.22.4 \
+    IBMPOWERVS_IMAGE_NAME="capibm-powervs-centos-streams8-1-26-2" \
+    IBMPOWERVS_SERVICE_INSTANCE_ID="3229a94c-af54-4212-bf60-6202b6fd0a07" \
+    IBMPOWERVS_NETWORK_NAME="capi-test" \
+    clusterctl generate cluster ibm-powervs-1 --kubernetes-version v1.26.2 \
     --target-namespace default \
     --control-plane-machine-count=3 \
     --worker-machine-count=1 \
@@ -93,15 +90,15 @@ following the steps below.
     ```console
     ~ kubectl get kubeadmcontrolplane
     NAME                       INITIALIZED   API SERVER AVAILABLE   VERSION   REPLICAS   READY   UPDATED   UNAVAILABLE
-    ibm-powervs-1-control-plane    true          true                   v1.22.4   1          1       1
+    ibm-powervs-1-control-plane    true          true                   v1.26.2   1          1       1
     ```
 
     Machines
     ```console
     ~ kubectl get machines
-    ibm-powervs-1-control-plane-vzz47     ibmpowervs://ibm-powervs-1/ibm-powervs-1-control-plane-rg6xv   Running        v1.22.4
-    ibm-powervs-1-md-0-5444cfcbcd-6gg5z   ibmpowervs://ibm-powervs-1/ibm-powervs-1-md-0-dbxb7            Running        v1.22.4
-    ibm-powervs-1-md-0-5444cfcbcd-7kr9x   ibmpowervs://ibm-powervs-1/ibm-powervs-1-md-0-k7blr            Running        v1.22.4
+    ibm-powervs-1-control-plane-vzz47     ibmpowervs://ibm-powervs-1/ibm-powervs-1-control-plane-rg6xv   Running        v1.26.2
+    ibm-powervs-1-md-0-5444cfcbcd-6gg5z   ibmpowervs://ibm-powervs-1/ibm-powervs-1-md-0-dbxb7            Running        v1.26.2
+    ibm-powervs-1-md-0-5444cfcbcd-7kr9x   ibmpowervs://ibm-powervs-1/ibm-powervs-1-md-0-k7blr            Running        v1.26.2
     ```
 
 4. Deploy Container Network Interface (CNI)
@@ -118,7 +115,7 @@ following the steps below.
     ```console
     ~ kubectl get nodes
     NAME                             STATUS   ROLES    AGE   VERSION
-    ibm-powervs-1-control-plane-rg6xv    Ready    master   41h   v1.22.4
-    ibm-powervs-1-md-0-4dc5c             Ready    <none>   41h   v1.22.4
-    ibm-powervs-1-md-0-dbxb7             Ready    <none>   20h   v1.22.4
+    ibm-powervs-1-control-plane-rg6xv    Ready    master   41h   v1.26.2
+    ibm-powervs-1-md-0-4dc5c             Ready    <none>   41h   v1.26.2
+    ibm-powervs-1-md-0-dbxb7             Ready    <none>   20h   v1.26.2
     ```