From 0e5130901971339869cced10a77f850f60cd33fa Mon Sep 17 00:00:00 2001 From: Aleksei Sizov Date: Mon, 30 Mar 2026 11:57:19 -0600 Subject: [PATCH] fix: add a note regarding cluster name length (cherry picked from commit 7b008d21962ff3d229466e4fae5db3767dccf373) --- docs/admin/clusters/deploy-cluster.md | 8 +++++++- docs/admin/hosted-control-plane/index.md | 9 +++++++-- 2 files changed, 14 insertions(+), 3 deletions(-) diff --git a/docs/admin/clusters/deploy-cluster.md b/docs/admin/clusters/deploy-cluster.md index 7a161bbcf..496deaecf 100644 --- a/docs/admin/clusters/deploy-cluster.md +++ b/docs/admin/clusters/deploy-cluster.md @@ -27,6 +27,9 @@ 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: + > Double-check to make sure that your credentials have sufficient permissions to create resources on the target infrastructure. + > NOTE: > A `Credential` may optionally specify the `spec.region` field. When set, all `ClusterDeployment` objects that reference > this `Credential` will be deployed to the corresponding regional cluster. @@ -88,6 +91,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 @@ -168,7 +174,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): ```bash 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