README.md

Terraform Provider BigAnimal

A Terraform Provider to manage your workloads on EDB BigAnimal interacting with the BigAnimal API. The provider is licensed under the MPL v2.

If you are willing to contribute please read here.

Main links:

• License
• Code of Conduct
• Security
• Contributing
• Development

Requirements

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

Using the provider

To install the BigAnimal provider, copy and paste this code into your Terraform configuration. Then, run terraform init.

terraform {
  required_providers {
    biganimal = {
      source  = "EnterpriseDB/biganimal"
      version = "1.1.1"
    }
  }
}

provider "biganimal" {
  # Configuration options
  ba_access_key = <redacted> // See Getting an Access Key section for details
}

You can also set the BA_ACCESS_KEY environment variable. When it is set as env var, you don't need to add any configuration options to the provider block described above.

export BA_ACCESS_KEY=<redacted>

Getting an Access Key

You can use an access key to access the BigAnimal API. The advantage of an access key compared to an API token is that it can be set to have a long expiry date which will aide automation.

To get an access key or manage access keys Log in to https://portal.biganimal.com/, hover over your username and from the drop down click "Access Keys".

Development

Please visit the DEVELOPMENT.md page for further details about development and testing.