nodepool

Documentation

Index

• type ClusterNodePoolIdentifier
  • func NewClusterNodePoolIdentifier(cfg map[string]string) (ClusterNodePoolIdentifier, error)
  • func NewCombinedClusterPoolIdentifier(poolIdentifiers []ClusterNodePoolIdentifier, ...) ClusterNodePoolIdentifier
  • func NewNodeClassPoolIdentifier(id string) ClusterNodePoolIdentifier
  • func NewNodeDatacenterPoolIdentifier(id string) ClusterNodePoolIdentifier
  • func NewNodePoolClusterPoolIdentifier(pool string) ClusterNodePoolIdentifier
• type CombinedClusterPoolIdentifierMode

Types

type ClusterNodePoolIdentifier

type ClusterNodePoolIdentifier interface {

	// IsPoolMember identifies whether the node is a member of the node pool.
	// It is the responsibility of the implementation to read the node info if
	// the required information is not within the stub struct.
	IsPoolMember(*api.NodeListStub) bool

	// Key returns the string representation of the pool identifier.
	Key() string

	// Value returns the pool identifier value that nodes are being filtered
	// by.
	Value() string
}

ClusterNodePoolIdentifier is the interface that defines how nodes are classed into pools of resources.

func NewClusterNodePoolIdentifier

func NewClusterNodePoolIdentifier(cfg map[string]string) (ClusterNodePoolIdentifier, error)

NewClusterNodePoolIdentifier generates a new ClusterNodePoolIdentifier based on the provided configuration. If a valid option is not found, an error will be returned.

func NewCombinedClusterPoolIdentifier

func NewCombinedClusterPoolIdentifier(poolIdentifiers []ClusterNodePoolIdentifier, mode CombinedClusterPoolIdentifierMode) ClusterNodePoolIdentifier

NewCombinedClusterPoolIdentifier returns a new combinedClusterPoolIdentifier.

func NewNodeClassPoolIdentifier

func NewNodeClassPoolIdentifier(id string) ClusterNodePoolIdentifier

NewNodeClassPoolIdentifier returns a new nodeClassClusterPoolIdentifier implementation of the ClusterNodePoolIdentifier interface.

func NewNodeDatacenterPoolIdentifier

func NewNodeDatacenterPoolIdentifier(id string) ClusterNodePoolIdentifier

NewNodeDatacenterPoolIdentifier returns a new nodeDatacenterClusterPoolIdentifier implementation of the ClusterNodePoolIdentifier interface.

func NewNodePoolClusterPoolIdentifier

func NewNodePoolClusterPoolIdentifier(pool string) ClusterNodePoolIdentifier

NewNodePoolClusterPoolIdentifier returns a new nodePoolClusterPoolIdentifier implementation of the ClusterNodePoolIdentifier interface.

type CombinedClusterPoolIdentifierMode

type CombinedClusterPoolIdentifierMode string

CombinedClusterPoolIdentifierMode defines how different ClusterNodePoolIdentifiers are combined.

const (
	// CombinedClusterPoolIdentifierAnd requires all identifiers to return true.
	CombinedClusterPoolIdentifierAnd CombinedClusterPoolIdentifierMode = "and"

	// CombinedClusterPoolIdentifierOr requires at least one identifier to
	// return true.
	CombinedClusterPoolIdentifierOr CombinedClusterPoolIdentifierMode = "or"
)