configwrite

Documentation

Index

• Constants
• type Changes
  • func (c Changes) Write() error
• type File
  • func ExistingFile(path string, fs afero.Fs) (*File, error)
  • func NewFile(path string) *File
  • func (f *File) Destination() string
  • func (f *File) Diff() difflib.UnifiedDiff
  • func (f *File) Write() error
• type RemoteBackend
  • func (b *RemoteBackend) Changes() (Changes, error)
  • func (b *RemoteBackend) Description() string
  • func (b *RemoteBackend) MultipleWorkspaces() bool
  • func (b *RemoteBackend) Name() string
  • func (b *RemoteBackend) WithWriter(w *Writer) Step
• type RemoteBackendConfig
• type RemoteState
  • func (s *RemoteState) Changes() (Changes, error)
  • func (s *RemoteState) Description() string
  • func (s *RemoteState) Name() string
  • func (s *RemoteState) WithWriter(w *Writer) Step
• type Step
• type Steps
  • func NewSteps(w *Writer, steps Steps) Steps
  • func (s Steps) Append(steps ...Step) Steps
  • func (s Steps) Changes() (Changes, error)
• type TerraformWorkspace
  • func (s *TerraformWorkspace) Changes() (Changes, error)
  • func (s *TerraformWorkspace) Complete() bool
  • func (s *TerraformWorkspace) Description() string
  • func (s *TerraformWorkspace) Name() string
  • func (s *TerraformWorkspace) WithWriter(w *Writer) Step
• type Tfvars
  • func (s *Tfvars) Changes() (Changes, error)
  • func (s *Tfvars) Complete() bool
  • func (s *Tfvars) Description() string
  • func (s *Tfvars) Name() string
  • func (s *Tfvars) WithWriter(w *Writer) Step
• type WorkspaceConfig
• type Writer
  • func New(module *configs.Module) *Writer
  • func (w *Writer) Backend() *configs.Backend
  • func (w *Writer) Dir() string
  • func (w *Writer) File(path string) (*File, error)
  • func (w *Writer) HasBackend() bool
  • func (w *Writer) RemoteStateDataSources() []*configs.Resource
  • func (w *Writer) Variables() map[string]*configs.Variable

Constants

const (
	TfvarsFilename          = "terraform.tfvars"
	TfvarsAlternateFilename = "terraform.auto.tfvars"
)

const (
	BackendTypeRemote = "remote"
)

Types

type Changes

type Changes map[string]*File

Changes is map of paths to file objects that should be written to prepare the module for Terraform Cloud

func (Changes) Write

func (c Changes) Write() error

type File

type File struct {
	Dir           string
	OriginalName  string
	OriginalBytes []byte
	NewName       string
	// contains filtered or unexported fields
}

func ExistingFile

func ExistingFile(path string, fs afero.Fs) (*File, error)

func NewFile

func NewFile(path string) *File

func (*File) Destination

func (f *File) Destination() string

func (*File) Diff

func (f *File) Diff() difflib.UnifiedDiff

func (*File) Write

func (f *File) Write() error

type RemoteBackend

type RemoteBackend struct {
	Config RemoteBackendConfig
	// contains filtered or unexported fields
}

func (*RemoteBackend) Changes

func (b *RemoteBackend) Changes() (Changes, error)

Changes updates the configured backend

func (*RemoteBackend) Description

func (b *RemoteBackend) Description() string

Description returns a description of the step

func (*RemoteBackend) MultipleWorkspaces

func (b *RemoteBackend) MultipleWorkspaces() bool

MultipleWorkspaces returns whether the remote backend will be configured for multiple prefixed workspaces

func (*RemoteBackend) Name

func (b *RemoteBackend) Name() string

func (*RemoteBackend) WithWriter

func (b *RemoteBackend) WithWriter(w *Writer) Step

type RemoteBackendConfig

type RemoteBackendConfig struct {
	Hostname     string
	Organization string
	Workspaces   WorkspaceConfig
}

type RemoteState

type RemoteState struct {
	Path          string
	RemoteBackend RemoteBackendConfig
	// contains filtered or unexported fields
}

func (*RemoteState) Changes

func (s *RemoteState) Changes() (Changes, error)

Changes updates the configured backend

func (*RemoteState) Description

func (s *RemoteState) Description() string

Description returns a description of the step

func (*RemoteState) Name

func (s *RemoteState) Name() string

func (*RemoteState) WithWriter

func (s *RemoteState) WithWriter(w *Writer) Step

type Step

type Step interface {
	Name() string

	// Description returns a description of the step
	Description() string

	// Changes returns a list of file changes and an error if changes could not be completed
	Changes() (Changes, error)

	WithWriter(*Writer) Step
}

Step is a step required to prepare a module to run in Terraform Cloud

type Steps

type Steps []Step

func NewSteps

func NewSteps(w *Writer, steps Steps) Steps

func (Steps) Append

func (s Steps) Append(steps ...Step) Steps

func (Steps) Changes

func (s Steps) Changes() (Changes, error)

type TerraformWorkspace

type TerraformWorkspace struct {
	Variable string
	// contains filtered or unexported fields
}

func (*TerraformWorkspace) Changes

func (s *TerraformWorkspace) Changes() (Changes, error)

Changes determines changes required to remove terraform.workspace

func (*TerraformWorkspace) Complete

func (s *TerraformWorkspace) Complete() bool

Complete checks if any terraform.workspace replaces are proposed

func (*TerraformWorkspace) Description

func (s *TerraformWorkspace) Description() string

Description returns a description of the step

func (*TerraformWorkspace) Name

func (s *TerraformWorkspace) Name() string

func (*TerraformWorkspace) WithWriter

func (s *TerraformWorkspace) WithWriter(w *Writer) Step

type Tfvars

type Tfvars struct {
	Filename string
	// contains filtered or unexported fields
}

func (*Tfvars) Changes

func (s *Tfvars) Changes() (Changes, error)

Changes determines changes required to remove terraform.workspace

func (*Tfvars) Complete

func (s *Tfvars) Complete() bool

Complete checks if a terraform.tfvars file exists and returns false if it does

func (*Tfvars) Description

func (s *Tfvars) Description() string

Description returns a description of the step

func (*Tfvars) Name

func (s *Tfvars) Name() string

func (*Tfvars) WithWriter

func (s *Tfvars) WithWriter(w *Writer) Step

type WorkspaceConfig

type WorkspaceConfig struct {
	Name   string
	Prefix string
}

type Writer

type Writer struct {
	// contains filtered or unexported fields
}

Writer provides access to information about the Terraform module structure and the ability to update its files

func New

func New(module *configs.Module) *Writer

func (*Writer) Backend

func (w *Writer) Backend() *configs.Backend

Backend returns the backend, or nil if none is defined

func (*Writer) Dir

func (w *Writer) Dir() string

Dir returns the module directory

func (*Writer) File

func (w *Writer) File(path string) (*File, error)

File returns an existing file object or creates and caches one

func (*Writer) HasBackend

func (w *Writer) HasBackend() bool

HasBackend returns true if the module has a backend configuration

func (*Writer) RemoteStateDataSources

func (w *Writer) RemoteStateDataSources() []*configs.Resource

RemoteStateDataSources returns a list of remote state data sources defined for the module

func (*Writer) Variables

func (w *Writer) Variables() map[string]*configs.Variable

Variables returns the declared variables for the module