The Serval Terraform provider provides convenient access to the Serval REST API from Terraform.

This provider requires Terraform CLI 1.0 or later. You can install it for your system on Hashicorp's website.

Add the following to your main.tf file:

# Declare the provider and version
terraform {
  required_providers {
    serval = {
      source  = "ServalHQ/serval"
      version = "~> 0.26.0"
    }
  }
}

# Initialize the provider
provider "serval" {
  client_id = "My Client ID" # or set SERVAL_CLIENT_ID env variable
  client_secret = "My Client Secret" # or set SERVAL_CLIENT_SECRET env variable
  bearer_token = "My Bearer Token" # or set SERVAL_BEARER_TOKEN env variable
}

# Configure a resource
resource "serval_access_policy" "example_access_policy" {

}

Initialize your project by running terraform init in the directory.

Additional examples can be found in the ./examples folder within this repository, and you can refer to the full documentation on the Terraform Registry.

When you initialize the provider, the following options are supported. It is recommended to use environment variables for sensitive values like access tokens. If an environment variable is provided, then the option does not need to be set in the terraform source.

This package generally follows SemVer conventions, though certain backwards-incompatible changes may be released as minor versions:

1. Changes to library internals which are technically public but not intended or documented for external use. (Please open a GitHub issue to let us know if you are relying on such internals.)
2. Changes that we do not expect to impact the vast majority of users in practice.

We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.

We are keen for your feedback; please open an issue with questions, bugs, or suggestions.