doc: add documentation on naming functions in a Kptfile #4010
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR documents/clarifies that using
name
on functions in aKptfile
is important when updating packages withkpt pkg update
. The issue was discussed in Slack here: https://kubernetes.slack.com/archives/C0155NSPJSZ/p1689926397556699The
name
field was not mentioned in the current version of the book, and since function lists are merged as associative lists, the effect of not specifying aname
may result in unpredictable ordering of the function lists.Specifically, the PR updates section 4.1 of the kpt book on "Declarative Function Execution"
A few considerations for reviewers:
image
. This PR does not describe this situation since there are multiple requirements for this to be possible. Also, I'm suspecting that this functionality may no longer be active since the example shown in the Slack thread should have merged the updated function list if it had usedimage
as identifier.