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.

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

feat(replacements): add IgnoreMissingField option #5778

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

bt-macole
Copy link

@bt-macole bt-macole commented Oct 3, 2024

This change adds a field option to replacements for IgnoreMissingField that will find/replace all matching fields and ignore resources that match the target but do not have the field instead of throwing an error.

Context:

When using replacements as a reusable component across multiple manifests, especially in environmental overlays, a common pattern emerges. For example, certain elements like an accountId in an IRSA role annotation on a ServiceAccount often need to be replaced.

In cases where you have many ServiceAccount resources—such as N applications with M workloads and M ServiceAccounts—only X of those ServiceAccounts may require the annotation replacement, while others do not.

This approach ensures flexibility, allowing replacements to be applied only where needed, without enforcing unnecessary changes across all resources.

resolves #5777

Copy link

linux-foundation-easycla bot commented Oct 3, 2024

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: bt-macole / name: Mason Cole (6ed2bbf)

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Oct 3, 2024
@k8s-ci-robot
Copy link
Contributor

Welcome @bt-macole!

It looks like this is your first PR to kubernetes-sigs/kustomize 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/kustomize has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot
Copy link
Contributor

Hi @bt-macole. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Oct 3, 2024
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: bt-macole
Once this PR has been reviewed and has the lgtm label, please assign knverey for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Oct 3, 2024
@bt-macole bt-macole force-pushed the replacements-ignoremissingfield branch 3 times, most recently from c05c6a9 to deb08ff Compare October 4, 2024 14:44
@bt-macole bt-macole force-pushed the replacements-ignoremissingfield branch from deb08ff to 6ed2bbf Compare October 4, 2024 15:09
@bt-macole
Copy link
Author

@varshaprasad96 hihi, reaching out based on the recommendation in the above comment. any chance I could get a review on this? all feedback is greatly appreciated--thanks 🙏😊

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Replacements IgnoreMissingField
2 participants