Terraform Provider cPanel

Available Resources

The whole list of resources has not been implemented yet. The following resources are available:

• Cron Jobs

• PostgreSQL Databases & Users

Feel free to open an issue or a pull request to implement new resources.

Requirements

• Terraform >= 1.4

• Go >= 1.20

Building The Provider

1. Clone the repository
1. Enter the repository directory
1. Build the provider using the Go install command:

go install

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

You MUST disable parallelism when using the provider, because cPanel's API does not support concurrent requests.
To do so, you can run the defined commands:

make plan

make apply

Or you can manually:

• Set an environment variable: export TF_CLI_ARGS_apply="-parallelism=1"

• Set a CLI flag: terraform apply -parallelism=1

Developing the Provider

If you wish to work on the provider, you'll first need Go installed on your machine (see Requirements above).

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:

make generate-documentation

To lint the code, run:

make lint

In order to run the full suite of Acceptance tests, run:

make test

Note: Acceptance tests create real resources, and requires a real cPanel account to run. Please be aware of the costs associated with running acceptance tests. For more information, refer to the Acceptance Testing documentation.