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:
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.10.0"
}
}
}
provider "biganimal" {
# Configuration options
ba_bearer_token = <redacted> // See Getting an API Token section for details
ba_access_key = <redacted> // See Getting an Access Key section for details
}You can also set the BA_BEARER_TOKEN, BA_ACCESS_KEY environment variables. When those environment variables are present, you
don't need to add any configuration options to the provider block described above. Only either BA_BEARER_TOKEN or BA_ACCESS_KEY needs to be set, if both are set then BA_ACCESS_KEY will take priority and be used.
export BA_BEARER_TOKEN=<redacted>
export BA_ACCESS_KEY=<redacted>Warning
OAuth2 authorization and thus BA_BEARER_TOKEN will be deprecated in future Terraform Provider releases. It is recommended to use BA_ACCESS_KEY as soon as you can.
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.
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".
Please visit the DEVELOPMENT.md page for further details about development and testing.