From c9a87f4dcb3c0dec4e10e66e41716aa4726d20be Mon Sep 17 00:00:00 2001 From: arshadda Date: Wed, 5 Feb 2025 11:25:22 +0530 Subject: [PATCH] add ref links for environment variables --- .../src/topics/powervs/creating-a-cluster.md | 21 ++++++++++++++++++- .../book/src/topics/vpc/creating-a-cluster.md | 11 +++++++++- 2 files changed, 30 insertions(+), 2 deletions(-) diff --git a/docs/book/src/topics/powervs/creating-a-cluster.md b/docs/book/src/topics/powervs/creating-a-cluster.md index 008d9915e..3c1e7347a 100644 --- a/docs/book/src/topics/powervs/creating-a-cluster.md +++ b/docs/book/src/topics/powervs/creating-a-cluster.md @@ -40,6 +40,7 @@ following the steps below. > **Note:** > - Set `EXP_CLUSTER_RESOURCE_SET` to `true` as the cluster will be deployed with external cloud provider which will create the resources to run the cloud controller manager. > - The `IBMPOWERVS_IMAGE_NAME` value below should reflect the name of the custom image and the `kubernetes-version` value below should reflect the kubernetes version of the custom image. + > - Refer detailed information on POWERVS variables [here](/topics/powervs/creating-a-cluster#note-refer-below-for-more-detailed-information-on-powervs-variables.html) ```console IBMPOWERVS_SSHKEY_NAME="my-pub-key" \ @@ -71,6 +72,8 @@ following the steps below. kubeadmconfigtemplate.bootstrap.cluster.x-k8s.io/ibm-powervs-1-md-0 created ``` + **Note:** Refer detailed information on POWERVS variables [here](/topics/powervs/creating-a-cluster#note-refer-below-for-more-detailed-information-on-powervs-variables) + Additional parameters for modifying PowerVS Control-Plane spec ``` IBMPOWERVS_CONTROL_PLANE_MEMORY @@ -181,4 +184,20 @@ following the steps below. --control-plane-machine-count=3 \ --worker-machine-count=1 \ --flavor=powervs-clusterclass | kubectl apply -f - - ``` \ No newline at end of file + ``` + +#### Note: Refer below for more detailed information on POWERVS variables. +- IBMPOWERVS_CLUSTER_CLASS_NAME : Name of the cluster that user want to keep. +- [IBMPOWERVS_SSHKEY_NAME](https://cloud.ibm.com/docs/power-iaas?topic=power-iaas-creating-ssh-key) +- [IBMPOWERVS_VIP](/topics/capibmadm/powervs/network#1-capibmadm-powervs-network-create) +- [IBMPOWERVS_VIP_EXTERNAL](/topics/capibmadm/powervs/network#1-capibmadm-powervs-network-create) +- [IBMPOWERVS_VIP_CIDR](/topics/capibmadm/powervs/network#1-capibmadm-powervs-network-create) +- [IBMPOWERVS_IMAGE_NAME](https://cloud.ibm.com/docs/power-iaas?topic=power-iaas-conn-COS-custom-image) +- [IBMPOWERVS_SERVICE_INSTANCE_ID](/topics/capibmadm/powervs/image.html) +- [IBMACCOUNT_ID](https://cloud.ibm.com/docs/account?topic=account-accountfaqs#account-details) +- [IBMPOWERVS_NETWORK_NAME](/topics/capibmadm/powervs/network#1-capibmadm-powervs-network-create.html) +- [IBMPOWERVS_REGION](/reference/regions-zones-mapping.html) +- [IBMPOWERVS_ZONE](/reference/regions-zones-mapping.html) +- [COS_BUCKET_REGION](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-endpoints#endpoints-region) +- [COS_BUCKET_NAME](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-getting-started-cloud-object-storage#gs-create-buckets) +- [COS_OBJECT_NAME](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-getting-started-cloud-object-storage#gs-add-objects) \ No newline at end of file diff --git a/docs/book/src/topics/vpc/creating-a-cluster.md b/docs/book/src/topics/vpc/creating-a-cluster.md index 64d46b096..fe9a785f4 100644 --- a/docs/book/src/topics/vpc/creating-a-cluster.md +++ b/docs/book/src/topics/vpc/creating-a-cluster.md @@ -121,4 +121,13 @@ There are two following variables for controlling the volume size for the boot d IBMACCOUNT_ID="ibm-accountid" \ BASE64_API_KEY=$(echo -n $IBMCLOUD_API_KEY | base64) \ clusterctl generate cluster ibm-vpc-clusterclass --kubernetes-version v1.26.2 --target-namespace default --control-plane-machine-count=1 --worker-machine-count=2 --from=./templates/cluster-template-vpc-clusterclass.yaml | kubectl apply -f - - \ No newline at end of file + +**Note:** Refer below for more detailed information on VPC variables. +- IBMVPC_CLUSTER_CLASS_NAME : Name of the cluster that user want to keep. +- [IBMVPC_REGION](/reference/regions-zones-mapping.html) +- [IBMVPC_ZONE](/reference/regions-zones-mapping.html) +- [IBMVPC_RESOURCEGROUP](https://cloud.ibm.com/docs/account?topic=account-rgs&interface=ui) +- [IBMVPC_IMAGE_NAME](https://cloud.ibm.com/docs/vpc?topic=vpc-planning-custom-images) +- [IBMVPC_PROFILE](https://cloud.ibm.com/docs/vpc?topic=vpc-profiles&interface=ui) +- [IBMVPC_SSHKEY_NAME](https://cloud.ibm.com/docs/vpc?topic=vpc-managing-ssh-keys&interface=ui) +- [IBMACCOUNT_ID](https://cloud.ibm.com/docs/account?topic=account-accountfaqs#account-details)