kubernetes-sigs
[docs] Document local-only config option + patterns
We should add docs for the config.kubernetes.io/local-config annotation and why you might want to use it, e.g.:
- as a source of data for a Replacement
- as an anchor for identifying and updating a name that occurs across multiple objects (but is not the metadata.name of any of them), demonstrated in the test in https://github.com/kubernetes-sigs/kustomize/pull/4895
- as a source of shared configuration for multiple KRM Functions
AFAICT it is currently only mentioned in the in-repo docs for KRM Function authors.
/kind docs /triage accepted
@KnVerey: The label(s) kind/docs cannot be applied, because the repository doesn't have them.
In response to this:
We should add docs for the
config.kubernetes.io/local-configannotation and why you might want to use it, e.g.:
- as a source of data for a Replacement
- as an anchor for identifying and updating a name that occurs across multiple objects (but is not the metadata.name of any of them), demonstrated in the test in https://github.com/kubernetes-sigs/kustomize/pull/4895
- as a source of shared configuration for multiple KRM Functions
AFAICT it is currently only mentioned in the in-repo docs for KRM Function authors.
/kind docs /triage accepted
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.
This issue has not been updated in over 1 year, and should be re-triaged.
You can:
- Confirm that this issue is still relevant with
/triage accepted(org members only) - Close this issue with
/close
For more details on the triage process, see https://www.kubernetes.dev/docs/guide/issue-triage/
/remove-triage accepted
@koba1t: This request has been marked as needing help from a contributor.
Guidelines
Please ensure that the issue body includes answers to the following questions:
- Why are we solving this issue?
- To address this issue, are there any code changes? If there are code changes, what needs to be done in the code and what places can the assignee treat as reference points?
- Does this issue have zero to low barrier of entry?
- How can the assignee reach out to you for help?
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.
In response to this:
/triage accepted /help
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.
This is also mentioned under well-known annotations in the official Kubernetes documentation: config.kubernetes.io/local-config
