Skip to content

Commit

Permalink
chore: fix tag names so that they match recommended best practices (a…
Browse files Browse the repository at this point in the history
  • Loading branch information
jorisdon authored Oct 7, 2024
1 parent 7738dcd commit 4ac34a7
Show file tree
Hide file tree
Showing 16 changed files with 58 additions and 58 deletions.
12 changes: 6 additions & 6 deletions modules/jenkins/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@

| Name | Version |
|------|---------|
| <a name="provider_aws"></a> [aws](#provider\_aws) | 5.57.0 |
| <a name="provider_random"></a> [random](#provider\_random) | 3.6.2 |
| <a name="provider_aws"></a> [aws](#provider\_aws) | 5.69.0 |
| <a name="provider_random"></a> [random](#provider\_random) | 3.6.3 |

## Modules

Expand Down Expand Up @@ -92,9 +92,9 @@ No modules.

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| <a name="input_artifact_buckets"></a> [artifact\_buckets](#input\_artifact\_buckets) | List of Amazon S3 buckets you wish to create to store build farm artifacts. | <pre>map(<br> object({<br> name = string<br> enable_force_destroy = optional(bool, true)<br> enable_versioning = optional(bool, true)<br> tags = optional(map(string), {})<br> })<br> )</pre> | `null` | no |
| <a name="input_build_farm_compute"></a> [build\_farm\_compute](#input\_build\_farm\_compute) | Each object in this map corresponds to an ASG used by Jenkins as build agents. | <pre>map(object(<br> {<br> ami = string<br> #TODO: Support mixed instances / spot with custom policies<br> instance_type = string<br> ebs_optimized = optional(bool, true)<br> enable_monitoring = optional(bool, true)<br> }<br> ))</pre> | `{}` | no |
| <a name="input_build_farm_fsx_openzfs_storage"></a> [build\_farm\_fsx\_openzfs\_storage](#input\_build\_farm\_fsx\_openzfs\_storage) | Each object in this map corresponds to an FSx OpenZFS file system used by the Jenkins build agents. | <pre>map(object(<br> {<br> storage_capacity = number<br> throughput_capacity = number<br> storage_type = optional(string, "SSD") # "SSD", "HDD"<br> deployment_type = optional(string, "SINGLE_AZ_1")<br> route_table_ids = optional(list(string), null)<br> tags = optional(map(string), null)<br> }<br> ))</pre> | `{}` | no |
| <a name="input_artifact_buckets"></a> [artifact\_buckets](#input\_artifact\_buckets) | List of Amazon S3 buckets you wish to create to store build farm artifacts. | <pre>map(<br/> object({<br/> name = string<br/> enable_force_destroy = optional(bool, true)<br/> enable_versioning = optional(bool, true)<br/> tags = optional(map(string), {})<br/> })<br/> )</pre> | `null` | no |
| <a name="input_build_farm_compute"></a> [build\_farm\_compute](#input\_build\_farm\_compute) | Each object in this map corresponds to an ASG used by Jenkins as build agents. | <pre>map(object(<br/> {<br/> ami = string<br/> #TODO: Support mixed instances / spot with custom policies<br/> instance_type = string<br/> ebs_optimized = optional(bool, true)<br/> enable_monitoring = optional(bool, true)<br/> }<br/> ))</pre> | `{}` | no |
| <a name="input_build_farm_fsx_openzfs_storage"></a> [build\_farm\_fsx\_openzfs\_storage](#input\_build\_farm\_fsx\_openzfs\_storage) | Each object in this map corresponds to an FSx OpenZFS file system used by the Jenkins build agents. | <pre>map(object(<br/> {<br/> storage_capacity = number<br/> throughput_capacity = number<br/> storage_type = optional(string, "SSD") # "SSD", "HDD"<br/> deployment_type = optional(string, "SINGLE_AZ_1")<br/> route_table_ids = optional(list(string), null)<br/> tags = optional(map(string), null)<br/> }<br/> ))</pre> | `{}` | no |
| <a name="input_build_farm_subnets"></a> [build\_farm\_subnets](#input\_build\_farm\_subnets) | The subnets to deploy the build farms into. | `list(string)` | n/a | yes |
| <a name="input_certificate_arn"></a> [certificate\_arn](#input\_certificate\_arn) | The TLS certificate ARN for the Jenkins service load balancer. | `string` | n/a | yes |
| <a name="input_cluster_name"></a> [cluster\_name](#input\_cluster\_name) | The ARN of the cluster to deploy the Jenkins service into. Defaults to null and a cluster will be created. | `string` | `null` | no |
Expand Down Expand Up @@ -124,7 +124,7 @@ No modules.
| <a name="input_jenkins_service_subnets"></a> [jenkins\_service\_subnets](#input\_jenkins\_service\_subnets) | A list of subnets to deploy the Jenkins service into. Private subnets are recommended. | `list(string)` | n/a | yes |
| <a name="input_name"></a> [name](#input\_name) | The name attached to Jenkins module resources. | `string` | `"jenkins"` | no |
| <a name="input_project_prefix"></a> [project\_prefix](#input\_project\_prefix) | The project prefix for this workload. This is appeneded to the beginning of most resource names. | `string` | `"cgd"` | no |
| <a name="input_tags"></a> [tags](#input\_tags) | Tags to apply to resources. | `map(any)` | <pre>{<br> "IAC_MANAGEMENT": "CGD-Toolkit",<br> "IAC_MODULE": "Jenkins",<br> "IAC_PROVIDER": "Terraform"<br>}</pre> | no |
| <a name="input_tags"></a> [tags](#input\_tags) | Tags to apply to resources. | `map(any)` | <pre>{<br/> "iac-management": "CGD-Toolkit",<br/> "iac-module": "Jenkins",<br/> "iac-provider": "Terraform"<br/>}</pre> | no |
| <a name="input_vpc_id"></a> [vpc\_id](#input\_vpc\_id) | The ID of the existing VPC you would like to deploy the Jenkins service and build farms into. | `string` | n/a | yes |

## Outputs
Expand Down
2 changes: 1 addition & 1 deletion modules/jenkins/examples/complete/dns.tf
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ resource "aws_acm_certificate" "jenkins" {
validation_method = "DNS"

tags = {
Environment = "dev"
environment = "dev"
}

lifecycle {
Expand Down
2 changes: 1 addition & 1 deletion modules/jenkins/local.tf
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ locals {
name_prefix = "${var.project_prefix}-${var.name}"

tags = merge(var.tags, {
"ENVIRONMENT" = var.environment
"environment" = var.environment
})
}
2 changes: 1 addition & 1 deletion modules/jenkins/s3.tf
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ resource "aws_s3_bucket" "artifact_buckets" {

tags = merge(
{
"ENVIRONMENT" = var.environment
"environment" = var.environment
},
each.value.tags,
)
Expand Down
6 changes: 3 additions & 3 deletions modules/jenkins/variables.tf
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ variable "environment" {
variable "tags" {
type = map(any)
default = {
"IAC_MANAGEMENT" = "CGD-Toolkit"
"IAC_MODULE" = "Jenkins"
"IAC_PROVIDER" = "Terraform"
"iac-management" = "CGD-Toolkit"
"iac-module" = "Jenkins"
"iac-provider" = "Terraform"
}
description = "Tags to apply to resources."
}
Expand Down
2 changes: 1 addition & 1 deletion modules/perforce/examples/complete/dns.tf
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ resource "aws_acm_certificate" "helix" {
validation_method = "DNS"

tags = {
Environment = "dev"
environment = "dev"
}

lifecycle {
Expand Down
2 changes: 1 addition & 1 deletion modules/perforce/helix-authentication-service/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ No modules.
| <a name="input_internal"></a> [internal](#input\_internal) | Set this flag to true if you do not want the Helix Authentication Service load balancer to have a public IP. | `bool` | `false` | no |
| <a name="input_name"></a> [name](#input\_name) | The name attached to Helix Authentication Service module resources. | `string` | `"helix-auth-svc"` | no |
| <a name="input_project_prefix"></a> [project\_prefix](#input\_project\_prefix) | The project prefix for this workload. This is appeneded to the beginning of most resource names. | `string` | `"cgd"` | no |
| <a name="input_tags"></a> [tags](#input\_tags) | Tags to apply to resources. | `map(any)` | <pre>{<br> "IAC_MANAGEMENT": "CGD-Toolkit",<br> "IAC_MODULE": "helix-authentication-service",<br> "IAC_PROVIDER": "Terraform"<br>}</pre> | no |
| <a name="input_tags"></a> [tags](#input\_tags) | Tags to apply to resources. | `map(any)` | <pre>{<br/> "iac-management": "CGD-Toolkit",<br/> "iac-module": "helix-authentication-service",<br/> "iac-provider": "Terraform"<br/>}</pre> | no |
| <a name="input_vpc_id"></a> [vpc\_id](#input\_vpc\_id) | The ID of the existing VPC you would like to deploy Helix Authentication Service into. | `string` | n/a | yes |

## Outputs
Expand Down
6 changes: 3 additions & 3 deletions modules/perforce/helix-authentication-service/variables.tf
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ variable "environment" {
variable "tags" {
type = map(any)
default = {
"IAC_MANAGEMENT" = "CGD-Toolkit"
"IAC_MODULE" = "helix-authentication-service"
"IAC_PROVIDER" = "Terraform"
"iac-management" = "CGD-Toolkit"
"iac-module" = "helix-authentication-service"
"iac-provider" = "Terraform"
}
description = "Tags to apply to resources."
}
Expand Down
50 changes: 25 additions & 25 deletions modules/perforce/helix-core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,17 @@
| Name | Version |
|------|---------|
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0 |
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | 5.68.0 |
| <a name="requirement_awscc"></a> [awscc](#requirement\_awscc) | 1.15.0 |
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | 5.69.0 |
| <a name="requirement_awscc"></a> [awscc](#requirement\_awscc) | 1.16.1 |
| <a name="requirement_random"></a> [random](#requirement\_random) | 3.6.3 |

## Providers

| Name | Version |
|------|---------|
| <a name="provider_aws"></a> [aws](#provider\_aws) | 5.59.0 |
| <a name="provider_awscc"></a> [awscc](#provider\_awscc) | 1.6.0 |
| <a name="provider_random"></a> [random](#provider\_random) | 3.6.2 |
| <a name="provider_aws"></a> [aws](#provider\_aws) | 5.69.0 |
| <a name="provider_awscc"></a> [awscc](#provider\_awscc) | 1.16.1 |
| <a name="provider_random"></a> [random](#provider\_random) | 3.6.3 |

## Modules

Expand All @@ -26,26 +26,26 @@ No modules.

| Name | Type |
|------|------|
| [aws_ebs_volume.depot](https://registry.terraform.io/providers/hashicorp/aws/5.68.0/docs/resources/ebs_volume) | resource |
| [aws_ebs_volume.logs](https://registry.terraform.io/providers/hashicorp/aws/5.68.0/docs/resources/ebs_volume) | resource |
| [aws_ebs_volume.metadata](https://registry.terraform.io/providers/hashicorp/aws/5.68.0/docs/resources/ebs_volume) | resource |
| [aws_eip.helix_core_eip](https://registry.terraform.io/providers/hashicorp/aws/5.68.0/docs/resources/eip) | resource |
| [aws_iam_instance_profile.helix_core_instance_profile](https://registry.terraform.io/providers/hashicorp/aws/5.68.0/docs/resources/iam_instance_profile) | resource |
| [aws_iam_policy.helix_core_default_policy](https://registry.terraform.io/providers/hashicorp/aws/5.68.0/docs/resources/iam_policy) | resource |
| [aws_iam_role.helix_core_default_role](https://registry.terraform.io/providers/hashicorp/aws/5.68.0/docs/resources/iam_role) | resource |
| [aws_instance.helix_core_instance](https://registry.terraform.io/providers/hashicorp/aws/5.68.0/docs/resources/instance) | resource |
| [aws_security_group.helix_core_security_group](https://registry.terraform.io/providers/hashicorp/aws/5.68.0/docs/resources/security_group) | resource |
| [aws_volume_attachment.depot_attachment](https://registry.terraform.io/providers/hashicorp/aws/5.68.0/docs/resources/volume_attachment) | resource |
| [aws_volume_attachment.logs_attachment](https://registry.terraform.io/providers/hashicorp/aws/5.68.0/docs/resources/volume_attachment) | resource |
| [aws_volume_attachment.metadata_attachment](https://registry.terraform.io/providers/hashicorp/aws/5.68.0/docs/resources/volume_attachment) | resource |
| [aws_vpc_security_group_egress_rule.helix_core_internet](https://registry.terraform.io/providers/hashicorp/aws/5.68.0/docs/resources/vpc_security_group_egress_rule) | resource |
| [awscc_secretsmanager_secret.helix_core_super_user_password](https://registry.terraform.io/providers/hashicorp/awscc/1.15.0/docs/resources/secretsmanager_secret) | resource |
| [awscc_secretsmanager_secret.helix_core_super_user_username](https://registry.terraform.io/providers/hashicorp/awscc/1.15.0/docs/resources/secretsmanager_secret) | resource |
| [aws_ebs_volume.depot](https://registry.terraform.io/providers/hashicorp/aws/5.69.0/docs/resources/ebs_volume) | resource |
| [aws_ebs_volume.logs](https://registry.terraform.io/providers/hashicorp/aws/5.69.0/docs/resources/ebs_volume) | resource |
| [aws_ebs_volume.metadata](https://registry.terraform.io/providers/hashicorp/aws/5.69.0/docs/resources/ebs_volume) | resource |
| [aws_eip.helix_core_eip](https://registry.terraform.io/providers/hashicorp/aws/5.69.0/docs/resources/eip) | resource |
| [aws_iam_instance_profile.helix_core_instance_profile](https://registry.terraform.io/providers/hashicorp/aws/5.69.0/docs/resources/iam_instance_profile) | resource |
| [aws_iam_policy.helix_core_default_policy](https://registry.terraform.io/providers/hashicorp/aws/5.69.0/docs/resources/iam_policy) | resource |
| [aws_iam_role.helix_core_default_role](https://registry.terraform.io/providers/hashicorp/aws/5.69.0/docs/resources/iam_role) | resource |
| [aws_instance.helix_core_instance](https://registry.terraform.io/providers/hashicorp/aws/5.69.0/docs/resources/instance) | resource |
| [aws_security_group.helix_core_security_group](https://registry.terraform.io/providers/hashicorp/aws/5.69.0/docs/resources/security_group) | resource |
| [aws_volume_attachment.depot_attachment](https://registry.terraform.io/providers/hashicorp/aws/5.69.0/docs/resources/volume_attachment) | resource |
| [aws_volume_attachment.logs_attachment](https://registry.terraform.io/providers/hashicorp/aws/5.69.0/docs/resources/volume_attachment) | resource |
| [aws_volume_attachment.metadata_attachment](https://registry.terraform.io/providers/hashicorp/aws/5.69.0/docs/resources/volume_attachment) | resource |
| [aws_vpc_security_group_egress_rule.helix_core_internet](https://registry.terraform.io/providers/hashicorp/aws/5.69.0/docs/resources/vpc_security_group_egress_rule) | resource |
| [awscc_secretsmanager_secret.helix_core_super_user_password](https://registry.terraform.io/providers/hashicorp/awscc/1.16.1/docs/resources/secretsmanager_secret) | resource |
| [awscc_secretsmanager_secret.helix_core_super_user_username](https://registry.terraform.io/providers/hashicorp/awscc/1.16.1/docs/resources/secretsmanager_secret) | resource |
| [random_string.helix_core](https://registry.terraform.io/providers/hashicorp/random/3.6.3/docs/resources/string) | resource |
| [aws_ami.helix_core_ami](https://registry.terraform.io/providers/hashicorp/aws/5.68.0/docs/data-sources/ami) | data source |
| [aws_iam_policy_document.ec2_trust_relationship](https://registry.terraform.io/providers/hashicorp/aws/5.68.0/docs/data-sources/iam_policy_document) | data source |
| [aws_iam_policy_document.helix_core_default_policy](https://registry.terraform.io/providers/hashicorp/aws/5.68.0/docs/data-sources/iam_policy_document) | data source |
| [aws_subnet.instance_subnet](https://registry.terraform.io/providers/hashicorp/aws/5.68.0/docs/data-sources/subnet) | data source |
| [aws_ami.helix_core_ami](https://registry.terraform.io/providers/hashicorp/aws/5.69.0/docs/data-sources/ami) | data source |
| [aws_iam_policy_document.ec2_trust_relationship](https://registry.terraform.io/providers/hashicorp/aws/5.69.0/docs/data-sources/iam_policy_document) | data source |
| [aws_iam_policy_document.helix_core_default_policy](https://registry.terraform.io/providers/hashicorp/aws/5.69.0/docs/data-sources/iam_policy_document) | data source |
| [aws_subnet.instance_subnet](https://registry.terraform.io/providers/hashicorp/aws/5.69.0/docs/data-sources/subnet) | data source |

## Inputs

Expand All @@ -72,7 +72,7 @@ No modules.
| <a name="input_project_prefix"></a> [project\_prefix](#input\_project\_prefix) | The project prefix for this workload. This is appeneded to the beginning of most resource names. | `string` | `"cgd"` | no |
| <a name="input_server_type"></a> [server\_type](#input\_server\_type) | The Perforce Helix Core server type. | `string` | n/a | yes |
| <a name="input_storage_type"></a> [storage\_type](#input\_storage\_type) | The type of backing store [EBS, FSxZ] | `string` | n/a | yes |
| <a name="input_tags"></a> [tags](#input\_tags) | Tags to apply to resources. | `map(any)` | <pre>{<br> "IAC_MANAGEMENT": "CGD-Toolkit",<br> "IAC_MODULE": "helix-core",<br> "IAC_PROVIDER": "Terraform"<br>}</pre> | no |
| <a name="input_tags"></a> [tags](#input\_tags) | Tags to apply to resources. | `map(any)` | <pre>{<br/> "iac-management": "CGD-Toolkit",<br/> "iac-module": "helix-core",<br/> "iac-provider": "Terraform"<br/>}</pre> | no |
| <a name="input_vpc_id"></a> [vpc\_id](#input\_vpc\_id) | The VPC where Helix Core should be deployed | `string` | n/a | yes |

## Outputs
Expand Down
6 changes: 3 additions & 3 deletions modules/perforce/helix-core/variables.tf
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ variable "environment" {
variable "tags" {
type = map(any)
default = {
"IAC_MANAGEMENT" = "CGD-Toolkit"
"IAC_MODULE" = "helix-core"
"IAC_PROVIDER" = "Terraform"
"iac-management" = "CGD-Toolkit"
"iac-module" = "helix-core"
"iac-provider" = "Terraform"
}
description = "Tags to apply to resources."
}
Expand Down
4 changes: 2 additions & 2 deletions modules/perforce/helix-swarm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ No modules.
| <a name="input_enable_helix_swarm_alb_deletion_protection"></a> [enable\_helix\_swarm\_alb\_deletion\_protection](#input\_enable\_helix\_swarm\_alb\_deletion\_protection) | Enables deletion protection for the Helix Swarm ALB. Defaults to true. | `bool` | `true` | no |
| <a name="input_enable_sso"></a> [enable\_sso](#input\_enable\_sso) | Set this to true if using SSO for Helix Swarm authentication. | `bool` | `false` | no |
| <a name="input_environment"></a> [environment](#input\_environment) | The current environment (e.g. dev, prod, etc.) | `string` | `"dev"` | no |
| <a name="input_existing_redis_connection"></a> [existing\_redis\_connection](#input\_existing\_redis\_connection) | The connection specifications to use for an existing Redis deployment. | <pre>object({<br> host = string<br> port = number<br> })</pre> | `null` | no |
| <a name="input_existing_redis_connection"></a> [existing\_redis\_connection](#input\_existing\_redis\_connection) | The connection specifications to use for an existing Redis deployment. | <pre>object({<br/> host = string<br/> port = number<br/> })</pre> | `null` | no |
| <a name="input_existing_security_groups"></a> [existing\_security\_groups](#input\_existing\_security\_groups) | A list of existing security group IDs to attach to the Helix Swarm service load balancer. | `list(string)` | `[]` | no |
| <a name="input_fully_qualified_domain_name"></a> [fully\_qualified\_domain\_name](#input\_fully\_qualified\_domain\_name) | The fully qualified domain name that Swarm should use for internal URLs. | `string` | `null` | no |
| <a name="input_helix_swarm_alb_access_logs_bucket"></a> [helix\_swarm\_alb\_access\_logs\_bucket](#input\_helix\_swarm\_alb\_access\_logs\_bucket) | ID of the S3 bucket for Helix Swarm ALB access log storage. If access logging is enabled and this is null the module creates a bucket. | `string` | `null` | no |
Expand All @@ -98,7 +98,7 @@ No modules.
| <a name="input_p4d_swarm_password_arn"></a> [p4d\_swarm\_password\_arn](#input\_p4d\_swarm\_password\_arn) | The ARN of the parameter or secret where the swarm user password is stored. | `string` | n/a | yes |
| <a name="input_p4d_swarm_user_arn"></a> [p4d\_swarm\_user\_arn](#input\_p4d\_swarm\_user\_arn) | The ARN of the parameter or secret where the swarm user username is stored. | `string` | n/a | yes |
| <a name="input_project_prefix"></a> [project\_prefix](#input\_project\_prefix) | The project prefix for this workload. This is appeneded to the beginning of most resource names. | `string` | `"cgd"` | no |
| <a name="input_tags"></a> [tags](#input\_tags) | Tags to apply to resources. | `map(any)` | <pre>{<br> "IAC_MANAGEMENT": "CGD-Toolkit",<br> "IAC_MODULE": "swarm",<br> "IAC_PROVIDER": "Terraform"<br>}</pre> | no |
| <a name="input_tags"></a> [tags](#input\_tags) | Tags to apply to resources. | `map(any)` | <pre>{<br/> "iac-management": "CGD-Toolkit",<br/> "iac-module": "swarm",<br/> "iac-provider": "Terraform"<br/>}</pre> | no |
| <a name="input_vpc_id"></a> [vpc\_id](#input\_vpc\_id) | The ID of the existing VPC you would like to deploy swarm into. | `string` | n/a | yes |

## Outputs
Expand Down
6 changes: 3 additions & 3 deletions modules/perforce/helix-swarm/variables.tf
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ variable "environment" {
variable "tags" {
type = map(any)
default = {
"IAC_MANAGEMENT" = "CGD-Toolkit"
"IAC_MODULE" = "swarm"
"IAC_PROVIDER" = "Terraform"
"iac-management" = "CGD-Toolkit"
"iac-module" = "swarm"
"iac-provider" = "Terraform"
}
description = "Tags to apply to resources."
}
Expand Down
Loading

0 comments on commit 4ac34a7

Please sign in to comment.