diff --git a/docs/admin/clusters/deploy-cluster.md b/docs/admin/clusters/deploy-cluster.md index d70910785..ebb47cac2 100644 --- a/docs/admin/clusters/deploy-cluster.md +++ b/docs/admin/clusters/deploy-cluster.md @@ -26,7 +26,7 @@ Follow these steps to deploy a standalone Kubernetes cluster tailored to your sp Start by creating a `Credential` object that includes all required authentication details for your chosen infrastructure provider. Follow the instructions in the [chapter about credential management](../access/credentials/index.md), as well as the specific instructions for your [target infrastructure](../installation/prepare-mgmt-cluster/index.md). - > TIP: + > TIP: > Double-check to make sure that your credentials have sufficient permissions to create resources on the target infrastructure. 2. Select a Template @@ -77,6 +77,9 @@ Follow these steps to deploy a standalone Kubernetes cluster tailored to your sp Create a `ClusterDeployment` configuration in a YAML file, following this structure: + > WARNING: + > Cluster names must not exceed **40** characters. + ```yaml apiVersion: k0rdent.mirantis.com/v1beta1 kind: ClusterDeployment @@ -143,7 +146,7 @@ Follow these steps to deploy a standalone Kubernetes cluster tailored to your sp kubectl -n get cluster -o=yaml ``` - > TIP: + > TIP: > For a detailed view of the provisioning process, use the `clusterctl describe` command (note that this requires the [`clusterctl`](https://github.com/kubernetes-sigs/cluster-api/releases) CLI): ```shell @@ -157,6 +160,10 @@ Follow these steps to deploy a standalone Kubernetes cluster tailored to your sp ```shell kubectl get secret -n -kubeconfig -o=jsonpath={.data.value} | base64 -d > kubeconfig ``` +<<<<<<< HEAD +======= + +>>>>>>> 7b008d21 (fix: add a note regarding cluster name length) You can then use this file to access the cluster, as in: ```shell diff --git a/docs/admin/hosted-control-plane/index.md b/docs/admin/hosted-control-plane/index.md index 5559b6ad8..4092aa892 100644 --- a/docs/admin/hosted-control-plane/index.md +++ b/docs/admin/hosted-control-plane/index.md @@ -12,8 +12,8 @@ fully used. For either of these cases, a better choice may be a "hosted control plane". -A hosted control plane is a Kubernetes setup in which the control plane components (such as the API server, -etcd, and controllers) run as pods inside the management cluster instead of separate controller nodes. This +A hosted control plane is a Kubernetes setup in which the control plane components (such as the API server, +etcd, and controllers) run as pods inside the management cluster instead of separate controller nodes. This architecture centralizes control plane management and improves scalability by sharing resources in the management cluster. Need more controllers? Spin up another pod. Need fewer controllers? Remove some pods. @@ -31,3 +31,8 @@ Instructions for setting up a hosted control plane vary slighting depending on t - [OpenStack](hcp-openstack.md) - [VMware](hcp-vmware.md) - [GCP](hcp-gcp.md) + +**Important note:** while creating hosted control plane cluster please choose +the cluster names shorter that **40** characters long. Otherwise you may face +issues with resources creation due to [RFC-1035](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#rfc-1035-label-names) +label length limits. \ No newline at end of file