providers

Documentation

Index

• type GenericConfig
• type Provider

Types

type GenericConfig

type GenericConfig map[string]interface{}

type Provider

type Provider interface {
	// Select will collect a list of resources based on a target configuration
	Select() (target.Selection, error)

	// Read will read the settings of a resource
	// by its key identifiers
	Read() error

	// Clone will copy an active resource
	// replacing any parameters with any that are present and
	// altered in the Provider's supplied config
	Clone() error

	// Apply will provision a resource from some declaration
	// or config that has been passed to the Provider
	Apply() error

	// Annotate applies Labels or Tags for a given resource
	Annotate(id string, l labels.Labels) error

	// ProbeReadiness is for testing that a
	// resource is ready to be enabled
	ProbeReadiness() (bool, error)

	// AwaitReadiness utilizes
	AwaitReadiness() chan error

	// Teardown is the de-provisioning
	// any resource created by the provider
	Teardown() error

	// Cancel will safely cancel any
	// in flight provision request as cleanly
	// as possible
	Cancel() error

	// Stop...i dunno yet
	Stop() error
}

Provider is an interface which any specific integration should implement