Skip to content

Commit

Permalink
📖 Clarify plugin executable locations (#3643)
Browse files Browse the repository at this point in the history
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
  • Loading branch information
tomasaschan committed Sep 30, 2023
1 parent e9459d6 commit 274de81
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions docs/book/src/plugins/external-plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,11 +84,17 @@ If you need to include logs or debug messages while developing your plugin, cons
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:
```sh
# for Linux
$HOME/.config/kubebuilder/plugins/${name}/${version}
$HOME/.config/kubebuilder/plugins/${name}/${version}/${name}

# for OSX
~/Library/Application Support/kubebuilder/plugins/${name}/${version}
~/Library/Application Support/kubebuilder/plugins/${name}/${version}/${name}
```
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.
In other words, passing the flag `--plugins=foo.acme.io/v2` to `kubebuilder` would find the plugin at either of these locations
* `$HOME/.config/kubebuilder/plugins/foo.acme.io/v2/foo.acme.io`
* `$HOME/.config/kubebuilder/plugins/foo.acme.io/v2/foo.acme.io.sh`
* `$HOME/.config/kubebuilder/plugins/foo.acme.io/v2/foo.acme.io.py`
* etc...

### Subcommands:

Expand Down

0 comments on commit 274de81

Please sign in to comment.