Skip to content

Commit fa5471c

Browse files
shyamradhakrishnanshyamradhakrishnan
authored
Minor changes to docs (#212)
1 parent 79ff79f commit fa5471c

File tree

2 files changed

+44
-11
lines changed

2 files changed

+44
-11
lines changed

‎docs/src/gs/create-workload-cluster.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -33,15 +33,15 @@ and OCPU count.
3333

3434
The following Cluster API parameters are also available:
3535

36-
| Parameter | Default Value | Description |
37-
|-------------------------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
38-
| `CLUSTER_NAME` | | The name of the workload cluster to create. |
39-
| `CONTROL_PLANE_MACHINE_COUNT` | 1 | The number of control plane machines for the workload cluster. |
40-
| `KUBERNETES_VERSION` | | The Kubernetes version installed on the workload cluster nodes. If this environement variable is not configured, the version must be specifed in the `.cluster-api/clusterctl.yaml` file |
41-
| `NAMESPACE` | | The namespace for the workload cluster. If not specified, the current namespace is used. |
42-
| `POD_CIDR` | 192.168.0.0/16 | CIDR range of the Kubernetes pod-to-pod network. |
43-
| `SERVICE_CIDR` | 10.128.0.0/12 | CIDR range of the Kubernetes pod-to-services network. |
44-
| `NODE_MACHINE_COUNT` | | The number of worker machines for the workload cluster. |
36+
| Parameter | Default Value | Description |
37+
|-------------------------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
38+
| `CLUSTER_NAME` | | The name of the workload cluster to create. |
39+
| `CONTROL_PLANE_MACHINE_COUNT` | 1 | The number of control plane machines for the workload cluster. |
40+
| `KUBERNETES_VERSION` | | The Kubernetes version installed on the workload cluster nodes. If this environment variable is not configured, the version must be specified in the `.cluster-api/clusterctl.yaml` file |
41+
| `NAMESPACE` | | The namespace for the workload cluster. If not specified, the current namespace is used. |
42+
| `POD_CIDR` | 192.168.0.0/16 | CIDR range of the Kubernetes pod-to-pod network. |
43+
| `SERVICE_CIDR` | 10.128.0.0/12 | CIDR range of the Kubernetes pod-to-services network. |
44+
| `NODE_MACHINE_COUNT` | | The number of worker machines for the workload cluster. |
4545

4646
## Create a new workload cluster on virtual instances using an Ubuntu custom image
4747

‎docs/src/managed/managedcluster.md‎

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ custom resources:
99
- `OCIManagedCluster`
1010
- `OCIManagedMachinePool`
1111

12+
> NOTE: CAPOCI does not support flannel as the CNI provider in OKE clusters. This will be fixed in
13+
> an upcoming release.
14+
1215
## Workload Cluster Parameters
1316

1417
The following Oracle Cloud Infrastructure (OCI) configuration parameters are available
@@ -22,6 +25,16 @@ when creating a managed workload cluster on OCI using one of our predefined temp
2225
| `OCI_MANAGED_NODE_MACHINE_TYPE_OCPUS` | 1 | The number of OCPUs allocated to the worker node instance. |
2326
| `OCI_SSH_KEY` | | The public SSH key to be added to the Kubernetes nodes. It can be used to login to the node and troubleshoot failures. |
2427

28+
The following Cluster API parameters are also available:
29+
30+
| Parameter | Default Value | Description |
31+
|-------------------------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
32+
| `CLUSTER_NAME` | | The name of the workload cluster to create. |
33+
| `KUBERNETES_VERSION` | | The Kubernetes version installed on the workload cluster nodes. If this environement variable is not configured, the version must be specified in the `.cluster-api/clusterctl.yaml` file |
34+
| `NAMESPACE` | | The namespace for the workload cluster. If not specified, the current namespace is used. |
35+
| `NODE_MACHINE_COUNT` | | The number of machines in the OKE nodepool. |
36+
37+
2538
## Pre-Requisites
2639

2740
### Environment Variables
@@ -82,12 +95,32 @@ clusterctl generate cluster <cluster-name>\
8295
--from cluster-template-managedprivate.yaml | kubectl apply -f -
8396
```
8497

98+
## Access kubeconfig of an OKE cluster
99+
100+
### Step 1 - Identify Cluster OCID
101+
102+
Access the management cluster using kubectl and identify the OKE cluster OCID
103+
104+
```bash
105+
kubectl get ocimanagedcontrolplane <workload-cluster-name> -n <workload-cluster-namespace> -o jsonpath='{.spec.id}'
106+
```
107+
108+
### Step 2 - Access kubeconfig
109+
110+
Access kubeconfig
111+
112+
```bash
113+
oci ce cluster create-kubeconfig --cluster-id <cluster-ocid> --file <file-name> --region <region> --kube-endpoint PUBLIC_ENDPOINT
114+
```
115+
Please read the [doc][download-kubeconfig] for more details on how to access kubeconfig file of OKE clusters.
85116

86117

87-
[node-images-shapes]: https://docs.oracle.com/en-us/iaas/Content/ContEng/Reference/contengimagesshapes.htm
118+
[node-images]: https://docs.oracle.com/en-us/iaas/Content/ContEng/Reference/contengimagesshapes.htm#images
119+
[node-images-shapes]: https://docs.oracle.com/en-us/iaas/Content/ContEng/Reference/contengimagesshapes.htm#shapes
88120
[oke-policies]: https://docs.oracle.com/en-us/iaas/Content/ContEng/Concepts/contengpolicyconfig.htm
89121
[install-cluster-api]: ../gs/install-cluster-api.md
90122
[latest-release]: https://github.com/oracle/cluster-api-provider-oci/releases/latest
91123
[api-reference]: ../reference/api-reference.md
92124
[supported-versions]: https://docs.oracle.com/en-us/iaas/Content/ContEng/Concepts/contengaboutk8sversions.htm#supportedk8sversions
93-
[vcn-native-pod-networking]: https://docs.oracle.com/en-us/iaas/Content/ContEng/Concepts/contengpodnetworking_topic-OCI_CNI_plugin.htm
125+
[vcn-native-pod-networking]: https://docs.oracle.com/en-us/iaas/Content/ContEng/Concepts/contengpodnetworking_topic-OCI_CNI_plugin.htm
126+
[download-kubeconfig]:https://docs.oracle.com/en-us/iaas/Content/ContEng/Tasks/contengdownloadkubeconfigfile.htm

0 commit comments

Comments
 (0)