[MM-61281] allow customizable public ip allocation (#868)

* feat: allow customizable public ip allocation

* chore: update sample files with new field

config/deployer.sample.json

@@ -22,6 +22,7 @@
   "MetricsInstanceType": "t3.xlarge",
   "AgentInstanceCount": 2,
   "AgentInstanceType": "c7i.xlarge",
+  "AgentAllocatePublicIPAddress": true,
   "ElasticSearchSettings": {
     "InstanceCount": 0,
     "InstanceType": "r6g.large.search",
@@ -48,6 +49,7 @@
   "EnableAgentFullLogs": true,
   "ProxyInstanceCount": 1,
   "ProxyInstanceType": "c7i.xlarge",
+  "ProxyAllocatePublicIPAddress": true,
   "SSHPublicKey": "~/.ssh/id_rsa.pub",
   "TerraformStateDir" : "/var/lib/mattermost-load-test-ng",
   "S3BucketDumpURI" : "",

config/deployer.sample.toml

@@ -19,6 +19,7 @@ EnableNetPeekMetrics = false
 AgentInstanceCount = 2
 AgentInstanceType = 'c5.xlarge'
 EnableAgentFullLogs = true
+AgentAllocatePublicIPAddress = true
 
 # App servers configuration
 AppInstanceCount = 1
@@ -43,6 +44,7 @@ TerraformStateDir = '/var/lib/mattermost-load-test-ng'
 # Proxy server configuration
 ProxyInstanceType = 'c5.xlarge'
 ProxyInstanceCount = 1
+ProxyAllocatePublicIPAddress = true
 
 [ClusterSubnetIDs]
 App = []

deployment/config.go

@@ -51,10 +51,14 @@ type Config struct {
 	AgentInstanceType string `default:"c7i.xlarge" validate:"notempty"`
 	// Logs the command output (stdout & stderr) to home directory.
 	EnableAgentFullLogs bool `default:"true"`
+	// Should a pubic IP be allocated for the agent instance.
+	AgentAllocatePublicIPAddress bool `default:"true"`
 	// Number of proxy instances.
 	ProxyInstanceCount int `default:"1" validate:"range:[0,5]"`
 	// Type of the EC2 instance for proxy.
 	ProxyInstanceType string `default:"m4.xlarge" validate:"notempty"`
+	// Should a pubic IP be allocated for the proxy instance.
+	ProxyAllocatePublicIPAddress bool `default:"true"`
 	// Path to the SSH public key.
 	SSHPublicKey string `default:"~/.ssh/id_rsa.pub" validate:"notempty"`
 	// Terraform database connection and provision settings.

deployment/terraform/assets/cluster.tf

@@ -182,7 +182,7 @@ resource "aws_instance" "proxy_server" {
   ami                         = var.aws_ami
   instance_type               = var.proxy_instance_type
   count                       = var.proxy_instance_count
-  associate_public_ip_address = true
+  associate_public_ip_address = var.proxy_allocate_public_ip_address
   availability_zone           = var.aws_az
   subnet_id                   = (length(var.cluster_subnet_ids.proxy) > 0) ? element(tolist(var.cluster_subnet_ids.proxy), count.index) : null
 
@@ -370,7 +370,7 @@ resource "aws_instance" "loadtest_agent" {
   count         = var.agent_instance_count
   subnet_id     = (length(var.cluster_subnet_ids.agent) > 0) ? element(tolist(var.cluster_subnet_ids.agent), count.index) : null
 
-  associate_public_ip_address = true
+  associate_public_ip_address = var.agent_allocate_public_ip_address
   availability_zone           = var.aws_az
 
   vpc_security_group_ids = [aws_security_group.agent.id]

deployment/terraform/assets/variables.tf

@@ -27,12 +27,17 @@ variable "app_instance_count" {
 variable "app_instance_type" {
 }
 
+# Agent variables
+
 variable "agent_instance_count" {
 }
 
 variable "agent_instance_type" {
 }
 
+variable "agent_allocate_public_ip_address" {
+}
+
 # Elasticsearch variables
 
 variable "es_instance_count" {
@@ -82,6 +87,9 @@ variable "redis_engine_version" {
 variable "proxy_instance_type" {
 }
 
+variable "proxy_allocate_public_ip_address" {
+}
+
 variable "db_instance_count" {
 }
 

deployment/terraform/utils.go

@@ -259,6 +259,7 @@ func (t *Terraform) getParams() []string {
 		"-var", fmt.Sprintf("app_attach_iam_profile=%s", t.config.AppAttachIAMProfile),
 		"-var", fmt.Sprintf("agent_instance_count=%d", t.config.AgentInstanceCount),
 		"-var", fmt.Sprintf("agent_instance_type=%s", t.config.AgentInstanceType),
+		"-var", fmt.Sprintf("agent_allocate_public_ip_address=%t", t.config.AgentAllocatePublicIPAddress),
 		"-var", fmt.Sprintf("es_instance_count=%d", t.config.ElasticSearchSettings.InstanceCount),
 		"-var", fmt.Sprintf("es_instance_type=%s", t.config.ElasticSearchSettings.InstanceType),
 		"-var", fmt.Sprintf("es_version=%s", t.config.ElasticSearchSettings.Version),
@@ -269,6 +270,7 @@ func (t *Terraform) getParams() []string {
 		"-var", fmt.Sprintf("es_enable_cloudwatch_logs=%t", t.config.ElasticSearchSettings.EnableCloudwatchLogs),
 		"-var", fmt.Sprintf("proxy_instance_count=%d", t.config.ProxyInstanceCount),
 		"-var", fmt.Sprintf("proxy_instance_type=%s", t.config.ProxyInstanceType),
+		"-var", fmt.Sprintf("proxy_allocate_public_ip_address=%t", t.config.ProxyAllocatePublicIPAddress),
 		"-var", fmt.Sprintf("ssh_public_key=%s", t.config.SSHPublicKey),
 		"-var", fmt.Sprintf("db_instance_count=%d", t.config.TerraformDBSettings.InstanceCount),
 		"-var", fmt.Sprintf("db_instance_engine=%s", t.config.TerraformDBSettings.InstanceEngine),

docs/config/deployer.md

@@ -84,6 +84,12 @@ The number of load-test agent instances. The first instance will also host the [
 
 The type of the EC2 instance of the loadtest agent. See type [here](https://aws.amazon.com/ec2/instance-types/).
 
+## AgentAllocatePublicIPAddress
+
+*bool*
+
+Whether to allocate a public IP address to the agent instances.
+
 ## ClusterSubnetIDs
 
 ### App
@@ -251,6 +257,12 @@ Number of proxy instances to run. Right now, only values `0` and `1` are allowed
 
 The type of the EC2 instance of the proxy server. See type [here](https://aws.amazon.com/ec2/instance-types/).
 
+## ProxyAllocatePublicIPAddress
+
+*bool*
+
+Whether to allocate a public IP address to the proxy instances.
+
 ## SSHPublicKey
 
 *string*