hcp

Documentation

Index

• type Deps
  • func NewDeps(cfg config.CloudConfig, logger hclog.Logger) (Deps, error)
• type Manager
  • func NewManager(cfg ManagerConfig) *Manager
  • func (m *Manager) Run(ctx context.Context)
  • func (m *Manager) SendUpdate()
  • func (m *Manager) UpdateConfig(cfg ManagerConfig)
• type ManagerConfig
• type MockHCPServer
  • func NewMockHCPServer() *MockHCPServer
  • func (s *MockHCPServer) AddEndpoint(e TestEndpoint)
  • func (s *MockHCPServer) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type StatusCallback
• type TestEndpoint

Types

type Deps

type Deps struct {
	Client   hcpclient.Client
	Provider scada.Provider
	Sink     metrics.MetricSink
}

Deps contains the interfaces that the rest of Consul core depends on for HCP integration.

func NewDeps

func NewDeps(cfg config.CloudConfig, logger hclog.Logger) (Deps, error)

type Manager

type Manager struct {
	// contains filtered or unexported fields
}

func NewManager

func NewManager(cfg ManagerConfig) *Manager

NewManager returns an initialized Manager with a zero configuration. It won't do anything until UpdateConfig is called with a config that provides credentials to contact HCP.

func (*Manager) Run

func (m *Manager) Run(ctx context.Context)

Run executes the Manager it's designed to be run in its own goroutine for the life of a server agent. It should be run even if HCP is not configured yet for servers since a config update might configure it later and UpdateConfig called. It will effectively do nothing if there are no HCP credentials set other than wait for some to be added.

func (*Manager) SendUpdate

func (m *Manager) SendUpdate()

func (*Manager) UpdateConfig

func (m *Manager) UpdateConfig(cfg ManagerConfig)

type ManagerConfig

type ManagerConfig struct {
	Client hcpclient.Client

	StatusFn    StatusCallback
	MinInterval time.Duration
	MaxInterval time.Duration

	Logger hclog.Logger
}

type MockHCPServer

type MockHCPServer struct {
	// contains filtered or unexported fields
}

func NewMockHCPServer

func NewMockHCPServer() *MockHCPServer

func (*MockHCPServer) AddEndpoint

func (s *MockHCPServer) AddEndpoint(e TestEndpoint)

AddEndpoint allows adding additional endpoints from other packages e.g. bootstrap (which can't be merged into one package due to dependency cycles). It's not safe to call this concurrently with any other call to AddEndpoint or ServeHTTP.

func (*MockHCPServer) ServeHTTP

func (s *MockHCPServer) ServeHTTP(w http.ResponseWriter, r *http.Request)

type StatusCallback

type StatusCallback func(context.Context) (hcpclient.ServerStatus, error)

type TestEndpoint

type TestEndpoint struct {
	Methods    []string
	PathSuffix string
	Handler    func(r *http.Request, cluster resource.Resource) (interface{}, error)
}