backend

Documentation

Index

• Variables
• type Client
  • func New(ctx context.Context, opts Options) (Client, error)
• type Flatfile
• type Options

Variables

var ErrMissingBackendConfig = errors.New("no backend configuration specified in options")

ErrMissingBackendConfig indicates New was called without a backend configuration.

var ErrMultipleBackends = errors.New("only one backend option can be specified")

ErrMultipleBackends indicates the backend Options contains more than one backend configuration.

Types

type Client

type Client interface {
	ec2.Client
	hack.Client
	healthcheck.Client
}

Client is an abstraction for all frontend clients. Each backend implementation should satisfy this interface.

func New

func New(ctx context.Context, opts Options) (Client, error)

New creates a backend instance for the configuration specified by opts. Consumers may only supply 1 backend configuration. If no backend configuration is supplied, it returns ErrMissingBackendConfig.

type Flatfile

type Flatfile struct {
	// Path is a path to a YAML file containing a list of flatfile instances.
	Path string
}

FlatFileOptions is the configuration for a flatfile backend.

type Options

type Options struct {
	Flatfile   *Flatfile
	Kubernetes *kubernetes.Config
}

Options contains all options for all backend implementations. Only one backend option can be specified at a time.