Skip to content

Commit d9089c1

Browse files
committed
add ref links for environament variables
1 parent d0a00cc commit d9089c1

File tree

2 files changed

+57
-2
lines changed

2 files changed

+57
-2
lines changed

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

+47-1
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,15 @@ following the steps below.
148148
--flavor=powervs | kubectl apply -f -
149149
```
150150
151+
**Note:** Refer below for more detailed information on POWERVS variables.
152+
- [IBMPOWERVS_SSHKEY_NAME](https://cloud.ibm.com/docs/power-iaas?topic=power-iaas-creating-ssh-key)
153+
- [IBMPOWERVS_VIP](/topics/capibmadm/powervs/network#1-capibmadm-powervs-network-create)
154+
- [IBMPOWERVS_VIP_EXTERNAL](/topics/capibmadm/powervs/network#1-capibmadm-powervs-network-create)
155+
- [IBMPOWERVS_VIP_CIDR](/topics/capibmadm/powervs/network#1-capibmadm-powervs-network-create)
156+
- [IBMPOWERVS_IMAGE_NAME](https://cloud.ibm.com/docs/power-iaas?topic=power-iaas-conn-COS-custom-image)
157+
- [IBMPOWERVS_SERVICE_INSTANCE_ID](/topics/capibmadm/powervs/image.html)
158+
- [IBMPOWERVS_NETWORK_NAME] (/topics/capibmadm/powervs/network#1-capibmadm-powervs-network-create)
159+
151160
### Deploy a PowerVS cluster with infrastructure creation
152161
153162
#### Prerequisites:
@@ -176,6 +185,17 @@ following the steps below.
176185
--flavor=powervs-create-infra | kubectl apply -f -
177186
```
178187
188+
**Note:** Refer below for more detailed information on POWERVS variables.
189+
- [IBMPOWERVS_SSHKEY_NAME](https://cloud.ibm.com/docs/power-iaas?topic=power-iaas-creating-ssh-key)
190+
- [COS_BUCKET_REGION](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-endpoints#endpoints-region)
191+
- [COS_BUCKET_NAME](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-getting-started-cloud-object-storage#gs-create-buckets)
192+
- [COS_OBJECT_NAME](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-getting-started-cloud-object-storage#gs-add-objects)
193+
- [IBMACCOUNT_ID](https://cloud.ibm.com/docs/account?topic=account-accountfaqs#account-details)
194+
- [IBMPOWERVS_REGION](/reference/regions-zones-mapping.html)
195+
- [IBMPOWERVS_ZONE](/reference/regions-zones-mapping.html)
196+
- [IBMVPC_REGION](/reference/regions-zones-mapping.html)
197+
- [IBM_RESOURCE_GROUP](https://cloud.ibm.com/docs/account?topic=account-rgs&interface=ui)
198+
179199
### Deploy a PowerVS cluster with external cloud provider
180200
181201
#### Prerequisites:
@@ -201,6 +221,18 @@ following the steps below.
201221
--flavor=powervs-cloud-provider | kubectl apply -f -
202222
```
203223
224+
**Note:** Refer below for more detailed information on POWERVS variables.
225+
- [IBMPOWERVS_SSHKEY_NAME](https://cloud.ibm.com/docs/power-iaas?topic=power-iaas-creating-ssh-key)
226+
- [IBMPOWERVS_VIP](/topics/capibmadm/powervs/network#1-capibmadm-powervs-network-create)
227+
- [IBMPOWERVS_VIP_EXTERNAL](/topics/capibmadm/powervs/network#1-capibmadm-powervs-network-create)
228+
- [IBMPOWERVS_VIP_CIDR](/topics/capibmadm/powervs/network#1-capibmadm-powervs-network-create)
229+
- [IBMPOWERVS_IMAGE_NAME](https://cloud.ibm.com/docs/power-iaas?topic=power-iaas-conn-COS-custom-image)
230+
- [IBMPOWERVS_SERVICE_INSTANCE_ID](/topics/capibmadm/powervs/image.html)
231+
- [IBMPOWERVS_NETWORK_NAME] (/topics/capibmadm/powervs/network#1-capibmadm-powervs-network-create)
232+
- [IBMACCOUNT_ID](https://cloud.ibm.com/docs/account?topic=account-accountfaqs#account-details)
233+
- [IBMPOWERVS_REGION](/reference/regions-zones-mapping.html)
234+
- [IBMPOWERVS_ZONE](/reference/regions-zones-mapping.html)
235+
204236
### Deploy a PowerVS cluster with cluster class
205237
206238
#### Prerequisites:
@@ -226,4 +258,18 @@ following the steps below.
226258
--control-plane-machine-count=3 \
227259
--worker-machine-count=1 \
228260
--flavor=powervs-clusterclass | kubectl apply -f -
229-
```
261+
```
262+
263+
**Note:** Refer below for more detailed information on POWERVS variables.
264+
- [IBMPOWERVS_CLUSTER_CLASS_NAME](/tasks/experimental-features/cluster-class/index.html)
265+
- [IBMPOWERVS_SSHKEY_NAME](https://cloud.ibm.com/docs/power-iaas?topic=power-iaas-creating-ssh-key)
266+
- [IBMPOWERVS_VIP](/topics/capibmadm/powervs/network#1-capibmadm-powervs-network-create)
267+
- [IBMPOWERVS_VIP_EXTERNAL](/topics/capibmadm/powervs/network#1-capibmadm-powervs-network-create)
268+
- [IBMPOWERVS_VIP_CIDR](/topics/capibmadm/powervs/network#1-capibmadm-powervs-network-create)
269+
- [IBMPOWERVS_IMAGE_NAME](https://cloud.ibm.com/docs/power-iaas?topic=power-iaas-conn-COS-custom-image)
270+
- [IBMPOWERVS_SERVICE_INSTANCE_ID](/topics/capibmadm/powervs/image.html)
271+
- [IBMACCOUNT_ID](https://cloud.ibm.com/docs/account?topic=account-accountfaqs#account-details)
272+
- [IBMPOWERVS_NETWORK_NAME](/topics/capibmadm/powervs/network#1-capibmadm-powervs-network-create)
273+
- [IBMPOWERVS_REGION](/reference/regions-zones-mapping.html)
274+
- [IBMPOWERVS_ZONE](/reference/regions-zones-mapping.html)
275+

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

+10-1
Original file line numberDiff line numberDiff line change
@@ -122,4 +122,13 @@ There are two following variables for controlling the volume size for the boot d
122122
IBMACCOUNT_ID="ibm-accountid" \
123123
BASE64_API_KEY=$(echo -n $IBMCLOUD_API_KEY | base64) \
124124
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 -
125-
125+
126+
**Note:** Refer below for more detailed information on VPC variables.
127+
- [IBMVPC_CLUSTER_CLASS_NAME](/tasks/experimental-features/cluster-class/index.html)
128+
- [IBMVPC_REGION](/reference/regions-zones-mapping.html)
129+
- [IBMVPC_ZONE](/reference/regions-zones-mapping.html)
130+
- [IBMVPC_RESOURCEGROUP](https://cloud.ibm.com/docs/account?topic=account-rgs&interface=ui)
131+
- [IBMVPC_IMAGE_NAME](https://cloud.ibm.com/docs/vpc?topic=vpc-planning-custom-images)
132+
- [IBMVPC_PROFILE](https://cloud.ibm.com/docs/vpc?topic=vpc-profiles&interface=ui)
133+
- [IBMVPC_SSHKEY_NAME](https://cloud.ibm.com/docs/vpc?topic=vpc-managing-ssh-keys&interface=ui)
134+
- [IBMACCOUNT_ID](https://cloud.ibm.com/docs/account?topic=account-accountfaqs#account-details)

0 commit comments

Comments
 (0)