Skip to content

zscaler/terraform-gcp-zpa-app-connector-modules

Repository files navigation

GitHub release (latest by date) GitHub GitHub pull requests Terraform registry downloads total Terraform registry download month Zscaler Community

Zscaler App Connector GCP Terraform Modules

Support Disclaimer

-> Disclaimer: Please refer to our General Support Statement before proceeding with the use of this provider.

Description

This repository contains various modules and deployment configurations that can be used to deploy Zscaler App Connector appliances to securely connect to workloads within Google Cloud (GCP) via the Zscaler Zero Trust Exchange. The examples directory contains complete automation scripts for both greenfield/POV and brownfield/production use.

These deployment templates are intended to be fully functional and self service for both greenfield/pov as well as production use. All modules may also be utilized as design recommendation based on Zscaler's Official Zero Trust Access to Private Apps in GCP with ZPA.

~> IMPORTANT As of version 1.1.0 of this module, all App Connectors are deployed using the new Red Hat Enterprise Linux 9

Prerequisites

The GCP Terraform scripts leverage Terraform v1.1.9 which includes full binary and provider support for macOS M1 chips, but any Terraform version 0.13.7 should be generally supported.

  • provider registry.terraform.io/hashicorp/google v5.38.x
  • provider registry.terraform.io/hashicorp/random v3.6.x
  • provider registry.terraform.io/hashicorp/local v2.5.x
  • provider registry.terraform.io/hashicorp/null v3.2.x
  • provider registry.terraform.io/providers/hashicorp/tls v4.0.x
  • provider registry.terraform.io/providers/zscaler/zpa v3.31.x

GCP requirements

  1. A valid GCP account with Administrator Access to deploy required resources
  2. GCP service account keyfile
  3. GCP Region (E.g. us-central1)

Zscaler requirements

This module leverages the Zscaler Private Access ZPA Terraform Provider for the automated onboarding process. Before proceeding make sure you have the following pre-requistes ready.

  1. A valid Zscaler Private Access subscription and portal access
  2. Zscaler ZPA API Keys. Details on how to find and generate ZPA API keys can be located here
  • Client ID
  • Client Secret
  • Customer ID
  1. (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

See: Zscaler App Connector Deployment for Linux for additional prerequisite provisioning steps.

Terraform client requirements

If executing Terraform via the "zsec" wrapper bash script, it is advised that you run from a MacOS or Linux workstation. Minimum installed application requirements to successfully from the script are:

  • bash
  • curl
  • unzip


How to deploy

Provisioning templates are available for customer use/reference to successfully deploy fully operational App Connector appliances once the prerequisites have been completed. Please follow the instructions located in examples.

Format

This repository follows the Hashicorp Standard Modules Structure:

  • modules - All module resources utilized by and customized specifically for App Connector deployments. The intent is these modules are resusable and functional for any deployment type referencing for both production or lab/testing purposes.
  • examples - Zscaler provides fully functional deployment templates utilizing a combination of some or all of the modules published. These can utilized in there entirety or as reference templates for more advanced customers or custom deployments. For novice Terraform users, we also provide a bash script (zsac) that can be run from any Linux/Mac OS or CSP Cloud Shell that walks through all provisioning requirements as well as downloading/running an isolated teraform process. This allows App Connector deployments from any supported client without needing to even have Terraform installed or know how the language/syntax for running it.

Versioning

These modules follow recommended release tagging in Semantic Versioning. You can find each new release, along with the changelog, on the GitHub Releases page.

License and Copyright

Copyright (c) 2022 Zscaler, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.