cluster

Documentation

Index

• type Capabilities
  • func NewCapabilities(config *rest.Config, reader client.Reader, logger logr.Logger, ...) (Capabilities, error)
• type UpgradeChecker
  • func NewClusterUpgradeStatusChecker(mgr manager.Manager, caps Capabilities) (UpgradeChecker, error)

Types

type Capabilities

type Capabilities struct {
	IsOnOpenshift, HasMachineAPI, IsSupportedControlPlaneTopology bool
}

func NewCapabilities

func NewCapabilities(config *rest.Config, reader client.Reader, logger logr.Logger, ctx context.Context) (Capabilities, error)

NewCapabilities returns a Capabilities struct with the following fields: - IsOnOpenshift: true if the cluster is an OpenShift cluster - HasMachineAPI: true if the cluster has the Machine API installed - IsSupportedControlPlaneTopology: true if the cluster has a supported control plane topology

type UpgradeChecker

type UpgradeChecker interface {
	// Check if the cluster is currently under upgrade.
	// error should be thrown if it can't reliably determine if it's under upgrade or not.
	Check() (bool, error)
}

UpgradeChecker checks if the cluster is currently under upgrade. error should be thrown if it can't reliably determine if it's under upgrade or not.

func NewClusterUpgradeStatusChecker

func NewClusterUpgradeStatusChecker(mgr manager.Manager, caps Capabilities) (UpgradeChecker, error)

NewClusterUpgradeStatusChecker will return some implementation of a checker or err in case it can't reliably detect which implementation to use.