Merge pull request #44 from F5Networks/devel_new

adding new atc tools installation and readme changes
F5Networks · Mar 15, 2023 · 4929378 · 4929378
2 parents 53e7737 + 92331e9
commit 4929378
Show file tree

Hide file tree

Showing 10 changed files with 308 additions and 186 deletions.
diff --git a/examples/bigip_aws_1nic_deploy/README.md b/examples/bigip_aws_1nic_deploy/README.md
@@ -1,43 +1,49 @@
-## Deploys F5 BIG-IP AWS Cloud
+# Deploys F5 BIG-IP AWS Cloud
 
-This Terraform module example deploys 1-NIC BIG-IP in AWS, deployed BIGIP will be having management interface associated with user provided subnet and security-group
+* This Terraform module example deploys 1-NIC BIG-IP in AWS cloud. 
+* Using module `count` feature we can also deploy multiple BIGIP instances(default value of `count` is **1**)
+* Management interface associated with user provided **mgmt_subnet_ids** and **mgmt_securitygroup_ids**
+* Random generated `password` for login to BIG-IP
 
-## Steps to clone and use the module example locally
+## Example Usage
 
-```shell
-git clone https://github.com/f5devcentral/terraform-aws-bigip-module
-cd terraform-aws-bigip-module/examples/bigip_aws_1nic_deploy/
+```hcl
+module "bigip" {
+  source                 = "F5Networks/bigip-module/aws"
+  count                  = var.instance_count
+  prefix                 = format("%s-1nic", var.prefix)
+  ec2_key_name           = aws_key_pair.generated_key.key_name
+  f5_password            = random_string.password.result
+  mgmt_subnet_ids        = [{ "subnet_id" = aws_subnet.mgmt.id, "public_ip" = true, "private_ip_primary" = "" }]
+  mgmt_securitygroup_ids = [module.mgmt-network-security-group.security_group_id]
+}
 ```
 
-- Then follow the stated process in Example Usage below
-
-## Example Usage
-
-- Modify `terraform.tfvars` according to the requirement by changing `region` and `AllowedIPs` variables as follows:
+* Modify `terraform.tfvars` according to the requirement by changing `region` and `AllowedIPs` variables as follows:
 
     ```hcl
     region = "ap-south-1"
     AllowedIPs = ["0.0.0.0/0"]
     ```
 
-- Next, run the following commands to create and destroy your configuration
+* Next, run the following commands to create and destroy your configuration
 
     ```shell
-    terraform init
-    terraform plan
-    terraform apply
-    terraform destroy
+    $terraform init
+    $terraform plan
+    $terraform apply
+    $terraform destroy
     ```
 
-#### Optional Input Variables
+### Optional Input Variables
 
 | Name | Description | Type | Default |
 |------|-------------|------|---------|
 | prefix | Prefix for resources created by this module | `string` | tf-aws-bigip |
 | cidr | aws VPC CIDR | `string` | 10.2.0.0/16 |
 | availabilityZones | If you want the VM placed in an Availability Zone, and the AWS region you are deploying to supports it, specify the numbers of the existing Availability Zone you want to use | `List` | ["us-east-1a"] |
 
-#### Output Variables
+### Output Variables
 
 | Name | Description |
 |------|-------------|
@@ -51,4 +57,11 @@ cd terraform-aws-bigip-module/examples/bigip_aws_1nic_deploy/
 | public\_addresses | List of BIG-IP public addresses |
 | vpc\_id | VPC Id where BIG-IP Deployed |
 
-**NOTE:** A local json file will get generated which contains the DO declaration
+~>**NOTE:** A local json file will get generated which contains the DO declaration
+
+#### Steps to clone and use the module example locally
+
+```shell
+$git clone https://github.com/F5Networks/terraform-aws-bigip-module
+$cd terraform-aws-bigip-module/examples/bigip_aws_1nic_deploy/
+```
diff --git a/examples/bigip_aws_1nic_deploy/main.tf b/examples/bigip_aws_1nic_deploy/main.tf
@@ -180,6 +180,16 @@ resource "aws_key_pair" "generated_key" {
 }
 
 
+module "bigip" {
+  source                 = "F5Networks/bigip-module/aws"
+  count                  = var.instance_count
+  prefix                 = format("%s-1nic", var.prefix)
+  ec2_key_name           = aws_key_pair.generated_key.key_name
+  f5_password            = random_string.password.result
+  mgmt_subnet_ids        = [{ "subnet_id" = aws_subnet.mgmt.id, "public_ip" = true, "private_ip_primary" = "" }]
+  mgmt_securitygroup_ids = [module.mgmt-network-security-group.security_group_id]
+}
+
 #
 # Create BIG-IP
 #

diff --git a/examples/bigip_aws_1nic_deploy_airgap/README.md b/examples/bigip_aws_1nic_deploy_airgap/README.md
@@ -1,43 +1,49 @@
-## Deploys F5 BIG-IP AWS Cloud
+# Deploys F5 BIG-IP AWS Cloud
 
-This Terraform module example deploys 1-NIC BIG-IP in AWS, deployed BIGIP will be having management interface associated with user provided subnet and security-group
+* This Terraform module example deploys 1-NIC BIG-IP in AWS cloud. 
+* Using module `count` feature we can also deploy multiple BIGIP instances(default value of `count` is **1**)
+* Management interface associated with user provided **mgmt_subnet_ids** and **mgmt_securitygroup_ids**
+* Random generated `password` for login to BIG-IP
 
-## Steps to clone and use the module example locally
+## Example Usage
 
-```shell
-git clone https://github.com/f5devcentral/terraform-aws-bigip-module
-cd terraform-aws-bigip-module/examples/bigip_aws_1nic_deploy/
+```hcl
+module "bigip" {
+  source       = "F5Networks/bigip-module/aws"
+  count        = var.instance_count
+  prefix       = format("%s-1nic", var.prefix)
+  ec2_key_name = aws_key_pair.generated_key.key_name
+  f5_password  = random_string.password.result
+  mgmt_subnet_ids        = [{ "subnet_id" = aws_subnet.mgmt.id, "public_ip" = false, "private_ip_primary" = "" }]
+  mgmt_securitygroup_ids = [module.mgmt-network-security-group.security_group_id]
+}
 ```
 
-- Then follow the stated process in Example Usage below
-
-## Example Usage
-
-- Modify `terraform.tfvars` according to the requirement by changing `region` and `AllowedIPs` variables as follows:
+* Modify `terraform.tfvars` according to the requirement by changing `region` and `AllowedIPs` variables as follows:
 
     ```hcl
     region = "ap-south-1"
     AllowedIPs = ["0.0.0.0/0"]
     ```
 
-- Next, run the following commands to create and destroy your configuration
+* Next, run the following commands to create and destroy your configuration
 
     ```shell
-    terraform init
-    terraform plan
-    terraform apply
-    terraform destroy
+    $terraform init
+    $terraform plan
+    $terraform apply
+    $terraform destroy
     ```
 
-#### Optional Input Variables
+### Optional Input Variables
 
 | Name | Description | Type | Default |
 |------|-------------|------|---------|
 | prefix | Prefix for resources created by this module | `string` | tf-aws-bigip |
 | cidr | aws VPC CIDR | `string` | 10.2.0.0/16 |
 | availabilityZones | If you want the VM placed in an Availability Zone, and the AWS region you are deploying to supports it, specify the numbers of the existing Availability Zone you want to use | `List` | ["us-east-1a"] |
 
-#### Output Variables
+### Output Variables
 
 | Name | Description |
 |------|-------------|
@@ -51,4 +57,11 @@ cd terraform-aws-bigip-module/examples/bigip_aws_1nic_deploy/
 | public\_addresses | List of BIG-IP public addresses |
 | vpc\_id | VPC Id where BIG-IP Deployed |
 
-**NOTE:** A local json file will get generated which contains the DO declaration
+~>**NOTE:** A local json file will get generated which contains the DO declaration
+
+#### Steps to clone and use the module example locally
+
+```shell
+$git clone https://github.com/F5Networks/terraform-aws-bigip-module
+$cd terraform-aws-bigip-module/examples/bigip_aws_1nic_deploy_airgap/
+```
diff --git a/examples/bigip_aws_1nic_deploy_custom_runtime_init/README.md b/examples/bigip_aws_1nic_deploy_custom_runtime_init/README.md
@@ -1,43 +1,60 @@
-## Deploys F5 BIG-IP AWS Cloud
+# Deploys F5 BIG-IP AWS Cloud
 
-This Terraform module example deploys 1-NIC BIG-IP in AWS, deployed BIGIP will be having management interface associated with user provided subnet and security-group
+* This Terraform module example deploys 1-NIC BIG-IP in AWS cloud. 
+* Using module `count` feature we can also deploy multiple BIGIP instances(default value of `count` is **1**)
+* Management interface associated with user provided **mgmt_subnet_ids** and **mgmt_securitygroup_ids**
+* Random generated `password` for login to BIG-IP
 
-## Steps to clone and use the module example locally
+## Example Usage
 
-```shell
-git clone https://github.com/f5devcentral/terraform-aws-bigip-module
-cd terraform-aws-bigip-module/examples/bigip_aws_1nic_deploy/
+```hcl
+module "bigip" {
+  source       = "F5Networks/bigip-module/aws"
+  count        = var.instance_count
+  prefix       = format("%s-1nic", var.prefix)
+  ec2_key_name = aws_key_pair.generated_key.key_name
+  f5_password  = random_string.password.result
+  mgmt_subnet_ids        = [{ "subnet_id" = aws_subnet.mgmt.id, "public_ip" = true, "private_ip_primary" = "" }]
+  mgmt_securitygroup_ids = [module.mgmt-network-security-group.security_group_id]
+  custom_user_data = templatefile("custom_onboard_big.tmpl", {
+    bigip_username         = "bigipuser"
+    ssh_keypair            = fileexists("~/.ssh/id_rsa.pub") ? file("~/.ssh/id_rsa.pub") : ""
+    aws_secretmanager_auth = false
+    bigip_password         = "xxxxxx"
+    INIT_URL               = "https://cdn.f5.com/product/cloudsolutions/f5-bigip-runtime-init/v1.2.1/dist/f5-bigip-runtime-init-1.2.1-1.gz.run",
+    DO_URL                 = "https://github.com/F5Networks/f5-declarative-onboarding/releases/download/v1.21.0/f5-declarative-onboarding-1.21.0-3.noarch.rpm",
+    DO_VER                 = "v1.21.0"
+    AS3_URL                = "https://github.com/F5Networks/f5-appsvcs-extension/releases/download/v3.28.0/f5-appsvcs-3.28.0-3.noarch.rpm",
+    AS3_VER                = "v3.28.0"
+  })
+}
 ```
 
-- Then follow the stated process in Example Usage below
-
-## Example Usage
-
-- Modify `terraform.tfvars` according to the requirement by changing `region` and `AllowedIPs` variables as follows:
+* Modify `terraform.tfvars` according to the requirement by changing `region` and `AllowedIPs` variables as follows:
 
     ```hcl
     region = "ap-south-1"
     AllowedIPs = ["0.0.0.0/0"]
     ```
 
-- Next, run the following commands to create and destroy your configuration
+* Next, run the following commands to create and destroy your configuration
 
     ```shell
-    terraform init
-    terraform plan
-    terraform apply
-    terraform destroy
+    $terraform init
+    $terraform plan
+    $terraform apply
+    $terraform destroy
     ```
 
-#### Optional Input Variables
+### Optional Input Variables
 
 | Name | Description | Type | Default |
 |------|-------------|------|---------|
 | prefix | Prefix for resources created by this module | `string` | tf-aws-bigip |
 | cidr | aws VPC CIDR | `string` | 10.2.0.0/16 |
 | availabilityZones | If you want the VM placed in an Availability Zone, and the AWS region you are deploying to supports it, specify the numbers of the existing Availability Zone you want to use | `List` | ["us-east-1a"] |
 
-#### Output Variables
+### Output Variables
 
 | Name | Description |
 |------|-------------|
@@ -51,4 +68,11 @@ cd terraform-aws-bigip-module/examples/bigip_aws_1nic_deploy/
 | public\_addresses | List of BIG-IP public addresses |
 | vpc\_id | VPC Id where BIG-IP Deployed |
 
-**NOTE:** A local json file will get generated which contains the DO declaration
+~>**NOTE:** A local json file will get generated which contains the DO declaration
+
+#### Steps to clone and use the module example locally
+
+```shell
+$git clone https://github.com/F5Networks/terraform-aws-bigip-module
+$cd terraform-aws-bigip-module/examples/bigip_aws_1nic_deploy_custom_runtime_init/
+```
diff --git a/examples/bigip_aws_1nic_deploy_module_count/README.md b/examples/bigip_aws_1nic_deploy_module_count/README.md
@@ -1,47 +1,49 @@
-## Deploys F5 BIG-IP AWS Cloud
+# Deploys F5 BIG-IP AWS Cloud
 
-This Terraform module example deploys 2 BIG-IPs(1-Nic) in AWS and by using module count feature.
+* This Terraform module example deploys 1-NIC BIG-IP in AWS cloud. 
+* Using module `count` feature we can also deploy multiple BIGIP instances(default value of `count` is **1**)
+* Management interface associated with user provided **mgmt_subnet_ids** and **mgmt_securitygroup_ids**
+* Random generated `password` for login to BIG-IP
 
-- we can deploy multiple BIGIP instances by using module count feature. ref: [module count](https://www.terraform.io/docs/language/meta-arguments/count.html)
-
-## Steps to clone and use the module example locally
+## Example Usage
 
-```shell
-git clone https://github.com/f5devcentral/terraform-aws-bigip-module
-cd terraform-aws-bigip-module/examples/bigip_aws_1nic_deploy_module_count/
+```hcl
+module "bigip" {
+  source                 = "F5Networks/bigip-module/aws"
+  count                  = var.instance_count
+  prefix                 = format("%s-1nic", var.prefix)
+  ec2_key_name           = aws_key_pair.generated_key.key_name
+  f5_password            = random_string.password.result
+  mgmt_subnet_ids        = [{ "subnet_id" = aws_subnet.mgmt.id, "public_ip" = true, "private_ip_primary" = "" }]
+  mgmt_securitygroup_ids = [module.mgmt-network-security-group.security_group_id]
+}
 ```
 
-- Then follow the stated process in Example Usage below
-
-## Example Usage
-
-- Modify `terraform.tfvars` according to the requirement by changing `region` and `AllowedIPs` variables as follows:
+* Modify `terraform.tfvars` according to the requirement by changing `region` and `AllowedIPs` variables as follows:
 
     ```hcl
     region = "ap-south-1"
     AllowedIPs = ["0.0.0.0/0"]
-    instance_count    = 2
     ```
 
-- Next, run the following commands to create and destroy your configuration
+* Next, run the following commands to create and destroy your configuration
 
     ```shell
-    terraform init
-    terraform plan
-    terraform apply
-    terraform destroy
+    $terraform init
+    $terraform plan
+    $terraform apply
+    $terraform destroy
     ```
 
-#### Optional Input Variables
+### Optional Input Variables
 
 | Name | Description | Type | Default |
 |------|-------------|------|---------|
 | prefix | Prefix for resources created by this module | `string` | tf-aws-bigip |
 | cidr | aws VPC CIDR | `string` | 10.2.0.0/16 |
 | availabilityZones | If you want the VM placed in an Availability Zone, and the AWS region you are deploying to supports it, specify the numbers of the existing Availability Zone you want to use | `List` | ["us-east-1a"] |
-| instance_count | Number of Bigip instances to create | `number` | 1 |
 
-#### Output Variables
+### Output Variables
 
 | Name | Description |
 |------|-------------|
@@ -55,5 +57,11 @@ cd terraform-aws-bigip-module/examples/bigip_aws_1nic_deploy_module_count/
 | public\_addresses | List of BIG-IP public addresses |
 | vpc\_id | VPC Id where BIG-IP Deployed |
 
-**NOTE** |A local json file will get generated which contains the DO declaration|
-|------|-----|
+~>**NOTE:** A local json file will get generated which contains the DO declaration
+
+#### Steps to clone and use the module example locally
+
+```shell
+$git clone https://github.com/F5Networks/terraform-aws-bigip-module
+$cd terraform-aws-bigip-module/examples/bigip_aws_1nic_deploy/
+```