kubernetes-sigs / kubernetes-sigs/cluster-api

Add guidance on infrastructure resource names to provider implementation guides

Open
#7,030 10 comments 1 reaction 0 assignees View on GitHub
help wanted kind/documentation priority/backlog triage/accepted
Dominant language
Go
Stars
4.3k
Forks
1.6k
Avg merge
1d 3h
Merged PRs (30d)
113

Description

**User Story**

As a user, on some infrastructures when I go to deploy a cluster with names like the following, I experience some form of breakage:

### Example names

* default/longnamemorethansixtythreecharacterslong
* default/names.using.dots.in.them
* same cluster name, but in a different namespace ( default/cluster1 businessunit1/cluster1)

### Example forms of breakage

* The cluster infrastructure doesn't come up
* The VM doesn't come up
* The VM does come up but doesn't complete bootstrap, and there's complaints from cloud-init about the hostname.

**Detailed Description**

Provider contracts in https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/book/src/developer/providers/machine-infrastructure.md and https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/book/src/developer/providers/cluster-infrastructure.md should include guidance on how to implement the provider to accept all valid Kubernetes resource names, including techniques like conditional hashing (https://github.com/kubernetes-sigs/cluster-api-provider-aws/pull/1290).

And then after we do that, we should probably circulate this amongst provider implementers so they can check they're not affected, and maybe add appropriate E2Es according to the constraints of their infrastructure provider.

**Anything else you would like to add:**

A bunch of related issues:

* https://github.com/kubernetes-sigs/cluster-api/issues/2217
* https://github.com/kubernetes-sigs/cluster-api/issues/1554
* https://github.com/kubernetes-sigs/cluster-api-provider-aws/issues/2704
* https://github.com/kubernetes-sigs/cluster-api-provider-aws/issues/969
* https://github.com/kubernetes-sigs/cluster-api-provider-azure/issues/2330

[Miscellaneous information that will assist in solving the issue.]

/kind docs

Contributor guide

Open the contributing guide

Research direction

Start with docs/book/src/developer/providers/machine-infrastructure.md and docs/book/src/developer/providers/cluster-infrastructure.md, then review the linked conditional-hashing pull request and related issues. Add provider guidance covering valid Kubernetes resource names and document the relevant infrastructure constraints; the work is done when both contracts clearly address these cases.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, infrastructure
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.