terraform-provider-biganimal

README

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 = "0.7.1"
    }
  }
}

provider "biganimal" {
  # Configuration options
  ba_bearer_token = <redacted> // See Getting an API Token section for details
  // ba_api_uri   = "https://portal.biganimal.com/api/v3" // Optional
}

You can also set the BA_BEARER_TOKEN and BA_API_URI env vars. When those environment variables are present, you don't need to add any configuration options to the provider block described above.

export BA_BEARER_TOKEN=<redacted>
export BA_API_URI=https://portal.biganimal.com/api/v3

Getting an API Token

In order to access the BigAnimal API, it's necessary to fetch an api bearer token and either export it into your environment or add this token to the provider block.

Please visit Using the get-token script for more details.

Development

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