From 812fd69b453c7e61ae6e6609b68f8843dd40c77f Mon Sep 17 00:00:00 2001 From: Anjali Merchant <31166096+anjiemerchant@users.noreply.github.com> Date: Mon, 30 Nov 2020 07:03:32 -0500 Subject: [PATCH] Updates custom plugin documentation for clarity (#963) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 Co-authored-by: Michał Flendrich --- docs/guides/setting-up-custom-plugins.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/guides/setting-up-custom-plugins.md b/docs/guides/setting-up-custom-plugins.md index 6d86fb1b4c..cb8ae517c9 100644 --- a/docs/guides/setting-up-custom-plugins.md +++ b/docs/guides/setting-up-custom-plugins.md @@ -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).