Canary Release

Make the following request:

curl -X POST http://{HOST}:8001/services/{SERVICE}/plugins \
    --data "name=canary" 

SERVICE is the id or name of the service that this plugin configuration will target.

First, create a KongPlugin resource:

apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: <canary-example>
config:
  <optional_parameter>: <value>
plugin: canary

Next, apply the KongPlugin resource to a Service by annotating the Service as follows:

apiVersion: v1
kind: Service
metadata:
  name: {SERVICE}
  labels:
    app: {SERVICE}
  annotations:
    konghq.com/plugins: <canary-example>
spec:
  ports:
  - port: 80
    targetPort: 80
    protocol: TCP
    name: {SERVICE}
  selector:
    app: {SERVICE}

{SERVICE} is the id or name of the service that this plugin configuration will target.

Add this section to your declarative configuration file:

plugins:
- name: canary
  service: {SERVICE}
  config:
    <optional_parameter>: <value>

SERVICE is the id or name of the service that this plugin configuration will target.

1. In Konnect Cloud, select the service on the ServiceHub page.
2. Scroll down to Versions and select the version.
3. Scroll down to Plugins and click New Plugin.
4. Find and select the Canary Release plugin.
5. Click Create.

1. In Kong Manager, select the workspace.
2. From the Dashboard, scroll down to Services and click View for the service row.
3. Scroll down to plugins and click Add Plugin.

4. Find and select the Canary Release plugin.

   Note: If the plugin is greyed out, then it is not available for your product tier. See Kong Gateway tiers.
5. If the option is available, select Scoped.
6. Add the service name and ID to the Service field if it is not already prefilled.
7. Click Create.

Make the following request:

$ curl -X POST http://{HOST}:8001/routes/{ROUTE}/plugins \
    --data "name=canary" 

ROUTE is the id or name of the route that this plugin configuration will target.

First, create a KongPlugin resource:

apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: <canary-example>
config:
  <optional_parameter>: <value>
plugin: canary

Then, apply it to an ingress (Route or Routes) by annotating the ingress as follows:

apiVersion: networking/v1beta1
kind: Ingress
metadata:
  name: {ROUTE}
  annotations:
    kubernetes.io/ingress.class: kong
    konghq.com/plugins: <canary-example>
spec:
  rules:
  - host: examplehostname.com
    http:
      paths:
      - path: /bar
        backend:
          serviceName: echo
          servicePort: 80

ROUTE is the id or name of the route that this plugin configuration will target.

Add this section to your declarative configuration file:

plugins:
- name: canary
  route: <route>
  config:
    <optional_parameter>: <value>

ROUTE is the id or name of the route that this plugin configuration will target.

1. In Konnect Cloud, select the service from the ServiceHub page.
2. Scroll down to Versions and select the version.
3. Select the route.
4. Scroll down to Plugins and click Add Plugin.
5. Find and select the Canary Release plugin.
6. Click Create.

1. In Kong Manager, select the workspace.
2. From the Dashboard, select Routes in the left navigation.
3. Click View for the route row.
4. Scroll down to plugins and click Add Plugin.

5. Find and select the Canary Release plugin.

   Note: If the plugin is greyed out, then it is not available for your product tier. See Kong Gateway tiers.
6. If the option is available, select Scoped.
7. Add the Route ID if it is not already prefilled.
8. Click Create.

Make the following request:

$ curl -X POST http://{HOST}:8001/consumers/{CONSUMER}/plugins \
    --data "name=canary" 

CONSUMER is the id or username of the consumer that this plugin configuration will target.

You can combine consumer.id, service.id, or route.id in the same request, to further narrow the scope of the plugin.

First, create a KongPlugin resource:

apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: <canary-example>
config:
  <optional_parameter>: <value>
plugin: canary

Then, apply it to a consumer by annotating the KongConsumer resource as follows:

apiVersion: configuration.konghq.com/v1
kind: KongConsumer
metadata:
  name: {CONSUMER}
  annotations:
    konghq.com/plugins: <canary-example>
    kubernetes.io/ingress.class: kong

CONSUMER is the id or username of the consumer that this plugin configuration will target.

Add this section to your declarative configuration file:

plugins:
- name: canary
  consumer: {CONSUMER}
  config:
    <optional_parameter>: <value>

CONSUMER is the id or username of the consumer that this plugin configuration will target.

1. In Kong Manager, select the workspace.
2. From the Dashboard, scroll down to Consumers and click View for the consumer row.
3. Select the Plugins tab.
4. Click Add Plugin.

5. Find and select the Canary Release plugin.

   Note: If the plugin is greyed out, then it is not available for your product tier. See Kong Gateway tiers.
6. If the option is available, select Global.
7. Click Create.

Make the following request:

$ curl -X POST http://{HOST}:8001/plugins/ \
    --data "name=canary" 

Create a KongClusterPlugin resource and label it as global:

apiVersion: configuration.konghq.com/v1
kind: KongClusterPlugin
metadata:
  name: <global-canary>
  annotations:
    kubernetes.io/ingress.class: kong
  labels:
    global: \"true\"
config:
  <optional_parameter>: <value>
plugin: canary

Add a plugins entry in the declarative configuration file:

plugins:
- name: canary
  config:
    <optional_parameter>: <value>

1. In Kong Manager, select the workspace.
2. From the Dashboard, select Plugins in the left navigation.
3. Click New Plugin.

4. Find and select the Canary Release plugin.

   Note: If the plugin is greyed out, then it is not available for your product tier. See Kong Gateway tiers.
5. If the option is available, set the plugin scope to Global.
6. Click Create.