Enable Vault authenticationv1.0+
Enable the plugin and associate it with a Vault object.
Important: The Vault object is not the same as a Vault entity. The Vault object is used only by the Vault Auth plugin. The Vault entity is a standalone entity in Kong Gateway for managing secrets.
For a full how-to guide, see Enable authentication with Vault in Kong Gateway.
Prerequisites
Environment variables
VAULT_ID: The UUID of the Vault object to associate to the plugin.
Add this section to your kong.yaml configuration file:
_format_version: "3.0"
plugins:
- name: vault-auth
config:
vault:
id: ${{ env "DECK_VAULT_ID" }}Make the following request:
curl -i -X POST http://localhost:8001/plugins/ \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data '
{
"name": "vault-auth",
"config": {
"vault": {
"id": "'$VAULT_ID'"
}
}
}
'echo "
apiVersion: configuration.konghq.com/v1
kind: KongClusterPlugin
metadata:
name: vault-auth
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
labels:
global: 'true'
config:
vault:
id: '$VAULT_ID'
plugin: vault-auth
" | kubectl apply -f -Prerequisite: Configure your Personal Access Token
terraform {
required_providers {
konnect = {
source = "kong/konnect"
}
}
}
provider "konnect" {
personal_access_token = "$KONNECT_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 = var.vault_id
}
}
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
}This example requires the following variables to be added to your manifest. You can specify values at runtime by setting TF_VAR_name=value.
variable "vault_id" {
type = string
}Add this section to your kong.yaml configuration file:
_format_version: "3.0"
plugins:
- name: vault-auth
service: serviceName|Id
config:
vault:
id: ${{ env "DECK_VAULT_ID" }}Make sure to replace the following placeholders with your own values:
serviceName|Id: Theidornameof the service the plugin configuration will target.
Make the following request:
curl -i -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": "'$VAULT_ID'"
}
}
}
'Make sure to replace the following placeholders with your own values:
serviceName|Id: Theidornameof the service the plugin configuration will target.
echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
name: vault-auth
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
config:
vault:
id: '$VAULT_ID'
plugin: vault-auth
" | kubectl apply -f -Next, apply the KongPlugin resource by annotating the service resource:
kubectl annotate -n kong service SERVICE_NAME konghq.com/plugins=vault-authPrerequisite: Configure your Personal Access Token
terraform {
required_providers {
konnect = {
source = "kong/konnect"
}
}
}
provider "konnect" {
personal_access_token = "$KONNECT_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 = var.vault_id
}
}
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
service = {
id = konnect_gateway_service.my_service.id
}
}This example requires the following variables to be added to your manifest. You can specify values at runtime by setting TF_VAR_name=value.
variable "vault_id" {
type = string
}Add this section to your kong.yaml configuration file:
_format_version: "3.0"
plugins:
- name: vault-auth
route: routeName|Id
config:
vault:
id: ${{ env "DECK_VAULT_ID" }}Make sure to replace the following placeholders with your own values:
routeName|Id: Theidornameof the route the plugin configuration will target.
Make the following request:
curl -i -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": "'$VAULT_ID'"
}
}
}
'Make sure to replace the following placeholders with your own values:
routeName|Id: Theidornameof the route the plugin configuration will target.
echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
name: vault-auth
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
config:
vault:
id: '$VAULT_ID'
plugin: vault-auth
" | kubectl apply -f -Next, apply the KongPlugin resource by annotating the httproute or ingress resource:
kubectl annotate -n kong httproute konghq.com/plugins=vault-authkubectl annotate -n kong ingress konghq.com/plugins=vault-authPrerequisite: Configure your Personal Access Token
terraform {
required_providers {
konnect = {
source = "kong/konnect"
}
}
}
provider "konnect" {
personal_access_token = "$KONNECT_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 = var.vault_id
}
}
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
route = {
id = konnect_gateway_route.my_route.id
}
}This example requires the following variables to be added to your manifest. You can specify values at runtime by setting TF_VAR_name=value.
variable "vault_id" {
type = string
}