rancluster

Documentation

Index

• func AreClustersPresent(clusters []*clients.Settings) bool
• func CheckSpokeClusterType(client *clients.Settings) (ranparam.ClusterType, error)
• func DoesClusterLabelExist(client *clients.Settings, clusterName string, label string) (bool, error)
• func GetPlusOneWorkerName(client *clients.Settings) (string, error)
• func IsClusterStable(client *clients.Settings) (bool, error)
• func IsNodeControlPlane(node *nodes.Builder) bool
• func IsSnoPlusOne(client *clients.Settings) (bool, error)
• func ListNodesByLabel(client *clients.Settings, labelMap map[string]string) ([]*nodes.Builder, error)
• func PowerOffAndWait(bmcClient *bmc.BMC) error
• func PowerOffWithRetries(bmcClient *bmc.BMC, retries uint) error
• func PowerOnAndWait(bmcClient *bmc.BMC) error
• func PowerOnWithRetries(bmcClient *bmc.BMC, retries uint) error
• func WaitForNumberOfNodes(client *clients.Settings, expected int, timeout time.Duration) error

Functions

func AreClustersPresent

func AreClustersPresent(clusters []*clients.Settings) bool

AreClustersPresent checks all of the provided clusters and returns false if any are nil.

func CheckSpokeClusterType

func CheckSpokeClusterType(client *clients.Settings) (ranparam.ClusterType, error)

CheckSpokeClusterType checks and returns a spoke cluster type based on number of control plane nodes.

func DoesClusterLabelExist

func DoesClusterLabelExist(client *clients.Settings, clusterName string, label string) (bool, error)

DoesClusterLabelExist looks for a label on a managed cluster and returns true if it exists.

func GetPlusOneWorkerName

func GetPlusOneWorkerName(client *clients.Settings) (string, error)

GetPlusOneWorkerName gets the name of the one worker in a SNO+1 cluster.

func IsClusterStable

func IsClusterStable(client *clients.Settings) (bool, error)

IsClusterStable checks if the provided cluster does not have any unschedulable nodes.

func IsNodeControlPlane

func IsNodeControlPlane(node *nodes.Builder) bool

IsNodeControlPlane checks whether the provided node is a control plane node.

func IsSnoPlusOne

func IsSnoPlusOne(client *clients.Settings) (bool, error)

IsSnoPlusOne checks if the specified cluster has one control plane and one worker node.

func ListNodesByLabel

func ListNodesByLabel(client *clients.Settings, labelMap map[string]string) ([]*nodes.Builder, error)

ListNodesByLabel returns a list of nodes that have the specified label.

func PowerOffAndWait

func PowerOffAndWait(bmcClient *bmc.BMC) error

PowerOffAndWait will trigger a power off and poll every 30 seconds for up to 3 minutes until the system is off.

func PowerOffWithRetries

func PowerOffWithRetries(bmcClient *bmc.BMC, retries uint) error

PowerOffWithRetries will attempt to power off and wait until the system is powered off, trying up to retries times if the system does not power off.

func PowerOnAndWait

func PowerOnAndWait(bmcClient *bmc.BMC) error

PowerOnAndWait will trigger a power on and poll every 30 seconds for up to 3 minutes until the system is on.

func PowerOnWithRetries

func PowerOnWithRetries(bmcClient *bmc.BMC, retries uint) error

PowerOnWithRetries will attempt to power on and wait until the system is powered on, trying up to retries times if the system does not power on.

func WaitForNumberOfNodes

func WaitForNumberOfNodes(client *clients.Settings, expected int, timeout time.Duration) error

WaitForNumberOfNodes waits up to timeout until the number of nodes on the cluster matches the expected.