Canary Release

Overview Examples Configuration reference Changelog

Configuration

configobject

Hide Child Parameters

canary_by_header_namestring

A string representing an HTTP header name.

durationnumber

The duration of the canary release in seconds.

Default:3600

>= 0

groupsarray[string]

The groups allowed to access the canary release.

hashstring

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.

Allowed values:allowconsumerdenyheaderipnone

Default:consumer

hash_headerstring

A string representing an HTTP header name.

percentagenumber

The percentage of traffic to be routed to the canary release.

>= 0<= 100

startnumber

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.

stepsnumber

The number of steps for the canary release.

Default:1000

>= 1

upstream_fallbackboolean

Specifies whether to fallback to the upstream server if the canary release fails.

Default:false

upstream_hoststring

A string representing a host name, such as example.com.

upstream_portinteger

An integer representing a port number between 0 and 65535, inclusive.

>= 0<= 65535

upstream_uristring

The URI of the upstream server to be used for the canary release.

>= 1 characters

protocolsarray[string]

A set of strings representing HTTP protocols.

Allowed values:grpcgrpcshttphttps

Default:grpc, grpcs, http, https

routeobject

If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.

* Additional properties are NOT allowed.

Hide Child Parameters

idstring

serviceobject

If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.

* Additional properties are NOT allowed.

Hide Child Parameters

idstring

Canary Release

Configuration

Did this doc help?

Help us make these docs great!

Still need help