noderefutil

Documentation

Overview

Package noderefutil implements NodeRef utils.

Index

• Variables
• func GetReadyCondition(status *corev1.NodeStatus) *corev1.NodeCondition
• func IsNodeAvailable(node *corev1.Node, minReadySeconds int32, now metav1.Time) bool
• func IsNodeReady(node *corev1.Node) bool
• func IsNodeUnreachable(node *corev1.Node) bool
• type ProviderID
  • func NewProviderID(id string) (*ProviderID, error)
  • func (p *ProviderID) CloudProvider() string
  • func (p *ProviderID) Equals(o *ProviderID) bool
  • func (p *ProviderID) ID() string
  • func (p *ProviderID) IndexKey() string
  • func (p ProviderID) String() string
  • func (p *ProviderID) Validate() bool

Variables

var (
	// ErrEmptyProviderID means that the provider id is empty.
	ErrEmptyProviderID = errors.New("providerID is empty")

	// ErrInvalidProviderID means that the provider id has an invalid form.
	ErrInvalidProviderID = errors.New("providerID must be of the form <cloudProvider>://<optional>/<segments>/<provider id>")
)

Functions

func GetReadyCondition

func GetReadyCondition(status *corev1.NodeStatus) *corev1.NodeCondition

GetReadyCondition extracts the ready condition from the given status and returns that. Returns nil and -1 if the condition is not present, and the index of the located condition.

func IsNodeAvailable

func IsNodeAvailable(node *corev1.Node, minReadySeconds int32, now metav1.Time) bool

IsNodeAvailable returns true if the node is ready and minReadySeconds have elapsed or is 0. False otherwise.

func IsNodeReady

func IsNodeReady(node *corev1.Node) bool

IsNodeReady returns true if a node is ready; false otherwise.

func IsNodeUnreachable

func IsNodeUnreachable(node *corev1.Node) bool

IsNodeUnreachable returns true if a node is unreachable. Node is considered unreachable when its ready status is "Unknown".

Types

type ProviderID

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

ProviderID is a struct representation of a Kubernetes ProviderID. Format: cloudProvider://optional/segments/etc/id

func NewProviderID

func NewProviderID(id string) (*ProviderID, error)

NewProviderID parses the input string and returns a new ProviderID.

func (*ProviderID) CloudProvider

func (p *ProviderID) CloudProvider() string

CloudProvider returns the cloud provider portion of the ProviderID.

func (*ProviderID) Equals

func (p *ProviderID) Equals(o *ProviderID) bool

Equals returns true if this ProviderID string matches another ProviderID string.

func (*ProviderID) ID

func (p *ProviderID) ID() string

ID returns the identifier portion of the ProviderID.

func (*ProviderID) IndexKey

func (p *ProviderID) IndexKey() string

IndexKey returns the required level of uniqueness to represent and index machines uniquely from their node providerID.

func (ProviderID) String

func (p ProviderID) String() string

String returns the string representation of this object.

func (*ProviderID) Validate

func (p *ProviderID) Validate() bool

Validate returns true if the provider id is valid.