aws

Tyk Dashboard on AWS Terraform module

Terraform module which creates AWS resources for Tyk Dashboard.

This module includes the following components:

• Security groups for LB and instances
• Application Load Balancer for dashboard instances, with target groups, listeners and health checks
• Launch configuration for dashboard instances based on latest Amazon Linux 2 AMI and official tyk-dashboard package
• Auto-scaling group that utilises the launch configuration and LB target groups for fault-tolerance and zero-downtime deployments
• Optional scaling policies based on LB target group latency

Usage

module "tyk_dashboard" {
  source = "modules/tyk-dashboard/aws"

  vpc_id                  = "vpc-a123f4da"
  instance_subnets        = ["subnet-012345c34d32a4ca9", "subnet-5432108982f9ca6c3"]
  lb_subnets              = ["subnet-1cfbde23", "subnet-326ab10e"]
  ssh_sg_id               = "sg-0f12c3fb044629789"
  key_name                = "ssh-key-name"
  redis_host              = "some.redis"
  redis_port              = "6379"
  redis_password          = "secret"
  mongo_url               = "mongodb://user:[email protected]:27017,cluster0-shard-00-01.mongo:27017,cluster0-shard-00-02.mongo:27017/tyk?replicaSet=Cluster0-shard-0"
  mongo_use_ssl           = "true"
  license_key             = "tyk license here"
  instance_type           = "t3.medium"
  min_size                = 2
  max_size                = 4
  create_scaling_policies = true
  port                    = "80"
  notifications_port      = "5000"
  dashboard_version       = "1.9.4"
  gateway_host            = "http://gw.host"
  gateway_port            = "80"
  gateway_secret          = "supersecret1"
  shared_node_secret      = "supersecret2"
  admin_secret            = "supersecret3"
  hostname                = "admin.host"
  api_hostname            = "gw.host"
  portal_root             = "/portal"
}

This example will create a launch configuration with tyk-dashboard-1.9.4 running on t3.medium instances in VPC subnets "subnet-012345c34d32a4ca9" and "subnet-5432108982f9ca6c3" accessible on port 80 (and 5000 for notifications), connected to Redis and MongoDB via specified configurations.

The auto-scaling group will have between 2 and 4 instances with default scaling policies created too.

The load balancer will be provisioned in VPC subnets "subnet-012345c34d32a4ca9" and "subnet-5432108982f9ca6c3".

Bootstrap

Please note that doing bootstrap through the GUI is not working at the moment and you will need to do the bootstrap manually. Instruction of how to do this can be found here: https://tyk.io/docs/tyk-dashboard-api/#creating-organisations-and-users. We have fix coming up in one of the next major releases, which will resolve the GUI bootstrap issue.

Inputs

Name	Description	Type	Default	Required
admin_secret	Tyk dashboard admin API secret	string	``	no
api_hostname	API hostname	string	``	no
certificate_arn	ARN of the TLS certificate resource in ACM (required if enable_https is true)	string	``	no
create_scaling_policies	Create scaling policies and alarm for autoscaling group	string	false	no
dashboard_config	Full dashboard config file contents (replaces the default config file if set)	string	``	no
dashboard_version	Version of Tyk dashboard to deploy	string	-	yes
enable_cloudwatch_policy	Enable CloudWatch agent IAM policy for the instance profile	string	false	no
enable_https	Enable HTTPS listener on the ALB	string	false	no
enable_ssm	Enable AWS Systems Manager	string	false	no
gateway_host	Tyk gateway host	string	``	no
gateway_port	Tyk gateway port	string	``	no
gateway_secret	Tyk gateway secret	string	``	no
hostname	Tyk dashboard hostname	string	``	no
https_port	HTTPS listener port	string	443	no
ingress_cidr	CIDR of ingress source	string	0.0.0.0/0	no
instance_subnets	List of subnets to use for instances	list	-	yes
instance_type	EC2 instance type	string	c5.large	no
key_name	EC2 key pair name	string	-	yes
lb_subnets	List of subnets to use for load balancing	list	-	yes
license_key	Tyk license	string	``	no
max_size	Maximum number of instance in autoscaling group	string	2	no
metrics_cloudconfig	Rendered cloud-init config for metrics and logs collection setup	string	``	no
min_size	Minimum number of instances in autoscaling group	string	1	no
mongo_url	MongoDB connection string	string	``	no
mongo_use_ssl	Should MongoDB connection use SSL/TLS?	string	``	no
package_repository	Repository name for the PackageCloud package	string	tyk-dashboard	no
port	HTTP port of the dashboard	string	80	no
portal_root	Tyk dashboard portal root path	string	``	no
redis_enable_cluster	Is Redis clustering enabled?	string	``	no
redis_host	Redis host	string	``	no
redis_hosts	Redis cluster connection parameters	string	``	no
redis_password	Redis password	string	``	no
redis_port	Redis port	string	``	no
shared_node_secret	Shared gateway-dashboard secret for API definitions	string	``	no
ssh_sg_id	Security group for SSH access	string	``	no
statsd_conn_str	Connection string for statsd instrumentation	string	``	no
statsd_prefix	Prefix for statsd metrics	string	tykDB	no
tls_policy	The name of the TLS policy for the listener (defaults to TLSv1.2 with modern cipher suite, modify for your needs)	string	ELBSecurityPolicy-TLS-1-2-2017-01	no
vpc_id	VPC to use for Tyk dashboard	string	-	yes

Outputs

Name	Description
asg_arn	ARN of the auto-scaling group
asg_name	Name of the auto-scaling group
dns_name	Domain name of the load balancer
instance_profile_name	Name of the IAM instance profile
instance_role_name	Name of the IAM instance role
lb_id	ID of the load balancer
lb_sg_id	ID of the load balancer security group
sg_id	ID of the instances security group
zone_id	ID of the load balancer domain zone