terraform-provider-ztc

README

Support Disclaimer

-> Disclaimer: Please refer to our General Support Statement before proceeding with the use of this provider. You can also refer to our troubleshooting guide for guidance on typical problems.

Terraform Provider for ☁️Zero Trust Cloud (ZTC)☁️

The ZTC provider is a Terraform plugin that allows for the full lifecycle management of Zscaler Zero Trust Cloud resources.

• Website: https://www.terraform.io
• Documentation: https://help.zscaler.com/cloud-branch-connector
• Zscaler Community: Zscaler Community

Examples

All the resources and data sources have one or more examples to give you an idea of how to use this provider to build your own Zscaler Internet Access configuration. Provider's official documentation is located in the official terraform registry.

Requirements

• Install Terraform 0.12.x/0.13.x/0.14.x/0.15.x (0.11.x or lower is incompatible)
• Install Go 1.16+ (This will be used to build the provider plugin.)
• Create a directory, go, follow this doc to edit ~/.bash_profile to setup the GOPATH environment variable)

Quick Start

If you wish to work on the provider, you'll first need Go installed on your machine (please check the requirements before proceeding).

Note: This project uses Go Modules making it safe to work with it outside your existing GOPATH. The instructions that follow assume a directory in your home directory outside the standard GOPATH (i.e $HOME/development/terraform-providers/).

Clone repository to: $HOME/development/terraform-providers/

$ mkdir -p $HOME/development/terraform-providers/; cd $HOME/development/terraform-providers/
$ git clone git@github.com:zscaler/terraform-provider-ztc.git
...

Enter the provider directory and run make tools. This will install the needed tools for the provider.

$ make tools

To compile the provider, run make build13. This will build the provider and put the provider binary in the $GOPATH/bin directory.

$ make build13
...
$ $GOPATH/bin/terraform-provider-ztc
...

Testing the Provider

In order to test the provider, you can run make test.

$ make test

In order to run the full suite of Acceptance tests, run make testacc.

Note: Acceptance tests create real resources.

$ make testacc

Using the Provider

To use a released provider in your Terraform environment, run terraform init and Terraform will automatically install the provider. To specify a particular provider version when installing released providers, see the Terraform documentation on provider versioning .

To instead use a custom-built provider in your Terraform environment (e.g. the provider binary from the build instructions above), follow the instructions to install it as a plugin. After placing the custom-built provider into your plugins' directory, run terraform init to initialize it.

For either installation method, documentation about the provider specific configuration options can be found on the provider's website.

Contributing

Terraform is the work of thousands of contributors. We really appreciate your help!

We have these minimum requirements for source code contributions.

Bug fix pull requests must include:

• Terraform Plugin Acceptance Tests.

Pull requests with new resources and data sources must include:

• Make API calls with the zscaler-sdk-go v3 client
• Include Terraform Plugin Acceptance Tests

Issues on GitHub are intended to be related to the bugs or feature requests with provider codebase. See Plugin SDK Community and Discuss forum for a list of community resources to ask questions about Terraform.

License

=======

Copyright (c) 2022 Zscaler

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.