basic/basic_cluster_alb_ssl

A basic infrastructure for the Twitch Extension Sample which creates a Genvid cluster and required workers.

Important

The ALB SSL integration have two assumptions:

  1. The web backend is served on port 30000 of the public nodes and have a health check on /health.

  2. The leaf websocket is served on port 30001 of the public nodes and have a health check on /health.

Not all nodes need to run the services, but they will be discarded if not present.

Changed in version 1.26.0: removed variables public_subnets and private_subnets

Providers

  • aws (~> 3.35.0)

  • tls (~> 3.1.0)

Requirements

  • terraform >= 0.13

  • aws ~> 3.35.0

  • tls ~> 3.1.0

Inputs

bastionid (string)

ID of this bastion instance.

cluster (string)

Name of your cluster.

trusted_cidr (string)

CIDR to be trusted. This should at least contain the external CIDR (<ip>/32) for the local machine. Otherwise, the provisioning and access to Consul/Nomad will fail.

admin_password (string)

The administrator password for the Windows machine. The Windows machine is only accessible from the other server instances and from other machines that share the same external IP as yours [2].

Default: 1genvid6

ami_version (string)

Version prefix of the AMIs (both wingame and server) to use. For example, “1.20.0” will match both the 1.20.0 and 1.20.0.0 versions.

In order to use an AMI with a version suffix, the whole version with the suffix must be specified. (For example, 1.28.0.1.mysuffix.)

Default: 1.45.0

azs (list(string))

A list of availability zones to use in the region. An empty list selects all available zones.

Note

Changing the order of zones will result in the cluster being rebuilt. Appending to the list will not affect existing resources.

custom_tags (map(string))

Map of user defined tags to add to all cloud resources. [1] [4]

datacenter (string)

Consul/Nomad datacenter.

Default: default

domain_name (string)

Root domain name.

Default: acme.com

game_ami_owners (list(string))

The list of owners that can own the game AMI. Default to self.

New in version 1.30.0.

Default: [‘self’]

game_ami_prefix (string)

A common prefix for the game AMI. This is the prefix we use in the Save the AMI section. You can change it if you want to experiment with your own AMI. [5]

Default: default

instance_encoding_count (number)

Number of encoding workers to spawn.

Default: 1

instance_encoding_type (string)

Type of EC2 instance to use for encoding servers.

Default: c5.2xlarge

instance_game_count (number)

Number of game instances to spawn.

Default: 1

instance_game_type (string)

Type of EC2 instance to use for game servers.

Default: g5.xlarge

instance_internal_count (number)

Number of internal workers to spawn.

Default: 2

instance_internal_type (string)

Type of EC2 instance to use for internal servers.

Default: t3.small

instance_public_count (number)

Number of public workers to spawn.

Default: 1

instance_public_type (string)

Type of EC2 instance to use for public servers.

Default: t3.small

instance_server_count (number)

The number of supervisor servers. Must be an odd number. (Usually 3 for production deployment.)

Default: 1

instance_server_type (string)

Type of EC2 instance to use for admin servers.

Default: t3.small

leaf_port (number)

The port that Leaf service is running on.

Default: 30001

leaf_stickiness_ttl (number)

Sets the Leaf target group stickiness timeout.

Default: 600

leaf_tg_stickiness_enabled (bool)

Sets the Leaf target group stickiness to enabled or disabled.

Default: True

region (string)

AWS deployment region.

Default: us-east-1

server_ami_owners (list(string))

The list of owners that a valid AMI can have. Default to the Genvid public account.

New in version 1.30.0.

Default: [‘149754531711’]

server_ami_prefix (string)

A common prefix for the server AMI. You can change it if you want to experiment with your own AMI. [5]

Default: genvidtech

subdomain_name (string)

Use subdomain_name to create a zone in AWS. (For example, subdomain.acme.com.)

Note

The default value for subdomain_name is {bastionid}-{clustername} if nothing is provided.

Note

If changing or updating the subdomain on an existing cluster, you must manually remove the NS record for the old subdomain from the main domain in AWS Route53. The old NS record will not be automatically removed.

subnet_cidr_block_size (number)

Sets the size of the subnet CIDR blocks. Subnets span across availability zones. The total size of all the subnets must fit within the VPC’s CIDR block (10.0.0.0/16). This means that larger blocks could span fewer availability zones.

For example, size 18 could span 2 availability zones. Size 27 would be able to span 2048 availability zones.

Max size: 18

Min size: 27

Default: 27

toolbox_location (string)

Genvid Toolbox Wheel file.

Only required if you need to update the one from the AMI. An empty value indicates to not install the toolbox.

trusted_cidrs (list(string))

A list of CIDRs to be trusted.

trusted_security_groups (list(string))

A list of security groups to be trusted.

use_drive_encryption (bool)

Select true if you want to have encrypted EBS. If you don’t want to have encypted EBS or are upgrading the SDK version from 1.24.0 or below to 1.25.0 or higher, select false.

Warning

Your drives will be recreated if you toggle this feature with existing drives. Prior to 1.25, the drives were not encrypted. Starting with version 1.25 the encryption is enabled by default.

Default: True

web_health_check_path (string)

Health check endpoint path for Web service. It should match the path defined in the web.nomad.tmpl. [3]

Default: /health

web_port (number)

The port that Web service is running on.

Default: 30000

web_stickiness_ttl (number)

Setd the Web target group stickiness timeout.

Default: 600

web_tg_stickiness_enabled (bool)

Setd the Web target group stickiness to enabled or disabled.

Default: True

Outputs

ami_version

Version of the AMIs (both wingame and server) to use.

azs_available

List of availability zones that were detected as available to use.

azs_selected

List of availability zones that were selected to use.

cluster

Name of your cluster

consul_nodes

The Console node

datacenter

Consul/Nomad datacenter

domain_name

The domain name that you wish to create and associate with your cluster

encoding_worker_private_ips

The private IP addresses of the Encoding instance(s)

encoding_worker_public_ips

The public IP addresses of the Encoding instance(s)

endpoint_leaf

The endpoint URL of the leaf service

endpoint_web

The endpoint URL of the web service

game_instance_profile_name

The instance profile name used by the Game instance(s)

game_private_ips

The private IP addresses of the Game instance(s)

game_public_ips

The public IP addresses of the Game instance(s)

internal_worker_private_ips

The private IP addresses of the Internal instance(s)

internal_worker_public_ips

The public IP addresses of the Internal instance(s)

leaf_port

Port that Leaf is listening on.

private_key_pem

The private key that can be used to connect to the instances with SSH or RDP

private_subnets

A list of private subnets inside the VPC

public_key

The public key for connecting to the instances used by AWS for authentication

public_subnets

A list of public subnets inside the VPC

public_worker_private_ips

The private IP addresses of the Public instance(s)

public_worker_public_ips

The public IP addresses of the Public instance(s)

region

AWS deployment region

server_instance_profile_name

The instance profile name used by the Server, Encoding, Internal, and Public instances

server_private_ips

The private IP addresses of the Server instance(s)

server_public_ips

The public IP addresses of the Server instance(s)

subnet_ids

Specifies an ordered list of subnets that was used.

vpc_id_selected

The ID of the selected VPC

web_health_check_path

Health check endpoint path for Web service.

web_port

Port that Web Service is listening on.