https://github.com/global-vmware/vcd_nsxt_alb_pool
This Repository contains the "vcd_nsxt_alb_pool" Terraform Module. You can use this Module to deploy NSX-T ALB Pools into a VMware Cloud Director (VCD) Environment.
https://github.com/global-vmware/vcd_nsxt_alb_pool
infrastructure-as-code load-balancer load-balancing terraform terraform-module vmware vmware-nsx
Last synced: 11 months ago
JSON representation
This Repository contains the "vcd_nsxt_alb_pool" Terraform Module. You can use this Module to deploy NSX-T ALB Pools into a VMware Cloud Director (VCD) Environment.
- Host: GitHub
- URL: https://github.com/global-vmware/vcd_nsxt_alb_pool
- Owner: global-vmware
- Created: 2023-06-16T21:08:45.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-12-11T17:12:51.000Z (over 2 years ago)
- Last Synced: 2025-03-27T15:53:56.327Z (about 1 year ago)
- Topics: infrastructure-as-code, load-balancer, load-balancing, terraform, terraform-module, vmware, vmware-nsx
- Language: HCL
- Homepage: https://www.rackspace.com/cloud/vmware
- Size: 5.86 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# VCD NSX-T ALB Pool Module
This Terraform module will deploy a NSX-T ALB Pool into an existing VMware Cloud Director (VCD) environment. It can be used to provision a new ALB Pool, which represents a group of servers to which the load balancer can distribute traffic. This module can be used to provision new ALB Pools into [Rackspace Technology SDDC Flex](https://www.rackspace.com/cloud/private/software-defined-data-center-flex) VCD Data Center Regions.
## Requirements
| Name | Version |
|------|---------|
| terraform | ~> 1.2 |
| vcd | ~> 3.8 |
## Resources
| Name | Type |
|------|------|
| [vcd_vdc_group](https://registry.terraform.io/providers/vmware/vcd/latest/docs/data-sources/vdc_group) | Data Source |
| [vcd_nsxt_edgegateway](https://registry.terraform.io/providers/vmware/vcd/latest/docs/data-sources/nsxt_edgegateway) | Data Source |
| [vcd_library_certificate](https://registry.terraform.io/providers/vmware/vcd/latest/docs/data-sources/library_certificate) | Data Source |
| [vcd_nsxt_ip_set](https://registry.terraform.io/providers/vmware/vcd/latest/docs/data-sources/nsxt_ip_set) | Data Source |
| [vcd_nsxt_alb_pool](https://registry.terraform.io/providers/vmware/vcd/latest/docs/resources/nsxt_alb_pool) | Resource |
## Inputs
| Name | Description | Type | Default | Required |
|------|-------------|------|---------|----------|
| vdc_org_name | The name of the Data Center Group Organization in VCD | string | `"Organization Name Format: --"` | yes |
| vdc_group_name | The name of the Data Center Group in VCD | string | `"Data Center Group Name Format: -- "` | yes |
| vcd_edge_name | Name of the Data Center Group Edge Gateway | string | `"Edge Gateway Name Format: ---"` | Yes |
| pool_name | A name for NSX-T ALB Pool | string | "" | yes |
| members | List of pool members | list(object({ enabled = bool, ip_address = string, port = number, ratio = number })) | [] | yes |
| member_group_id | A reference to NSX-T IP Set | string | "" | no |
| member_group_ip_set_name | The name of the Member Group IP Set | string | "" | no |
| use_member_group | Whether to use an IP set as pool members | bool | false | no |
| description | An optional description NSX-T ALB Pool | string | "" | no |
| enabled | Boolean value if NSX-T ALB Pool should be enabled | bool | true | no |
| algorithm | Optional algorithm for choosing pool members | string | "LEAST_CONNECTIONS" | no |
| default_port | Default Port defines destination server port used by the traffic sent to the member | number | 80 | no |
| graceful_timeout_period | Maximum time in minutes to gracefully disable pool member | string | "1" | no |
| passive_monitoring_enabled | Defines if client traffic should be used to check if pool member is up or down | bool | true | no |
| ca_certificate_name | The name of the CA certificate | string | "" | no |
| cn_check_enabled | Specifies whether to check the common name of the certificate presented by the pool member | bool | false | no |
| domain_names | A set of domain names which will be used to verify the common names or subject alternative names presented by the pool member certificates | list(string) | [] | no |
| persistence_profile | Persistence profile to ensure that the same user sticks to the same server for a desired duration of time | list(object({ type = string, value = string })) | [] | no |
| health_monitor | Health monitor to check if a member is up or down | list(object({ type = string })) | [] | no |
## Outputs
| Name | Description |
|------|-------------|
| associated_virtual_service_ids | The IDs of the Virtual Services associated with the ALB Pool |
| associated_virtual_services | The names of the Virtual Services associated with the ALB Pool |
| lb_pool_members | List of all members with their details in the ALB Pool |
| lb_member_count | The total count of the members in the ALB Pool |
| lb_up_member_count | The count of the up members in the ALB Pool |
| lb_enabled_member_count | The count of the enabled members in the ALB Pool |
| health_message | The health message for the ALB Pool |
| lb_algorithm | The load balancing algorithm used for the ALB Pool |
| lb_default_server_port | The default server port for the ALB Pool |
| lb_persistence_profile_name | System generated name of Persistence Profile |
| lb_health_monitor_type | Type of health monitor. One of HTTP, HTTPS, TCP, UDP, PING |
| lb_health_monitor_name | System generated name of Health monitor |
| lb_health_monitor_system_defined | A boolean flag if the Health monitor is system defined |
| lb_member_group_ipset_name | The name of the IP set used for the member group in the ALB Pool |
## Use Case Example #1 (Member Type: IP Address)
This is an example of a `main.tf` file that uses the `"github.com/global-vmware/vcd_nsxt_alb_pool"` Module source to create a NSX-T ALB Pool that is using a Member Type of: `IP Address`.
```terraform
module "vcd_nsxt_alb_pool" {
source = "github.com/global-vmware/vcd_nsxt_alb_pool.git?ref=v1.2.1"
vdc_group_name = ""
vdc_org_name = ""
vdc_edge_name = ""
pool_name = "test-pool-01"
default_port = 80
members = [
{
ip_address = "172.16.0.10",
enabled = true,
port = 80,
ratio = 1
},
{
ip_address = "172.16.0.11",
enabled = true,
port = 80,
ratio = 1
}
]
algorithm = "FASTEST_RESPONSE"
persistence_profile = [
{
type = "CLIENT_IP"
value = ""
}
]
health_monitor = [
{
type = "HTTP"
}
]
}
```
## Use Case Example #2 (Member Type: Group)
This is an example of a `main.tf` file that uses the `"github.com/global-vmware/vcd_nsxt_alb_pool"` Module source to create a NSX-T ALB Pool that is using a Member Type of: `Group`.
```terraform
module "vcd_nsxt_alb_pool" {
source = "github.com/global-vmware/vcd_nsxt_alb_pool.git?ref=v1.2.0"
vdc_group_name = ""
vdc_org_name = ""
vdc_edge_name = ""
pool_name = "test-pool-01"
default_port = 80
use_member_group = true
member_group_ip_set_name = "US1-Prod-App-Web-Pool"
algorithm = "LEAST_LOAD"
persistence_profile = [
{
type = "CLIENT_IP"
value = ""
}
]
health_monitor = [
{
type = "HTTP"
}
]
}
```
## Authors
This module is maintained by the [Global VMware Cloud Automation Services Team](https://github.com/global-vmware).