Quick Start in Kubernetes
The tyk-k8s-demo library allows you
to stand up an entire Tyk Stack with all its dependencies as well as other tools that can integrate with Tyk.
The library will spin up everything in Kubernetes using
helm and bash magic to get you started.
Minimize the amount of effort needed to stand up the Tyk infrastructure and show examples of how Tyk can be setup in k8s using different deployment architectures as well as different integrations.
You will need the following tools to be able to run this library.
Tested on Linux/Unix based systems on AMD64 and ARM architectures
.env file and update the appropriate fields with your licenses. If you require a trial license you can obtain one
here. If you are looking to use the
tyk-gateway deployment only you will not require any licensing
as that is the open source deployment.
git clone https://github.com/TykTechnologies/tyk-k8s-demo.git cd tyk-k8s-demo cp .env.example .env
Depending on the deployments you would like install set values of the
PORTAL_LICENSE inside the
If you are deploying this on Minikube, you will need to enable the ingress addon. You do so by running the following:
minikube start minikube addons enable ingress
./up.sh --deployments portal,operator-httpbin tyk-stack
This quick start command will stand up the entire Tyk stack along with the Tyk Enterprise Portal and the Tyk Operator and httpbin CRD example.
tyk-stack: Tyk single region self-managed deployment
tyk-cp: Tyk self-managed multi region control plane
tyk-dp: Tyk self-managed data plane, this can connect to Tyk Cloud or a Tyk Control Plane
tyk-gateway: Tyk oss self-managed single region
redis: Bitnami Redis deployment
redis-cluster: Bitnami Redis Cluster deployment
redis-sentinel: Bitnami Redis Sentinel deployment
mongo: Bitnami Mongo database deployment as a Tyk backend
postgres: Bitnami Postgres database deployment as a Tyk backend
Please see this page for Tyk deployments compatibility charts.
- Datadog: connects tyk deployments analytics and logs to datadog.
- Elasticsearch: connects tyk deployments analytics to elasticsearch.
- Kibana: connects a Kibana installment to the elasticsearch deployment.
- k6: generates a load of traffic to seed analytical data.
- SLO Traffic: generates a load of traffic to seed analytical data.
- Keycloak: stands up a keycloak deployment.
- Operator: this deployment option will install the Tyk Operator and its dependency cert-manager.
- HttpBin: creates API examples using the tyk-operator.
- GraphQL: creates GraphQL API examples using the tyk-operator.
- Universal Data Graph: creates Universal Data Graph API examples using the tyk-operator.
- Federation v1: creates Federation v1 API examples using the tyk-operator.
- Portal: this deployment will install the Tyk Enterprise Developer Portal as well as its dependency PostgreSQL.
- Prometheus: this deployment will stand up a Tyk Prometheus pump with custom analytics.
- Grafana: connects a Grafana installment to the Prometheus deployment.
If you are running a POC and would like an example of how to integrate a specific tool. Please submit a request through the repository here.
./up.sh \ --storage postgres \ --deployments prometheus-grafana \ tyk-stack
The deployment will take 10 minutes as the installation is sequential and the dependencies require a bit of time before they are stood up. Once the installation is complete, the script will print out a list of all the services that were stood up and how those can be accessed. The k6s job will start running after the script is finished and will run in the background for 15 minutes to generate traffic over that period of time. To visualize the live traffic, you can use the credentials provided by the script to access Grafana or the Tyk Dashboard.
Start Tyk deployment
Create and start up the deployments
Usage: ./up.sh [flags] [command] Available Commands: tyk-stack tyk-cp tyk-dp tyk-gateway Flags: -v, --verbose bool set log level to debug --dry-run bool set the execution mode to dry run. This will dump the kubectl and helm commands rather than execute them -n, --namespace string namespace the tyk stack will be installed in, defaults to 'tyk' -f, --flavor enum k8s environment flavor. This option can be set 'openshift' and defaults to 'vanilla' -e, --expose enum set this option to 'port-forward' to expose the services as port-forwards or to 'load-balancer' to expose the services as load balancers or 'ingress' which exposes services as a k8s ingress object. Defaults to 'port-forward' -r, --redis enum the redis mode that tyk stack will use. This option can be set 'redis', 'redis-sentinel' and defaults to 'redis-cluster' -s, --storage enum database the tyk stack will use. This option can be set 'mongo' and defaults to 'postgres' -d, --deployments string comma separated list of deployments to launch -c, --cloud enum stand up k8s infrastructure in 'aws', 'gcp' or 'azure'. This will require Terraform and the CLIs associate with the cloud of choice
Stop Tyk deployment
Usage: ./down.sh [flags] Flags: -v, --verbose bool set log level to debug -n, --namespace string namespace the tyk stack will be installed in, defaults to 'tyk' -p, --ports bool disconnect port connections only -c, --cloud enum tear down k8s cluster stood up
You can get the library to create demo clusters for you on AWS, GCP, or Azure. That can be set using the
and requires the respective cloud CLI to be installed and authorized on your system. You will also need to specify the
GCP_PROJECT (for GCP only) parameters in the .env file.
You can find examples of .env files here:
For more information about cloud CLIs:
GOOGLE_APPLICATION_CREDENTIALSenvironment variable per google’s documentation
This library can also act as a guide to help you get set up with Tyk. If you just want to know how to set up a specific
tool with Tyk, you can run the library with the
--verbose flags. This will output all the commands that
the library will run to stand up any installation. This can be helpful for debugging as well as figuring out what
configuration options are required to set these tools up.
Furthermore, you can also add any Tyk environment variables to your
.env file and those variables will be mapped to
their respective Tyk deployments.
... TYK_MDCB_SYNCWORKER_ENABLED=true TYK_MDCB_SYNCWORKER_HASHKEYS=true TYK_GW_SLAVEOPTIONS_SYNCHRONISERENABLED=true
The script has defaults for minimal settings in this env file,
and it will give errors if something is missing.
You can also add or change any Tyk environments variables in the
and they will be mapped to the respective
extraEnvs section in the helm charts.
||Path to charts, can be a local directory or a helm repo|
||Default password for all the services deployed|
||Default password for all the services deployed|
|TYK_WORKER_CONNECTIONSTRING||MDCB URL for worker connection|
|TYK_WORKER_ORGID||Org ID of dashboard user|
|TYK_WORKER_AUTHTOKEN||Auth token of dashboard user|
|TYK_WORKER_SHARDING_TAGS||API Gateway segmentation tags|
||Set the gateway service port to use|
|DATADOG_APIKEY||Datadog API key|
|DATADOG_APPKEY||Datadog Application key. This is used to create a dashboard and create a pipeline for the Tyk logs|
||Datadog site. Change to
|GCP_PROJECT||The GCP project for terraform authentication on GCP|
|CLUSTER_LOCATION||Cluster location that will be created on AKS, EKS, or GKE|
|CLUSTER_MACHINE_TYPE||Machine type for the cluster that will be created on AKS, EKS, or GKE|
|CLUSTER_NODE_COUNT||Number of nodes for the cluster that will be created on AKS, EKS, or GKE|