Merge remote-tracking branch 'origin/master' into MM-60675

config/deployer.sample.json

@@ -145,5 +145,7 @@
     "EnableAppProfiling": true,
     "EnableAgentProfiling": true,
     "BlockProfileRate": 0
+  },
+  "CustomTags": {
   }
 }

config/deployer.sample.toml

@@ -140,3 +140,5 @@ InstanceEngine = 'aurora-postgresql'
 InstanceType = 'db.r6g.large'
 Password = 'mostest80098bigpass_'
 UserName = 'mmuser'
+
+[CustomTags]

deployment/config.go

@@ -118,6 +118,21 @@ type Config struct {
 	StorageSizes StorageSizes
 	// EnableNetPeekMetrics enables fine grained networking metrics collection through netpeek utility.
 	EnableNetPeekMetrics bool `default:"false"`
+	// CustomTags is an optional list of key-value pairs, which will be used as default
+	// tags for all resources deployed
+	CustomTags TerraformMap
+}
+
+// TerraformMap is a map of string -> string that serializes to the format expected by
+// the Terraform AWS provider when formatted as a string
+type TerraformMap map[string]string
+
+func (t TerraformMap) String() string {
+	var pairs []string
+	for key, value := range t {
+		pairs = append(pairs, fmt.Sprintf("%s = %q", key, value))
+	}
+	return "{" + strings.Join(pairs, ", ") + "}"
 }
 
 type StorageSizes struct {

deployment/config_test.go

@@ -123,3 +123,40 @@ func TestValidateElasticSearchConfig(t *testing.T) {
 		require.NoError(t, cfg.validateElasticSearchConfig())
 	})
 }
+
+func TestTerraformMapString(t *testing.T) {
+	var nilMap TerraformMap
+	emptyMap := make(TerraformMap)
+
+	testCases := []struct {
+		actual   TerraformMap
+		expected string
+	}{
+		{
+			actual: TerraformMap{
+				"uno": "1",
+			},
+			expected: "{uno = \"1\"}",
+		},
+		{
+			actual: TerraformMap{
+				"uno": "1",
+				"dos": "2",
+			},
+			expected: "{uno = \"1\", dos = \"2\"}",
+		},
+		{
+			actual:   nilMap,
+			expected: "{}",
+		},
+		{
+			actual:   emptyMap,
+			expected: "{}",
+		},
+	}
+
+	for _, testCase := range testCases {
+		require.Equal(t, testCase.expected, testCase.actual.String())
+	}
+
+}

deployment/terraform/assets/cluster.tf

@@ -11,9 +11,12 @@ provider "aws" {
   region  = var.aws_region
   profile = var.aws_profile
   default_tags {
-    tags = {
-      ClusterName = var.cluster_name
-    }
+    tags = merge(
+      {
+        "ClusterName" = var.cluster_name
+      },
+      var.custom_tags
+    )
   }
 }
 
@@ -104,7 +107,7 @@ resource "aws_iam_role" "metrics_role" {
 }
 
 resource "aws_iam_instance_profile" "metrics_profile" {
-  name = "metrics_profile"
+  name = "${var.cluster_name}-metrics_profile"
   role = aws_iam_role.metrics_role.name
 }
 

deployment/terraform/assets/variables.tf

@@ -178,5 +178,9 @@ variable "aws_region" {
 variable "aws_ami" {
 }
 
+variable "custom_tags" {
+  type = map(string)
+}
+
 variable "aws_az" {
 }

deployment/terraform/utils.go

@@ -266,6 +266,7 @@ func (t *Terraform) getParams() []string {
 		"-var", fmt.Sprintf("redis_node_type=%s", t.config.RedisSettings.NodeType),
 		"-var", fmt.Sprintf("redis_param_group_name=%s", t.config.RedisSettings.ParameterGroupName),
 		"-var", fmt.Sprintf("redis_engine_version=%s", t.config.RedisSettings.EngineVersion),
+		"-var", fmt.Sprintf("custom_tags=%s", t.config.CustomTags),
 	}
 }
 

docs/config/deployer.md

@@ -522,3 +522,9 @@ Enable continuous profiling of all the agent instances.
 *int*
 
 Set the pprof block profile rate. This value applies to both agent and Mattermost server processes.
+
+## CustomTags
+
+*map[string]string*
+
+Optional map of key-value pairs, used to tag all deployed resources in AWS. Check [AWS documentation on tags](https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/what-are-tags.html) for more information and best practices.