Canary Release Configuration

You are browsing documentation for an outdated plugin version.

Configuration

This plugin is compatible with DB-less mode.

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.

• 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.

  • hash

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

    Entity to be used for hashing. Options: consumer, ip, header, allow, deny, or none. When using consumer or ip, make sure to properly set the settings for trusted IPs (see the trusted_ips and real_ip_header settings in the Kong configuration file.)

  • hash_header

    string

    Header name whose value will be used as hash input. Required if config.hash is set to header.

  • duration

    number default: 3600

    The duration of the transition in seconds. Ignored when percentage is set, or when using allow or deny in hash.

  • steps

    number default: 1000

    Number of steps the release should be broken into.

  • percentage

    number between: 0 100

    Fixed percentage of traffic to be routed to new target, if given overrides start and duration. The value must be between 0 and 100.

  • upstream_host

    string

    The target hostname where traffic will be routed. Required if upstream_uri and upstream_port are not set.

  • upstream_port

    integer between: 0 65535

    The target port where traffic will be routed. Required if upstream_uri and upstream_host are not set. Must be a value between 0 and 65535.

  • upstream_uri

    string len_min: 1

    The Upstream URI where traffic will be routed. Required if upstream_port and upstream_host are not set.

  • upstream_fallback

    boolean required default: false

  • groups

    array of type string

    An array of strings with the group names that are allowed or denied. Set hash to either allow (the listed groups go into the canary) or deny (the listed groups will NOT go into the canary.)

  • 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..