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:
-
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
.
- If using the Kong Admin API, Konnect API, declarative configuration, or decK files, the field is
-
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)
-
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
. -
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
. -
boolean default:
true
Whether this plugin will be applied.
-
record required
-
number
Future time in seconds since epoch, when the canary release will start. Ignored when
percentage
is set, or when usingallow
ordeny
inhash
.
-
string default:
consumer
Must be one of:consumer
,ip
,none
,allow
,deny
,header
Hash algorithm to be used for canary release.
-
consumer
: The hash will be based on the consumer. -
ip
: The hash will be based on the client IP address. -
none
: No hash will be applied. -
allow
: Allows the specified groups to access the canary release. -
deny
: Denies the specified groups from accessing the canary release. -
header
: The hash will be based on the specified header value.
-
-
string
A string representing an HTTP header name.
-
number default:
3600
The duration of the canary release in seconds.
-
number default:
1000
The number of steps for the canary release.
-
number between:
0
100
The percentage of traffic to be routed to the canary release.
-
string
A string representing a host name, such as example.com.
-
integer between:
0
65535
An integer representing a port number between 0 and 65535, inclusive.
-
string len_min:
1
The URI of the upstream server to be used for the canary release.
-
boolean required default:
false
Specifies whether to fallback to the upstream server if the canary release fails.
-
array of type
string
The groups allowed to access the canary release.
-
string
A string representing an HTTP header name.
-
-
string
Hash algorithm to be used for canary release.
whitelist
is deprecated. Useallow
insteadblacklist
is deprecated. Usedeny
instead.Deprecation notice: