/terraform-provider-bigip

Terraform resources that can configure F5 BIGIP products

Primary LanguageGoMozilla Public License 2.0MPL-2.0

Overview

A Terraform provider for F5 BigIP LTM.

Build Status Go Report Card license Gitter chat

Requirements

  • Terraform 0.11.x / 0.12.x
  • Go 1.11 (to build the provider plugin)

F5 BigIP LTM requirements

  • This provider uses the iControlREST API, make sure that it is installed and enabled on your F5 device before proceeding.

These BIG-IP versions are supported in these Terraform versions.

BIG-IP version Terraform 0.12 Terraform 0.11
BIG-IP 14.x X X
BIG-IP 12.x X X
BIG-IP 13.x X X

Documentation

Provider documentation and reference can be found here.

Building the Provider

Clone repository to: $GOPATH/src/github.com/terraform-providers/terraform-provider-bigip

$ mkdir -p $GOPATH/src/github.com/terraform-providers; cd $GOPATH/src/github.com/terraform-providers
$ git clone https://github.com/terraform-providers/terraform-provider-bigip.git

Enter the provider directory and build the provider

$ cd $GOPATH/src/github.com/terraform-providers/terraform-provider-bigip
$ make build

Using the Provider

If you're building the provider, follow the instructions to install it as a plugin. After placing it into your plugins directory, run terraform init to initialize it.

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.

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

$ make build
...
$ $GOPATH/bin/terraform-provider-bigip
...

Testing

Running the acceptance test suite requires an F5 to test against. Set BIGIP_HOST, BIGIP_USER and BIGIP_PASSWORD to a device to run the tests against. By default tests will use the Common partition for creating objects. You can change the partition by setting BIGIP_TEST_PARTITION.

BIGIP_HOST=f5.mycompany.com BIGIP_USER=foo BIGIP_PASSWORD=secret make testacc

Read here for more information about acceptance testing in Terraform.

Community Help

We encourage you to use our Slack channel for discussion and assistance on Terraform Resources (click the terraform channel). There are F5 employees who are members of this community who typically monitor the channel Monday-Friday 9-5 PST and will offer best-effort assistance. This slack channel community support should not be considered a substitute for F5 Technical Support. See the Slack Channel Statement for guidelines on using this channel.