diff --git a/docs/src/gs/create-workload-cluster.md b/docs/src/gs/create-workload-cluster.md index c63393b1..e829fd66 100644 --- a/docs/src/gs/create-workload-cluster.md +++ b/docs/src/gs/create-workload-cluster.md @@ -33,15 +33,15 @@ and OCPU count. The following Cluster API parameters are also available: -| Parameter | Default Value | Description | -|-------------------------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `CLUSTER_NAME` | | The name of the workload cluster to create. | -| `CONTROL_PLANE_MACHINE_COUNT` | 1 | The number of control plane machines for the workload cluster. | -| `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 | -| `NAMESPACE` | | The namespace for the workload cluster. If not specified, the current namespace is used. | -| `POD_CIDR` | 192.168.0.0/16 | CIDR range of the Kubernetes pod-to-pod network. | -| `SERVICE_CIDR` | 10.128.0.0/12 | CIDR range of the Kubernetes pod-to-services network. | -| `NODE_MACHINE_COUNT` | | The number of worker machines for the workload cluster. | +| Parameter | Default Value | Description | +|-------------------------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `CLUSTER_NAME` | | The name of the workload cluster to create. | +| `CONTROL_PLANE_MACHINE_COUNT` | 1 | The number of control plane machines for the workload cluster. | +| `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 | +| `NAMESPACE` | | The namespace for the workload cluster. If not specified, the current namespace is used. | +| `POD_CIDR` | 192.168.0.0/16 | CIDR range of the Kubernetes pod-to-pod network. | +| `SERVICE_CIDR` | 10.128.0.0/12 | CIDR range of the Kubernetes pod-to-services network. | +| `NODE_MACHINE_COUNT` | | The number of worker machines for the workload cluster. | ## Create a new workload cluster on virtual instances using an Ubuntu custom image diff --git a/docs/src/managed/managedcluster.md b/docs/src/managed/managedcluster.md index 00f30e03..0626874c 100644 --- a/docs/src/managed/managedcluster.md +++ b/docs/src/managed/managedcluster.md @@ -9,6 +9,9 @@ custom resources: - `OCIManagedCluster` - `OCIManagedMachinePool` +> NOTE: CAPOCI does not support flannel as the CNI provider in OKE clusters. This will be fixed in +> an upcoming release. + ## Workload Cluster Parameters 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 | `OCI_MANAGED_NODE_MACHINE_TYPE_OCPUS` | 1 | The number of OCPUs allocated to the worker node instance. | | `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. | +The following Cluster API parameters are also available: + +| Parameter | Default Value | Description | +|-------------------------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `CLUSTER_NAME` | | The name of the workload cluster to create. | +| `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 | +| `NAMESPACE` | | The namespace for the workload cluster. If not specified, the current namespace is used. | +| `NODE_MACHINE_COUNT` | | The number of machines in the OKE nodepool. | + + ## Pre-Requisites ### Environment Variables @@ -82,12 +95,32 @@ clusterctl generate cluster \ --from cluster-template-managedprivate.yaml | kubectl apply -f - ``` +## Access kubeconfig of an OKE cluster + +### Step 1 - Identify Cluster OCID + +Access the management cluster using kubectl and identify the OKE cluster OCID + +```bash +kubectl get ocimanagedcontrolplane -n -o jsonpath='{.spec.id}' +``` + +### Step 2 - Access kubeconfig + +Access kubeconfig + +```bash +oci ce cluster create-kubeconfig --cluster-id --file --region --kube-endpoint PUBLIC_ENDPOINT +``` +Please read the [doc][download-kubeconfig] for more details on how to access kubeconfig file of OKE clusters. -[node-images-shapes]: https://docs.oracle.com/en-us/iaas/Content/ContEng/Reference/contengimagesshapes.htm +[node-images]: https://docs.oracle.com/en-us/iaas/Content/ContEng/Reference/contengimagesshapes.htm#images +[node-images-shapes]: https://docs.oracle.com/en-us/iaas/Content/ContEng/Reference/contengimagesshapes.htm#shapes [oke-policies]: https://docs.oracle.com/en-us/iaas/Content/ContEng/Concepts/contengpolicyconfig.htm [install-cluster-api]: ../gs/install-cluster-api.md [latest-release]: https://github.com/oracle/cluster-api-provider-oci/releases/latest [api-reference]: ../reference/api-reference.md [supported-versions]: https://docs.oracle.com/en-us/iaas/Content/ContEng/Concepts/contengaboutk8sversions.htm#supportedk8sversions -[vcn-native-pod-networking]: https://docs.oracle.com/en-us/iaas/Content/ContEng/Concepts/contengpodnetworking_topic-OCI_CNI_plugin.htm \ No newline at end of file +[vcn-native-pod-networking]: https://docs.oracle.com/en-us/iaas/Content/ContEng/Concepts/contengpodnetworking_topic-OCI_CNI_plugin.htm +[download-kubeconfig]:https://docs.oracle.com/en-us/iaas/Content/ContEng/Tasks/contengdownloadkubeconfigfile.htm \ No newline at end of file