This repository is the place for curated contributions for the Knative client, especially Knative plugins
All plugins are stored below the plugins/
directory. Currently, you can find the following plugins there:
kn-hello is a "Hello World" plugin which also serves as a blueprint for new plugins. It contains the pieces that a mandatory for any new (golang based) plugin.
I.e. it demonstrates:
build.sh
which can easily be customizedkn-admin helps in configuring a Knative installation on Kubernetes.
kn-migration helps in migrating the Knative services from source cluster to destination cluster.
list of plugins to be continued ...
First of all, thank you for considering to contribute a kn
plugin. That's so awesome, and we love contributions!
Before you start to craft a pull request, please consider to perform the following step:
plugins/hello
to a new directory with your plugins short name (i.e. the command name), also below plugins/
. E.g. plugins/awesome
if you are about to create a kn-awesome
plugin enriching kn with a kn awesome
command.pkg/
and cmd/
directories, similar to the existing code.hack/build.sh
to reflect your plugins settings.README.md
which is supposed to serve as full documentation for your plugin. See the example section given there and replace it with the content for your plugin. Especially reference documentation is required as well as an example section.OWNERS
file to fill in the maintainers of your plugin, but also leave the existing folks in that file (as a fallback)Please note that all plugins in this repository share the same release cycle and release cadence, which is currently six weeks together with the Knative client release.