Adding custom plugins in Konnect
You can manage schemas for custom plugins via the Konnect UI or
the Konnect Control Planes Config API.
After uploading a schema to Konnect, upload your
custom plugin to each data plane node, then Konnect can manage the
configuration for your plugin like any other Kong entity.
If you need to update a schema for a plugin that was already uploaded
to Konnect, there are a few considerations based on the type
See Editing or deleting a custom plugin’s schema
for more information.
Your custom plugin meets Konnect’s requirements
The schema file must be in Lua, even if the custom plugin is written in another supported language.
For help with developing plugins, see the plugin development resources.
If you have a custom plugin written in a language other than Lua, convert the schema
schema.lua file before uploading it to Konnect.
When using the
/plugin-schemas API, authenticate your requests with either a personal access token or a system account token by including it in the authentication header:
--header 'Authorization: Bearer kpat_xgfT'
Add a custom plugin to a control plane
Konnect only requires the custom plugin’s
Using that file, it creates a plugin entry in the plugin catalog for your control plane.
Upload a custom plugin schema to create a configurable entity in Konnect:
Uploading a custom plugin schema adds the plugin to a specific control plane.
If you need it to be available in multiple control planes, add the schema individually to each one.
Upload files to data plane nodes
After uploading a schema to Konnect,
handler.lua for your plugin to each
Kong Gateway data plane node.
If a data plane node doesn’t have these files, the plugin won’t be able to run on that node.
Konnect does not support plugins with
You can now configure this custom plugin like any other plugin in Konnect.
Caution: Carefully test the operation of any custom plugins before using them in production. Kong is not responsible for the operation or support of any
custom plugins, including any performance impacts on your Konnect
or Kong Gateway deployments.