Skip to content

Commit

Permalink
Updates custom plugin documentation for clarity (#963)
Browse files Browse the repository at this point in the history
This PR adds clarifying documentation to Setting up custom plugins, defining details that are necessary for successful installation.

* Updates custom plugin documentation for clarity

* apply review suggestion

Co-authored-by: Michał Flendrich <[email protected]>
Co-authored-by: Michał Flendrich <[email protected]>
  • Loading branch information
3 people authored Nov 30, 2020
1 parent 62f024e commit 812fd69
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/guides/setting-up-custom-plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,5 +198,12 @@ Kong on when to execute the plugin:
konghq.com/plugins: my-custom-plugin
```
Please ensure that the `KongPlugin` custom resource is created in the same namespace
as the one in which the Ingress or Service to be annotated is going to be installed.
Note that any environmental variables that your plugin requires should be added to
the `config` section `header_value`. If no environmental variables are used, this
section can be omitted from the `KongPlugin` resource.
Once you have got Kong up and running, configure your
custom plugin via [KongPlugin resource](using-kongplugin-resource.md).

0 comments on commit 812fd69

Please sign in to comment.