-
Notifications
You must be signed in to change notification settings - Fork 212
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
doc(kustomize/replacements): add select and reject explanation #360
doc(kustomize/replacements): add select and reject explanation #360
Conversation
Welcome @bugoverdose! |
/hold Adding a hold as we will wait for the next release to merge this |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! Looks good. Small comment to request that we add similar documentation for the select
field.
I know you didn't change select
, but it will be helpful to document that behavior too.
@@ -142,6 +142,29 @@ reject: | |||
- kind: StatefulSet | |||
``` | |||
|
|||
Moreover, when the selected target is going to be transformed during the kustomization process, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Above, somewhere it says:
Replacements will be applied to all targets that are matched by the `select` field and
are NOT matched by the `reject` field, and will be applied to all listed `fieldPaths`.
Could you add another example, after this sentence, similar to the one you added here for reject
, but with a ####Select
header, to show that you can also use select
with a previous or current id?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- It felt kinda random to explain only about the behavior I fixed, so I added a bit more info about the functionality of
select
field in general so that it matchesreject
. - I used
namePrefix
for explainingselect
because I already usednameSuffix
atreject
.
73c130b
to
eee1ce2
Compare
eee1ce2
to
68a0cef
Compare
/lgtm LGTM! The docs go live as soon as the PR is merged, so we can remove the hold during the next kustomize release. Thanks so much for the change |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: bugoverdose, natasha41575 The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
@natasha41575 This PR is not merged yet, but I'm thinking about applying the changes to our new doc. Below is the PR I'm working on right now. |
SGTM. We will almost certainly release your fixes before the new docs site is launched, so feel free to add the changes there. |
The Kubernetes project currently lacks enough contributors to adequately respond to all PRs. This bot triages PRs according to the following rules:
You can:
Please send feedback to sig-contributor-experience at kubernetes/community. /lifecycle stale |
The Kubernetes project currently lacks enough active contributors to adequately respond to all PRs. This bot triages PRs according to the following rules:
You can:
Please send feedback to sig-contributor-experience at kubernetes/community. /lifecycle rotten |
The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs. This bot triages PRs according to the following rules:
You can:
Please send feedback to sig-contributor-experience at kubernetes/community. /close |
@k8s-triage-robot: Closed this PR. In response to this:
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. |
from kubernetes-sigs/kustomize#5263
After fixing a bug regarding the replacements field at kustomize, I'm adding an explanation on the current functionality with a basic example.
cc. @natasha41575