Remote state data source for cross-project in Terraform - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a remote state data source in Terraform?

A remote state data source lets Terraform read the saved state of infrastructure from another project or workspace. This helps share information between projects safely.

beginner

Why use remote state data source for cross-project references?

It allows one Terraform project to access outputs or resources from another project without duplicating resources or manual syncing.

intermediate

Which backend is commonly used for storing remote state in Terraform for cross-project access?

Backends like AWS S3, Google Cloud Storage, or Terraform Cloud are commonly used to store remote state securely and allow cross-project access.

intermediate

What is the key block to define a remote state data source in Terraform?

The key block is `data "terraform_remote_state"` which specifies the backend and configuration to read the remote state.

advanced

How do you ensure security when accessing remote state across projects?

Use proper access controls on the backend storage, encrypt state files, and limit permissions to only what is needed for reading state.

What Terraform block is used to access remote state from another project?

A output "remote_state"

B data "terraform_remote_state"

C resource "remote_state"

D module "remote_state"

The `data "terraform_remote_state"` block is used to read remote state data from another project or workspace.

Which of these is NOT a common backend for storing Terraform remote state?

A Local file system

B AWS S3

C Terraform Cloud

D Google Cloud Storage

Local file system is not suitable for cross-project remote state sharing because it is not accessible remotely.

Why is remote state important for cross-project Terraform setups?

A To store logs

B To speed up Terraform runs

C To share resource outputs between projects

D To avoid writing Terraform code

Remote state allows sharing outputs or resource information between projects to coordinate infrastructure.

What must you configure in the remote state data source to access a specific project’s state?

A Output variables

B Terraform version

C Resource tags

D Backend type and configuration details

You must specify the backend type (like S3) and its configuration (bucket, key, region) to access the remote state.

How can you protect sensitive data in remote state files?

A Encrypt the state file and restrict access permissions

B Store state files locally

C Use plain text files

D Share state files publicly

Encrypting state files and restricting access ensures sensitive data is protected when using remote state.

Explain how to configure a Terraform remote state data source to read state from another project.

Think about the backend and how Terraform reads remote state.

Describe best practices for securely sharing Terraform remote state across projects.

Focus on security and access control.

Practice

1. What is the main purpose of using a terraform_remote_state data source in Terraform?

easy

A. To store Terraform state files locally

B. To access outputs from another Terraform project's state

C. To create new resources in a different cloud provider

D. To encrypt Terraform state files automatically

Solution

1. Step 1: Understand remote state data source role

   The terraform_remote_state data source allows one Terraform configuration to read outputs from another configuration's state file.

2. Step 2: Differentiate from other options

   It does not store state locally, create new resources, or encrypt state automatically; it only reads existing state outputs.

3. Final Answer:

   To access outputs from another Terraform project's state -> Option B

4. Quick Check:

   Remote state data source = Access outputs [OK]

Hint: Remote state data source reads outputs from other projects [OK]

Common Mistakes:

• Confusing remote state with local state storage
• Thinking it creates resources instead of reading state
• Assuming it encrypts state automatically

2. Which of the following is the correct syntax to define a terraform_remote_state data source for a backend stored in an S3 bucket named my-terraform-state?

easy

A. data "terraform_remote_state" "example" { backend = "local" config = { path = "my-terraform-state" } }

B. resource "terraform_remote_state" "example" { backend = "s3" bucket = "my-terraform-state" }

C. terraform_remote_state "example" { backend = "s3" bucket = "my-terraform-state" }

D. data "terraform_remote_state" "example" { backend = "s3" config = { bucket = "my-terraform-state" key = "state.tfstate" region = "us-east-1" } }

Solution

1. Step 1: Identify correct resource type and syntax

   The terraform_remote_state must be declared as a data block, not a resource.

2. Step 2: Check backend and config structure

   For S3 backend, the config requires bucket, key, and region inside a config map.

3. Final Answer:

   data "terraform_remote_state" "example" { backend = "s3" config = { bucket = "my-terraform-state" key = "state.tfstate" region = "us-east-1" } } -> Option D

4. Quick Check:

   Correct syntax = data "terraform_remote_state" "example" { backend = "s3" config = { bucket = "my-terraform-state" key = "state.tfstate" region = "us-east-1" } } [OK]

Hint: Use data block with backend and config map for remote state [OK]

Common Mistakes:

• Using resource instead of data block
• Missing required config keys like key or region
• Using wrong backend type like local for S3

3. Given this Terraform snippet accessing remote state:

data "terraform_remote_state" "network" {
  backend = "gcs"
  config = {
    bucket = "tf-state-bucket"
    prefix = "network"
  }
}

output "vpc_id" {
  value = data.terraform_remote_state.network.outputs.vpc_id
}

What will output.vpc_id contain?

medium

A. The entire remote state file content as a string

B. An error because prefix is not a valid config key for GCS backend

C. The VPC ID output from the remote state stored in the GCS bucket under prefix 'network'

D. Null because outputs cannot be accessed from remote state

Solution

1. Step 1: Understand remote state data source usage

   The data source reads the remote state from the GCS bucket with the given prefix, making outputs available.

2. Step 2: Confirm output access

   The output vpc_id is accessed correctly via data.terraform_remote_state.network.outputs.vpc_id, so it returns the VPC ID value.

3. Final Answer:

   The VPC ID output from the remote state stored in the GCS bucket under prefix 'network' -> Option C

4. Quick Check:

   Remote output access = VPC ID value [OK]

Hint: Remote state outputs accessed via data.<name>.outputs.<key> [OK]

Common Mistakes:

• Confusing prefix usage for GCS backend (it is valid)
• Expecting entire state file instead of outputs
• Assuming outputs cannot be read remotely

4. You have this Terraform remote state data source:

data "terraform_remote_state" "app" {
  backend = "azurerm"
  config = {
    resource_group_name = "rg-state"
    storage_account_name = "stterraform"
    container_name = "tfstate"
    key = "app.terraform.tfstate"
  }
}

When running terraform plan, you get an error: Failed to load remote state. What is the most likely cause?

medium

A. Incorrect or missing permissions to access the Azure storage account

B. The backend type should be s3 instead of azurerm

C. The key parameter is not supported in azurerm backend

D. Terraform remote state data source cannot be used with Azure

Solution

1. Step 1: Verify backend and config correctness

   The backend azurerm with given config keys is valid for Azure Blob Storage remote state.

2. Step 2: Identify common causes of load failure

   Most common cause is missing or incorrect permissions to access the storage account or container.

3. Final Answer:

   Incorrect or missing permissions to access the Azure storage account -> Option A

4. Quick Check:

   Access permissions issue = Load failure [OK]

Hint: Check storage permissions if remote state load fails [OK]

Common Mistakes:

• Assuming backend type is wrong when it is correct
• Thinking key parameter is unsupported in azurerm backend
• Believing remote state cannot be used with Azure

5. You manage two Terraform projects: network and app. The network project stores its state remotely in an S3 bucket with key network/terraform.tfstate. You want the app project to use the VPC ID output from network. Which configuration correctly sets up the remote state data source in app to access network outputs securely and follows best practices?

hard

A. data "terraform_remote_state" "network" {
backend = "s3"
config = {
bucket = "my-tf-state-bucket"
key = "network/terraform.tfstate"
region = "us-west-2"
}
}

B. data "terraform_remote_state" "network" {
backend = "s3"
config = {
bucket = "my-tf-state-bucket"
key = "app/terraform.tfstate"
region = "us-west-2"
}
}

C. data "terraform_remote_state" "network" {
backend = "local"
config = {
path = "../network/terraform.tfstate"
}
}

D. resource "terraform_remote_state" "network" {
backend = "s3"
config = {
bucket = "my-tf-state-bucket"
key = "network/terraform.tfstate"
region = "us-west-2"
}
}

Solution

1. Step 1: Confirm correct backend and key for remote state

   The remote state is stored in S3 bucket with key network/terraform.tfstate, so the data source must match this.

2. Step 2: Ensure data source type and security best practices

   Use a data block (not resource) with backend = "s3", specify region, and avoid incorrect keys.

3. Final Answer:

   Data source with backend s3, correct bucket/key, and region -> Option A

4. Quick Check:

   Correct backend and secure config = data "terraform_remote_state" "network" { backend = "s3" config = { bucket = "my-tf-state-bucket" key = "network/terraform.tfstate" region = "us-west-2" } } [OK]

Hint: Match backend/key exactly and use data block [OK]

Common Mistakes:

• Using wrong key path for remote state
• Using resource block instead of data block
• Using local backend instead of remote S3
• Omitting region config