Deploys BIG-IP in AWS Cloud

This Terraform module deploys N-nic F5 BIG-IP in AWS cloud,and with module count feature we can also deploy multiple instances of BIG-IP.

Prerequisites

This module is supported from Terraform 0.13 version onwards.

It is tested against following provider/terraform versions

Terraform v0.13.0

• provider registry.terraform.io/hashicorp/aws v3.8.0
• provider registry.terraform.io/hashicorp/random v2.3.0
• provider registry.terraform.io/hashicorp/template v2.1.2
• provider registry.terraform.io/hashicorp/null v2.1.2

Releases and Versioning

This module is supported in the following bigip and terraform version

BIGIP version	Terraform 0.13
BIG-IP 15.x	X
BIG-IP 14.x	X
BIG-IP 13.x	X

Password Management

By default bigip module will have random password setting to give dynamic password generation

cat terraform-aws-bigip-module/variables.tf

variable aws_secretmanager_auth {
  description = "Whether to use key vault to pass authentication"
  type        = bool
  default     = false
}

Outputs:

bigip_password = [
  "xxxxxxxxxxxxxxxxxx",
]

To use AWS secret manager password,we have to enable the variable "aws_secretmanager_auth" to true and supply the secret name to variable "aws_secretmanager_secret_id"

cat terraform-aws-bigip-module/variables.tf

variable aws_secretmanager_auth {
  description = "Whether to use key vault to pass authentication"
  type        = bool
  default     = true
}

variable aws_secretmanager_secret_id {
  description = "AWS Secret Manager Secret ID that stores the BIG-IP password"
  type        = string
  default     = "tf-aws-bigip-bigip-secret-9759"
} 

Outputs:

bigip_password = [
  "xxxxxxxxxxxxxxx",
]

Example Usage

We have provided some common deployment examples

Note

There should be one to one mapping between subnet_ids and securitygroup_ids (for example if we have 2 or more external subnet_ids,we have to give same number of external securitygroup_ids to module)

Users can have dynamic or static private ip allocation.If primary/secondary private ip value is null, it will be dynamic or else static private ip allocation.

With Static private ip allocation we can assign primary and secondary private ips for external interfaces, whereas primary private ip for management
and internal interfaces.

If it is static private ip allocation we can't use module count as same private ips will be tried to allocate for multiple bigip instances based on module count.

With Dynamic private ip allocation,we have to pass null value to primary/secondary private ip declaration and module count will be supported.

Note

Sometimes it is observed that the given static primary and secondary private ips may get exchanged. This is the limitation present in aws.

Below example snippets show how this module is called ( Dynamic private ip allocation )

#
#Example 1-NIC Deployment Module usage
#
module bigip {
  count                  = var.instance_count
  source                 = "../../"
  prefix                 = "bigip-aws-1nic"
  ec2_key_name           = aws_key_pair.generated_key.key_name
  mgmt_subnet_ids        = [{ "subnet_id" = "subnet_id_mgmt", "public_ip" = true, "private_ip_primary" =  ""}]
  mgmt_securitygroup_ids = ["securitygroup_id_mgmt"]
}

#
#Example 2-NIC Deployment Module usage
#
module bigip {
  count                  = var.instance_count
  source                      = "../../"
  prefix                      = "bigip-aws-2nic"
  ec2_key_name                = aws_key_pair.generated_key.key_name
  mgmt_subnet_ids             = [{ "subnet_id" = "subnet_id_mgmt", "public_ip" = true, "private_ip_primary" =  ""}]
  mgmt_securitygroup_ids      = ["securitygroup_id_mgmt"]
  external_subnet_ids         = [{ "subnet_id" = "subnet_id_external", "public_ip" = true, "private_ip_primary" = "", "private_ip_secondary" = ""}]
  external_securitygroup_ids  = ["securitygroup_id_external"]
}

#
#Example 3-NIC Deployment  Module usage
#
module bigip {
  count                  = var.instance_count
  source                      = "../../"
  prefix                      = "bigip-aws-3nic"
  ec2_key_name                = aws_key_pair.generated_key.key_name
  mgmt_subnet_ids             = [{ "subnet_id" = "subnet_id_mgmt", "public_ip" = true, "private_ip_primary" =  ""}]
  mgmt_securitygroup_ids      = ["securitygroup_id_mgmt"]
  external_subnet_ids         = [{ "subnet_id" = "subnet_id_external", "public_ip" = true, "private_ip_primary" = "", "private_ip_secondary" = ""}]
  external_securitygroup_ids  = ["securitygroup_id_external"]
  internal_subnet_ids         = [{"subnet_id" =  "subnet_id_internal", "public_ip"=false, "private_ip_primary" = ""}]
  internal_securitygroup_ids  = ["securitygropu_id_internal"]
}

#
#Example 4-NIC Deployment  Module usage(with 2 external public interfaces,one management and internal interface.There should be one to one mapping between subnet_ids and securitygroupids)
#

module bigip {
  count                  = var.instance_count
  source                      = "../../"
  prefix                      = "bigip-aws-4nic"
  ec2_key_name                = aws_key_pair.generated_key.key_name
  mgmt_subnet_ids             = [{ "subnet_id" = "subnet_id_mgmt", "public_ip" = true }]
  mgmt_securitygroup_ids      = ["securitygroup_id_mgmt"]
  external_subnet_ids         = [{ "subnet_id" = "subnet_id_external", "public_ip" = true },{"subnet_id" =  "subnet_id_external2", "public_ip" = true }]
  external_securitygroup_ids  = ["securitygroup_id_external","securitygroup_id_external"]
  internal_subnet_ids         = [{"subnet_id" =  "subnet_id_internal", "public_ip"=false }]
  internal_securitygroup_ids  = ["securitygropu_id_internal"]
}

Similarly we can have N-nic deployments based on user provided subnet_ids and securitygroup_ids.
With module count, user can deploy multiple bigip instances in the aws cloud (with the default value of count being one )

Below is the example snippet for private ip allocation

Example 3-NIC Deployment with static private ip allocation

module bigip {
  source                      = "../../"
  count                       = var.instance_count
  prefix                      = format("%s-3nic", var.prefix)
  ec2_key_name                = aws_key_pair.generated_key.key_name
  aws_secretmanager_secret_id = aws_secretsmanager_secret.bigip.id
  mgmt_subnet_ids             = [{ "subnet_id" = aws_subnet.mgmt.id, "public_ip" = true, "private_ip_primary" = "10.0.1.4"}]
  mgmt_securitygroup_ids      = [module.mgmt-network-security-group.this_security_group_id]
  external_securitygroup_ids  = [module.external-network-security-group-public.this_security_group_id]
  internal_securitygroup_ids  = [module.internal-network-security-group-public.this_security_group_id]
  external_subnet_ids         = [{ "subnet_id" = aws_subnet.external-public.id, "public_ip" = true, "private_ip_primary" = "10.0.2.4", "private_ip_secondary" = "10.0.2.5"}]
  internal_subnet_ids         = [{ "subnet_id" = aws_subnet.internal.id, "public_ip" = false, "private_ip_primary" = "10.0.3.4"}]
}

BIG-IP Automation Toolchain InSpec Profile for testing readiness of Automation Tool Chain components

After the module deployment, we can use inspec tool for verifying the Bigip connectivity along with ATC components

This InSpec profile evaluates the following:

• Basic connectivity to a BIG-IP management endpoint ('bigip-connectivity')
• Availability of the Declarative Onboarding (DO) service ('bigip-declarative-onboarding')
• Version reported by the Declarative Onboarding (DO) service ('bigip-declarative-onboarding-version')
• Availability of the Application Services (AS3) service ('bigip-application-services')
• Version reported by the Application Services (AS3) service ('bigip-application-services-version')
• Availability of the Telemetry Streaming (TS) service ('bigip-telemetry-streaming')
• Version reported by the Telemetry Streaming (TS) service ('bigip-telemetry-streaming-version')
• Availability of the Cloud Failover Extension( CFE ) service ('bigip-cloud-failover-extension')
• Version reported by the Cloud Failover Extension( CFE ) service('bigip-cloud-failover-extension-version')

run inspec tests

we can either run inspec exec command or execute runtests.sh in any one of example nic folder which will run below inspec command

inspec exec inspec/bigip-ready --input bigip_address=$BIGIP_MGMT_IP bigip_port=$BIGIP_MGMT_PORT user=$BIGIP_USER password=$BIGIP_PASSWORD do_version=$DO_VERSION as3_version=$AS3_VERSION ts_version=$TS_VERSION fast_version=$FAST_VERSION cfe_version=$CFE_VERSION

Required Input Variables

These variables must be set in the module block when using this module.

Name	Description	Type
prefix	This value is inserted in the beginning of each aws object. Note: requires alpha-numeric without special character	string
ec2_key_name	AWS EC2 Key name for SSH access	string
mgmt_subnet_ids	Map with Subnet-id and public_ip as keys for the management subnet	List of Maps
mgmt_securitygroup_ids	securitygroup_ids for the management interface	List
instance_count	Number of Bigip instances to spin up	number

Optional Input Variables

These variables have default values and don't have to be set to use this module. You may set these variables to override their default values.

Name	Description	Type	Default
f5_username	The admin username of the F5 BIG-IP that will be deployed	string	bigipuser
ec2_instance_type	AWS EC2 instance type	string	m5.large
f5_ami_search_name	BIG-IP AMI name to search for	string	F5 Networks BIGIP-14.* PAYG - Best 200Mbps*
mgmt_eip	Enable an Elastic IP address on the management interface	bool	TRUE
aws_secretmanager_auth	Whether to use key vault to pass authentication	bool	FALSE
aws_secretmanager_secret_id	AWS Secret Manager Secret ID that stores the BIG-IP password	string
DO_URL	URL to download the BIG-IP Declarative Onboarding module	string	latest
AS3_URL	URL to download the BIG-IP Application Service Extension 3 (AS3) module	string	latest
TS_URL	URL to download the BIG-IP Telemetry Streaming module	string	latest
fastPackageUrl	URL to download the BIG-IP FAST module	string	latest
CFE_URL	URL to download the BIG-IP Cloud Failover Extension module	string	latest
libs_dir	Directory on the BIG-IP to download the A&O Toolchain into	string	/config/cloud/aws/node_modules
onboard_log	Directory on the BIG-IP to store the cloud-init logs	string	/var/log/startup-script.log
external_subnet_ids	he subnet id of the virtual network where the virtual machines will reside	List of Maps	[{ "subnet_id" = null, "public_ip" = null }]
internal_subnet_ids	The subnet id of the virtual network where the virtual machines will reside	List of Maps	[{ "subnet_id" = null, "public_ip" = null }]
external_securitygroup_ids	The Network Security Group ids for external network	List	[]
internal_securitygroup_ids	The Network Security Group ids for internal network	List	[]

Note: For each external interface there will be one primary,secondary private ip will be assigned.

Output Variables

Name	Description
mgmtPublicIP	The actual ip address allocated for the resource
mgmtPublicDNS	fqdn to connect to the first vm provisioned
mgmtPort	Mgmt Port
f5_username	BIG-IP username
bigip_password	BIG-IP Password (if dynamic_password is choosen it will be random generated password or if aws_secretmanager_auth is choosen it will be aws_secretsmanager_secret_version secret string )
private_addresses	List of BIG-IP private addresses
public_addresses	List of BIG-IP public addresses

NOTE: A local json file will get generated which contains the DO declaration

Support Information

This repository is community-supported. Follow instructions below on how to raise issues.

Filing Issues and Getting Help

If you come across a bug or other issue, use GitHub Issues to submit an issue for our team. You can also see the current known issues on that page, which are tagged with a purple Known Issue label.

Copyright

Copyright 2014-2019 F5 Networks Inc.

F5 Networks Contributor License Agreement

Before you start contributing to any project sponsored by F5 Networks, Inc. (F5) on GitHub, you will need to sign a Contributor License Agreement (CLA).

If you are signing as an individual, we recommend that you talk to your employer (if applicable) before signing the CLA since some employment agreements may have restrictions on your contributions to other projects. Otherwise by submitting a CLA you represent that you are legally entitled to grant the licenses recited therein.

If your employer has rights to intellectual property that you create, such as your contributions, you represent that you have received permission to make contributions on behalf of that employer, that your employer has waived such rights for your contributions, or that your employer has executed a separate CLA with F5.

If you are signing on behalf of a company, you represent that you are legally entitled to grant the license recited therein. You represent further that each employee of the entity that submits contributions is authorized to submit such contributions on behalf of the entity pursuant to the CLA.