remotestate

Documentation

Overview

Package remotestate implements a Backend for remote state implementations from the state/remote package that also implement a backend schema for configuration.

Index

• func TestClient(t *testing.T, raw backend.Backend)
• type Backend
  • func (b *Backend) Configure(obj cty.Value) tfdiags.Diagnostics
  • func (b *Backend) DeleteWorkspace(name string) error
  • func (b *Backend) StateMgr(name string) (statemgr.Full, error)
  • func (b *Backend) Workspaces() ([]string, error)

Functions

func TestClient

func TestClient(t *testing.T, raw backend.Backend)

Types

type Backend

type Backend struct {
	// Backend should be set to the configuration schema. ConfigureFunc
	// should not be set on the schema.
	*schema.Backend

	// ConfigureFunc takes the ctx from a schema.Backend and returns a
	// fully configured remote client to use for state operations.
	ConfigureFunc func(ctx context.Context) (remote.Client, error)
	// contains filtered or unexported fields
}

Backend implements backend.Backend for remote state backends.

All exported fields should be set. This struct should only be used by implementers of backends, not by consumers. If you're consuming, please use a higher level package such as Consul backends.

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) (statemgr.Full, error)

func (*Backend) Workspaces

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