Open randomvariable opened 2 years ago
@randomvariable: The label(s) kind/docs
cannot be applied, because the repository doesn't have them.
Should add I'm happy to make the docs change.
Does anyone have any other examples of stuff that should be documented?
/assign
/kind documentation /triage accepted
The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.
This bot triages issues and PRs according to the following rules:
lifecycle/stale
is appliedlifecycle/stale
was applied, lifecycle/rotten
is appliedlifecycle/rotten
was applied, the issue is closedYou can:
/remove-lifecycle stale
/lifecycle rotten
/close
Please send feedback to sig-contributor-experience at kubernetes/community.
/lifecycle stale
in CAPI we can give some general guidelines, but documentation for each infrastructure should be implemented in each provider.
if we want to fix this properly, one possible approach is to implement additional validation webhooks for CAPI resources in providers, but this seems out of scope of the current request so eventually this + follow up discussions should be moved to a separated issue
/lifecycle frozen /unassign @randomvariable /help
@fabriziopandini: This request has been marked as needing help from a contributor.
Please ensure that the issue body includes answers to the following questions:
For more details on the requirements of such an issue, please see here and ensure that they are met.
If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-help
command.
This issue has not been updated in over 1 year, and should be re-triaged.
You can:
/triage accepted
(org members only)/close
For more details on the triage process, see https://www.kubernetes.dev/docs/guide/issue-triage/
/remove-triage accepted
/priority backlog
/triage accepted
Having guidelines like this will be super valuable for the entire Cluster API community.
We should also consider discussing a guideline about how which "root" use to compute infrastructure names (e.g machine or infrastructure machines, see e.g. the issue in https://github.com/kubernetes-sigs/cluster-api/issues/10463)
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
Example forms of breakage
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:
[Miscellaneous information that will assist in solving the issue.]
/kind docs