takescoop/Terraform Cloud Workspace

Manages Terraform Cloud workspaces

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
terraform_versionWorkspace Terraform version. This can be either an exact version or a version constraint (like ~> 1.0.0).1
terraform_tokenTerraform Cloud token.yes
terraform_hostTerraform Cloud host.app.terraform.io
terraform_organizationTerraform Cloud organization.yes
tfe_provider_versionTerraform Cloud provider version.0.30.2
nameName of the workspace. Becomes a prefix if workspaces are passed (`${name}-${workspace}`).${{ github.event.repository.name }}
descriptionTerraform Cloud workspace description${{ github.event.repository.description }}
tagsYAML encoded list of tag names applied to all workspaces""
workspace_tagsYAML encoded map of workspace names to a list of tag names, which are applied to the specified workspace""
runner_terraform_versionTerraform version used in GitHub Actions to manage the workspace and related resources.1.1.8
workspacesYAML encoded list of workspace names.""
backend_configYAML encoded backend configurations.
applyWhether to apply the proposed Terraform changes.yes
importWhether to import existing matching resources from the Terraform Cloud organization.true
variablesYAML encoded variables to apply to all workspaces.""
workspace_variablesYAML encoded map of variables to apply to specific workspaces, with each key corresponding to a workspace.""
vcs_typeTerraform VCS type (e.g., "github"). Superseded by `vcs_token_id`. If neither are passed, no VCS integration is added.no
vcs_token_idTerraform VCS client token ID. Takes precedence over `vcs_name`. If neither are passed, no VCS integration is added.
vcs_repoRepository identifier for a VCS integration.${{ github.repository }}
vcs_ingress_submodulesWhether to allow submodule ingress.false
working_directoryA relative path that Terraform will execute within. Defaults to the root of your repository.
agent_pool_idID of an agent pool to assign to the workspace. If passed, execution_mode is set to "agent".
execution_modeExecution mode to use for the workspace.remote
global_remote_stateWhether all workspaces in the organization can access the workspace via remote state.false
remote_state_consumer_idsComma separated list of workspace IDs to allow read access to the workspace outputs.""
auto_applyWhether to set auto_apply on the workspace or workspaces.true
queue_all_runsWhether the workspace should start automatically performing runs immediately after creation.
speculative_enabledWhether the workspace allows speculative plans.
ssh_key_idSSH key ID to assign the workspace.
file_triggers_enabledWhether to filter runs based on the changed files in a VCS push.
remote_statesYAML encoded remote state blocks to configure in the workspace.
team_accessYAML encoded teams and their associated permissions to be granted to the created workspaces.no
allow_workspace_deletionWhether to allow workspaces to be deleted. If enabled, workspace state may be irrecoverably deleted.false
run_triggersYAML encoded list of either workspace IDs or names that, when applied, trigger runs in all the created workspaces (max 20)
workspace_run_triggersA YAML encoded map of workspaces to workspace IDs or names, which like `run_triggers`, will trigger a run for the associated workspace when the source workspace is ran
notification_configurationA YAML encoded map of notification settings applied to all created workspaces
namedescription
planA human friendly output of the Terraform plan.
plan_jsonA JSON representation of the Terraform plan.