This README serves as a quick start guide to deploy Zscaler Branch Connector resources in a VMware ESXi vCenter environment using Terraform. To learn more about the resources created when deploying Branch Connector with Terraform, see Deployment Templates for Zscaler Branch Connector. These deployment templates are intended to be fully functional and self service for production use. All modules may also be utilized as design recommendation based on the Zscaler Zero Trust SD-WAN Datasheet .
Use this repository to create the deployment resources required to deploy and operate Branch Connector in an existing VMware ESXi environment. The examples directory contains complete automation scripts for all deployment template solutions.
Our Deployment scripts are leveraging Terraform v1.1.9 that includes full binary and provider support for MacOS M1 chips, but any Terraform version 0.13.7 and higher should be generally supported.
- provider registry.terraform.io/hashicorp/vsphere v2.2.x
- provider registry.terraform.io/hashicorp/random v3.3.x
- provider registry.terraform.io/hashicorp/local v2.2.x
- provider registry.terraform.io/hashicorp/null v3.1.x
- provider registry.terraform.io/providers/zscaler/zpa v2.5.x
- vCenter Administrator credentials. For full list of Terraform Provider for VMware vSphere required privileges, refer to the documentation here.
- Admin username
- Admin password
- vCenter server name (FQDN or IP)
Note: Profile-driver Storage access:
The provider implementation requires the ability to read storage profiles from vSphere for some resource and data source operations. Ensure that the user account used for Terraform is provided the Profile-driven Storage > View (StorageProfile.View) privilege to be able to read the available storage policies.
- A valid Zscaler Branch Connector provisioning URL generated from the Branch Connector Portal
- Zscaler Branch Connector Credentials (api key, username, password)
- Download the Branch Connector OVA and save to the desired deployment type 'bootstrap' directory.
- A valid Zscaler Private Access subscription and portal access
- Zscaler ZPA API Keys. Details on how to find and generate ZPA API keys can be located here:
- Client ID
- Client Secret
- Customer ID
- (Optional) An existing App Connector Group and Provisioning Key. Otherwise, you can follow the prompts in the examples terraform.tfvars to create a new Connector Group and Provisioning Key
Use the Starter Deployment Template to deploy your Branch Connector in an existing ESXi environment.
Use the Starter Deployment Template with App Connector to deploy your combined Branch Connector + App Connector in an existing ESXi environment.
Use the Starter Deployment Template with High-Availability to deploy your Branch Connector in an existing ESXi environment. This template achieves high availability between two Branch Connectors.
Use the Starter Deployment Template with App Connector and High-Availability to deploy your combined Branch Connector + App Connector in an existing ESXi environment. This template achieves high availability between two Branch Connectors.