コンテンツにスキップ
|
Plugin Hub
report-issue問題を報告する
header icon

Canary Release設定

By Kong Inc.

このページは、まだ日本語ではご利用いただけません。翻訳中です。

構成

このプラグインはDBレスモードに対応しています。

互換性のあるプロトコル

Canary Releaseプラグインは以下のプロトコルに対応しています：

grpc, grpcs, http, https

パラメータ

このプラグインの設定で使用できるすべてのパラメータのリストは次のとおりです。

  • name or plugin

    string required

    プラグイン名。この場合は canary 。

    • Kong Admin API、Kong Konnect API、宣言型構成、または decK ファイルを使用する場合、フィールドはnameです。
    • Kubernetes で KongPlugin オブジェクトを使用する場合、フィールドはpluginです。

  • instance_name

    string

    プラグインのインスタンスを識別するための任意のカスタム名 (例: canary_my-service 。

    インスタンス名はKong ManagerとKonnectに表示されるので、 例えば複数のサービスで同じプラグインを複数のコンテキストで実行する場合に便利です。また、Kong Admin API経由で特定のプラグインインスタンスに アクセスするためにも使用できます。

    インスタンス名は、次のコンテキスト内で一意である必要があります。

    • Kong Gateway Enterpriseのワークスペース内
    • Konnectのコントロールプレーン（CP）またはコントロールプレーン（CP）グループ内
    • Kong Gateway (OSS)の全世界

  • 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

      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

      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.

    • hash_header

      string

      A string representing an HTTP header name.

    • duration

      number default: 3600

      The duration of the canary release in seconds.

    • steps

      number default: 1000

      The number of steps for the canary release.

    • percentage

      number between: 0 100

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

    • upstream_host

      string

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

    • upstream_port

      integer between: 0 65535

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

    • upstream_uri

      string len_min: 1

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

    • upstream_fallback

      boolean required default: false

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

    • groups

      array of type string

      The groups allowed to access the canary release.

    • canary_by_header_name

      string

      A string representing an HTTP header name.

  • hash

    string

    Hash algorithm to be used for canary release. whitelist is deprecated. Use allow instead blacklist is deprecated. Use deny instead.

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