Skip to content

Commit 274de81

Browse files
authored
📖 Clarify plugin executable locations (#3643)
Clarify plugin executable locations This was confusing to me, so I tried to make it less confusing. See https://kubernetes.slack.com/archives/CAR30FCJZ/p1695820734815719
1 parent e9459d6 commit 274de81

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

docs/book/src/plugins/external-plugins.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,11 +84,17 @@ If you need to include logs or debug messages while developing your plugin, cons
8484
This can be done by setting the `${EXTERNAL_PLUGINS_PATH}` environment variable, or by placing the plugin in a path that follows a `group-like name and version` scheme:
8585
```sh
8686
# for Linux
87-
$HOME/.config/kubebuilder/plugins/${name}/${version}
87+
$HOME/.config/kubebuilder/plugins/${name}/${version}/${name}
8888

8989
# for OSX
90-
~/Library/Application Support/kubebuilder/plugins/${name}/${version}
90+
~/Library/Application Support/kubebuilder/plugins/${name}/${version}/${name}
9191
```
92+
As an example, if you're on Linux and you want to use `v2` of an external plugin called `foo.acme.io`, you'd place the executable in the folder `$HOME/.config/kubebuilder/plugins/foo.acme.io/v2/` with a file name that also matches the plugin name up to an (optional) file extension.
93+
In other words, passing the flag `--plugins=foo.acme.io/v2` to `kubebuilder` would find the plugin at either of these locations
94+
* `$HOME/.config/kubebuilder/plugins/foo.acme.io/v2/foo.acme.io`
95+
* `$HOME/.config/kubebuilder/plugins/foo.acme.io/v2/foo.acme.io.sh`
96+
* `$HOME/.config/kubebuilder/plugins/foo.acme.io/v2/foo.acme.io.py`
97+
* etc...
9298

9399
### Subcommands:
94100

0 commit comments

Comments
 (0)