Documentation
¶
Index ¶
- Constants
- func IsBackendBlock(block *hclwrite.Block) bool
- func RunProcess(terragruntOptions *options.TerragruntOptions) error
- type BackendHandler
- type BlockAndFile
- type ExceededMaxNestedBlocks
- type MissingExpectedParam
- type PathBasedBackendHandler
- type ResourcesNotAllowed
- type TerraformBackend
- type TerraformFiles
- type UnrecognizedBackendType
- type WorkspaceBasedBackendHandler
- type WrongNumberOfArguments
- type WrongNumberOfLabels
Constants ¶
View Source
const ProcessHelp = `` /* 290-byte string literal not displayed */
Variables ¶
This section is empty.
Functions ¶
func IsBackendBlock ¶
func RunProcess ¶
func RunProcess(terragruntOptions *options.TerragruntOptions) error
Types ¶
type BackendHandler ¶
type BackendHandler interface {
// UpdateBackendConfig updates the backend configuration for the current module to have the proper settings in the
// generated code (after preprocessing). This method should make the changes directly in the given backend object.
UpdateBackendConfig(backend *TerraformBackend, currentModuleName string, envName *string, terragruntOptions *options.TerragruntOptions) error
// UpdateTerraformRemoteStateConfig updates the configuration of a terraform_remote_state data source to allow the
// current module to read the state file of another module. This method should make the changes directly in the
// given backendConfigBody object, which represents the body of the config = { ... } section of the
// terraform_remote_state data source.
UpdateTerraformRemoteStateConfig(backend *TerraformBackend, backendConfigBody *hclwrite.Body, currentModuleName string, otherModuleName string) error
}
BackendHandler represents a way to automatically update various types of Terraform backends: e.g., s3, azurerm, gcs, remote, cloud, etc.
type BlockAndFile ¶
type BlockAndFile struct {
// contains filtered or unexported fields
}
type ExceededMaxNestedBlocks ¶
type ExceededMaxNestedBlocks int
func (ExceededMaxNestedBlocks) Error ¶
func (err ExceededMaxNestedBlocks) Error() string
type MissingExpectedParam ¶
type MissingExpectedParam struct {
// contains filtered or unexported fields
}
func (MissingExpectedParam) Error ¶
func (err MissingExpectedParam) Error() string
type PathBasedBackendHandler ¶
type PathBasedBackendHandler struct {
// The name of the attribute in this backend's config that stores the "path" of the Terraform state file
PathAttributeName string
}
PathBasedBackendHandler represents Terraform backends that track where to store Terraform state using a "path" that looks like a file system path: e.g., /foo/bar/terraform.tfstate.
func (PathBasedBackendHandler) UpdateBackendConfig ¶
func (handler PathBasedBackendHandler) UpdateBackendConfig(backend *TerraformBackend, currentModuleName string, envName *string, terragruntOptions *options.TerragruntOptions) error
func (PathBasedBackendHandler) UpdateTerraformRemoteStateConfig ¶
func (handler PathBasedBackendHandler) UpdateTerraformRemoteStateConfig(backend *TerraformBackend, backendConfigBody *hclwrite.Body, currentModuleName string, otherModuleName string) error
type ResourcesNotAllowed ¶
type ResourcesNotAllowed struct {
// contains filtered or unexported fields
}
func (ResourcesNotAllowed) Error ¶
func (err ResourcesNotAllowed) Error() string
type TerraformBackend ¶
type TerraformBackend struct {
// contains filtered or unexported fields
}
func NewTerraformBackend ¶
func NewTerraformBackend(block *hclwrite.Block) (*TerraformBackend, error)
func (*TerraformBackend) ConfigureDataSource ¶
func (backend *TerraformBackend) ConfigureDataSource(dataSourceBody *hclwrite.Body, currentModuleName string, otherModuleName string, envName *string, terragruntOptions *options.TerragruntOptions) error
func (*TerraformBackend) UpdateConfig ¶
func (backend *TerraformBackend) UpdateConfig(currentModuleName string, envName *string, terragruntOptions *options.TerragruntOptions) error
type TerraformFiles ¶
TerraformFiles is a map from file path to the parsed HCL
type UnrecognizedBackendType ¶
type UnrecognizedBackendType string
func (UnrecognizedBackendType) Error ¶
func (err UnrecognizedBackendType) Error() string
type WorkspaceBasedBackendHandler ¶
type WorkspaceBasedBackendHandler struct {
// The name of the block in this backend's config that stores the workspace configuration
WorkspaceBlockName string
// The name of the attribute in the WorkspaceBlockName block that stores the name of the workspace
WorkspaceNameAttrName string
}
WorkspaceBasedBackendHandler represents Terraform backends that track where to store Terraform state using workspaces. TODO: this handler only supports named workspaces; it does not support workspaces that use prefixes or tags.
func (WorkspaceBasedBackendHandler) UpdateBackendConfig ¶
func (handler WorkspaceBasedBackendHandler) UpdateBackendConfig(backend *TerraformBackend, currentModuleName string, envName *string, terragruntOptions *options.TerragruntOptions) error
func (WorkspaceBasedBackendHandler) UpdateTerraformRemoteStateConfig ¶
func (handler WorkspaceBasedBackendHandler) UpdateTerraformRemoteStateConfig(backend *TerraformBackend, backendConfigBody *hclwrite.Body, currentModuleName string, otherModuleName string) error
type WrongNumberOfArguments ¶
type WrongNumberOfArguments struct {
// contains filtered or unexported fields
}
func (WrongNumberOfArguments) Error ¶
func (err WrongNumberOfArguments) Error() string
type WrongNumberOfLabels ¶
type WrongNumberOfLabels struct {
// contains filtered or unexported fields
}
func (WrongNumberOfLabels) Error ¶
func (err WrongNumberOfLabels) Error() string
Click to show internal directories.
Click to hide internal directories.