Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add reference links for environment variables for VPC and PowerVS #2172

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+26 −2
Open

Add reference links for environment variables for VPC and PowerVS #2172

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c577b4d
add ref links for environment variables
arshadd-b Feb 5, 2025
052c3e5
address review comments
arshadd-b Feb 10, 2025
dce9b41
address review comments
arshadd-b Feb 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion docs/book/src/topics/powervs/creating-a-cluster.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ following the steps below.
> - 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.
> - While working with unreleased versions like from main branch, instead of `--flavor=powervs` use `--from=./templates/cluster-template-powervs.yaml`.
> - Refer detailed information on PowerVS variables [here](/topics/powervs/creating-a-cluster#note-refer-below-for-more-detailed-information-on-powervs-variables)

```console
IBMPOWERVS_SSHKEY_NAME="my-pub-key" \
Expand Down Expand Up @@ -186,4 +187,18 @@ following the steps below.
--control-plane-machine-count=3 \
--worker-machine-count=1 \
--flavor=powervs-clusterclass | kubectl apply -f -
```
```

#### Note: Refer below for more detailed information on PowerVS variables.
- IBMPOWERVS_CLUSTER_CLASS_NAME : Name of the cluster that user provides.
- [IBMPOWERVS_SSHKEY_NAME](https://cloud.ibm.com/docs/power-iaas?topic=power-iaas-creating-ssh-key)
- IBMPOWERVS_VIP, IBMPOWERVS_VIP_EXTERNAL and IBMPOWERVS_VIP_CIDR : Once we have created the network and port, the values will be available on listing the ports. Refer [here](/topics/powervs/creating-a-cluster.html)
- IBMPOWERVS_IMAGE_NAME : Name of the custom image. Refer [here](/topics/capibmadm/powervs/image.html) to get image details.
- IBMPOWERVS_SERVICE_INSTANCE_ID : ID of the PowerVS workspace. Refer [here](https://cloud.ibm.com/docs/power-iaas-cli-plugin?topic=power-iaas-cli-plugin-power-iaas-cli-reference-v1#ibmcloud-pi-workspace)
- [IBMACCOUNT_ID](https://cloud.ibm.com/docs/account?topic=account-accountfaqs#account-details)
- IBMPOWERVS_NETWORK_NAME : The name of the network. Refer [here](/topics/capibmadm/powervs/network.html) how to get the network details.
- [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)
11 changes: 10 additions & 1 deletion docs/book/src/topics/vpc/creating-a-cluster.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,4 +122,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 -


**Note:** Refer below for more detailed information on VPC variables.
- IBMVPC_CLUSTER_CLASS_NAME : Name of the cluster that user provides.
- [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)