Skip to content
Kong Docs are moving soon! Our docs are migrating to a new home. You'll be automatically redirected to the new site in the future. In the meantime, view this page on the new site!
|
Contribution guidelines
github-edit-pageEdit this page
report-issueReport an issue

Single-sourced plugins

We use a Jekyll plugin (plugin_single_source_generator.rb) to dynamically generate pages from a single source file.

Here’s how it works:

  1. Read all version files (app/_hub/**/versions.yml).
  2. For each version listed in the file, check if app/_hub/[vendor]/[name]/[version].md exists.
  3. If not, read app/_hub/[vendor]/[name]/_index.md and generate a version of the page.
  4. The latest version is always generated as index.html, while older versions are generated as [version].html.

Automatic plugin versioning

Each versions.yml is expected to contain a strategy and a list of releases:

strategy: gateway
releases:
  minimum_version: '2.1.x'
  maximum_version: '3.0.x' # optional

Which reads all available Gateway versions from kong_versions.yml and selects those that are in the specified range.

Note: Although strategy supports either matrix for the original rendering, or gateway for plugins that have versions pinned to the Gateway version, the matrix option is no longer in use. It remains at the moment for backwards compatibility.

This can also be used with overrides to set a custom plugin version name:

strategy: gateway
releases:
  minimum_version: '2.1.x'
overrides:
  2.8.x: 0.13.x
  2.7.x: 0.12.x

Version-specific plugin pages

Content within a page can be conditionally rendered using if_version. Adding specific pages to a range of versions is also supported by including minimum_version and/or maximum_version in the front matter the of the page.

---
title: Page for a specific version range
minimum_version: 3.6.x
---

If a page has one of these set in front matter, it gets generated for that version range. Otherwise, it defaults to the setting for the whole plugin, which is specified in versions.yml

Open source and enterprise discrepancies

In some cases, the version of a plugin is different between the Community Edition (OSS) and Enterprise Edition. In these instances, each release should be entered as a unique version in the config file.

Here’s an example where Gateway 2.3.x CE uses plugin version 1.0, while 2.3.x EE uses plugin version 2.0:

strategy: gateway
releases:
  minimum_version: 2.2.x
replacements:
  2.3.x:
    - 2.3.x-CE
    - 2.3.x-EE
overrides:
  2.4.x: 2.0.x
  2.3.x-EE: 2.0.x
  2.3.x-CE: 1.0.x
  2.2.x: 1.0.x

2.3.x-EE and 2.4.x both use plugin version 2.0.x and the default _index source file. 2.3.x-CE and 2.2.x use plugin version 1.0.x.

If you want to use releases but have one or two versions that you need to override, you can use replacements:

strategy: gateway
releases:
  minimum_version: '2.1.x'
replacements:
  2.3.x:
    - 2.3.x-CE
    - 2.3.x-EE
overrides:
  2.3.x-EE: 2.0.x
  2.3.x-CE: 1.0.x

See also