Skip to content

CheckPointSW/terraform-provider-checkpoint

Repository files navigation

Terraform Provider for CHECK POINT SOFTWARE TECHNOLOGIES

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 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.

Requirements

  • Terraform 0.10.x
  • Go 1.11 (to build the provider plugin)

Building the provider

  1. 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
  1. To build the provider locally, run the following command from the repository root directory.
# Windows
go build -o terraform-provider-checkpoint.exe
  1. (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
  1. For local development, update dev_overrides configuration file. See the next section below.

Developing the provider

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 ...

Running local tests

  1. 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 and CHECKPOINT_CONTEXT

  2. (Optional) In order to test the provider, you can simply run make test.

$ make test
  1. (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