Terraform Provider Google Workspace

This Google Workspace provider for Terraform allows you to manage domains, users, and groups in your Google Workspace.

This provider is a technical preview, which means it's a community supported project. It still requires extensive testing and polishing to mature into a HashiCorp officially supported project. Please file issues generously and detail your experience while using the provider. We welcome your feedback.

Experimental Status

By using the software in this repository (the "Software"), you acknowledge that: (1) the Software is still in development, may change, and has not been released as a commercial product by HashiCorp and is not currently supported in any way by HashiCorp; (2) the Software is provided on an "as-is" basis, and may include bugs, errors, or other issues; (3) the Software is NOT INTENDED FOR PRODUCTION USE, use of the Software may result in unexpected results, loss of data, or other unexpected results, and HashiCorp disclaims any and all liability resulting from use of the Software; and (4) HashiCorp reserves all rights to make all decisions about the features, functionality and commercial release (or non-release) of the Software, at any time and without any obligation or liability whatsoever.

Maintainers

This provider plugin is maintained by the Terraform team at HashiCorp

Requirements

• Terraform >= 0.13.x
• Go >= 1.16

Upgrading the provider

The Google Workspace provider doesn't upgrade automatically once you've started using it. After a new release you can run

terraform init -upgrade

to upgrade to the latest stable version of the Google Workspace provider. See the Terraform website for more information on provider upgrades, and how to set version constraints on your provider.

Building The Provider

1. Clone the repository
2. Enter the repository directory
3. Build the provider using the Go install command or make build:

$ make build

Adding Dependencies

This provider uses Go modules. Please see the Go documentation for the most up to date information about using Go modules.

To add a new dependency github.com/author/dependency to your Terraform provider:

go get github.com/author/dependency
go mod tidy

Then commit the changes to go.mod and go.sum.

Using The provider

See the Google Workspace Provider documentation to get started using the Google Workspace provider.

Developing the Provider

If you wish to work on the provider, you'll first need Go installed on your machine (see Requirements above). You can use goenv to manage your Go version. To compile the provider, run go install. This will build the provider and put the provider binary in the $GOPATH/bin directory.

To generate or update documentation, run go generate.

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

Note: Acceptance tests create real resources, and often cost money to run.

$ make testacc

For guidance on common development practices such as testing changes, see the contribution guidelines. If you have other development questions we don't cover, please file an issue!

Special Recognition

• Chase - for the excellent work creating the DeviaVir/terraform-provider-gsuite provider, the inspiration for this project.

General Feedback

• How can we best support you ? - feedback