docs: Clarify the Kustomize components relative paths requirement #861
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hiddeco
reviewed
May 12, 2023
stefanprodan
changed the title
Add clarification on how to handle component(s) paths. Signed-off-by: Daniel Loader <hello@danielloader.uk>
stefanprodan
approved these changes
May 12, 2023
seh
reviewed
May 12, 2023
| ``` | ||
|
|
||
| **Note:** The component paths must be local and relative to the source root. | ||
| **Note:** The components paths must be local and relative to the path specified by `.spec.path`. |
There was a problem hiding this comment.
What does "local" mean here? Is that an antonym to "remote"?
There was a problem hiding this comment.
Yes, we disallow remote component bases.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
WARNING: Since components are alpha level in kustomize this may be removed at any time.
Add clarification on how to handle component paths
Currently the advice is that the components are relative to the source root path and after some investigation I've found they're relative to the
.spec.pathwhich itself is an absolute reference to the source root.Updated the documentation to match.