Canary Releaseの基本構成例 - Plugin

基本構成例

serviceで有効にする

routeで有効にする

グローバルに有効にする

以下の例では、canaryプラグインをserviceで有効にするための一般的な設定をご紹介します。

Kong Admin API

Konnect API

Declarative (YAML)

Konnect Terraform

次のリクエストを行います。

curl -X POST http://localhost:8001/services/{serviceName|Id}/plugins \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
  "name": "canary",
  "config": {
    "percentage": 50,
    "upstream_host": "example.com",
    "upstream_port": 80
  }
}
    '

SERVICE_NAME

IDを、このプラグイン構成の対象となるサービスの idまたはnameに置き換えてください。

独自のアクセストークン、リージョン、コントロールプレーンID、サービスIDを代入して、次のリクエストを行ってください。

curl -X POST \
https://{us|eu}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/services/{serviceId}/plugins \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer TOKEN" \
    --data '{"name":"canary","config":{"percentage":50,"upstream_host":"example.com","upstream_port":80}}'

地域固有のURLと個人アクセストークンの詳細については、 Konnect API referenceをご参照ください。

このセクションを宣言型構成ファイルに追加します。

plugins:
- name: canary
  service: SERVICE_NAME|ID
  config:
    percentage: 50
    upstream_host: example.com
    upstream_port: 80

SERVICE_NAME

IDを、このプラグイン構成の対象となるサービスの idまたはnameに置き換えてください。

前提条件： パーソナルアクセストークンの設定

terraform {
  required_providers {
    konnect = {
      source  = "kong/konnect"
    }
  }
}

provider "konnect" {
  personal_access_token = "kpat_YOUR_TOKEN"
  server_url            = "https://us.api.konghq.com/"
}

Kong Konnectゲートウェイプラグインを作成するには、Terraform 構成に以下を追加します。

resource "konnect_gateway_plugin_canary" "my_canary" {
  enabled = true

  config = {
    percentage = 50
    upstream_host = "example.com"
    upstream_port = 80
  }

  control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
  service = {
    id = konnect_gateway_service.my_service.id
  }
}

以下の例では、canaryプラグインをrouteで有効にするための一般的な設定をご紹介します。

Kong Admin API

Konnect API

Declarative (YAML)

Konnect Terraform

次のリクエストを行います。

curl -X POST http://localhost:8001/routes/{routeName|Id}/plugins \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
  "name": "canary",
  "config": {
    "percentage": 50,
    "upstream_host": "example.com",
    "upstream_port": 80
  }
}
    '

ROUTE_NAME

IDを、このプラグイン構成が対象とするルートのid またはnameに置き換えてください。

独自のアクセストークン、リージョン、コントロールプレーン（CP）ID、ルートIDを代入して、次のリクエストをしてください。

curl -X POST \
https://{us|eu}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/routes/{routeId}/plugins \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer TOKEN" \
    --data '{"name":"canary","config":{"percentage":50,"upstream_host":"example.com","upstream_port":80}}'

地域固有のURLと個人アクセストークンの詳細については、 Konnect API referenceをご参照ください。

このセクションを宣言型構成ファイルに追加します。

plugins:
- name: canary
  route: ROUTE_NAME|ID
  config:
    percentage: 50
    upstream_host: example.com
    upstream_port: 80

ROUTE_NAME

IDを、このプラグイン構成が対象とするルートのid またはnameに置き換えてください。

前提条件： パーソナルアクセストークンの設定

terraform {
  required_providers {
    konnect = {
      source  = "kong/konnect"
    }
  }
}

provider "konnect" {
  personal_access_token = "kpat_YOUR_TOKEN"
  server_url            = "https://us.api.konghq.com/"
}

Kong Konnectゲートウェイプラグインを作成するには、Terraform 構成に以下を追加します。

resource "konnect_gateway_plugin_canary" "my_canary" {
  enabled = true

  config = {
    percentage = 50
    upstream_host = "example.com"
    upstream_port = 80
  }

  control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
  route = {
    id = konnect_gateway_route.my_route.id
  }
}

どのサービス、ルート、コンシューマー、コンシューマーグループにも関連しないプラグインは_global_とみなされ、すべてのリクエストで実行されます。

自己管理型のKong Gateway Enterpriseでは、プラグインは特定のワークスペース内のすべてのエンティティに適用されます。
セルフマネージドKong Gateway (OSS)では、プラグインは環境全体に適用されます。
Konnectでは、プラグインは特定のコントロールプレーン（CP）内のすべてのエンティティに適用されます。

詳しくはプラグインリファレンスとプラグインの優先順位のセクションをご覧ください。

以下の例では、Canary Releaseプラグインをグローバルに有効にするための典型的な設定をいくつかご紹介します。

Kong Admin API

Konnect API

Declarative (YAML)

Konnect Terraform

次のリクエストを行います。

curl -X POST http://localhost:8001/plugins/ \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
  "name": "canary",
  "config": {
    "percentage": 50,
    "upstream_host": "example.com",
    "upstream_port": 80
  }
}
    '

独自のアクセストークン、リージョン、コントロールプレーン（CP）IDを代入して、次のリクエストをしてください。

curl -X POST \
https://{us|eu}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/plugins/ \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer TOKEN" \
    --data '{"name":"canary","config":{"percentage":50,"upstream_host":"example.com","upstream_port":80}}'

地域固有のURLと個人アクセストークンの詳細については、 Konnect API referenceをご参照ください。

宣言型構成ファイルにpluginsエントリを追加します。

plugins:
- name: canary
  config:
    percentage: 50
    upstream_host: example.com
    upstream_port: 80

前提条件： パーソナルアクセストークンの設定

terraform {
  required_providers {
    konnect = {
      source  = "kong/konnect"
    }
  }
}

provider "konnect" {
  personal_access_token = "kpat_YOUR_TOKEN"
  server_url            = "https://us.api.konghq.com/"
}

Kong Konnectゲートウェイプラグインを作成するには、Terraform 構成に以下を追加します。

resource "konnect_gateway_plugin_canary" "my_canary" {
  enabled = true

  config = {
    percentage = 50
    upstream_host = "example.com"
    upstream_port = 80
  }

  control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
}

前へ Canary Release設定

次へ Canary Release変更履歴