docs(plugin): document KUSTOMIZE_PLUGIN_HOME and plugin-home resolution#6127
docs(plugin): document KUSTOMIZE_PLUGIN_HOME and plugin-home resolution#6127alliasgher wants to merge 1 commit intokubernetes-sigs:masterfrom
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: alliasgher The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
Welcome @alliasgher! |
|
Hi @alliasgher. 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 Regular contributors should join the org to skip this step. Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. DetailsInstructions 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. |
Add a "Plugin home" section to plugin/README.md describing the order in which kustomize resolves the plugin home directory: 1. $KUSTOMIZE_PLUGIN_HOME 2. $XDG_CONFIG_HOME/kustomize/plugin 3. $HOME/.config/kustomize/plugin 4. $HOME/kustomize/plugin Also note the Windows $USERPROFILE fallback and the relative path layout used when loading an individual plugin. Content is taken directly from api/konfig/plugins.go and api/internal/plugins/loader. Signed-off-by: Ali <alliasgher123@gmail.com>
a20caf6 to
dc29d4b
Compare
Summary
Adds a "Plugin home" section to `plugin/README.md` describing the directory kustomize uses to look up Exec and Go plugins.
The section documents the four-step resolution order kustomize applies to find the plugin home:
It also notes the Windows `$USERPROFILE` fallback for `$HOME` and the relative layout kustomize uses to load an individual plugin (`///`).
Content comes directly from `api/konfig/plugins.go` and `api/internal/plugins/loader/loader.go`.
Fixes #5706.
/kind documentation