Skip to main content

Configure Terraform State storage

Terraform State is a file with the .tfstate extension that stores current information about the infrastructure state and the configurations used. Terraform State is created after running the terraform apply command for the first time and is updated every time changes are made to the configuration files. Terraform compares the actual infrastructure with its description in the Terraform State file. If Terraform detects discrepancies, it modifies the actual infrastructure so that it matches the description in Terraform State again. Learn more about Terraform State in the Terraform State in HCP Terraform article and the State section of the HashiCorp documentation.

By default, the Terraform State file is stored locally. To allow users to retrieve the IDs of created resources and share the infrastructure state, we recommend storing the Terraform State remotely. For example, you can configure Terraform State storage in Selectel S3.

Configure Terraform State storage in Selectel S3

For your information

This instruction is for Terraform version 1.6.0 and later.

  1. Create a bucket in S3.

  2. Add the backend block to the configuration file:

    terraform {
      required_providers {
        selectel = {
          source  = "selectel/selectel"
          version = "~> 8.6.0"
        }
        openstack = {
          source  = "terraform-provider-openstack/openstack"
          version = "3.4.0"
        }
      }

      backend "s3" {
        endpoints                   = { s3 = "https://s3.ru-1.storage.selcloud.ru" }
        key                         = "<file_name>.tfstate"
        region                      = "ru-1"
        skip_region_validation      = true
        skip_credentials_validation = true
        skip_requesting_account_id  = true
        skip_s3_checksum            = true
        skip_metadata_api_check     = true
      }
    }

    Specify <file_name> — the name of the Terraform state file in the S3 bucket.

  3. Create a secret.backend.tfvars file and add sensitive information required for authorization in S3 to it:

    bucket     = "<bucket_name>"
    access_key = "<access_key>"
    secret_key = "<secret_key>"

    Specify:

    • <bucket_name> — the name of the S3 bucket where the Terraform state file will be stored. You can find it in the Control panel under S3 → Containers;
    • <access_key> — the S3 Access Key ID issued to the user;
    • <secret_key> — the S3 Secret Access Key.

  4. Initialize the Terraform configuration changes:

    terraform init -backend-config=secret.backend.tfvars