Skip to content
Kong Logo | Kong Docs Logo
search
  • We're Hiring!
  • Docs
    • Kong Gateway
    • Kong Konnect
    • Kong Mesh
    • Plugin Hub
    • decK
    • Kubernetes Ingress Controller
    • Insomnia
    • Kuma

    • Docs contribution guidelines
  • Plugin Hub
  • Support
  • Community
  • Kong Academy
Get a Demo Start Free Trial
  • Kong Gateway
  • Kong Konnect
  • Kong Mesh
  • Plugin Hub
  • decK
  • Kubernetes Ingress Controller
  • Insomnia
  • Kuma

  • Docs contribution guidelines
  • 3.2.x (latest)
  • 3.1.x
  • 3.0.x
  • 2.8.x
  • 2.7.x
  • 2.6.x
  • Older Enterprise versions (2.1-2.5)
  • Older OSS versions (2.1-2.5)
  • Archive (pre-2.1)
    • Overview of Kong Gateway
      • Version Support Policy
      • Supported Installation Options
      • Supported Linux Distributions
    • Stability
    • Release Notes
      • Services
        • Overview
        • Configure Routes with Expressions
      • Upstreams
      • Plugins
      • Routing Traffic
      • Load Balancing
      • Health Checks and Circuit Breakers
      • Kong Performance Testing
    • Glossary
    • Get Kong
    • Services and Routes
    • Rate Limiting
    • Proxy Caching
    • Key Authentication
    • Load-Balancing
      • Overview
        • Overview
        • Deploy Kong Gateway in Hybrid mode
      • DB-less Deployment
      • Traditional
      • Overview
        • Helm
        • OpenShift with Helm
        • kubectl apply
        • Kubernetes Deployment Options
        • Using docker run
        • Build your own Docker images
        • Amazon Linux
        • Debian
        • Red Hat
        • Ubuntu
      • Running Kong as a non-root user
      • Securing the Admin API
      • Using systemd
      • Start Kong Gateway Securely
      • Programatically Creating Admins
      • Enabling RBAC
      • Overview
      • Download your License
      • Deploy Enterprise License
      • Using the License API
      • Monitor Licenses Usage
      • Default Ports
      • DNS Considerations
      • Network and Firewall
      • CP/DP Communication through a Forward Proxy
    • Kong Configuration File
    • Environment Variables
    • Serving a Website and APIs from Kong
      • Overview
      • Prometheus
      • StatsD
      • Datadog
      • Overview
      • Writing a Custom Trace Exporter
      • Tracing API Reference
    • Resource Sizing Guidelines
    • Security Update Process
    • Blue-Green Deployments
    • Canary Deployments
    • Clustering Reference
      • Log Reference
      • Dynamic log level updates
      • Customize Gateway Logs
      • Upgrade Kong Gateway 3.1.x
      • Migrate from OSS to Enterprise
    • Overview
      • Overview
      • Metrics
      • Analytics with InfluxDB
      • Analytics with Prometheus
      • Estimate Analytics Storage in PostgreSQL
      • Overview
      • Getting Started
      • Advanced Usage
        • Overview
        • Environment Variables
        • AWS Secrets Manager
        • Google Secrets Manager
        • Hashicorp Vault
        • Securing the Database with AWS Secrets Manager
      • Reference Format
      • Overview
      • Get Started with Dynamic Plugin Ordering
      • Overview
      • Enable the Dev Portal
      • Publish an OpenAPI Spec
      • Structure and File Types
      • Themes Files
      • Working with Templates
      • Using the Editor
        • Basic Auth
        • Key Auth
        • OIDC
        • Sessions
        • Adding Custom Registration Fields
        • Manage Developers
        • Developer Roles and Content Permissions
        • Authorization Provider Strategy
        • Enable Application Registration
        • Enable Key Authentication for Application Registration
          • External OAuth2 Support
          • Set up Okta and Kong for External Oauth
          • Set up Azure AD and Kong for External Authentication
        • Manage Applications
        • Theme Editing
        • Migrating Templates Between Workspaces
        • Markdown Rendering Module
        • Customizing Portal Emails
        • Adding and Using JavaScript Assets
        • Single Page App in Dev Portal
        • Alternate OpenAPI Renderer
      • SMTP
      • Workspaces
      • Helpers CLI
      • Portal API Documentation
    • Audit Logging
    • Keyring and Data Encryption
    • Workspaces
    • Consumer Groups
    • Event Hooks
    • FIPS 140-2
    • Overview
    • Enable Kong Manager
      • Services and Routes
      • Rate Limiting
      • Proxy Caching
      • Authentication with Consumers
      • Load Balancing
      • Overview
      • Create a Super Admin
      • Workspaces and Teams
      • Reset Passwords and RBAC Tokens
      • Basic Auth
        • Configure LDAP
        • LDAP Service Directory Mapping
        • Configure OIDC
        • OIDC Authenticated Group Mapping
      • Sessions
        • Overview
        • Enable RBAC
        • Add a Role and Permissions
        • Create a User
        • Create an Admin
    • Networking Configuration
    • Workspaces
    • Create Consumer Groups
    • Sending Email
    • Overview
    • File Structure
    • Implementing Custom Logic
    • Plugin Configuration
    • Accessing the Data Store
    • Storing Custom Entities
    • Caching Custom Entities
    • Extending the Admin API
    • Writing Tests
    • (un)Installing your Plugin
      • Overview
      • kong.client
      • kong.client.tls
      • kong.cluster
      • kong.ctx
      • kong.ip
      • kong.jwe
      • kong.log
      • kong.nginx
      • kong.node
      • kong.request
      • kong.response
      • kong.router
      • kong.service
      • kong.service.request
      • kong.service.response
      • kong.table
      • kong.tracing
      • kong.vault
      • kong.websocket.client
      • kong.websocket.upstream
      • Go
      • Javascript
      • Python
      • Running Plugins in Containers
      • External Plugin Performance
    • Overview
        • Overview
        • OpenID Connect with Curity
        • OpenID Connect with Azure AD
        • OpenID Connect with Google
        • OpenID Connect with Okta
        • OpenID Connect with Auth0
        • OpenID Connect with Cognito
      • Authentication Reference
      • Allow Multiple Authentication Plugins
    • Rate Limiting Plugin
      • Add a Body Value
    • GraphQL
      • gRPC Plugins
      • Configure a gRPC service
    • Overview
    • Information Routes
    • Health Routes
    • Tags
    • Debug Routes
    • Services
    • Routes
    • Consumers
    • Plugins
    • Certificates
    • CA Certificates
    • SNIs
    • Upstreams
    • Targets
    • Vaults
    • Keys
    • Licenses
    • Workspaces
    • RBAC
    • Admins
    • Developers
    • Consumer Groups
    • Event Hooks
    • Keyring and Data Encryption
    • Audit Logs
    • kong.conf
    • Injecting Nginx Directives
    • CLI
    • File Permissions Reference
    • Key Management
    • Performance Testing Framework
    • Router Expressions Language
    • FAQ

github-edit-pageEdit this page

report-issueReport an issue

enterprise-switcher-iconSwitch to OSS

On this page
  • Prerequisites
  • Configure Kong Gateway to use AWS Secrets Manager
  • More information
Kong Gateway
3.1.x
  • Home
  • Kong Gateway
  • Kong Enterprise
  • Secrets Management
  • How To
  • Securing Kong Gateway database credentials with AWS Secrets Manager
You are browsing documentation for an outdated version. See the latest documentation here.

Securing Kong Gateway database credentials with AWS Secrets Manager

Application secrets include sensitive data like passwords, keys, certifications, tokens, and other items which must be secured. Kong Gateway supports Secrets Management which allows you to store secrets in various secure backend systems and helps you protect them from accidental exposure.

Traditionally, Kong Gateway is configured with static credentials for connecting to its external database. This guide will show you how to configure Kong Gateway to use AWS Secrets Manager to read database credentials securely instead the conventional file or environment variable based solutions.

For this guide, you will run the PostgreSQL and Kong Gateway locally on Docker. You will create a secret in the AWS Secrets Manager and deploy Kong Gateway using a vault reference to read the value securely.

Prerequisites

  • An AWS account. Your account must have the proper IAM permissions to allow access to the AWS Secrets Manager service. Permission policy examples can be found in the AWS Secrets Manager documentation. Additionally, you must have the following permissions:
    • secretsmanager:CreateSecret
    • secretsmanager:PutSecretValue
    • secretsmanager:GetSecretValue
  • The AWS CLI installed and configured. You must be able to configure the gateway environment with AWS CLI environment variables because this is the method that Kong Gateway uses to connect to the Secrets Manager service.

  • Docker installed.
  • curl is required on your system to send requests to the gateway for testing. Most systems come with curl pre-installed.

Configure Kong Gateway to use AWS Secrets Manager

  1. Create a Docker network for Kong Gateway and the database to communicate over:

    docker network create kong-net
    
  2. Configure and run the database:

    docker run -d --name kong-database \
      --network=kong-net \
      -p 5432:5432 \
      -e "POSTGRES_USER=admin" \
      -e "POSTGRES_PASSWORD=password" \
      postgres:9.6
    

    The username and password used above are the PostgreSQL master credentials, not the username and password you will use to authorize Kong Gateway with the database.

    Note: A production deployment can use AWS RDS for PostgreSQL which supports direct integration with AWS Secrets Manager.

  3. Create a username and password for Kong Gateway’s database and store them in environment variables to use in this guide:

    KONG_PG_USER=kong
    KONG_PG_PASSWORD=KongFTW
    
  4. Create the Kong Gateway database user inside the PostgreSQL server container:

    docker exec -it kong-database psql -U admin -c \
      "CREATE USER ${KONG_PG_USER} WITH PASSWORD '${KONG_PG_PASSWORD}'"
    

    You should see:

    CREATE ROLE
    
  5. Create a database named kong inside the PostgreSQL container:

    docker exec -it kong-database psql -U admin -c "CREATE DATABASE kong OWNER ${KONG_PG_USER};"
    

    You should see:

    CREATE DATABASE
    
  6. Create a new AWS secret:

    aws secretsmanager create-secret --name kong-gateway-database \
      --description "Kong GW Database credentials"
    
  7. Update the secret value with the username and password from the variables assigned above. If you want to update the secret values later, this is the command you would use:

    aws secretsmanager put-secret-value --secret-id kong-gateway-database \
      --secret-string '{"pg_user":"'${KONG_PG_USER}'","pg_password":"'${KONG_PG_PASSWORD}'"}'
    
  8. Before launching Kong Gateway, run the following command to perform the database migrations:

    Note: Currently, the kong migrations tool does not support Secrets Management, so this step must be done with traditional Kong Gateway configuration options. In this example, we are passing the secrets to Docker via the environment.

    docker run --rm \
      --network=kong-net \
      -e "KONG_DATABASE=postgres" \
      -e "KONG_PG_HOST=kong-database" \
      -e "KONG_PG_USER=$KONG_PG_USER" \
      -e "KONG_PG_PASSWORD=$KONG_PG_PASSWORD" \
      kong/kong-gateway:latest kong migrations bootstrap
    
  9. Launch Kong Gateway configured to use values it can reference for the database username and password. To authorize Kong Gateway to connect to AWS Secrets Manager, you need to provide IAM security credentials via environment variables.

    You specify the database credentials using the standard KONG_ environment variable names, but instead of providing a static value you use a reference value.

    The format looks like this: {vault://aws/kong-gateway-database/pg_user}. In this example, the reference format contains aws as the backend vault type, kong-gateway-database matches the name of the secret created earlier, and pg_user is the JSON field name you want to reference in the secret value.

    See the AWS Secrets Manager documentation for more details.

    Assuming you have set AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_REGION, and AWS_SESSION_TOKEN in the current environment, start Kong Gateway like this:

    docker run --rm \
      --network=kong-net \
      -e "KONG_DATABASE=postgres" \
      -e "KONG_PG_HOST=kong-database" \
      -e "AWS_ACCESS_KEY_ID" \
      -e "AWS_SECRET_ACCESS_KEY" \
      -e "AWS_REGION" \
      -e "AWS_SESSION_TOKEN" \
      -e "KONG_PG_USER={vault://aws/kong-gateway-database/pg_user}" \
      -e "KONG_PG_PASSWORD={vault://aws/kong-gateway-database/pg_password}" \
      kong/kong-gateway:3.1.x
    

    After a moment, Kong Gateway should be running, which you can verify with the Admin API:

    curl -s localhost:8001
    

    You should receive a JSON response with various information from Kong Gateway.

The Secrets Management documentation contains more information about available backends and configuration details.

More information

  • See the following documentation for supported vault backends that Kong Gateway can integrate with:
    • Environment Variables Vault
    • AWS Secrets Manager
    • Hashicorp Vault
    • Google Secrets Management
  • See Starting Kong Securely for more security practices with Kong Gateway
Thank you for your feedback.
Was this page useful?
  • Kong
    THE CLOUD CONNECTIVITY COMPANY

    Kong powers reliable digital connections across APIs, hybrid and multi-cloud environments.

    • Company
    • Customers
    • Events
    • Investors
    • Careers Hiring!
    • Partners
    • Press
    • Contact
  • Products
    • Kong Konnect
    • Kong Gateway
    • Kong Mesh
    • Get Started
    • Pricing
  • Resources
    • eBooks
    • Webinars
    • Briefs
    • Blog
    • API Gateway
    • Microservices
  • Open Source
    • Install Kong Gateway
    • Kong Community
    • Kubernetes Ingress
    • Kuma
    • Insomnia
  • Solutions
    • Decentralize
    • Secure & Govern
    • Create a Dev Platform
    • API Gateway
    • Kubernetes
    • Service Mesh
Star
  • Terms•Privacy
© Kong Inc. 2023