Skip to content
Terraform provider for Contentful
Go Makefile Shell
Branch: master
Clone or download

README.md

Build Status license

Terraform Provider for Contentful's Content Management API

About

Contentful provides a content infrastructure for digital teams to power content in websites, apps, and devices. Unlike a CMS, Contentful was built to integrate with the modern software stack. It offers a central hub for structured content, powerful management and delivery APIs, and a customizable web app that enable developers and content creators to ship digital products faster.

Terraform is a tool for building, changing, and versioning infrastructure safely and efficiently. Terraform can manage existing and popular service providers as well as custom in-house solutions.

Features

Create, update and delete Contentful resources such as:

  • Spaces
  • Content Types
  • API Keys
  • Webhooks
  • Locales

Getting started

Download go for your platform.

Follow the Install the Go tools instructions.

Download terraform for your platform.

Follow the Installing Terraform instructions.

Create a directory where your terraform files and states will be placed. Although not mandatory this should be placed under a version control software such as git.

Make sure you have your Content Management API Token and the organization ID before starting. As an alternative to configuring the provider in the terraform file you can also set environment variables.

    # For Linux/Mac OS
    export CONTENTFUL_ORGANIZATION_ID=<your organization ID>
    export CONTENTFUL_MANAGEMENT_TOKEN=<your CMA Token>
    REM For Windows
    setx CONTENTFUL_ORGANIZATION_ID "<your organization ID>"
    setx CONTENTFUL_MANAGEMENT_TOKEN "<your CMA Token>"

Using the provider

Build the binary

$ go build -o terraform-provider-contentful

Add it to your ~/.terraformrc (or %APPDATA%/terraform.rc for Windows)

$ cat ~/.terraformrc
providers {
    contentful = "<path to the go binary>/terraform-provider-contentful"
}

Use the provider by creating a main.tf file with:

provider "contentful" {
  cma_token = "<your CMA Token>"
  organization_id = "<your organization ID>"
}
resource "contentful_space" "test" {
  name = "my-update-space-name"
}

Run the terraform plan

terraform plan -out=contentful.plan

Check the changes

The refreshed state will be used to calculate this plan, but will not be
persisted to local or remote state storage.

The Terraform execution plan has been generated and is shown below.
Resources are shown in alphabetical order for quick scanning. Green resources
will be created (or destroyed and then created if an existing resource
exists), yellow resources are being changed in-place, and red resources
will be destroyed. Cyan entries are data sources to be read.

Your plan was also saved to the path below. Call the "apply" subcommand
with this plan file and Terraform will exactly execute this execution
plan.

Path: contentful.plan

+ contentful_space.test
    default_locale: "en"
    name:           "my-update-space-name"
    version:        "<computed>"


Plan: 1 to add, 0 to change, 0 to destroy.

Apply the plan

contentful_space.test: Creating...
  default_locale: "" => "en"
  name:           "" => "my-update-space-name"
  version:        "" => "<computed>"
contentful_space.test: Creation complete (ID: yculypygam9h)

Apply complete! Resources: 1 added, 0 changed, 0 destroyed.

The state of your infrastructure has been saved to the path
below. This state is required to modify and destroy your
infrastructure, so keep it safe. To inspect the complete state
use the `terraform show` command.

State path:

Testing

TF_ACC=1 go test -v

To enable higher verbose mode

TF_LOG=debug TF_ACC=1 go test -v

Documentation/References

Hashicorp

Terraform plugins

Writing custom terraform providers

Other references

Julien Fabre: Writing a Terraform provider

Support

If you have a problem with this provider, please file an issue here on Github.

License

MIT

You can’t perform that action at this time.