[docs] Document local-only config option + patterns

KnVerey commented 1 year ago

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

k8s-ci-robot commented 1 year ago

@KnVerey: The label(s) kind/docs cannot be applied, because the repository doesn't have them.

In response to [this](https://github.com/kubernetes-sigs/kustomize/issues/4902): >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](https://github.com/kubernetes-sigs/kustomize/blob/f4e6816338c73a8c6dfec0d59ff7b75203be2a0b/cmd/config/docs/api-conventions/manifest-annotations.md). > >/kind docs >/triage accepted Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.

k8s-triage-robot commented 8 months ago

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 commented 6 months ago

/triage accepted /help

k8s-ci-robot commented 6 months ago

@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](https://github.com/kubernetes-sigs/kustomize/issues/4902): >/triage accepted >/help Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.

webwurst commented 6 months ago

This is also mentioned under well-known annotations in the official Kubernetes documentation: config.kubernetes.io/local-config

kubernetes-sigs / kustomize

[docs] Document local-only config option + patterns #4902

Guidelines