atlas

Documentation

Index

• Constants
• type Backend
  • func New() *Backend
  • func (b *Backend) CLIInit(opts *backend.CLIOpts) error
  • func (b *Backend) Colorize() *colorstring.Colorize
  • func (b *Backend) ConfigSchema() *configschema.Block
  • func (b *Backend) Configure(obj cty.Value) tfdiags.Diagnostics
  • func (b *Backend) DeleteWorkspace(name string) error
  • func (b *Backend) StateMgr(name string) (state.State, error)
  • func (b *Backend) ValidateConfig(obj cty.Value) tfdiags.Diagnostics
  • func (b *Backend) Workspaces() ([]string, error)

Constants

const EnvVarAddress = "ATLAS_ADDRESS"

const EnvVarToken = "ATLAS_TOKEN"

Types

type Backend

type Backend struct {
	// CLI and Colorize control the CLI output. If CLI is nil then no CLI
	// output will be done. If CLIColor is nil then no coloring will be done.
	CLI      cli.Ui
	CLIColor *colorstring.Colorize

	// ContextOpts are the base context options to set when initializing a
	// Terraform context. Many of these will be overridden or merged by
	// Operation. See Operation for more details.
	ContextOpts *terraform.ContextOpts
	// contains filtered or unexported fields
}

Backend is an implementation of EnhancedBackend that performs all operations in Atlas. State must currently also be stored in Atlas, although it is worth investigating in the future if state storage can be external as well.

func New

func New() *Backend

New returns a new initialized Atlas backend.

func (*Backend) CLIInit

func (b *Backend) CLIInit(opts *backend.CLIOpts) error

backend.CLI impl.

func (*Backend) Colorize

func (b *Backend) Colorize() *colorstring.Colorize

Colorize returns the Colorize structure that can be used for colorizing output. This is gauranteed to always return a non-nil value and so is useful as a helper to wrap any potentially colored strings.

func (*Backend) ConfigSchema

func (b *Backend) ConfigSchema() *configschema.Block

func (*Backend) Configure

func (b *Backend) Configure(obj cty.Value) tfdiags.Diagnostics

func (*Backend) DeleteWorkspace

func (b *Backend) DeleteWorkspace(name string) error

func (*Backend) StateMgr

func (b *Backend) StateMgr(name string) (state.State, error)

func (*Backend) ValidateConfig

func (b *Backend) ValidateConfig(obj cty.Value) tfdiags.Diagnostics

func (*Backend) Workspaces

func (b *Backend) Workspaces() ([]string, error)