remote

Documentation

Index

• Constants
• Variables
• func CreateS3Bucket(s3Client *s3.S3, config *RemoteStateConfigS3, ...) error
• func CreateS3BucketWithVersioning(s3Client *s3.S3, config *RemoteStateConfigS3, ...) error
• func CreateS3Client(awsRegion, awsProfile string) (*s3.S3, error)
• func DoesS3BucketExist(s3Client *s3.S3, config *RemoteStateConfigS3) bool
• func EnableVersioningForS3Bucket(s3Client *s3.S3, config *RemoteStateConfigS3, ...) error
• func InitializeRemoteStateS3(config map[string]interface{}, terragruntOptions *options.TerragruntOptions) error
• func WaitUntilS3BucketExists(s3Client *s3.S3, config *RemoteStateConfigS3, ...) error
• type CantParseTerraformStateFile
  • func (err CantParseTerraformStateFile) Error() string
• type MaxRetriesWaitingForS3BucketExceeded
  • func (err MaxRetriesWaitingForS3BucketExceeded) Error() string
• type MissingRequiredS3RemoteStateConfig
  • func (configName MissingRequiredS3RemoteStateConfig) Error() string
• type RemoteState
  • func (remoteState *RemoteState) FillDefaults()
  • func (remoteState *RemoteState) Initialize(terragruntOptions *options.TerragruntOptions) error
  • func (remoteState *RemoteState) NeedsInit(terragruntOptions *options.TerragruntOptions) (bool, error)
  • func (remoteState *RemoteState) String() string
  • func (remoteState RemoteState) ToTerraformInitArgs() []string
  • func (remoteState *RemoteState) Validate() error
• type RemoteStateConfigS3
• type RemoteStateInitializer
• type TerraformBackend
• type TerraformState
  • func ParseTerraformStateFile(path string) (*TerraformState, error)
  • func ParseTerraformStateFileFromLocation(workingDir string) (*TerraformState, error)
  • func (state *TerraformState) IsRemote() bool
• type TerraformStateModule

Constants

const DEFAULT_PATH_TO_LOCAL_STATE_FILE = "terraform.tfstate"

When storing Terraform state locally, this is the default path to the tfstate file

const DEFAULT_PATH_TO_REMOTE_STATE_FILE = ".terraform/terraform.tfstate"

When using remote state storage, Terraform keeps a local copy of the state file in this folder

const MAX_RETRIES_WAITING_FOR_S3_BUCKET = 12

const SLEEP_BETWEEN_RETRIES_WAITING_FOR_S3_BUCKET = 5 * time.Second

Variables

var RemoteBackendMissing = fmt.Errorf("The remote_state.backend field cannot be empty")

Functions

func CreateS3Bucket

func CreateS3Bucket(s3Client *s3.S3, config *RemoteStateConfigS3, terragruntOptions *options.TerragruntOptions) error

Create the S3 bucket specified in the given config

func CreateS3BucketWithVersioning

func CreateS3BucketWithVersioning(s3Client *s3.S3, config *RemoteStateConfigS3, terragruntOptions *options.TerragruntOptions) error

Create the given S3 bucket and enable versioning for it

func CreateS3Client

func CreateS3Client(awsRegion, awsProfile string) (*s3.S3, error)

Create an authenticated client for DynamoDB

func DoesS3BucketExist

func DoesS3BucketExist(s3Client *s3.S3, config *RemoteStateConfigS3) bool

Returns true if the S3 bucket specified in the given config exists and the current user has the ability to access it.

func EnableVersioningForS3Bucket

func EnableVersioningForS3Bucket(s3Client *s3.S3, config *RemoteStateConfigS3, terragruntOptions *options.TerragruntOptions) error

Enable versioning for the S3 bucket specified in the given config

func InitializeRemoteStateS3

func InitializeRemoteStateS3(config map[string]interface{}, terragruntOptions *options.TerragruntOptions) error

Initialize the remote state S3 bucket specified in the given config. This function will validate the config parameters, create the S3 bucket if it doesn't already exist, and check that versioning is enabled.

func WaitUntilS3BucketExists

func WaitUntilS3BucketExists(s3Client *s3.S3, config *RemoteStateConfigS3, terragruntOptions *options.TerragruntOptions) error

AWS is eventually consistent, so after creating an S3 bucket, this method can be used to wait until the information about that S3 bucket has propagated everywhere

Types

type CantParseTerraformStateFile

type CantParseTerraformStateFile struct {
	Path          string
	UnderlyingErr error
}

func (CantParseTerraformStateFile) Error

func (err CantParseTerraformStateFile) Error() string

type MaxRetriesWaitingForS3BucketExceeded

type MaxRetriesWaitingForS3BucketExceeded string

func (MaxRetriesWaitingForS3BucketExceeded) Error

func (err MaxRetriesWaitingForS3BucketExceeded) Error() string

type MissingRequiredS3RemoteStateConfig

type MissingRequiredS3RemoteStateConfig string

func (MissingRequiredS3RemoteStateConfig) Error

func (configName MissingRequiredS3RemoteStateConfig) Error() string

type RemoteState

type RemoteState struct {
	Backend string                 `hcl:"backend"`
	Config  map[string]interface{} `hcl:"config"`
}

Configuration for Terraform remote state

func (*RemoteState) FillDefaults

func (remoteState *RemoteState) FillDefaults()

Fill in any default configuration for remote state

func (*RemoteState) Initialize

func (remoteState *RemoteState) Initialize(terragruntOptions *options.TerragruntOptions) error

Perform any actions necessary to initialize the remote state before it's used for storage. For example, if you're using S3 for remote state storage, this may create the S3 bucket if it doesn't exist already.

func (*RemoteState) NeedsInit

func (remoteState *RemoteState) NeedsInit(terragruntOptions *options.TerragruntOptions) (bool, error)

Returns true if remote state needs to be configured. This will be the case when:

1. Remote state has not already been configured 2. Remote state has been configured, but for a different backend type, and the user confirms it's OK to overwrite it.

func (*RemoteState) String

func (remoteState *RemoteState) String() string

func (RemoteState) ToTerraformInitArgs

func (remoteState RemoteState) ToTerraformInitArgs() []string

Convert the RemoteState config into the format used by the terraform init command

func (*RemoteState) Validate

func (remoteState *RemoteState) Validate() error

Validate that the remote state is configured correctly

type RemoteStateConfigS3

type RemoteStateConfigS3 struct {
	Encrypt   bool   `mapstructure:"encrypt"`
	Bucket    string `mapstructure:"bucket"`
	Key       string `mapstructure:"key"`
	Region    string `mapstructure:"region"`
	Profile   string `mapstructure:"profile"`
	LockTable string `mapstructure:"lock_table"`
}

A representation of the configuration options available for S3 remote state

type RemoteStateInitializer

type RemoteStateInitializer func(map[string]interface{}, *options.TerragruntOptions) error

type TerraformBackend

type TerraformBackend struct {
	Type   string
	Config map[string]interface{}
}

The structure of the "backend" section of the Terraform .tfstate file

type TerraformState

type TerraformState struct {
	Version int
	Serial  int
	Backend *TerraformBackend
	Modules []TerraformStateModule
}

The structure of the Terraform .tfstate file

func ParseTerraformStateFile

func ParseTerraformStateFile(path string) (*TerraformState, error)

Parse the Terraform .tfstate file at the given path

func ParseTerraformStateFileFromLocation

func ParseTerraformStateFileFromLocation(workingDir string) (*TerraformState, error)

Parse the Terraform .tfstate file from the location specified by workingDir. If no location is specified, search the current directory. If the file doesn't exist at any of the default locations, return nil.

func (*TerraformState) IsRemote

func (state *TerraformState) IsRemote() bool

Return true if this Terraform state is configured for remote state storage

type TerraformStateModule

type TerraformStateModule struct {
	Path      []string
	Outputs   map[string]interface{}
	Resources map[string]interface{}
}

The structure of a "module" section of the Terraform .tfstate file