manager

Documentation

Index

• type EdgeLBManager
  • func NewEdgeLBManager(opts EdgeLBManagerOptions) (EdgeLBManager, error)
  • func NewFakeEdgeLBManager() EdgeLBManager
• type EdgeLBManagerOptions

Types

type EdgeLBManager

type EdgeLBManager interface {
	// CreatePool creates the specified EdgeLB pool in the EdgeLB API server.
	CreatePool(context.Context, *edgelbmodels.V2Pool) (*edgelbmodels.V2Pool, error)
	// DeletePool deletes the EdgeLB pool with the specified name.
	DeletePool(context.Context, string) error
	// GetPools returns the list of EdgeLB pools known to the EdgeLB API server.
	GetPools(ctx context.Context) ([]*edgelbmodels.V2Pool, error)
	// GetPool returns the EdgeLB pool with the specified name.
	GetPool(context.Context, string) (*edgelbmodels.V2Pool, error)
	// GetPoolMetadata returns the metadata associated with the specified EdgeLB pool
	GetPoolMetadata(context.Context, string) (*edgelbmodels.V2PoolMetadata, error)
	// GetVersion returns the current version of EdgeLB.
	GetVersion(context.Context) (string, error)
	// PoolGroup returns the DC/OS service group in which to create EdgeLB pools.
	PoolGroup() string
	// UpdatePool updates the specified EdgeLB pool in the EdgeLB API server.
	UpdatePool(context.Context, *edgelbmodels.V2Pool) (*edgelbmodels.V2Pool, error)
}

EdgeLBManager knows how to manage the configuration of EdgeLB pools.

func NewEdgeLBManager

func NewEdgeLBManager(opts EdgeLBManagerOptions) (EdgeLBManager, error)

NewEdgeLBManager creates a new instance of EdgeLBManager configured according to the provided options.

func NewFakeEdgeLBManager

func NewFakeEdgeLBManager() EdgeLBManager

type EdgeLBManagerOptions

type EdgeLBManagerOptions struct {
	// BearerToken is the (optional) bearer token to use when communicating with the EdgeLB API server.
	BearerToken string
	// Host is the host at which the EdgeLB API server can be reached.
	Host string
	// InsecureSkipTLSVerify indicates whether to skip verification of the TLS certificate presented by the EdgeLB API server.
	InsecureSkipTLSVerify bool
	// Path is the path at which the EdgeLB API server can be reached.
	Path string
	// PoolGroup is the DC/OS service group in which to create EdgeLB pools.
	PoolGroup string
	// Scheme is the scheme to use when communicating with the EdgeLB API server.
	Scheme string
}

EdgeLBManagerOptions groups options that can be used to configure an instance of the EdgeLB Manager.