Skip to content

Commit

Permalink
doc: input and output descriptions (#6)
Browse files Browse the repository at this point in the history
  • Loading branch information
jordan-acosta authored Mar 29, 2024
1 parent d150b78 commit fd6ec3e
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 4 deletions.
7 changes: 7 additions & 0 deletions outputs.tf
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ output "runner" {
value = {
odr_iam_role_arn = module.odr_iam_role.iam_role_arn
}
description = "A map of runner attributes: odr_iam_role_arn."
}

output "cluster" {
Expand All @@ -18,6 +19,7 @@ output "cluster" {
cluster_security_group_id = module.eks.cluster_security_group_id
node_security_group_id = module.eks.node_security_group_id
}
description = "A map of EKS cluster attributes: arn, certificate_authority_data, endpoint, name, platform_version, status, oidc_issuer_url, cluster_security_group_id, node_security_group_id."
}

output "vpc" {
Expand All @@ -36,13 +38,15 @@ output "vpc" {
public_subnet_ids = module.vpc.public_subnets
default_security_group_id = module.vpc.default_security_group_id
}
description = "A map of vpc attributes: name, id, cidr, azs, private_subnet_cidr_blocks, private_subnet_ids, public_subnet_cidr_blocks, public_subnet_ids, default_security_group_id."
}

output "account" {
value = {
id = data.aws_caller_identity.current.account_id
region = var.region
}
description = "A map of AWS account attributes: id, region."
}

output "ecr" {
Expand All @@ -53,6 +57,7 @@ output "ecr" {
registry_id = module.ecr.repository_registry_id
registry_url = "${data.aws_caller_identity.current.account_id}.dkr.ecr.${var.region}.amazonaws.com"
}
description = "A map of ECR attributes: repository_url, repository_arn, repository_name, registry_id, registry_url."
}

output "public_domain" {
Expand All @@ -61,6 +66,7 @@ output "public_domain" {
name = aws_route53_zone.public.name
zone_id = aws_route53_zone.public.id
}
description = "A map of public Route53 zone attributes: nameservers, name, zone_id."
}

output "internal_domain" {
Expand All @@ -69,4 +75,5 @@ output "internal_domain" {
name = aws_route53_zone.internal.name
zone_id = aws_route53_zone.internal.id
}
description = "A map of internal Route53 zone attributes: nameservers, name, zone_id."
}
8 changes: 4 additions & 4 deletions variables.tf
Original file line number Diff line number Diff line change
Expand Up @@ -86,23 +86,23 @@ variable "external_access_role_arns" {

variable "waypoint_odr_namespace" {
type = string
description = "Namespace that the ODR iam role's service account presides."
description = "Namespace in which the ODR IAM Role's service account presides."
}

variable "waypoint_odr_service_account_name" {
type = string
description = "Service account that the ODR iam role should be assumable from."
description = "Service account which the ODR IAM Role should be assumable from."
}

variable "public_root_domain" {
type = string
description = "public root domain."
description = "The public root domain."
}

// NOTE: if you would like to create an internal load balancer, with TLS, you will have to use the public domain.
variable "internal_root_domain" {
type = string
description = "internal root domain."
description = "The internal root domain."
}

variable "tags" {
Expand Down

0 comments on commit fd6ec3e

Please sign in to comment.