このページは、まだ日本語ではご利用いただけません。翻訳中です。
古いプラグインバージョンのドキュメントを閲覧しています。
構成
このプラグインはDBレスモードに対応しています。
パラメータ
このプラグインの設定で使用できるすべてのパラメータのリストは次のとおりです。
-
name or plugin
string requiredプラグイン名。この場合は
canary
。- Kong Admin API、Kong Konnect API、宣言型構成、または decK ファイルを使用する場合、フィールドは
name
です。 - Kubernetes で KongPlugin オブジェクトを使用する場合、フィールドは
plugin
です。
- Kong Admin API、Kong Konnect API、宣言型構成、または decK ファイルを使用する場合、フィールドは
-
service.name or service.id
stringプラグインが対象とするサービス名または ID。最上位の
/plugins
エンドポイント. からプラグインをサービスに追加する場合は、これらのパラメータのいずれかを設定してください/services/{serviceName|Id}/plugins
を使用する場合は必要ありません。 -
route.name or route.id
stringプラグインがターゲットとするルート名または ID。最上位の
/plugins
エンドポイント. を通るルートにプラグインを追加する場合は、これらのパラメータのいずれかを設定してください/routes/{routeName|Id}/plugins
を使用する場合は必要ありません。 -
enabled
boolean default:true
このプラグインが適用されるかどうか。
-
config
record required-
start
numberFuture time in seconds since epoch, when the canary release will start. Ignored when
percentage
is set, or when usingallow
ordeny
inhash
.
-
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
, ornone
. When usingconsumer
orip
, make sure to properly set the settings for trusted IPs (see thetrusted_ips
andreal_ip_header
settings in the Kong configuration file.)
-
hash_header
stringHeader name whose value will be used as hash input. Required if
config.hash
is set toheader
.
-
duration
number default:3600
The duration of the transition in seconds. Ignored when
percentage
is set, or when usingallow
ordeny
inhash
.
-
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
andduration
. The value must be between 0 and 100.
-
upstream_host
stringThe target hostname where traffic will be routed. Required if
upstream_uri
andupstream_port
are not set.
-
upstream_port
integer between:0
65535
The target port where traffic will be routed. Required if
upstream_uri
andupstream_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
andupstream_host
are not set.
-
upstream_fallback
boolean required default:false
-
groups
array of typestring
An array of strings with the group names that are allowed or denied. Set
hash
to eitherallow
(the listed groups go into the canary) ordeny
(the listed groups will NOT go into the canary.)
-
canary_by_header_name
stringHeader 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.
- If the configured header is present with the value
-
-
hash
stringDeprecation notice: