You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/book/src/getting-started.md
+44-34Lines changed: 44 additions & 34 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,44 +41,24 @@ it into a management cluster using `clusterctl`.
41
41
```console
42
42
export IBMCLOUD_API_KEY=<YOUR_API_KEY>
43
43
```
44
-
For enabling debug level logs for the controller, set the `LOGLEVEL` environment variable(defaults to 0).
45
-
```console
46
-
export LOGLEVEL=5
47
-
```
48
-
49
-
> Note: Refer [Regions-Zones Mapping](/reference/regions-zones-mapping.html) for more information.
50
-
51
-
> Note: To deploy VPC workload cluster with [IBM cloud controller manager](/topics/vpc/load-balancer.html) which is currently in experimental stage. Set the `PROVIDER_ID_FORMAT` environmental variable.
52
-
Currently, [ClusterResourceset](https://cluster-api.sigs.k8s.io/tasks/experimental-features/cluster-resource-set.html) is experimental feature, so we need to enable the feature gate by setting `EXP_CLUSTER_RESOURCE_SET` environmental variables.
53
-
```console
54
-
export PROVIDER_ID_FORMAT=v2
55
-
export EXP_CLUSTER_RESOURCE_SET=true
56
-
```
57
-
58
-
> Note: To deploy workload cluster with [PowerVS cloud controller manager](/topics/powervs/external-cloud-provider.html) which is currently in experimental stage. Set the `POWERVS_PROVIDER_ID_FORMAT` environmental variable.
59
-
Currently, [ClusterResourceset](https://cluster-api.sigs.k8s.io/tasks/experimental-features/cluster-resource-set.html) is experimental feature so we need to enable the feature gate by setting `EXP_CLUSTER_RESOURCE_SET` environmental variables.
60
-
```console
61
-
export POWERVS_PROVIDER_ID_FORMAT=v2
62
-
export EXP_CLUSTER_RESOURCE_SET=true
63
-
```
64
-
> Note: To deploy workload cluster with [PowerVS clusterclass-template](/topics/powervs/clusterclass-cluster.html). Set the `POWERVS_PROVIDER_ID_FORMAT` environmental variable.
65
-
Currently, both [ClusterClass](https://cluster-api.sigs.k8s.io/tasks/experimental-features/cluster-class/index.html) and [ClusterResourceset](https://cluster-api.sigs.k8s.io/tasks/experimental-features/cluster-resource-set.html) are experimental feature so we need to enable the feature gate by setting `EXP_CLUSTER_RESOURCE_SET`, `CLUSTER_TOPOLOGY` environmental variables.
66
-
```console
67
-
export POWERVS_PROVIDER_ID_FORMAT=v2
68
-
export EXP_CLUSTER_RESOURCE_SET=true
69
-
export CLUSTER_TOPOLOGY=true
70
-
```
44
+
45
+
3. To deploy workload cluster with Custom Service Endpoint, Set `SERVICE_ENDPOINT` environmental variable in semi-colon separated format:
> Note: Refer [Regions-Zones Mapping](/reference/regions-zones-mapping.html) for more information.
55
+
56
+
4. For enabling debug level logs for the controller, set the `LOGLEVEL` environment variable(defaults to 0).
57
+
```console
58
+
export LOGLEVEL=5
59
+
```
80
60
81
-
2. Initialize local bootstrap cluster as a management cluster
61
+
5. Initialize local bootstrap cluster as a management cluster
82
62
83
63
When executed for the first time, the following command accepts the infrastructure provider as an input to install. `clusterctl init` automatically adds to the list the cluster-api core provider, and if unspecified, it also adds the kubeadm bootstrap and kubeadm control-plane providers, thereby converting it into a management cluster which will be used to provision a workload cluster in IBM Cloud.
84
64
@@ -106,4 +86,34 @@ it into a management cluster using `clusterctl`.
5. Once the management cluster is ready with the required providers up and running, proceed to provisioning the workload cluster. Check the respective sections for [VPC](/topics/vpc/creating-a-cluster.html) and [PowerVS](/topics/powervs/creating-a-cluster.html) to deploy the cluster.
89
+
6. Once the management cluster is ready with the required providers up and running, proceed to provisioning the workload cluster. Check the respective sections for [VPC](/topics/vpc/creating-a-cluster.html) and [PowerVS](/topics/powervs/creating-a-cluster.html) to deploy the cluster.
90
+
91
+
7. For deploying with your workload cluster with Cloud Controller manager or Cluster Class template, refer to [deploy with cloud controller manager](#deploy-with-cloud-contoller-manager) and [deploy PowerVS cluster with cluster class template](#deploy-powervs-cluster-with-clusterclass-template) sections respectively.
92
+
93
+
94
+
### Deploy with Cloud Contoller manager
95
+
96
+
1. To deploy VPC workload cluster with [IBM cloud controller manager](/topics/vpc/load-balancer.html), set the `PROVIDER_ID_FORMAT` environmental variable.
97
+
```console
98
+
export PROVIDER_ID_FORMAT=v2
99
+
export EXP_CLUSTER_RESOURCE_SET=true
100
+
```
101
+
102
+
2. To deploy workload cluster with [PowerVS cloud controller manager](/topics/powervs/external-cloud-provider.html), set the `POWERVS_PROVIDER_ID_FORMAT` environmental variable.
103
+
```console
104
+
export POWERVS_PROVIDER_ID_FORMAT=v2
105
+
export EXP_CLUSTER_RESOURCE_SET=true
106
+
```
107
+
> Note: `EXP_CLUSTER_RESOURCE_SET` should be set for deploying workload cluster with Cloud Controller manager.
108
+
109
+
### Deploy PowerVS cluster with ClusterClass template
110
+
111
+
To deploy workload cluster with [PowerVS clusterclass-template](/topics/powervs/clusterclass-cluster.html). Set the following environmental variables.
112
+
113
+
```console
114
+
export POWERVS_PROVIDER_ID_FORMAT=v2
115
+
export EXP_CLUSTER_RESOURCE_SET=true
116
+
export CLUSTER_TOPOLOGY=true
117
+
```
118
+
119
+
> Note: Currently, both [ClusterClass](https://cluster-api.sigs.k8s.io/tasks/experimental-features/cluster-class/index.html) and [ClusterResourceset](https://cluster-api.sigs.k8s.io/tasks/experimental-features/cluster-resource-set.html) are experimental feature so we need to enable the feature gate by setting `EXP_CLUSTER_RESOURCE_SET`, `CLUSTER_TOPOLOGY` environmental variables.
0 commit comments