Tyk Demo

This repo provides an example installation of Tyk. It uses Docker Compose to provide a quick, simple deployment, where you can choose what features to include.

The concept is that there is a base deployment of Tyk, which gives you the usual Tyk components: Gateway, Dashboard, Pump, plus the databases Redis and MongoDB. This standard deployment can be extended by including additional feature deployments as needed. The feature deployments cover particular scenarios for Tyk, such as:

• Single sign on
• TLS
• Analytics export
• Tracking
• CI/CD
• 2nd Tyk Environment
• Instrumentation

Each feature deployment has its own directory, with the necessary files to deploy the feature and a readme to describe how to use it.

There is a focus on simplicity. Docker Compose is used to provision the containers, and bootstrap scripts are used to initialise the environment so that it is ready to use straight away - applying configuration and populating data.

See the Developer Guide for information on how to work with this repo.

Repository Structure

• deployments/*: Contains all the deployments available as sub-directories
• tyk_demo.postman_collection.json: A Postman collection of requests which correspond to APIs available in the deployment
• scripts/*.sh: Some useful commands encapsulated in scripts
• up.sh: Brings up the deployment
• down.sh: Takes down the deployment

Deployments

The deployment directories (deployments/*) contain the various deployments which can be made with this repo. The base deployment is in the deployments/tyk directory. The other directories are feature deployments, which extend the base deployment functionality and require the base deployment in order to function correctly.

All of the directories contain docker-compose.yml, bootstrap.sh and README.md files specific to the deployment. They may also contain directories called data or volumes, which hold the data necessary during bootstrapping or providing as mapped volumes into the container.

Getting Started

Step 1: Install dependencies

JQ

The bootstrap script uses JQ for extracting data from JSON object, it can be installed as follows.

Install on OS X using Homebrew:

brew install jq

Install on Debian/Ubuntu using APT:

sudo apt-get install jq

See the JQ installation page for other operating systems.

Step 2: Map Tyk hostnames to localhost IP

Update the /etc/hosts file to contain host entries for the Tyk Dashboard and Portal:

127.0.0.1   tyk-portal.localhost
127.0.0.1   tyk-dashboard.localhost

Step 3: Add Docker Environment variables

The tyk/docker-compose.yml and tyk2/docker-compose.yml files use a Docker environment variable to set the dashboard licence. To set this, create a file called .env in the root directory of the repo, then set the content of the file as follows, replacing <YOUR_LICENCE> with your Dashboard licence:

DASHBOARD_LICENCE=<YOUR_LICENCE>

In addition to this, some features require entries in the .env file. These are set automatically by the up.sh file, depending on the deployment parameters.

Step 4: Bring the deployment up

To bootstrap the system we will run the up.sh script, which will run the necessary docker-compose and bootstrap commands to start the containers and bootstrap the system.

./up.sh

This will bring up the standard Tyk deployment, after which you can log into the Dashboard and start using Tyk.

Deploying a feature

If you want to deploy features, run the up.sh command, passing a parameter of the directory name of the feature to deploy. For example, to deploy both the standard Tyk deployment and the analytics deployment:

./up.sh analytics

The feature names are the directory names from the deployments directory.

Deploying multiple features at the same time

Multiple features can be deployed at the same time by providing multiple feature parameters. For example, to deploy analytics and instrumentation:

./up.sh analytics instrumentation

Bootstrap logging

The bootstrap scripts provide feedback on progress in the bootstrap.log file.

Step 5: Log into the Dashboard

The bootstrap process provides credentials and other useful information in the terminal output. Check this output for the Dashboard credentials.

When you log into the Dashboard, you will find the imported APIs and Policies are now available.

Step 6: Import API requests into Postman

There is a Postman collection provided which compliments the imported API definitions and Policies. This lets you demonstrate Tyk features and functionality.

Import the tyk_demo.postman_collection.json into your Postman to start making requests.

Resetting

If you want to reset your environment then you need to remove the volumes associated with the container as well as the containers themselves. The down.sh script can do this for you. You do not need to declare which component to remove since the up.sh has already registered them in .bootstrap/bootstrapped_deployments so the down.sh will just read it and stop all those services.

To bring down the containers and delete associated volumes:

./down.sh

Redeploying

The up.sh script is not intended to be run consecutively without running down.sh in between. The reason for this is that the up.sh script assumes that the system will not contain any data, so it attempts to bootstrap the system by creating data. This means that running the script consecutively will likely generate errors and duplicate data.

Troubleshooting

1. Application error when opening the documentation in the portal

You will also see an error in the field that has the base64 encode of the OAS in the catalogue document. Since the value cannot be base64 decoded it means that the base64 encoding failed during bootstrap. One possible reason is that you are using Brew's base64 binary, since Brew's version inserts \r to the output rather than just output the base64 encoding as is. You can run whereis base64 to find out. The expected path should be /usr/bin/base64.