Skip to content
|
Plugin Hub
github-edit-pageEdit this page
report-issueReport an issue
header icon

Basic config examples for Vault Authentication

By Kong Inc.

Basic configuration examples

The following examples provide some typical configurations for enabling the vault-auth plugin on a service.

Make the following request:

curl -X POST http://localhost:8001/services/{serviceName|Id}/plugins \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
  "name": "vault-auth",
  "config": {
    "vault": {
      "id": "00000000-0000-0000-0000-000000000000"
    }
  }
}
    '

Replace SERVICE_NAME|ID with the id or name of the service that this plugin configuration will target.

First, create a KongPlugin resource:

echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: vault-auth-example
plugin: vault-auth
config:
  vault:
    id: 00000000-0000-0000-0000-000000000000
" | kubectl apply -f -

Next, apply the KongPlugin resource to an ingress by annotating the service as follows:

kubectl annotate service SERVICE_NAME konghq.com/plugins=vault-auth-example

Replace SERVICE_NAME with the name of the service that this plugin configuration will target. You can see your available ingresses by running kubectl get service.

Note: The KongPlugin resource only needs to be defined once and can be applied to any service, consumer, or route in the namespace. If you want the plugin to be available cluster-wide, create the resource as a KongClusterPlugin instead of KongPlugin.

Add this section to your declarative configuration file:

plugins:
- name: vault-auth
  service: SERVICE_NAME|ID
  config:
    vault:
      id: 00000000-0000-0000-0000-000000000000

Replace SERVICE_NAME|ID with the id or name of the service that this plugin configuration will target.

Prerequisite: Configure your Personal Access Token 
terraform {
  required_providers {
    konnect = {
      source  = "kong/konnect"
    }
  }
}

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

Add the following to your Terraform configuration to create a Konnect Gateway Plugin:

resource "konnect_gateway_plugin_vault_auth" "my_vault_auth" {
  enabled = true

  config = {
    vault = {
      id = "00000000-0000-0000-0000-000000000000"
    }
  }

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

The following examples provide some typical configurations for enabling the vault-auth plugin on a route.

Make the following request:

curl -X POST http://localhost:8001/routes/{routeName|Id}/plugins \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
  "name": "vault-auth",
  "config": {
    "vault": {
      "id": "00000000-0000-0000-0000-000000000000"
    }
  }
}
    '

Replace ROUTE_NAME|ID with the id or name of the route that this plugin configuration will target.

First, create a KongPlugin resource:

echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: vault-auth-example
plugin: vault-auth
config:
  vault:
    id: 00000000-0000-0000-0000-000000000000
" | kubectl apply -f -

Next, apply the KongPlugin resource to an ingress by annotating the ingress as follows:

kubectl annotate ingress INGRESS_NAME konghq.com/plugins=vault-auth-example

Replace INGRESS_NAME with the name of the ingress that this plugin configuration will target. You can see your available ingresses by running kubectl get ingress.

Note: The KongPlugin resource only needs to be defined once and can be applied to any service, consumer, or route in the namespace. If you want the plugin to be available cluster-wide, create the resource as a KongClusterPlugin instead of KongPlugin.

Add this section to your declarative configuration file:

plugins:
- name: vault-auth
  route: ROUTE_NAME|ID
  config:
    vault:
      id: 00000000-0000-0000-0000-000000000000

Replace ROUTE_NAME|ID with the id or name of the route that this plugin configuration will target.

Prerequisite: Configure your Personal Access Token 
terraform {
  required_providers {
    konnect = {
      source  = "kong/konnect"
    }
  }
}

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

Add the following to your Terraform configuration to create a Konnect Gateway Plugin:

resource "konnect_gateway_plugin_vault_auth" "my_vault_auth" {
  enabled = true

  config = {
    vault = {
      id = "00000000-0000-0000-0000-000000000000"
    }
  }

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

A plugin which is not associated to any service, route, consumer, or consumer group is considered global, and will be run on every request.

  • In self-managed Kong Gateway Enterprise, the plugin applies to every entity in a given workspace.
  • In self-managed Kong Gateway (OSS), the plugin applies to your entire environment.

Read the Plugin Reference and the Plugin Precedence sections for more information.

The following examples provide some typical configurations for enabling the Vault Authentication plugin globally.

Make the following request:

curl -X POST http://localhost:8001/plugins/ \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
  "name": "vault-auth",
  "config": {
    "vault": {
      "id": "00000000-0000-0000-0000-000000000000"
    }
  }
}
    '

Create a KongClusterPlugin resource and label it as global:

apiVersion: configuration.konghq.com/v1
kind: KongClusterPlugin
metadata:
  name: <global-vault-auth>
  annotations:
    kubernetes.io/ingress.class: kong
  labels:
    global: "true"
config:
  vault:
    id: 00000000-0000-0000-0000-000000000000
plugin: vault-auth

Add a plugins entry in the declarative configuration file:

plugins:
- name: vault-auth
  config:
    vault:
      id: 00000000-0000-0000-0000-000000000000
Prerequisite: Configure your Personal Access Token 
terraform {
  required_providers {
    konnect = {
      source  = "kong/konnect"
    }
  }
}

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

Add the following to your Terraform configuration to create a Konnect Gateway Plugin:

resource "konnect_gateway_plugin_vault_auth" "my_vault_auth" {
  enabled = true

  config = {
    vault = {
      id = "00000000-0000-0000-0000-000000000000"
    }
  }

  control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
}