runway.module.terraform module

Terraform module.

class runway.module.terraform.Terraform

Bases: RunwayModule[TerraformOptions], DelCachedPropMixin

Terraform Runway Module.

__init__(context: RunwayContext, *, explicitly_enabled: bool | None = False, logger: RunwayLogger = <RunwayLogger runway.module.terraform (WARNING)>, module_root: Path, name: str | None = None, options: dict[str, Any] | ModuleOptions | None = None, parameters: dict[str, Any] | None = None, **_: Any) → None

Instantiate class.

Parameters:

• context – Runway context object for the current session.

• explicitly_enabled – Whether or not the module is explicitly enabled. This is can be set in the event that the current environment being deployed to matches the defined environments of the module/deployment.

• logger – Used to write logs.

• module_root – Root path of the module.

• name – Name of the module.

• options – Options passed to the module class from the config as options or module_options if coming from the deployment level.

• parameters – Values to pass to the underlying infrastructure as code tool that will alter the resulting infrastructure being deployed. Used to templatize IaC.

property auto_tfvars: Path

Return auto.tfvars file if one is being used.

cleanup_dot_terraform() → None

Remove .terraform excluding the plugins directly.

This step is crucial for allowing Runway to deploy to multiple regions or deploy environments without prompting the user for input.

The plugins directory is retained to improve performance when they are used by subsequent runs.

property current_workspace: str

Wrap “terraform_workspace_show” to cache the value.

Returns:

The currently active Terraform workspace.

deploy() → None

Run Terraform apply.

destroy() → None

Run Terraform destroy.

property env_file: list[str]

Find the environment file for the module.

gen_command(command: list[str] | str | tuple[str, ...], args_list: list[str] | None = None) → list[str]

Generate Terraform command.

handle_backend() → None

Handle backend configuration.

This needs to be run before “skip” is assessed or env_file/auto_tfvars is used in case their behavior needs to be altered.

handle_parameters() → None

Handle parameters.

Either updating environment variables or writing to a file.

init() → None

Run init.

plan() → None

Run Terraform plan.

run(action: Literal['apply', 'destroy', 'get', 'init', 'plan', 'workspace_list', 'workspace_new', 'workspace_select', 'workspace_show']) → None

Run module.

property skip: bool

Determine if the module should be skipped.

terraform_apply() → None

Execute terraform apply command.

https://www.terraform.io/docs/cli/commands/apply.html

terraform_destroy() → None

Execute terraform destroy command.

https://www.terraform.io/docs/cli/commands/destroy.html

terraform_get() → None

Execute terraform get command.

https://www.terraform.io/docs/cli/commands/get.html

terraform_init() → None

Execute terraform init command.

https://www.terraform.io/docs/cli/commands/init.html

terraform_plan() → None

Execute terraform plan command.

https://www.terraform.io/docs/cli/commands/plan.html

terraform_workspace_list() → str

Execute terraform workspace list command.

https://www.terraform.io/docs/cli/commands/workspace/list.html

Returns:

The available Terraform workspaces.

Return type:

str

terraform_workspace_new(workspace: str) → None

Execute terraform workspace new command.

permanently to https://www.terraform.io/docs/cli/commands/workspace/new.html

Parameters:

workspace – Terraform workspace to create.

terraform_workspace_select(workspace: str) → None

Execute terraform workspace select command.

https://www.terraform.io/docs/cli/commands/workspace/select.html

Parameters:

workspace – Terraform workspace to select.

terraform_workspace_show() → str

Execute terraform workspace show command.

https://www.terraform.io/docs/cli/commands/workspace/show.html

Returns:

The current Terraform workspace.

property tf_bin: str

Path to Terraform binary.

property tfenv: TFEnvManager

Terraform environment manager.

property version: Version

Version of Terraform being used.

class runway.module.terraform.TerraformBackendConfig

Bases: ModuleOptions

Terraform backend configuration module options.

__init__(data: RunwayTerraformBackendConfigDataModel, deploy_environment: DeployEnvironment, path: Path) → None

Instantiate class.

Parameters:

• data – Options parsed into a data model.

• deploy_environment – Current deploy environment.

• path – Module path.

property config_file: Path | None

Backend configuration file.

static gen_backend_filenames(environment: str, region: str) → list[str]

Generate possible Terraform backend filenames.

Parameters:

• environment – Current deploy environment.

• region – Current AWS region.

classmethod get_backend_file(path: Path, environment: str, region: str) → Path | None

Determine Terraform backend file.

Parameters:

• path – Path to the module.

• environment – Current deploy environment.

• region – Current AWS region.

get_full_configuration() → dict[str, str]

Get full backend configuration.

property init_args: list[str]

Return command line arguments for init.

classmethod parse_obj(deploy_environment: DeployEnvironment, obj: object, path: Path | None = None) → TerraformBackendConfig

Parse options definition and return an options object.

Parameters:

• deploy_environment – Current deploy environment.

• obj – Object to parse.

• path – Module path.

class runway.module.terraform.TerraformOptions

Bases: ModuleOptions

Module options for Terraform.

args

CLI arguments/options to pass to Terraform.

data

Options parsed into a data model.

env

Current deploy environment.

path

Module path.

version

String containing a Terraform version.

write_auto_tfvars

Optionally write parameters to a tfvars file instead of updating variables.

__init__(data: RunwayTerraformModuleOptionsDataModel, deploy_environment: DeployEnvironment, path: Path | None = None) → None

Instantiate class.

Parameters:

• deploy_environment – Current deploy environment.

• data – Options parsed into a data model.

• path – Module path.

property backend_config: TerraformBackendConfig

Backend configuration options.

classmethod parse_obj(deploy_environment: DeployEnvironment, obj: object, path: Path | None = None) → TerraformOptions

Parse options definition and return an options object.

Parameters:

• deploy_environment – Current deploy environment.

• obj – Object to parse.

• path – Module path.

runway.module.terraform.gen_workspace_tfvars_files(environment: str, region: str) → list[str]

Generate possible Terraform workspace tfvars filenames.

runway.module.terraform.update_env_vars_with_tf_var_values(os_env_vars: dict[str, str], tf_vars: dict[str, dict[str, Any] | list[Any] | str]) → dict[str, str]

Return os_env_vars with TF_VAR values for each tf_var.