Kong API Gateway Release Definition Template

A Screwdriver CD template that deploys an immutable instance of Kong API Gateway to AWS. It uses the screwdriver-template-main npm package to assist with template validation, publishing, and tagging. This template tags the latest versions with the latest tag.

Tip

Kong API gateway release definition template is a satellite project of hashicorp-aws and more documentation can be found in its dedicated page for Kong deployment support

How to Use This Template

Note

Before preceding, please note that it is assumed the template have already been installed in Screwdriver. If not, please see documentation on publishing a template in Screwdriver

Create a Screwdriver pipeline that uses this template with the screwdriver.yaml file of

---
jobs:
  main:
    requires: [~pr, ~commit]
    template: QubitPi/kong-api-gateway-release-definition-template@latest

The following Screwdriver CD Secrets needs to be defined before running the pipeline:

• AWS_ACCESS_KEY_ID
• AWS_SECRET_ACCESS_KEY
• SSL_CERTIFICATE - the content of SSL certificate file serving HTTPS-enabled DNS name of the EC2 hosting our Kong API Gateway instance. This is the same as the SSL_CERTIFICATE from the general SSL setup of hashicorp-aws
• SSL_CERTIFICATE_KEY - the content of SSL certificate key file serving HTTPS-enabled DNS name of the EC2 hosting our API Gateway instance. This is the same as the SSL_CERTIFICATE_KEY from the general SSL setup of hashicorp-aws

To run the pipeline, fill in the AWS-related parameters first

Then hit "Submit" to start deploying.

License

The use and distribution terms for Kong API gateway release definition template are covered by the Apache License, Version 2.0.