- Website: https://www.terraform.io
- Documentation: https://www.terraform.io/docs/providers/checkpoint/index.html
- Mailing list: Google Groups
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 below), follow the instructions to install it as a plugin. After placing it 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.
- Clone repository to:
$GOPATH/src/github.com/terraform-providers/terraform-provider-checkpoint
$ git clone [email protected]:terraform-providers/terraform-provider-checkpoint $GOPATH/src/github.com/terraform-providers/terraform-provider-checkpoint
- To build the provider locally, run the following command from the repository root directory.
# Windows
go build -o terraform-provider-checkpoint.exe
- (Optional) Enter the provider directory and build the provider. This will put the provider binary in
$GOPATH/bin
directory.
$ cd $GOPATH/src/github.com/terraform-providers/terraform-provider-checkpoint
$ make build
- For local development, update
dev_overrides
configuration file. See the next section below.
If you wish to work on the provider, you'll first need Go installed on your machine (version 1.11+ is required).
You'll also need to correctly setup a GOPATH, as well as adding $GOPATH/bin
to your $PATH
.
From Terraform v0.14 and later, development overrides for provider developers can be used to tell Terraform where the local provider is located.
To do this, create Terraform CLI configuration file. For windows create terraform.rc
in %APPDATA%
or ~/.terraformrc
for all other platforms, and add the following block:
provider_installation {
dev_overrides {
"checkpoint" = "<full path to local provider binary directory>",
}
}
Create terraform file (*.tf
) with provider configuration and run terraform apply
, Terraform will use the local provider you set in dev_overrides
.
# Local provider configuration
provider "checkpoint" {
server = "192.0.2.1"
username = "aa"
password = "aaaa"
context = "web_api"
session_name = "Terraform session"
}
# Add any resource you want to run ...
-
Run specific test from IDE. Go to test file ends with
*_test.go
and click 'Run Test'. This requires to define the following environment variables:CHECKPOINT_SERVER
,CHECKPOINT_USERNAME
,CHECKPOINT_PASSWORD
andCHECKPOINT_CONTEXT
-
(Optional) In order to test the provider, you can simply run
make test
.
$ make test
- (Optional) 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