Konnect Config Store vault

Related Documentation
Minimum Version
Kong Gateway - 3.4
Incompatible with
on-prem

The Konnect Config Store vault lets you store and reference secrets directly in Konnect, without connecting to a third-party vault backend. You can manage secrets using the Control Planes Configuration API or the Konnect UI.

Because Konnect resolves these secrets after Kong Gateway connects to the control plane, you can only configure the Konnect Config Store vault using a Vault entity. It doesn’t support kong.conf parameters or environment variables, and you can’t use it to resolve secrets referenced in kong.conf.

Warning: The Konnect Config Store stores secrets at the control plane level, and secret references are resolved before sending the configuration to the data planes. Because of this behavior, you can’t use Konnect Config Store secrets directly in Lua code via the Kong PDK.

Create a Konnect Config Store vault

Before creating the Vault entity, create a Config Store by sending a POST request to the /config-stores endpoint:

curl -X POST "https://us.api.konghq.com/v2/control-planes/$CONTROL_PLANE_ID/config-stores" \
     --no-progress-meter --fail-with-body  \
     -H "Authorization: Bearer $KONNECT_TOKEN" \
     --json '{
       "name": "my-config-store"
     }'

Export the Config Store ID from the response:

export DECK_CONFIG_STORE_ID='CONFIG STORE ID'

Then create the konnect Vault entity:

Vault configuration options

The following table lists the available configuration parameters for a Konnect Config Store Vault:

Field name

Parameter format

Description

Config Store ID
  • Vault entity: vaults.config.config_store_id
The ID of the Konnect Config Store to use for this Vault. Create a Config Store by sending a POST request to the /config-stores endpoint, or by creating a Vault through the Konnect UI, which creates the Config Store for you.

Help us make these docs great!

Kong Developer docs are open source. If you find these useful and want to make them better, contribute today!