This repository serves as a playground to help you experiment with Tyk Gateway. It includes a Docker Compose file that allows you to quickly set up Tyk Gateway and Redis. Additionally, the repository provides several example API definitions and plugins to showcase the gateway's capabilities and help you learn some of its features.
Click here to get up and running but please remember to revisit the next section later as it provides valuable yet concise insights on how to make the most of your time while using this repository and learning to know Tyk
These settings apply to any Tyk OSS deployment, for development as well as production environments.
- Redis - Tyk gateway requires a running Redis. To make an easy start this repo has a Docker Compose that spins up the gateway and Redis. If you use our
docker compose, the config of the gateway is already set up to connect to the Redis service. As soon as it's up the gateway is ready to use. - API definitions - This is the way to set Tyk Gateway to service your API. To quickly get from zero to a live API behind Tyk Gateway use the API definition examples under the ./apps directory.
- Gateway configurations -
tyk.confis set up appropriately and ready to use, including the API key to access/config the gateway via its APIs.
This repo has a few libraries that contain the file required to demo some of the Tyk gateway capabilities:
- This README - please continue reading it before anything else, it will get you up and running.
- ./get-started - this docs directory has instructions to create your first API, API key, first plugin etc.
- ./app/ - Store your API configurations inside local directory
./apps. You can also find in it example API definitions ready to use. - ./middleware/ - Store your plugins in this directory. For more information, Check JavaScript Middleware documentation. You can also find a Javascript example ready to use.
- ./cloud-plugin/ - Many times you wouldn't want to store your plugin in the gateway, for that you can also use a server to serve your plugins and the Tyk gateway will load them from that service. This directory explains how to do that when using Tyk cloud while the gateway is functioning as a Hybrid gateway.
- ./certs -
These settings apply to any Tyk OSS deployment, this one using Docker Compose as well as test and production environments.
- Redis - Tyk gateway requires a running Redis. To make an easy start this repo has a Docker Compose that spins up the gateway and Redis. If you use our
docker compose, the config of the gateway is already set up to connect to the Redis service. As soon as it's up the gateway is ready to use. - API definitions - This is the way to set Tyk Gateway to service your API. To quickly get from zero to a live API behind Tyk Gateway use the API definition examples under the ./apps directory.
- Gateway configurations -
tyk.confis set up appropriately and ready to use, including the API key to access/config the gateway via its APIs.
To spin up Tyk deployment - Please continue reading
In this section, you will spin up a full Tyk OSS Deployment Using Docker Compose
Before you start, please install the following binaries:
docker compose- An HTTP Client - There are lots of options in the market:
- Most common command line - curl
- For GUI users, the most common one is Postman
- For VS Code users, you can get any of these VSCode extensions).
- If you chose REST Client extention, then you can use our example file ./useful_api_calls.http to quickly get up and running.
- jq - Optional. If you are using a command line HTTP client like
curl,jqwill help you to beautify the returned JSON.
Use docker-compose.yml to spin up a Tyk OSS environment with one command. This will start two services, Tyk gateway and Redis use the following command
$ docker-compose up -dIn the example below we call the /hello endpoint using curl (you can use any HTTP client you want):
curl http://localhost:8080/hello -i
It returns the gateway's version and the connection status of Redis.
HTTP/1.1 200 OK
Content-Type: application/json
Date: Mon, 25 Jul 2022 19:16:45 GMT
Content-Length: 156
{
"status": "pass",
"version": "v3.2.1",
"description": "Tyk GW",
"details": {
"redis": {
"status": "pass",
"componentType": "datastore",
"time": "2022-07-25T19:16:16Z"
}
}
}
To get the list of APIs that Tyk gateway services, run the following:
curl http://localhost:8080/tyk/apis -H "X-Tyk-Authorization: foo"
or in VS Code in a some-file.http:
http://localhost:8080/tyk/apis
X-Tyk-Authorization: fooThe response is a JSON array of the API definitions.
To beautify the list, use jq:
curl http://localhost:8080/tyk/apis -H "X-Tyk-Authorization: foo" | jq .Notice that we used the API key (secret) to connect to the gateway.
/tyk/apis is the way to configure or check the configuration of Tyk Gateway via APIs and as such it must be protected so only you can connect it.
If you want to run docker (not docker compose), use these instructions.
For production, in which you use docker (not docker compose), check the instructions on our docs website.
To you want to build an image yourself please use this Dockerfile
Tyk Hybrid Gateway is the same Tyk OSS gateway but here it's connecting to a control plane layer (specifically to a component called MDCB). The control plane can be self-managed or via the SaaS offering on Tyk cloud. As such, this option can be used only by paying clients (including users that trial the paying option).
FYI Tyk cloud has also a Cloud Free plan but Hybrid gateways are not part of it.
To set up a Hybrid gateway/cluster of gateways, do the following:
- Change the following 3 values in the gateway config file (in this repo it is referred to as tyk.hybrid.conf:
"slave_options": {
"rpc_key": "<ORG_ID>",
"api_key": "<API-KEY>",
"connection_string": "<MDCB-INGRESS>:443",it should look like this:
"slave_options": {
"rpc_key": "j3jf8as9991ad881349",
"api_key": "adk12k9d891j48df824",
"connection_string": "persistent-bangalore-hyb.aws-usw2.cloud-ara.tyk.io:443",- Use the hybrid config file in
docker composeby mounting it into the Gateway indocker-compose.yml
Change from
- ./tyk.standalone.conf:/opt/tyk-gateway/tyk.confTo:
- ./tyk.hybrid.conf:/opt/tyk-gateway/tyk.confThat's it! Now run docker-compose up
PRs with new examples and fixes are most welcome. A contributor guide will be added in the future but for the time being, please explain your PR in the description and provide evidence for manual testing of the code.
First response (clarifying questions/guidance on improvements/answering questions) - Target: 48 hours Detailed review and feedback on PRs - Target: 7 days
We'd love to know about any bug or defect you find, no matter how small it is.
First response (clarifying questions/guidance on improvements/answering questions) - Target: 48 hours
We'd love to hear from you. Any feedback, idea or feature request is most welcomed.
First response (clarifying questions/guidance on improvements/answering questions) - Target: 72 hours
Add Tyk pump to the docker compose so we can stream analytics to a data sink.
For question on products, please use Tyk Community forum.
Clients can also use support@tyk.io.
Potential clients and evaluators, please use info@tyk.io.