kong-pdk 0.26

Kong PDK for Python and Plugin Server

kong-python-pluginserver

Plugin server and PDK (Plugin Development Kit) for Python language support in Kong.

Requires Kong >= 2.3.0.

Install the plugin server

pip3 install kong-pdk

Usage

usage: kong-pluginserver.py [-h] [-p prefix] [-v] [--version]
                            [--socket-name SOCKET_NAME] [-m | -g] -d directory
                            [--dump-plugin-info name] [--dump-all-plugins]

Kong Python Plugin Server.

optional arguments:
  -h, --help            show this help message and exit
  -p prefix, --kong-prefix prefix, -kong-prefix prefix
                        unix domain socket path to listen
  -v, --verbose         turn on verbose logging
  --version, -version   show program's version number and exit
  --socket-name SOCKET_NAME
                        socket name to listen on
  -m, --multiprocessing
                        enable multiprocessing
  -g, --gevent          enable gevent
  -d directory, --plugins-directory directory, -plugins-directory directory
                        plugins directory
  --dump-plugin-info name, -dump-plugin-info name
                        dump specific plugin info into stdout
  --dump-all-plugins, -dump-all-plugins
                        dump all plugins info into stdout

Configure Kong

Add the following line into kong.conf:

plugins=bundled,py-hello,py-image
pluginserver_names=go, py
pluginserver_py_socket=/usr/local/kong/python_pluginserver.sock
pluginserver_py_start_cmd=/usr/local/bin/kong-python-pluginserver -d /dir/to/kong-python-pdk/examples
pluginserver_py_query_cmd=/usr/local/bin/kong-python-pluginserver -d /dir/to/kong-python-pdk/examples --dump-all-plugins

For example, to test examples, clone kong-python-pdk to /dir/to/kong-python-pdk.

To use seperate instance for each plugin, use:

plugins=bundled,py-hello,py-image
pluginserver_names=go, py-hello, py-image

pluginserver_py_hello_socket=/usr/local/kong/py_hello.sock
pluginserver_py_hello_start_cmd=/dir/to/kong-python-pdk/examples/py-hello.py
pluginserver_py_hello_query_cmd=/dir/to/kong-python-pdk/examples/py-hello.py -d

pluginserver_py_image_socket=/usr/local/kong/py_image.sock
pluginserver_py_image_start_cmd=/dir/to/kong-python-pdk/examples/py-image.py
pluginserver_py_image_query_cmd=/dir/to/kong-python-pdk/examples/py-image.py -d

Enable the plugin

Same step as it's a Lua plugin.

Notes

• All PDK API supported by Go Plugin Server is supported.
• If your plugins are CPU intensive, consider using multiprocessing mode (-m flag) or run the plugin instance in a seperate process (examples/py-hello.py as an example) to distribute workloads to multicore.
• If your plugins are I/O intensive, considering using gevent mode (-g flag) and use gevent libraries in the plugin.

TODO

• Tests
• Hot reload

Unreleased

0.2.6 - 2021-07-19

fix

• listener to use msgpack.Unpacker iterrator bed56c4

0.2.5 - 2021-06-24

fix

• use .py file for type hint (#13) 1bf3820

0.2.4 - 2021-06-17

fix

• check correct flags existence in dedicated server (#10) b18dd45

0.2.3 - 2021-05-13

feat

• add response phase (#4) 3aca283

fix

• display defaults on cli and print PluginServerException to warning 13991ec
• skip running cleanup timer e10c098
• standarlize error on instance not found 0dfc94f

0.2.2 - 2021-03-29

feat

• add typed interfaces f98e44d

fix

• correct license in setup.py (#3) b257c98
• threading mode pipe and styles 6f73ac7
• enable plugin server without gevent mode a29c4d7

0.2.1 - 2021-02-24

feat

• set friendly process title aa59083
• multiprocessing mode 1a97d26

fix

• disable gevent in multiprocessing and make it optional 5b6fb68
• chmod+x on examples 1f5905d

0.2.0 - 2021-02-22

feat

• exit server if parent is dead 0ee2183
• embed server in plugin af55deb

fix

• sync with Kong 2.3 update d42de7e

refactor

• rename kong_pluginserver to kong_pdk e802627

0.1.2 - 2020-02-21

fix

• python2 compatibility 0e4cf1c

0.1.1 - 2020-02-20

0.1.0 - 2020-01-03