Skip to content

Latest commit

 

History

History
99 lines (75 loc) · 3.95 KB

README.md

File metadata and controls

99 lines (75 loc) · 3.95 KB
Raw

terraform-aws-polkadot-network

This module sets up VPCs and security groups for running validator and API nodes on polkadot.

Terraform versions

For Terraform v0.12.0+

Usage

module "this" {
  source = "github.com/geometry-labs/terraform-aws-polkadot-network"
  all_enabled          = true
}

Examples

Known issues

No issue is creating limit on this module.

Requirements

Name Version
terraform >= 0.12

Providers

Name Version
aws n/a

Modules

Name Source Version
api_node_sg github.com/terraform-aws-modules/terraform-aws-security-group.git?ref=v3.2.0
validator_sg github.com/terraform-aws-modules/terraform-aws-security-group.git?ref=v3.2.0
vpc github.com/terraform-aws-modules/terraform-aws-vpc.git?ref=v2.15.0

Resources

Name
aws_availability_zones
aws_region

Inputs

Name Description Type Default Required
all_enabled Bool to enable all the security groups bool false no
api_enabled Boolean to allow api related traffic bool false no
api_sg_name Name for the api security group string "api-sg" no
azs List of availability zones list(string) [] no
cidr The cidr range for network string "10.0.0.0/16" no
health_check_port Port number for the health check string "5501" no
id A unique identifier for the deployment string "" no
name The name of the deployment string "polkadot-api" no
network_name The network name, ie kusama / mainnet string "kusama" no
network_settings Map of network settings to apply. Use either this or set individual variables. 
map(object({
    name                = string
    shortname           = string
    api_health          = string
    polkadot_prometheus = string
    json_rpc            = string
    ws_rpc              = string
  }))
 null no
network_stub The stub name of the Polkadot chain (polkadot = polkadot, kusama = ksmcc3) string "ksmcc3" no
num_azs The number of AZs to deploy into number 0 no
polkadot_prometheus_port Port number for the Prometheus Metrics exporter built into the Polkadot client string "9610" no
rpc_api_port Port number for the JSON RPC API string "9934" no
ssh_enabled Boolean to enable a ssh access. All ssh traffic restricted to ssh_cidr_blocks bool false no
ssh_inbound_cidr_blocks The corporate IP you want to restrict ssh traffic to string "0.0.0.0/0" no
tags The tags of the deployment map(string) {} no
validator_enabled Boolean to allow validator related traffic bool false no
validator_sg_name Name for the validator security group string "validator-sg" no
vpc_name The name of the VPC string "" no
wss_api_port Port number for the Websockets API string "9945" no

Outputs

Name Description
api_security_group_id n/a
azs n/a
private_subnets n/a
private_subnets_cidr_blocks n/a
public_subnet_cidr_blocks n/a
public_subnets n/a
validator_security_group_id n/a
vpc_id #### VPC ####

Authors

Module managed by Geometry Labs

License

Apache 2 Licensed. See LICENSE for full details.