Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

kustomize create should add config.kubernetes.io/local-config annotation #5746

Open
1 of 2 tasks
ringerc opened this issue Aug 11, 2024 · 1 comment · May be fixed by #5798
Open
1 of 2 tasks

kustomize create should add config.kubernetes.io/local-config annotation #5746

ringerc opened this issue Aug 11, 2024 · 1 comment · May be fixed by #5798
Labels
kind/feature Categorizes issue or PR as related to a new feature. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@ringerc
Copy link

ringerc commented Aug 11, 2024

Eschewed features

  • This issue is not requesting templating, unstuctured edits, build-time side-effects from args or env vars, or any other eschewed feature.

What would you like to have added?

The kustomize docs recommend that kustomization.yaml (and things like transformer configs) should have

metadata:
  annotations:
    config.kubernetes.io/local-config: "true"

but kustomize create does not add this itself.

Why is this needed?

see kustomize help docs-io-annotations

Can you accomplish the motivating task without this feature, and if so, how?

Yes, just patch the created resource with yq, or generate the kustomization manually.

What other solutions have you considered?

Not adding it, it's not (yet) vital

Anything else we should know?

No response

Feature ownership

  • I am interested in contributing this feature myself! 🎉
@ringerc ringerc added the kind/feature Categorizes issue or PR as related to a new feature. label Aug 11, 2024
@k8s-ci-robot k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Aug 11, 2024
bt-macole added a commit to bt-macole/kustomize that referenced this issue Nov 8, 2024
@bt-macole
feat(cmd): add local-config annotation on create
7c0036b 
this adds a DefaultMetadata object in konfig that can be used
when creating a new kustomization yaml that conforms with the
best practice recommendations in the kustomize docs.

> The `Kustomization` config in a `kustomization.yaml`
> **SHOULD** contain this annotation so that tools know it is not intended to be sent to
> the Kubernetes api server.

resolves: kubernetes-sigs#5746
bt-macole added a commit to bt-macole/kustomize that referenced this issue Nov 8, 2024
@bt-macole
feat(cmd): add local-config annotation on create
2b00eaf 
this adds a DefaultMetadata object in konfig that can be used
when creating a new kustomization yaml that conforms with the
best practice recommendations in the kustomize docs.

> The `Kustomization` config in a `kustomization.yaml`
> **SHOULD** contain this annotation so that tools know it is not intended to be sent to
> the Kubernetes api server.

resolves: kubernetes-sigs#5746
bt-macole added a commit to bt-macole/kustomize that referenced this issue Nov 8, 2024
@bt-macole
feat(cmd): add local-config annotation on create
15c6b9b 
this adds a DefaultMetadata object in konfig that can be used
when creating a new kustomization yaml that conforms with the
best practice recommendations in the kustomize docs.

> The `Kustomization` config in a `kustomization.yaml`
> **SHOULD** contain this annotation so that tools know it is not intended to be sent to
> the Kubernetes api server.

resolves: kubernetes-sigs#5746
@bt-macole bt-macole linked a pull request Nov 8, 2024 that will close this issue
Open
@stormqueen1990
Copy link
Member

/triage accepted

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Nov 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
kind/feature Categorizes issue or PR as related to a new feature. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat(cmd): add local-config annotation on create bt-macole/kustomize
3 participants
@ringerc @stormqueen1990 @k8s-ci-robot