State Management

Download remote Terraform/OpenTofu state configuration to work locally with deployed infrastructure.

Overview

When working with deployments in Bluebricks, state is automatically managed in the cloud. Use bricks bp state-config to retrieve remote state configuration and work with it locally.

Download State Configuration

bricks bp state-config <deployment-slug>

Prerequisites

• Authenticated with Bluebricks (bricks login)

• Existing deployment with Terraform/OpenTofu artifacts

• Local directory with infrastructure code

What This Command Does

The command retrieves the remote state backend configuration and generates two files:

backend.tf - HTTP backend configuration

terraform {
  backend "http" {
    address        = "https://api.bluebricks.co/api/v1/deployments/<uuid>/state"
    lock_address   = "https://api.bluebricks.co/api/v1/deployments/<uuid>/lock"
    unlock_address = "https://api.bluebricks.co/api/v1/deployments/<uuid>/lock"
    username       = "<deployment-uuid>"
    password       = "<jwt-token>"
  }
}

bbx-terraform-temp.auto.tfvars - Deployment variables

vpc_name = "my-production-vpc"
cidr_block = "10.10.0.0/16"
environment = "production"

Working with Remote State

Initialize Backend

After downloading the configuration, initialize the backend:

terraform init
# or
tofu init

View Current State

terraform show
# or
tofu show

Run Commands

Once initialized, run standard Terraform/OpenTofu commands:

# View plan
terraform plan

# Show resources
terraform state list

# View specific resource
terraform state show <resource-address>

Example Workflow

# 1. Download state config
bricks bp state-config my-vpc-deployment

# 2. Initialize backend
terraform init

# 3. View current state
terraform show

# 4. Make changes to your code
vim main.tf

# 5. Plan changes
terraform plan

Use Cases

Debugging Infrastructure View current state to troubleshoot issues or verify resource configuration.

Local Development Test changes against live state before deploying through Bluebricks.

State Inspection Examine resource attributes and outputs without accessing the cloud console.

Important Notes

• Read-only recommended: Avoid applying changes directly - use Bluebricks for deployments

• State locking: Automatic state locking prevents concurrent modifications

• Credentials: The generated JWT token expires after a period

• No manual import needed: State is already populated from the deployment

See also

• Bricks CLI overview -- CLI installation and configuration

• How to Authenticate with CLI -- authentication for state access