Documentation
¶
Overview ¶
Package terraform provides terraform-specific types and utilities for Atmos. This package contains shared data structures used by cmd/terraform and internal/exec. for terraform operations.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CleanOptions ¶
type CleanOptions struct {
Component string
Stack string
Force bool
Everything bool
SkipLockFile bool
DryRun bool
Cache bool // Clean shared plugin cache directory.
}
CleanOptions holds options for the terraform clean command.
type GenerateBackendOptions ¶
type GenerateBackendOptions struct {
Component string
Stack string
ProcessingOptions
}
GenerateBackendOptions holds options for generating Terraform backend configs.
type PlanfileOptions ¶
type PlanfileOptions struct {
Component string
Stack string
Format string
File string
ProcessTemplates bool
ProcessYamlFunctions bool
Skip []string
}
PlanfileOptions holds the options for generating a Terraform planfile.
type ProcessingOptions ¶
ProcessingOptions holds common options for template and function processing. This struct is embedded in command-specific options to avoid repetition.
type ShellOptions ¶
type ShellOptions struct {
Component string
Stack string
DryRun bool
Identity string // AWS identity to use for authentication (from --identity flag).
// WithSecrets, when true, exports secret-bearing variables into the interactive shell
// as TF_VAR_<name> environment variables. By default they are not exported (and never
// written to the on-disk varfile), so terraform inside the shell will not see them.
WithSecrets bool
// SkipInit, when true, skips `terraform init` before launching the shell (from --skip-init).
// Workspace selection is unaffected and stays governed by the workspaces_enabled setting.
SkipInit bool
ProcessingOptions
}
ShellOptions holds options for the terraform shell command.
type VarfileOptions ¶
type VarfileOptions struct {
Component string
Stack string
File string
// WithSecrets, when true, writes resolved secret values into the generated varfile.
// By default secrets are omitted from the varfile so plaintext secrets never hit disk.
WithSecrets bool
ProcessingOptions
}
VarfileOptions holds options for generating Terraform varfiles.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package cache is the lifecycle facade for the Terraform registry cache.
|
Package cache is the lifecycle facade for the Terraform registry cache. |
|
Package clean provides functionality to clean up Terraform state and artifacts.
|
Package clean provides functionality to clean up Terraform state and artifacts. |
|
Package generate provides functionality to generate files from the generate section in Atmos stack configuration.
|
Package generate provides functionality to generate files from the generate section in Atmos stack configuration. |
|
Package lockfile parses Terraform/OpenTofu dependency lock files (.terraform.lock.hcl) to extract the exact set of providers and versions a component depends on.
|
Package lockfile parses Terraform/OpenTofu dependency lock files (.terraform.lock.hcl) to extract the exact set of providers and versions a component depends on. |
|
Package mirror implements eager, multi-platform pre-seeding of the Terraform registry cache.
|
Package mirror implements eager, multi-platform pre-seeding of the Terraform registry cache. |
|
Package output provides functionality to format and export Terraform outputs in various formats suitable for CI/CD workflows, scripts, and configuration files.
|
Package output provides functionality to format and export Terraform outputs in various formats suitable for CI/CD workflows, scripts, and configuration files. |
|
Package rc renders Atmos's `components.terraform.rc` section into Terraform's native CLI configuration (HCL) and exposes it to the terraform/tofu subprocess via TF_CLI_CONFIG_FILE.
|
Package rc renders Atmos's `components.terraform.rc` section into Terraform's native CLI configuration (HCL) and exposes it to the terraform/tofu subprocess via TF_CLI_CONFIG_FILE. |
|
Package registry implements Terraform provider and module registry mirrors as adapters for the generic caching proxy (pkg/http/proxy).
|
Package registry implements Terraform provider and module registry mirrors as adapters for the generic caching proxy (pkg/http/proxy). |
|
Package tfvars partitions Terraform variables into a disk-safe subset and a secret-bearing subset, and renders the secret subset as TF_VAR_* environment variables.
|
Package tfvars partitions Terraform variables into a disk-safe subset and a secret-bearing subset, and renders the secret subset as TF_VAR_* environment variables. |