node

Documentation

Index

• Constants
• Variables
• func GetNodeLabel(labels *cpb.NodeLabels, key string) string
• func ValidateClusterDomain(d string) error
• func ValidateLabelKey(v string) error
• func ValidateLabelValue(v string) error
• type Labels
  • func (l Labels) Equals(others Labels) bool
  • func (l Labels) Filter(pred func(k, v string) bool) Labels
• type NetStatus

Constants

const (
	// MaxLabelsPerNode is the absolute maximum of labels that can be attached to a
	// node.
	MaxLabelsPerNode = 128
)

Variables

var (

	// ErrLabelEmpty is returned by ValidateLabel if the label key/value is not at
	// least one character long.
	ErrLabelEmpty = fmt.Errorf("empty")
	// ErrLabelTooLong is returned by ValidateLabel if the label key/value is more
	// than 63 characters long.
	ErrLabelTooLong = fmt.Errorf("too long")
	// ErrLabelInvalidFirstCharacter is returned by ValidateLabel if the label
	// key/value contains an invalid character on the first position.
	ErrLabelInvalidFirstCharacter = fmt.Errorf("first character not a letter or number")
	// ErrLabelInvalidLastCharacter is returned by ValidateLabel if the label
	// key/value contains an invalid character on the last position.
	ErrLabelInvalidLastCharacter = fmt.Errorf("last character not a letter or number")
	// ErrLabelInvalidCharacter is returned by ValidateLabel if the label key/value
	// contains an invalid character.
	ErrLabelInvalidCharacter = fmt.Errorf("invalid character")
	ErrLabelEmptyPrefix      = fmt.Errorf("empty prefix")
	ErrLabelInvalidPrefix    = fmt.Errorf("invalid prefix")
)

Functions

func GetNodeLabel

func GetNodeLabel(labels *cpb.NodeLabels, key string) string

GetNodeLabel retrieves a node label by key, returning its value or an empty string if no labels with this key is set on the node.

func ValidateClusterDomain

func ValidateClusterDomain(d string) error

ValidateClusterDomain returns an error if the passed string is not a valid cluster domain.

func ValidateLabelKey

func ValidateLabelKey(v string) error

ValidateLabelKey ensures that a given node label key is valid:

1. 1 to 63 characters long (inclusive);
2. Characters are all ASCII a-z A-Z 0-9 '_', '-' or '.';
3. The first character is ASCII a-z A-Z or 0-9.
4. The last character is ASCII a-z A-Z or 0-9.
5. Optional slash-delimited prefix which contains a valid 'DNS subdomain'.

If it's valid, nil is returned. Otherwise, one of ErrLabelEmpty, ErrLabelTooLong, ErrLabelInvalidFirstCharacter or ErrLabelInvalidCharacter is returned.

func ValidateLabelValue

func ValidateLabelValue(v string) error

ValidateLabelValue ensures that a given node label value is valid:

1. 0 to 63 characters long (inclusive);
2. Characters are all ASCII a-z A-Z 0-9 '_', '-' or '.';
3. The first character is ASCII a-z A-Z or 0-9.
4. The last character is ASCII a-z A-Z or 0-9.

If it's valid, nil is returned. Otherwise, one of ErrLabelTooLong, ErrLabelInvalidFirstCharacter, or ErrLabelInvalidLastCharacter, ErrLabelInvalidCharacter is returned.

Types

type Labels

type Labels map[string]string

Labels on a node, a map from label key to value.

func (Labels) Equals

func (l Labels) Equals(others Labels) bool

Equals returns true if these Labels are equal to some others. Equality is defined by having the same set of keys and corresponding values.

func (Labels) Filter

func (l Labels) Filter(pred func(k, v string) bool) Labels

Filter returns a subset of labels for which pred returns true.

type NetStatus

type NetStatus struct {
	ExternalAddress net.IP
}

NetStatus is the current network status of the host. It will be updated by the network Service whenever the node's network configuration changes. Spurious changes might occur, consumers should ensure that the change that occured is meaningful to them.