Skip to content

Commit cb2e7ce

Browse files
committed
add ref links for environment variables
1 parent c6b2def commit cb2e7ce

File tree

2 files changed

+99
-2
lines changed

2 files changed

+99
-2
lines changed

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

Lines changed: 89 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,32 @@ following the steps below.
134134
ibm-powervs-1-md-0-4dc5c Ready <none> 41h v1.26.2
135135
ibm-powervs-1-md-0-dbxb7 Ready <none> 20h v1.26.2
136136

137+
### Deploy a PowerVS cluster with user provided resources
138+
139+
```
140+
IBMPOWERVS_SSHKEY_NAME="my-pub-key" \
141+
IBMPOWERVS_VIP="192.168.167.6" \
142+
IBMPOWERVS_VIP_EXTERNAL="163.68.65.6" \
143+
IBMPOWERVS_VIP_CIDR="29" \
144+
IBMPOWERVS_IMAGE_NAME="capibm-powervs-centos-streams8-1-26-2" \
145+
IBMPOWERVS_SERVICE_INSTANCE_ID="3229a94c-af54-4212-bf60-6202b6fd0a07" \
146+
IBMPOWERVS_NETWORK_NAME="capi-test" \
147+
clusterctl generate cluster ibm-powervs-1 --kubernetes-version v1.26.2 \
148+
--target-namespace default \
149+
--control-plane-machine-count=3 \
150+
--worker-machine-count=1 \
151+
--flavor=powervs | kubectl apply -f -
152+
```
153+
154+
**Note:** Refer below for more detailed information on POWERVS variables.
155+
- [IBMPOWERVS_SSHKEY_NAME](https://cloud.ibm.com/docs/power-iaas?topic=power-iaas-creating-ssh-key)
156+
- [IBMPOWERVS_VIP](/topics/capibmadm/powervs/network#1-capibmadm-powervs-network-create)
157+
- [IBMPOWERVS_VIP_EXTERNAL](/topics/capibmadm/powervs/network#1-capibmadm-powervs-network-create)
158+
- [IBMPOWERVS_VIP_CIDR](/topics/capibmadm/powervs/network#1-capibmadm-powervs-network-create)
159+
- [IBMPOWERVS_IMAGE_NAME](https://cloud.ibm.com/docs/power-iaas?topic=power-iaas-conn-COS-custom-image)
160+
- [IBMPOWERVS_SERVICE_INSTANCE_ID](/topics/capibmadm/powervs/image.html)
161+
- [IBMPOWERVS_NETWORK_NAME](/topics/capibmadm/powervs/network#1-capibmadm-powervs-network-create.html)
162+
137163
### Deploy a PowerVS cluster with infrastructure creation
138164
139165
#### Prerequisites:
@@ -158,6 +184,54 @@ following the steps below.
158184
--flavor=powervs-create-infra | kubectl apply -f -
159185
```
160186
187+
**Note:** Refer below for more detailed information on POWERVS variables.
188+
- [IBMPOWERVS_SSHKEY_NAME](https://cloud.ibm.com/docs/power-iaas?topic=power-iaas-creating-ssh-key)
189+
- [COS_BUCKET_REGION](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-endpoints#endpoints-region)
190+
- [COS_BUCKET_NAME](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-getting-started-cloud-object-storage#gs-create-buckets)
191+
- [COS_OBJECT_NAME](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-getting-started-cloud-object-storage#gs-add-objects)
192+
- [IBMACCOUNT_ID](https://cloud.ibm.com/docs/account?topic=account-accountfaqs#account-details)
193+
- [IBMPOWERVS_REGION](/reference/regions-zones-mapping.html)
194+
- [IBMPOWERVS_ZONE](/reference/regions-zones-mapping.html)
195+
- [IBMVPC_REGION](/reference/regions-zones-mapping.html)
196+
- [IBM_RESOURCE_GROUP](https://cloud.ibm.com/docs/account?topic=account-rgs&interface=ui)
197+
198+
### Deploy a PowerVS cluster with external cloud provider
199+
200+
#### Prerequisites:
201+
- 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.
202+
- Set the `provider-id-fmt` [flag](https://github.com/kubernetes-sigs/cluster-api-provider-ibmcloud/blob/5e7f80878f2252c6ab13c16102de90c784a2624d/main.go#L168-L173) to `v2` via `PROVIDER_ID_FORMAT` environment variable.
203+
204+
```
205+
IBMPOWERVS_SSHKEY_NAME="my-pub-key" \
206+
IBMPOWERVS_VIP="192.168.167.6" \
207+
IBMPOWERVS_VIP_EXTERNAL="163.68.65.6" \
208+
IBMPOWERVS_VIP_CIDR="29" \
209+
IBMPOWERVS_IMAGE_NAME="capibm-powervs-centos-streams8-1-26-2" \
210+
IBMPOWERVS_SERVICE_INSTANCE_ID="3229a94c-af54-4212-bf60-6202b6fd0a07" \
211+
IBMPOWERVS_NETWORK_NAME="capi-test" \
212+
IBMACCOUNT_ID="ibm-accountid" \
213+
IBMPOWERVS_REGION="osa" \
214+
IBMPOWERVS_ZONE="osa21" \
215+
BASE64_API_KEY=$(echo -n $IBMCLOUD_API_KEY | base64) \
216+
clusterctl generate cluster ibm-powervs-1 --kubernetes-version v1.26.2 \
217+
--target-namespace default \
218+
--control-plane-machine-count=3 \
219+
--worker-machine-count=1 \
220+
--flavor=powervs-cloud-provider | kubectl apply -f -
221+
```
222+
223+
**Note:** Refer below for more detailed information on POWERVS variables.
224+
- [IBMPOWERVS_SSHKEY_NAME](https://cloud.ibm.com/docs/power-iaas?topic=power-iaas-creating-ssh-key)
225+
- [IBMPOWERVS_VIP](/topics/capibmadm/powervs/network#1-capibmadm-powervs-network-create)
226+
- [IBMPOWERVS_VIP_EXTERNAL](/topics/capibmadm/powervs/network#1-capibmadm-powervs-network-create)
227+
- [IBMPOWERVS_VIP_CIDR](/topics/capibmadm/powervs/network#1-capibmadm-powervs-network-create)
228+
- [IBMPOWERVS_IMAGE_NAME](https://cloud.ibm.com/docs/power-iaas?topic=power-iaas-conn-COS-custom-image)
229+
- [IBMPOWERVS_SERVICE_INSTANCE_ID](/topics/capibmadm/powervs/image.html)
230+
- [IBMPOWERVS_NETWORK_NAME](/topics/capibmadm/powervs/network#1-capibmadm-powervs-network-create.html)
231+
- [IBMACCOUNT_ID](https://cloud.ibm.com/docs/account?topic=account-accountfaqs#account-details)
232+
- [IBMPOWERVS_REGION](/reference/regions-zones-mapping.html)
233+
- [IBMPOWERVS_ZONE](/reference/regions-zones-mapping.html)
234+
161235
### Deploy a PowerVS cluster with cluster class
162236
163237
#### Prerequisites:
@@ -181,4 +255,18 @@ following the steps below.
181255
--control-plane-machine-count=3 \
182256
--worker-machine-count=1 \
183257
--flavor=powervs-clusterclass | kubectl apply -f -
184-
```
258+
```
259+
260+
**Note:** Refer below for more detailed information on POWERVS variables.
261+
- [IBMPOWERVS_CLUSTER_CLASS_NAME](/tasks/experimental-features/cluster-class/index.html)
262+
- [IBMPOWERVS_SSHKEY_NAME](https://cloud.ibm.com/docs/power-iaas?topic=power-iaas-creating-ssh-key)
263+
- [IBMPOWERVS_VIP](/topics/capibmadm/powervs/network#1-capibmadm-powervs-network-create)
264+
- [IBMPOWERVS_VIP_EXTERNAL](/topics/capibmadm/powervs/network#1-capibmadm-powervs-network-create)
265+
- [IBMPOWERVS_VIP_CIDR](/topics/capibmadm/powervs/network#1-capibmadm-powervs-network-create)
266+
- [IBMPOWERVS_IMAGE_NAME](https://cloud.ibm.com/docs/power-iaas?topic=power-iaas-conn-COS-custom-image)
267+
- [IBMPOWERVS_SERVICE_INSTANCE_ID](/topics/capibmadm/powervs/image.html)
268+
- [IBMACCOUNT_ID](https://cloud.ibm.com/docs/account?topic=account-accountfaqs#account-details)
269+
- [IBMPOWERVS_NETWORK_NAME](/topics/capibmadm/powervs/network#1-capibmadm-powervs-network-create.html)
270+
- [IBMPOWERVS_REGION](/reference/regions-zones-mapping.html)
271+
- [IBMPOWERVS_ZONE](/reference/regions-zones-mapping.html)
272+

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

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

0 commit comments

Comments
 (0)