Canary Release Configuration

You are browsing documentation for an outdated plugin version.

Configuration

This plugin is compatible with DB-less mode.

Compatible protocols

The Canary Release plugin is compatible with the following protocols:

grpc, grpcs, http, https

Parameters

Here's a list of all the parameters which can be used in this plugin's configuration:

• name or plugin

  string required

  The name of the plugin, in this case canary.

  • If using the Kong Admin API, Konnect API, declarative configuration, or decK files, the field is name.
  • If using the KongPlugin object in Kubernetes, the field is plugin.

• instance_name

  string

  An optional custom name to identify an instance of the plugin, for example canary_my-service.

  The instance name shows up in Kong Manager and in Konnect, so it's useful when running the same plugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance via the Kong Admin API.

  An instance name must be unique within the following context:

  • Within a workspace for Kong Gateway Enterprise
  • Within a control plane or control plane group for Konnect
  • Globally for Kong Gateway (OSS)

• service.name or service.id

  string

  The name or ID of the service the plugin targets. Set one of these parameters if adding the plugin to a service through the top-level /plugins endpoint. Not required if using /services/{serviceName|Id}/plugins.

• route.name or route.id

  string

  The name or ID of the route the plugin targets. Set one of these parameters if adding the plugin to a route through the top-level /plugins endpoint. Not required if using /routes/{routeName|Id}/plugins.

• enabled

  boolean default: true

  Whether this plugin will be applied.

• config

  record required
  • start

    number

    Future time in seconds since epoch, when the canary release will start. Ignored when percentage is set, or when using allow or deny in hash.

    If no value is set for the start field, it defaults to the timestamp of the moment that the plugin instance is created.

  • hash

    string default: consumer Must be one of: consumer, ip, none, allow, deny, header

  • hash_header

    string

  • duration

    number default: 3600

  • steps

    number default: 1000

  • percentage

    number between: 0 100

  • upstream_host

    string

  • upstream_port

    integer between: 0 65535

  • upstream_uri

    string len_min: 1

  • upstream_fallback

    boolean required default: false

  • groups

    array of type string

  • canary_by_header_name

    string

    Header name that, when present on a request, overrides the configured canary functionality.

    • If the configured header is present with the value always, the request will always go to the canary upstream.
    • If the header is present with the value never, the request will never go to the canary upstream.

    For all other values, the configured canary rules will be applied.

• hash

  string
  Deprecation notice: This field has been deprecated and will be removed in a future version..