Skip to content

Commit 99028cc

Browse files
committed
docs: fix misleading GCS service account impersonation claims
- Remove impersonate_service_account from example configurations - Update authentication methods to remove impersonation reference - Add clear limitation notice that impersonation is not yet implemented - Remove commented impersonation example in configuration This ensures users understand current limitations and prevents confusion about unsupported features.
1 parent 6fb4da5 commit 99028cc

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

website/docs/core-concepts/stacks/yaml-functions/terraform.state.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -368,8 +368,6 @@ components:
368368
bucket: "my-terraform-state"
369369
prefix: "terraform/state"
370370
credentials: "/path/to/service-account-key.json"
371-
# Or use impersonation:
372-
# impersonate_service_account: "[email protected]"
373371
vars:
374372
# Read state from another component
375373
vpc_id: !terraform.state vpc dev vpc_id
@@ -385,17 +383,19 @@ The GCS backend supports multiple authentication methods:
385383

386384
1. **Service Account Key File**: Specify the path to a service account JSON key file using the `credentials` parameter.
387385
2. **Default Credentials**: When no credentials are specified, the Google Cloud SDK default credentials are used.
388-
3. **Service Account Impersonation**: Use the `impersonate_service_account` parameter to impersonate a service account.
389-
4. **Workload Identity** (GKE): Automatically uses the workload identity when running in GKE with Workload Identity enabled.
386+
3. **Workload Identity** (GKE): Automatically uses the workload identity when running in GKE with Workload Identity enabled.
390387

391388
### GCS Backend Configuration Parameters
392389

393390
- `bucket`: The GCS bucket name where Terraform state files are stored
394391
- `prefix`: Optional prefix for the state file path within the bucket
395392
- `credentials`: Optional path to a service account JSON key file
396-
- `impersonate_service_account`: Optional service account email to impersonate
397393
- `state_file`: Optional custom name for the state file (defaults to `default.tfstate`)
398394

395+
:::note Current Limitations
396+
The `impersonate_service_account` parameter is parsed but not yet implemented. This feature is planned for a future release.
397+
:::
398+
399399
## Using `!terraform.state` with `static` remote state backend
400400

401401
Atmos supports [brownfield configuration by using the remote state of type `static`](/core-concepts/components/terraform/brownfield/#hacking-remote-state-with-static-backends).

0 commit comments

Comments
 (0)