Table of Contents

Kong with Cassandra

This template will provision Kong instances in a new or existing VPC. You will need to provide the contact points of your Cassandra cluster during the deployment process.



Kong with PostgreSQL

This template will provision Kong instances in a new or existing VPC. You can provide your own PostgreSQL instance, or if not, the template will create one on AWS RDS for you.



Kong in DB-less mode

Provisions Kong resources in a new VPC or existing VPC.

Note: User would need to provide an S3 bucket location where kong.yml is stored with the declarative configuration to bootstrap all the Kong instances.



Use this cloud formation as a basis for your own, adjust the variables and template to better suit your needs.

Setup Instructions

  1. Initial Setup

    Create the required key pair to access your Kong instances. If you are providing your own Cassandra/PostgreSQL instances, make sure they are accessible from your Kong instances. If you want to create instances in an existing VPC, this VPC needs to have two public subnets, and all required ports open to allow access to the Kong Load Balancer.

    Continue to next step if you want to use an existing key pair

  2. Choose a Region & VM Type

    Choose the region closest to your API servers, and pick the virtualization type you’d like from the list of available templates above.

    You should land on AWS Cloud Formation “Select Template” page

  3. Parameters

    Fill-in all the parameters details. If you chose to launch Kong with PostgreSQL but without specifying your own PostgreSQL server, you will be asked to fill-in a few extra parameters to create a PostgreSQL RDS instance. Check the description of each field and provide the appropriate values.

    Note: consult the templates documentation on GitHub for detailed description of parameters

  4. Option page

    Add Tags and other fields according to your requirements.

    Note: The template is configured to add a “Name” tag to each relevant resource

  5. Template Documentation

    For more details on parameters and further configuration options, please consult the templates documentation on GitHub

  6. Grab a Coffee!

    It will take several minutes (~20 minutes) to create the stack. Once the stack has a status of CREATE_COMPLETE, click on the “Output” tab to get the Proxy and Admin URLs, it may take 60 more seconds for the links to become active.

    Note: To monitor the progress go to AWS CloudFormation console, select the stack in the list. In the stack details pane, click the “Events” tab to see the progress.

    Note: Check out the kong-dist-cloudformation repository for further details.
  7. Use Kong

    Quickly learn how to use Kong with the 5-minute Quickstart.

Having Trouble? We're here to help!