Add information about building machine boot images (#752)

Author: mkumatag

docs/book/src/SUMMARY.md

@@ -18,6 +18,7 @@
   - [Rapid iterative development with Tilt](./developer/tilt.md)
   - [Guide for API conversions](./developer/conversion.md)
   - [Release Process](./developer/release.md)
+  - [How to build the machine boot images](./developer/build-images.md)
 - [Troubleshooting](./user/troubleshooting.md)
 - [Reference](./reference/reference.md)
   - [Regions-Zones Mapping](./reference/regions-zones-mapping.md)

docs/book/src/developer/build-images.md

@@ -0,0 +1,51 @@
+# How to build the machine boot images
+
+## VPC
+TO-DO
+
+## Power VS
+
+Compose the `user-varibales.json` file contains the information for the Power VS
+
+```json
+{
+  "account_id": "",
+  "apikey": "",
+  "capture_cos_access_key": "",
+  "capture_cos_bucket": "",
+  "capture_cos_region": "",
+  "capture_cos_secret_key": "",
+  "key_pair_name": "",
+  "kubernetes_deb_version": "",
+  "kubernetes_rpm_version": "",
+  "kubernetes_semver": "",
+  "kubernetes_series": "",
+  "region": "",
+  "service_instance_id": "",
+  "ssh_private_key_file": "",
+  "zone": ""
+}
+```
+
+- `account_id`: IBM Cloud account ID
+- `apikey`: IBM Cloud API Key
+- `capture_cos_access_key`: Access key for the IBM Cloud Object Storage(COS) to export the image to
+- `capture_cos_bucket`: IBM Cloud Object Storage(COS) bucket name
+- `capture_cos_region`: IBM Cloud Object Storage(COS) bucket region
+- `capture_cos_secret_key`: IBM Cloud Object Storage(COS) secret key
+- `key_pair_name`: SSH key name present in the Power VS
+- `kubernetes_deb_version`: Kubernetes deb version, e.g: 1.24.2-00
+- `kubernetes_rpm_version`: Kubernetes RPM package version, e.g: 1.24.2-0
+- `kubernetes_semver`: e.g: v1.24.2
+- `kubernetes_series`: e.g: v1.24
+- `region`: Power VS region, e.g: osa
+- `service_instance_id`: Power VS service instance ID
+- `ssh_private_key_file`: Path to the SSH private key file used to connect to the vm while image preparation, e.g: /Users/manjunath/.ssh/id_rsa
+- `zone`: Power VS zone, e.g: osa21
+
+```shell
+# Clone the image-builder repository
+$ git clone https://github.com/kubernetes-sigs/image-builder.git
+$ cd image-builder/images/capi
+$ PACKER_VAR_FILES=user-variables.json make build-powervs-centos-8
+```

docs/book/src/developer/index.md

@@ -2,4 +2,5 @@
 
 - [Rapid iterative development with Tilt](/developer/tilt.html)
 - [Guide for API conversions](/developer/conversion.html)
-- [Release process](/developer/release.html)
+- [Release process](/developer/release.html)
+- [How to build machine boot images](/developer/build-images.html)

docs/book/src/machine-images/powervs.md

@@ -7,8 +7,9 @@
 | us-south | power-oss-bucket | [capibm-powervs-centos-streams8-1-22-4.ova.gz][streams8-1-22-4] | 1.22.4             |
 | us-south | power-oss-bucket | [capibm-powervs-centos-streams8-1-24-2.ova.gz][streams8-1-24-2] | 1.24.2             |
 
-
+Note: These images are built using the [image-builder][image-builder] tool and more information can be found [here](../developer/build-images.md#power-vs)
 
 [streams8-1-24-2]: https://power-oss-bucket.s3.us-south.cloud-object-storage.appdomain.cloud/capibm-powervs-centos-streams8-1-24-2.ova.gz
 [streams8-1-23-5]: https://power-oss-bucket.s3.us-south.cloud-object-storage.appdomain.cloud/capibm-powervs-centos-streams8-1-23-5.ova.gz
 [streams8-1-22-4]: https://power-oss-bucket.s3.us-south.cloud-object-storage.appdomain.cloud/capibm-powervs-centos-streams8-1-22-4.ova.gz
+[image-builder]: https://github.com/kubernetes-sigs/image-builder

docs/book/src/topics/powervs/prerequisites.md

@@ -55,6 +55,16 @@ A public network is required for your kubernetes cluster. Perform the following
     DNS               8.8.8.8, 9.9.9.9
     ```
 
-## Build workload cluster image: 
+## Import the machine boot image: 
 
-1. ***TO-DO***
+```shell
+$ export IBMCLOUD_API_KEY=<API_KEY>
+$ pvsadm image import --instance-id <SERVICE_INSTANCE_ID> -b <BUCKETNAME> --object <OBJECT> --pvs-image-name <POWERVS_IMAGE_NAME> --bucket-region <REGION> --public-bucket
+```
+
+e.g:
+```shell
+$ pvsadm image import --instance-id 6d892c30-5387-4685-85d0-4999d9c22a8c -b power-oss-bucket --object capibm-powervs-centos-streams8-1-24-2.ova.gz --pvs-image-name capibm-powervs-centos-streams8-1-24-2 --bucket-region us-south --public-bucket
+```
+
+For more information about the images can be found at [machine-images](../../machine-images/powervs.md) section