base-code-docs.md

Information

Providers

The following providers are used by this module:

• aws

• random

• tls

Required Inputs

The following input variables are required:

aws_acct_no

Description: Base AWS Account Number for the Project; e.g. 00000000000

Type: string

builder

Description: AWS UserID of the person who Ran the Terraform last.

Type: string

dns_zone

Description: Domain where the Project Lives; if prod just base domain, else; e.g. .<domain

Type: string

domain

Description: Base Domain on AWS; e.g. domain.tld

Type: string

host_cidr

Description: Classless Inter-Domain Routing; e.g. 10.1.0.0/16

Type: string

kubeNode_type

Description: Define Pod Size for Project; e.g. t2.micro

Type: string

minDistSize

Description: Minium Distribution size for Subnet, Cluster, and more..

Type: number

myCo

Description: Shortname of the Company; e.g. acme-co

Type: string

myProject

Description: Base Project Name; e.g. test

Type: string

projectType

Description: Unique Project Type; e.g. r-n-d

Type: string

region

Description: AWS Region the project will process in.

Type: string

twoOctets

Description: First two Octets for a CIDR; e.g. 10.25

Type: string

Optional Inputs

The following input variables are optional (have default values):

db_cloudwatch

Description: Cloudwatch Logs Exports

Type: list(string)

Default:

[
  "postgresql",
  "upgrade"
]

db_port

Description: Database Port

Type: number

Default: 5432

db_type

Description: AWS Database Type

Type: string

Default: "postgres"

db_verison

Description: Database Version

Type: string

Default: "11.6"

envBuild

Description: Build Environment; e.g. dev, stage or prod

Type: string

Default: "dev"

maxDistSize

Description: Maxium Distribution size for Subnet, Cluster, and more..

Type: number

Default: 6

project

Description: Unique Tag for the Project; e.g. --

Type: string

Default: "example"

subnet_count

Description: Distribution size for Subnet

Type: number

Default: 3

Outputs

The following outputs are exported:

cluster_ca_certificate

Description: The base64 encoded certificate data required to communicate with your cluster.

cluster_endpoint

Description: The endpoint for your Kubernetes API server.

cluster_token

Description: The token to use to authenticate with the cluster.

database_endpoint

Description: Database Endpoint

database_password

Description: Database Password

database_port

Description: Database Port

database_username

Description: Database Username

domain_zone_id

Description: Project Domain Zone ID

node_group_arn

Description: ARN for EKS Node Workers, used for SRE Auth via ConfigMap

ssl_cert_arn

Description: ACM Certificate ARN for SSL Cert Validation

vault_kms_key

Description: KMS Key value needed for Vault to Auto-Unseal

xdns_arn

Description: Role ARN for External DNS