The Terraform provider for Contentstack lets you manage the configuration of a Contentstack stack as code. Content types, global fields, environments, locales and webhooks are defined in Terraform, so changes to a stack can be reviewed, versioned and applied the same way across stacks and branches. It is built on the Terraform Plugin Framework and uses contentstack-go-sdk to talk to the Contentstack Content Management API.
The full documentation is on the Terraform Registry.
- Terraform 1.0 or newer, or OpenTofu
- Go 1.27 or newer, only to build the provider
from source (see
go.mod)
Add the provider to your Terraform configuration and run terraform init:
terraform {
required_providers {
contentstack = {
source = "labd/contentstack"
version = "~> 0.4"
}
}
}All provider attributes are optional in the schema, but base_url and
api_key are needed to reach a stack, plus one way to authenticate:
management_token: a stack-level management token (recommended). It is sent as theauthorizationheader.auth_token: a user-specific authtoken. It is only used when nomanagement_tokenis set.
provider "contentstack" {
base_url = "https://eu-api.contentstack.com/"
api_key = var.contentstack_api_key
management_token = var.contentstack_management_token
branch = "main"
# Optional: retries for 429 (rate limit) responses
max_retries = 3
retry_wait_min = 1
retry_wait_max = 30
}| Attribute | Description |
|---|---|
base_url |
The Content Management API base URL for your region, see Base URL. |
api_key |
The API key of the stack. |
management_token |
Stack management token (sensitive). |
auth_token |
User authtoken (sensitive). |
branch |
The branch to manage resources in. Defaults to the main branch. |
max_retries |
Maximum retry attempts for 429 responses. Defaults to 3. |
retry_wait_min |
Minimum wait in seconds between retries. Defaults to 1. |
retry_wait_max |
Maximum wait in seconds between retries. Defaults to 30. |
The provider does not read any environment variables. To keep credentials out
of your configuration, pass them in through Terraform variables, for example
TF_VAR_contentstack_management_token.
The provider has these resources:
| Resource | Manages |
|---|---|
contentstack_content_type |
Content types |
contentstack_global_field |
Global fields |
contentstack_environment |
Publishing environments |
contentstack_locale |
Languages (locales) |
contentstack_webhook |
Webhooks |
A content type with its schema given as JSON, a locale, an environment and a webhook:
resource "contentstack_content_type" "page" {
title = "Page"
uid = "page"
description = "A simple page"
schema = jsonencode([
{
display_name = "Title"
uid = "title"
data_type = "text"
mandatory = true
unique = true
multiple = false
non_localizable = false
}
])
}
resource "contentstack_locale" "nl" {
name = "Nederlands"
code = "nl-nl"
fallback_locale = "nl"
}
resource "contentstack_environment" "production" {
name = "production"
url {
locale = "nl-nl"
url = "https://www.example.nl/"
}
}
resource "contentstack_webhook" "publish" {
name = "publish"
destination {
target_url = "https://example.com/hooks/contentstack"
http_basic_auth = "user"
http_basic_password = var.webhook_password
custom_headers = [{
header_name = "X-Custom"
value = "value"
}]
}
channels = ["assets.create"]
branches = ["main"]
retry_policy = "manual"
disabled = false
concise_payload = true
}All resources can be imported by their Contentstack UID:
terraform import contentstack_content_type.page pageMore examples are in the examples/ directory.
The repository uses Task as a task runner:
task format # go fmt ./...
task test # go test -v ./...
task docs # go generate: terraform fmt on examples/ and regenerate docs/
task coverage # test coverage reportCI runs go test -race -v ./..., golangci-lint, govulncheck and
go generate ./.... It fails when the generated docs differ from what is
committed, so run task docs after changing a schema or an example. This needs
terraform on your PATH.
To try a local build, install it with go install . and point Terraform at it
with a dev_overrides block in ~/.terraformrc:
provider_installation {
dev_overrides {
"labd/contentstack" = "/path/to/your/go/bin"
}
direct {}
}Releases are managed with changie:
- Every change adds a changelog fragment with
changie new. It is stored in.changes/unreleased/. Dependabot PRs get one automatically. - On every push to
main, the changie-release-action opens or updates a release PR that batches the unreleased fragments and updatesCHANGELOG.md. - Merging that PR tags the release and triggers the
releaseworkflow. That workflow runs GoReleaser to build and sign the binaries and publish a GitHub release, which the Terraform Registry picks up.
MIT, copyright Lab Digital.