Install the Chronosphere Terraform provider

To use the Chronosphere Terraform provider, you must first install Terraform. For details, see the Terraform documentation (opens in a new tab).

Use the following steps to install the Chronosphere Terraform provider for your use:

  1. Install the Terraform provider from a registry.
  2. Authenticate to Chronosphere.
  3. Bootstrap your Terraform configuration.

Install the provider from a registry

Chronosphere hosts the Terraform provider in a custom registry. To install and use the provider automatically, configure your provider using the following code:

terraform {
  required_providers {
    chronosphere = {
      version = "${versions.terraform}"
      source  = "tf-registry.chronosphere.io/chronosphere/chronosphere"
    }
  }
}

Replace ${versions.terraform} with "0.46.0".

Authenticate to Chronosphere

The Terraform provider requires an API token generated from an unrestricted service account to authenticate with the Chronosphere API. If you need to create a new service account, you must use an account that belongs to a team with the SysAdmin role.

⚠️

Store the API token in a secure location. If you lose your token, you must create a new service account.

After you have the API token, you can use it to grant Terraform permission to modify Chronosphere resources:

  1. In the shell environment where you plan to run Terraform, set the CHRONOSPHERE_API_TOKEN environment variable:

    export CHRONOSPHERE_API_TOKEN=API_TOKEN_VALUE

    Replace API_TOKEN_VALUE with the service account's API token.

  2. Add your organization to the provider configuration in your Terraform file:

    provider "chronosphere" {
      org = "MY_ORG"
    }

Replace MY_ORG with your Chronosphere subdomain name, such as MY_ORG.chronosphere.io.

  1. Run terraform init to set up the local data necessary to run Terraform with a new provider.

Bootstrap your Terraform configuration

You can use Terraform to manage new or existing supported resources. The chronotf tool generates Terraform configurations from existing resources and imports them into the Terraform state.

Install chronotf

Use curl (opens in a new tab) to download the latest version of chronotf, which is available for Linux and macOS.

  1. Download the darwin_amd64 build of chronotf:

    curl -LO https://storage.googleapis.com/chronosphere-terraform/0.46.0/chronotf_0.46.0_darwin_amd64

  2. Make the chronotf binary executable.

    chmod +x chronotf_0.46.0_darwin_amd64

  3. Move the binary into your PATH:

    sudo mv chronotf_0.46.0_darwin_amd64 /usr/local/bin/chronotf

    If you don't have permission to install to /usr/local/bin, replace it with another directory in your PATH.

  4. Test the chronotf installation by running it:

    chronotf version

Run chronotf

Terraform keeps local state to determine how to reconcile Terraform files with real resources.

If you created some of your Terraform resources outside of Terraform, import them into the Terraform state with the chronotf import-state command before running terraform apply.

  1. Create Terraform configuration for existing resources.

    Use the following command to export existing resources to a main.tf Terraform file:

    ./chronotf export-config -o main.tf --api-token API_TOKEN --org MY_ORG

    Replace the following:

    • API_TOKEN: a Chronosphere API token, such as from a service account.
    • MY_ORG: your Chronosphere subdomain name, such as MY_ORG.chronosphere.io.
  2. Preview what Terraform adds when bootstrapping its state with the --dry-run flag.

    From the directory with the Terraform files and state, run:

    chronotf import-state --dry-run
  3. Bootstrap the Terraform state.

    From the directory with the Terraform files and state, run:

    chronotf import-state