How to create global plugins when converting OpenAPI spec to declarative Kong config

When using the x-kong-plugin property in the OpenAPI spec file it adds the plugin to the service level. How can I add the plugin globally?

The decK file openapi2kong command converts OpenAPI spec to declarative config for Kong using Kong APIOps. When using the x-kong-plugin custom extension in the OpenAPI spec file can help to generate plugin config in the declarative config for Kong for routes and services. But for the plugin at the global level, it is not supported. You may need to manually add a plugins entry in the declarative configuration file after you have generated the declarative config.

For example, if you want to enable the rate limiting advanced plugin globally you can create the following rla-global.yaml file:

_format_version: "3.0"
_workspace: test
plugins:
- name: rate-limiting-advanced
  tags:
    - global-plugins
  config:
    limit:
    - 5
    window_size:
    - 30
    identifier: consumer
    sync_rate: -1
    namespace: example_namespace
    strategy: local
    hide_client_headers: false

Then, you can use the decK command deck gateway sync --select-tag global-plugins with the --workspace flag to determine which Kong workspace you want to sync.

Note it is important to add --select-tag global-plugins in this case, otherwise it will affect all the configuration in the workspace. Using the created rla-global.yaml file you can enable the rate-limiting-advanced plugin globally in the workspace “test” with the following command:

deck gateway sync --select-tag global-plugins --workspace test rla-global.yaml