Skip to content

Commit c93739b

Browse files
DOCSP-35411 -- Add K8s cluster naming convention callout (#1649)
* DOCSP-35411 -- Add K8s cluster naming convention callout * DOCSP-35411 -- copy review revisions * DOCSP-35411 -- copy review revisions * DOCSP-35411 -- copy review revisions
1 parent 41c38c2 commit c93739b

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

source/tutorial/plan-k8s-op-compatibility.txt

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,19 @@ spans the full release series starting from the listed version.
3232

3333
.. include:: /includes/list-tables/compatibility-k8s-os.rst
3434

35+
.. _k8s-naming-conventions:
36+
37+
Supported |k8s| Cluster Naming Conventions
38+
------------------------------------------
39+
40+
The |k8s-op-short| supports only |k8s| cluster names that consist of
41+
alphanumeric characters, dashes, underscores, and periods.
42+
43+
If your cluster name contains unsupported characters, you must `rename your cluster <https://kubernetes.io/docs/reference/kubectl/generated/kubectl_config/kubectl_config_rename-context/>`__
44+
to a supported name. For example, if you are deploying the |k8s-op-short| in an |aws|
45+
`EKS <https://docs.aws.amazon.com/eks/latest/userguide/clusters.html>`__ cluster, you must rename the
46+
cluster as the default name contains unsupported characters.
47+
3548
.. _k8s-cncf-compatibility:
3649

3750
Other Distributions of |k8s|

0 commit comments

Comments
 (0)