backend

Documentation

Index

• func IsValidCloudBackend(name string) bool
• func NewCloudBackendTemplates() (map[string]CloudBackend, error)
• type CloudBackend
  • func NewCloudBackend(name string) (CloudBackend, error)
• type CloudBackendProperties

Functions

func IsValidCloudBackend

func IsValidCloudBackend(name string) bool

func NewCloudBackendTemplates

func NewCloudBackendTemplates() (map[string]CloudBackend, error)

out: a map of included cloud provider templates

Types

type CloudBackend

type CloudBackend interface {
	config.Configurable

	// additional backend properties
	SetProperties(props interface{})

	// configures the storage for this backend with common
	// attributes fetched from a compatible provider
	Configure(
		cloudProvider provider.CloudProvider,
		storagePrefix, stateKey string,
	) error

	// the cloud provider associated with this backend. not
	// all backends have an associated provider.
	GetProviderType() string

	// retrieves the storage instance name from the
	// storage backend configuration
	GetStorageInstanceName() string

	// adds the backend configuration variables
	// to the given variable map
	GetVars(vars map[string]string) error
}

func NewCloudBackend

func NewCloudBackend(name string) (CloudBackend, error)

type CloudBackendProperties

type CloudBackendProperties struct {
	StatePath string
}