Skip to content

Latest commit

 

History

History
76 lines (70 loc) · 6.87 KB

INOUT.md

File metadata and controls

76 lines (70 loc) · 6.87 KB

Providers

Name Version
aws >= 2.42, < 4.0.0
consul >= 2.5
nomad >= 1.4
template >= 2.0

Inputs

Name Description Type Default Required
access_log_enable Enable access logging bool true no
access_log_json Log access in JSON bool false no
additional_docker_config Additional HCL to be added to the configuration for the Docker driver. Refer to the template Jobspec for what is already defined string "" no
deregistration_delay Time before an unhealthy Elastic Load Balancer target becomes removed number 60 no
elb_ssl_policy ELB SSL policy for HTTPs listeners. See https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html string "ELBSecurityPolicy-FS-1-2-Res-2020-10" no
external_certificate_arn ARN for the certificate to use for the external LB any n/a yes
external_drop_invalid_header_fields Set to true for external Nomad load balancer to drop invalid header fields bool true no
external_enable_http Set to true to enable external HTTP listener that redirects to HTTPS. Defaults to true bool true no
external_lb_incoming_cidr A list of CIDR-formatted IP address ranges from which the external Load balancer is allowed to listen to list(string) 
[
  "0.0.0.0/0"
]
 no
external_lb_name Name of the external Nomad load balancer string "traefik-external" no
external_nomad_clients_asg The Nomad Clients Autoscaling group to attach the external load balancer to any n/a yes
healthy_threshold The number of consecutive health checks successes required before considering an unhealthy target healthy (2-10). number 2 no
internal_certificate_arn ARN for the certificate to use for the internal LB any n/a yes
internal_drop_invalid_header_fields Set to true for internal Nomad load balancer to drop invalid header fields bool true no
internal_enable_http Set to true to enable internal HTTP listener that redirects to HTTPS. Defaults to true bool true no
internal_lb_incoming_cidr A list of CIDR-formatted IP address ranges from which the internal load balancer is allowed to listen to list(string) [] no
internal_lb_name Name of the external Nomad load balancer string "traefik-internal" no
internal_nomad_clients_asg The Nomad Clients Autoscaling group to attach the internal load balancer to any n/a yes
interval The approximate amount of time, in seconds, between health checks of an individual target. Minimum value 5 seconds, Maximum value 300 seconds. number 30 no
lb_external_access_log Log External Traefik LB access to a S3 bucket bool false no
lb_external_access_log_bucket S3 bucket to log access to the External Traefik LB to any n/a yes
lb_external_access_log_prefix Prefix in the S3 bucket to log External Traefik LB access string "" no
lb_external_subnets List of subnets to deploy the external LB to list(string) n/a yes
lb_internal_access_log Log internal Traefik LB access to a S3 bucket bool false no
lb_internal_access_log_bucket S3 bucket to log access to the internal Traefik LB to any n/a yes
lb_internal_access_log_prefix Prefix in the S3 bucket to log internal Traefik LB access string "" no
lb_internal_subnets List of subnets to deploy the internal LB to list(string) n/a yes
log_json Log in JSON format bool false no
nomad_clients_external_security_group The security group of the nomad clients that the external LB will be able to connect to any n/a yes
nomad_clients_internal_security_group The security group of the nomad clients that the internal LB will be able to connect to any n/a yes
nomad_clients_node_class Job constraint Nomad Client Node Class name any n/a yes
route53_zone Zone for Route 53 records any n/a yes
tags A map of tags to add to all resources map 
{
  "Environment": "development",
  "Terraform": "true"
}
 no
timeout The amount of time, in seconds, during which no response means a failed health check (2-60 seconds). number 5 no
traefik_consul_catalog_prefix Prefix for Consul catalog tags for Traefik string "traefik" no
traefik_consul_prefix Prefix on Consul to store Traefik configuration to string "traefik" no
traefik_count Number of copies of Traefik to run number 3 no
traefik_external_base_domain Domain to expose the external Traefik load balancer any n/a yes
traefik_internal_base_domain Domain to expose the external Traefik load balancer any n/a yes
traefik_priority Priority of the Nomad job for Traefik. See https://www.nomadproject.io/docs/job-specification/job.html#priority number 50 no
traefik_ui_domain Domain to access Traefik UI any n/a yes
traefik_version Docker image tag of the version of Traefik to run string "v1.7.12-alpine" no
unhealthy_threshold The number of consecutive health check failures required before considering a target unhealthy (2-10). number 2 no
vpc_id ID of the VPC to deploy the LB to any n/a yes

Outputs

Name Description
traefik_external_cname URL that applications should set a CNAME record to for Traefik reverse proxy
traefik_external_lb_dns URL that applications should set a CNAME or ALIAS record to the external LB directly
traefik_external_zone The canonical hosted zone ID of the external load balancer (to be used in a Route 53 Alias record).
traefik_internal_cname URL that applications should set a CNAME record to for Traefik reverse proxy
traefik_internal_lb_dns URL that applications should set a CNAME or ALIAS record to the internal LB directly
traefik_internal_zone The canonical hosted zone ID of the internal load balancer (to be used in a Route 53 Alias record).
traefik_jobspec Nomad Jobspec for the deployed Traefik reverse proxy
traefik_lb_external_arn ARN of the external load balancer
traefik_lb_external_https_listener_arn ARN of the HTTPS listener for the external load balancer
traefik_lb_external_security_group_id Security group ID for Traefik external LB
traefik_lb_internal_arn ARN of the internal load balancer
traefik_lb_internal_https_listener_arn ARN of the HTTPS listener for the internal load balancer
traefik_lb_internal_security_group_id Security group ID for Traefik internal LB