hostpool

Documentation

Index

• Constants
• type HostPool
  • func New(id string) HostPool

Constants

const (
	// HostnameKey is the key for indexing hostname in log message
	HostnameKey = "hostname"

	// HostPoolKey is the key for indexing host pool ID in log message
	HostPoolKey = "host_pool"
)

Types

type HostPool

type HostPool interface {
	// ID returns host pool id.
	ID() string

	// Hosts returns all hosts in the pool as a map from hostname to host summary.
	// TODO: Consider what host data host pool needs to track.
	Hosts() map[string]struct{}

	// Add adds given host to the pool.
	Add(host string)

	// Delete deletes given host from the pool.
	Delete(host string)

	// Cleanup deletes all hosts from the pool.
	Cleanup()
}

HostPool represents a set of hosts as a virtual host pool And provides abstraction to operate a host pool.

func New

func New(id string) HostPool

New returns a new hostPool instance.