From 5ceb45f6a5ba3b0606041a97f0e8a5f06df3e6b3 Mon Sep 17 00:00:00 2001 From: Sunil Singh Date: Fri, 5 Jan 2024 11:01:50 -0800 Subject: [PATCH 1/4] Updating the vSphere and OpenStack cloud provider pages with more information on the rancher_kubernetes_engine_config and where to update the cluster config YAML file. Signed-off-by: Sunil Singh --- docs/config-options/cloud-providers/openstack/openstack.md | 2 +- docs/config-options/cloud-providers/vsphere/vsphere.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/config-options/cloud-providers/openstack/openstack.md b/docs/config-options/cloud-providers/openstack/openstack.md index e22d496..0f15ae5 100644 --- a/docs/config-options/cloud-providers/openstack/openstack.md +++ b/docs/config-options/cloud-providers/openstack/openstack.md @@ -2,7 +2,7 @@ title: OpenStack Cloud Provider --- -To enable the OpenStack cloud provider, besides setting the name as `openstack`, there are specific configuration options that must be set. The OpenStack configuration options are grouped into different sections. +To enable the OpenStack cloud provider, besides setting the name as `openstack`, there are specific configuration options that must be set as defined below. The OpenStack configuration options are grouped into different sections and they must be nested under the `rancher_kubernetes_engine_config` directive in the cluster config YAML file. For more information on the configuration file structure please see the [Rancher RKE Cluster Configuration Reference](https://ranchermanager.docs.rancher.com/reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration#config-file-structure-in-rancher). ```yaml cloud_provider: diff --git a/docs/config-options/cloud-providers/vsphere/vsphere.md b/docs/config-options/cloud-providers/vsphere/vsphere.md index 86c8b03..8bcb1cd 100644 --- a/docs/config-options/cloud-providers/vsphere/vsphere.md +++ b/docs/config-options/cloud-providers/vsphere/vsphere.md @@ -6,7 +6,7 @@ This section describes how to enable the vSphere cloud provider. You will need t The [vSphere Cloud Provider](https://vmware.github.io/vsphere-storage-for-kubernetes/documentation/) interacts with VMware infrastructure (vCenter or standalone ESXi server) to provision and manage storage for persistent volumes in a Kubernetes cluster. -When provisioning Kubernetes using RKE CLI or using [RKE clusters](https://ranchermanager.docs.rancher.com/pages-for-subheaders/launch-kubernetes-with-rancher) in Rancher, the vSphere Cloud Provider can be enabled by configuring the `cloud_provider` directive in the cluster YAML file. +When provisioning Kubernetes using RKE CLI or using [RKE clusters](https://ranchermanager.docs.rancher.com/pages-for-subheaders/launch-kubernetes-with-rancher) in Rancher, the vSphere Cloud Provider can be enabled by configuring the `cloud_provider` directive nested under the `rancher_kubernetes_engine_config` directive in the cluster config YAML file. For more information on the configuration file structure please see the [Rancher RKE Cluster Configuration Reference](https://ranchermanager.docs.rancher.com/reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration#config-file-structure-in-rancher). ### Related Links From 7421d0f131fabf9d0fe7111b7954f4bb03e80b80 Mon Sep 17 00:00:00 2001 From: Sunil Singh Date: Mon, 8 Jan 2024 08:15:05 -0800 Subject: [PATCH 2/4] Update docs/config-options/cloud-providers/openstack/openstack.md Co-authored-by: Lucas Saintarbor --- docs/config-options/cloud-providers/openstack/openstack.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/config-options/cloud-providers/openstack/openstack.md b/docs/config-options/cloud-providers/openstack/openstack.md index 0f15ae5..5506a05 100644 --- a/docs/config-options/cloud-providers/openstack/openstack.md +++ b/docs/config-options/cloud-providers/openstack/openstack.md @@ -2,7 +2,7 @@ title: OpenStack Cloud Provider --- -To enable the OpenStack cloud provider, besides setting the name as `openstack`, there are specific configuration options that must be set as defined below. The OpenStack configuration options are grouped into different sections and they must be nested under the `rancher_kubernetes_engine_config` directive in the cluster config YAML file. For more information on the configuration file structure please see the [Rancher RKE Cluster Configuration Reference](https://ranchermanager.docs.rancher.com/reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration#config-file-structure-in-rancher). +To enable the OpenStack cloud provider, besides setting the name as `openstack`, specific configuration options must be set as defined below. The OpenStack configuration options are grouped into different sections and they must be nested under the `rancher_kubernetes_engine_config` directive in the cluster config YAML file. For more information on the configuration file structure, please see the [Rancher RKE Cluster Configuration Reference](https://ranchermanager.docs.rancher.com/reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration#config-file-structure-in-rancher). ```yaml cloud_provider: From 7b5e0de772db9e1fbb14955cb5d127ed9fb8dea0 Mon Sep 17 00:00:00 2001 From: Sunil Singh Date: Mon, 8 Jan 2024 08:15:13 -0800 Subject: [PATCH 3/4] Update docs/config-options/cloud-providers/vsphere/vsphere.md Co-authored-by: Lucas Saintarbor --- docs/config-options/cloud-providers/vsphere/vsphere.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/config-options/cloud-providers/vsphere/vsphere.md b/docs/config-options/cloud-providers/vsphere/vsphere.md index 8bcb1cd..fe76724 100644 --- a/docs/config-options/cloud-providers/vsphere/vsphere.md +++ b/docs/config-options/cloud-providers/vsphere/vsphere.md @@ -6,7 +6,7 @@ This section describes how to enable the vSphere cloud provider. You will need t The [vSphere Cloud Provider](https://vmware.github.io/vsphere-storage-for-kubernetes/documentation/) interacts with VMware infrastructure (vCenter or standalone ESXi server) to provision and manage storage for persistent volumes in a Kubernetes cluster. -When provisioning Kubernetes using RKE CLI or using [RKE clusters](https://ranchermanager.docs.rancher.com/pages-for-subheaders/launch-kubernetes-with-rancher) in Rancher, the vSphere Cloud Provider can be enabled by configuring the `cloud_provider` directive nested under the `rancher_kubernetes_engine_config` directive in the cluster config YAML file. For more information on the configuration file structure please see the [Rancher RKE Cluster Configuration Reference](https://ranchermanager.docs.rancher.com/reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration#config-file-structure-in-rancher). +When provisioning Kubernetes using RKE CLI or using [RKE clusters](https://ranchermanager.docs.rancher.com/pages-for-subheaders/launch-kubernetes-with-rancher) in Rancher, the vSphere Cloud Provider can be enabled by configuring the `cloud_provider` directive nested under the `rancher_kubernetes_engine_config` directive in the cluster config YAML file. For more information on the configuration file structure, please see the [Rancher RKE Cluster Configuration Reference](https://ranchermanager.docs.rancher.com/reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration#config-file-structure-in-rancher). ### Related Links From 918ca6a6008793db7a437bdca8dc4faf588153ed Mon Sep 17 00:00:00 2001 From: Sunil Singh Date: Tue, 9 Jan 2024 15:16:01 -0800 Subject: [PATCH 4/4] Updating the OpenStack and vSphere pages after review. Revised the vSphere page layout for better readability as well. Signed-off-by: Sunil Singh --- .../cloud-providers/openstack/openstack.md | 4 +++- .../cloud-providers/vsphere/vsphere.md | 24 ++++++++++--------- 2 files changed, 16 insertions(+), 12 deletions(-) diff --git a/docs/config-options/cloud-providers/openstack/openstack.md b/docs/config-options/cloud-providers/openstack/openstack.md index 5506a05..495cc82 100644 --- a/docs/config-options/cloud-providers/openstack/openstack.md +++ b/docs/config-options/cloud-providers/openstack/openstack.md @@ -2,7 +2,7 @@ title: OpenStack Cloud Provider --- -To enable the OpenStack cloud provider, besides setting the name as `openstack`, specific configuration options must be set as defined below. The OpenStack configuration options are grouped into different sections and they must be nested under the `rancher_kubernetes_engine_config` directive in the cluster config YAML file. For more information on the configuration file structure, please see the [Rancher RKE Cluster Configuration Reference](https://ranchermanager.docs.rancher.com/reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration#config-file-structure-in-rancher). +To enable the OpenStack cloud provider, besides setting the name as `openstack`, there are specific configuration options that must be set. The OpenStack configuration options are grouped into different sections provided in an example below. ```yaml cloud_provider: @@ -24,6 +24,8 @@ cloud_provider: search-order: xxxxxxxxxxxxxx ``` +If you are enabling the OpenStack cloud provider in Rancher the configurations must be nested under the `rancher_kubernetes_engine_config` directive in the cluster config YAML file. See here for more information on the [Rancher configuration file structure](https://ranchermanager.docs.rancher.com/reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration#config-file-structure-in-rancher). + ## Overriding the hostname The OpenStack cloud provider uses the instance name (as determined from OpenStack metadata) as the name of the Kubernetes Node object, you must override the Kubernetes name on the node by setting the `hostname_override` for each node. If you do not set the `hostname_override`, the Kubernetes node name will be set as the `address`, which will cause the OpenStack cloud provider to fail. diff --git a/docs/config-options/cloud-providers/vsphere/vsphere.md b/docs/config-options/cloud-providers/vsphere/vsphere.md index fe76724..83be926 100644 --- a/docs/config-options/cloud-providers/vsphere/vsphere.md +++ b/docs/config-options/cloud-providers/vsphere/vsphere.md @@ -2,19 +2,10 @@ title: vSphere Cloud Provider --- -This section describes how to enable the vSphere cloud provider. You will need to use the `cloud_provider` directive in the cluster YAML file. +This section describes how to enable the vSphere cloud provider. You will need to use the `cloud_provider` directive in the cluster YAML file. For more details on configuring the file structure refer to the [configuration reference](./config-reference/config-reference.md). The [vSphere Cloud Provider](https://vmware.github.io/vsphere-storage-for-kubernetes/documentation/) interacts with VMware infrastructure (vCenter or standalone ESXi server) to provision and manage storage for persistent volumes in a Kubernetes cluster. -When provisioning Kubernetes using RKE CLI or using [RKE clusters](https://ranchermanager.docs.rancher.com/pages-for-subheaders/launch-kubernetes-with-rancher) in Rancher, the vSphere Cloud Provider can be enabled by configuring the `cloud_provider` directive nested under the `rancher_kubernetes_engine_config` directive in the cluster config YAML file. For more information on the configuration file structure, please see the [Rancher RKE Cluster Configuration Reference](https://ranchermanager.docs.rancher.com/reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration#config-file-structure-in-rancher). - -### Related Links - -- **Configuration:** For details on vSphere configuration in RKE, refer to the [configuration reference.](./config-reference/config-reference.md) -- **Troubleshooting:** For guidance on troubleshooting a cluster with the vSphere cloud provider enabled, refer to the [troubleshooting section.](./troubleshooting/troubleshooting.md) -- **Storage:** If you are setting up storage, see the [official vSphere documentation on storage for Kubernetes,](https://vmware.github.io/vsphere-storage-for-kubernetes/documentation/) or the [official Kubernetes documentation on persistent volumes.](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) If you are using Rancher, refer to the [Rancher documentation on provisioning storage in vSphere.](https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/manage-clusters/provisioning-storage-examples/vsphere-storage#docusaurus_skipToContent_fallback) -- **For Rancher users:** Refer to the Rancher documentation on [creating vSphere Kubernetes clusters](https://ranchermanager.docs.rancher.com/pages-for-subheaders/vsphere) and [provisioning storage.](https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/manage-clusters/provisioning-storage-examples/vsphere-storage#docusaurus_skipToContent_fallback) - ## Prerequisites - **Credentials:** You'll need to have credentials of a vCenter/ESXi user account with privileges allowing the cloud provider to interact with the vSphere infrastructure to provision storage. Refer to [this document](https://vmware.github.io/vsphere-storage-for-kubernetes/documentation/vcp-roles.html) to create and assign a role with the required permissions in vCenter. @@ -23,4 +14,15 @@ When provisioning Kubernetes using RKE CLI or using [RKE clusters](https://ranch ## Enabling the vSphere Provider with the RKE CLI -To enable the vSphere Cloud Provider in the cluster, you must add the top-level `cloud_provider` directive to the cluster configuration file, set the `name` property to `vsphere` and add the `vsphereCloudProvider` directive containing the configuration matching your infrastructure. See the [configuration reference](./config-reference/config-reference.md) for the gory details. +To enable the vSphere Cloud Provider in the cluster, you must add the top-level `cloud_provider` directive to the cluster configuration file, set the `name` property to `vsphere` and add the `vsphereCloudProvider` directive containing the configuration matching your infrastructure. See the [configuration reference](./config-reference/config-reference.md) for more details. + +## Enabling the vSphere Provider in Rancher + +When provisioning Kubernetes using [RKE clusters](https://ranchermanager.docs.rancher.com/pages-for-subheaders/launch-kubernetes-with-rancher) in Rancher, the vSphere Cloud Provider can be enabled by configuring the `cloud_provider` directive nested under the `rancher_kubernetes_engine_config` directive in the cluster config YAML file. For more information on the configuration file structure please see the [Rancher RKE Cluster Configuration Reference](https://ranchermanager.docs.rancher.com/reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration#config-file-structure-in-rancher). + +## Related Links + +- **Configuration:** For details on vSphere configuration in RKE, refer to the [configuration reference.](./config-reference/config-reference.md) +- **Troubleshooting:** For guidance on troubleshooting a cluster with the vSphere cloud provider enabled, refer to the [troubleshooting section.](./troubleshooting/troubleshooting.md) +- **Storage:** If you are setting up storage, see the [official vSphere documentation on storage for Kubernetes,](https://vmware.github.io/vsphere-storage-for-kubernetes/documentation/) or the [official Kubernetes documentation on persistent volumes.](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) If you are using Rancher, refer to the [Rancher documentation on provisioning storage in vSphere.](https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/manage-clusters/provisioning-storage-examples/vsphere-storage#docusaurus_skipToContent_fallback) +- **For Rancher users:** Refer to the Rancher documentation on [creating vSphere Kubernetes clusters](https://ranchermanager.docs.rancher.com/pages-for-subheaders/vsphere) and [provisioning storage.](https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/manage-clusters/provisioning-storage-examples/vsphere-storage#docusaurus_skipToContent_fallback)