remote

Documentation

Index

• type Colorer
• type Colorize
  • func (c *Colorize) Color(v string) string
• type Remote
  • func New(services *disco.Disco, enc encryption.StateEncryption) *Remote
  • func (b *Remote) CLIInit(opts *backend.CLIOpts) error
  • func (b *Remote) Colorize() Colorer
  • func (b *Remote) ConfigSchema() *configschema.Block
  • func (b *Remote) Configure(obj cty.Value) tfdiags.Diagnostics
  • func (b *Remote) DeleteWorkspace(name string, _ bool) error
  • func (b *Remote) IgnoreVersionConflict()
  • func (b *Remote) IsLocalOperations() bool
  • func (b *Remote) LocalRun(op *backend.Operation) (*backend.LocalRun, statemgr.Full, tfdiags.Diagnostics)
  • func (b *Remote) Operation(ctx context.Context, op *backend.Operation) (*backend.RunningOperation, error)
  • func (b *Remote) PrepareConfig(obj cty.Value) (cty.Value, tfdiags.Diagnostics)
  • func (b *Remote) ServiceDiscoveryAliases() ([]backend.HostAlias, error)
  • func (b *Remote) StateMgr(name string) (statemgr.Full, error)
  • func (b *Remote) VerifyWorkspaceTerraformVersion(workspaceName string) tfdiags.Diagnostics
  • func (b *Remote) WorkspaceNamePattern() string
  • func (b *Remote) Workspaces() ([]string, error)

Types

type Colorer

type Colorer interface {
	Color(v string) string
}

Colorer is the interface that must be implemented to colorize strings.

type Colorize

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

Colorize is used to print output when the -no-color flag is used. It will strip all ANSI escaped color codes which are set while the operation was executed in Terraform Enterprise.

When Terraform Enterprise supports run specific variables, this code can be removed as we can then pass the CLI flag to the backend and prevent the color codes from being written to the output.

func (*Colorize) Color

func (c *Colorize) Color(v string) string

Color will strip all ANSI escaped color codes and return a uncolored string.

type Remote

type Remote 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
	// new OpenTofu context. Many of these will be overridden or merged by
	// Operation. See Operation for more details.
	ContextOpts *tofu.ContextOpts
	// contains filtered or unexported fields
}

Remote is an implementation of EnhancedBackend that performs all operations in a remote backend.

func New

func New(services *disco.Disco, enc encryption.StateEncryption) *Remote

New creates a new initialized remote backend.

func (*Remote) CLIInit

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

CLIInit implements backend.CLI

func (*Remote) Colorize

func (b *Remote) Colorize() Colorer

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

func (*Remote) ConfigSchema

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

ConfigSchema implements backend.Enhanced.

func (*Remote) Configure

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

Configure implements backend.Enhanced.

func (*Remote) DeleteWorkspace

func (b *Remote) DeleteWorkspace(name string, _ bool) error

DeleteWorkspace implements backend.Enhanced.

func (*Remote) IgnoreVersionConflict

func (b *Remote) IgnoreVersionConflict()

IgnoreVersionConflict allows commands to disable the fall-back check that the local OpenTofu version matches the remote workspace's configured OpenTofu version. This should be called by commands where this check is unnecessary, such as those performing remote operations, or read-only operations. It will also be called if the user uses a command-line flag to override this check.

func (*Remote) IsLocalOperations

func (b *Remote) IsLocalOperations() bool

func (*Remote) LocalRun

func (b *Remote) LocalRun(op *backend.Operation) (*backend.LocalRun, statemgr.Full, tfdiags.Diagnostics)

Context implements backend.Local.

func (*Remote) Operation

func (b *Remote) Operation(ctx context.Context, op *backend.Operation) (*backend.RunningOperation, error)

Operation implements backend.Enhanced.

func (*Remote) PrepareConfig

func (b *Remote) PrepareConfig(obj cty.Value) (cty.Value, tfdiags.Diagnostics)

PrepareConfig implements backend.Backend.

func (*Remote) ServiceDiscoveryAliases

func (b *Remote) ServiceDiscoveryAliases() ([]backend.HostAlias, error)

func (*Remote) StateMgr

func (b *Remote) StateMgr(name string) (statemgr.Full, error)

StateMgr implements backend.Enhanced.

func (*Remote) VerifyWorkspaceTerraformVersion

func (b *Remote) VerifyWorkspaceTerraformVersion(workspaceName string) tfdiags.Diagnostics

VerifyWorkspaceTerraformVersion compares the local OpenTofu version against the workspace's configured OpenTofu version. If they are equal, this means that there are no compatibility concerns, so it returns no diagnostics.

If the versions differ,

func (*Remote) WorkspaceNamePattern

func (b *Remote) WorkspaceNamePattern() string

WorkspaceNamePattern provides an appropriate workspace renaming pattern for backend migration purposes (handled outside of this package), based on previous usage of this backend with the 'prefix' workspace functionality. As of this writing, see meta_backend.migrate.go

func (*Remote) Workspaces

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

Workspaces implements backend.Enhanced.