From 25722486730be64689152e4d7a9586e9a1e14566 Mon Sep 17 00:00:00 2001 From: Amulyam24 Date: Wed, 20 Apr 2022 13:13:28 +0530 Subject: [PATCH] Add IBM Cloud --- docs/book/src/user/quick-start.md | 36 +++++++++++++++++++++++++++++-- 1 file changed, 34 insertions(+), 2 deletions(-) diff --git a/docs/book/src/user/quick-start.md b/docs/book/src/user/quick-start.md index 7580cb9e13bc..7809fc08e7a7 100644 --- a/docs/book/src/user/quick-start.md +++ b/docs/book/src/user/quick-start.md @@ -202,7 +202,7 @@ Additional documentation about experimental features can be found in [Experiment Depending on the infrastructure provider you are planning to use, some additional prerequisites should be satisfied before getting started with Cluster API. See below for the expected settings for common providers. -{{#tabs name:"tab-installation-infrastructure" tabs:"AWS,Azure,DigitalOcean,Docker,Equinix Metal,GCP,Hetzner,Metal3,Nutanix,OCI,OpenStack,vSphere"}} +{{#tabs name:"tab-installation-infrastructure" tabs:"AWS,Azure,DigitalOcean,Docker,Equinix Metal,GCP,Hetzner,IBM Cloud,Metal3,Nutanix,OCI,OpenStack,vSphere"}} {{#tab AWS}} Download the latest binary of `clusterawsadm` from the [AWS provider releases] and make sure to place it in your path. @@ -324,6 +324,20 @@ clusterctl init --infrastructure gcp Please visit the [Hetzner project][Hetzner provider]. +{{#/tab }} +{{#tab IBM Cloud}} + +In order to initialize the IBM Cloud Provider you have to expose the environment +variable `IBMCLOUD_API_KEY`. This variable is used to authorize the infrastructure +provider manager against the IBM Cloud API. To create one from the UI, refer [here](https://cloud.ibm.com/docs/account?topic=account-userapikey&interface=ui#create_user_key). + +```bash +export IBMCLOUD_API_KEY= + +# Finally, initialize the management cluster +clusterctl init --infrastructure ibmcloud +``` + {{#/tab }} {{#tab Metal3}} @@ -434,7 +448,7 @@ before configuring a cluster with Cluster API. Instructions are provided for com Otherwise, you can look at the `clusterctl generate cluster` [command][clusterctl generate cluster] documentation for details about how to discover the list of variables required by a cluster templates. -{{#tabs name:"tab-configuration-infrastructure" tabs:"AWS,Azure,DigitalOcean,Docker,Equinix Metal,GCP,Metal3,Nutanix,OpenStack,vSphere"}} +{{#tabs name:"tab-configuration-infrastructure" tabs:"AWS,Azure,DigitalOcean,Docker,Equinix Metal,GCP,IBM Cloud,Metal3,Nutanix,OpenStack,vSphere"}} {{#tab AWS}} ```bash @@ -553,6 +567,23 @@ export CLUSTER_NAME="" See the [GCP provider] for more information. +{{#/tab }} +{{#tab IBM Cloud}} + +```bash +export IBMPOWERVS_SSHKEY_NAME= +# Internal and external IP of the network +export IBMPOWERVS_VIP= +export IBMPOWERVS_VIP_EXTERNAL= +export IBMPOWERVS_VIP_CIDR=29 +export IBMPOWERVS_IMAGE_NAME= +# ID of the service instance in the cloud account +export IBMPOWERVS_SERVICE_INSTANCE_ID= +export IBMPOWERVS_NETWORK_NAME= +``` + +Please visit the [IBM Cloud provider] for more information. + {{#/tab }} {{#tab Metal3}} @@ -869,6 +900,7 @@ See the [clusterctl] documentation for more detail about clusterctl supported ac [Docker]: https://www.docker.com/ [GCP provider]: https://github.com/kubernetes-sigs/cluster-api-provider-gcp [Hetzner provider]: https://github.com/syself/cluster-api-provider-hetzner +[IBM Cloud provider]: https://github.com/kubernetes-sigs/cluster-api-provider-ibmcloud [infrastructure provider]: ../reference/glossary.md#infrastructure-provider [kind]: https://kind.sigs.k8s.io/ [KubeadmControlPlane]: ../developer/architecture/controllers/control-plane.md