check

Documentation

Overview

Package check implements checks for managed topology.

Index

• func ClusterClassReferencesAreValid(clusterClass *clusterv1.ClusterClass) field.ErrorList
• func ClusterClassesAreCompatible(current, desired *clusterv1.ClusterClass) field.ErrorList
• func IsMachineDeploymentUpgrading(ctx context.Context, c client.Reader, md *clusterv1.MachineDeployment) (bool, error)
• func IsMachinePoolUpgrading(ctx context.Context, c client.Reader, mp *expv1.MachinePool) (bool, error)
• func LocalObjectTemplateIsValid(template *clusterv1.LocalObjectTemplate, namespace string, ...) field.ErrorList
• func LocalObjectTemplatesAreCompatible(current, desired clusterv1.LocalObjectTemplate, pathPrefix *field.Path) field.ErrorList
• func LocalObjectTemplatesAreInSameNamespace(current, desired clusterv1.LocalObjectTemplate, pathPrefix *field.Path) field.ErrorList
• func MachineDeploymentClassesAreCompatible(current, desired *clusterv1.ClusterClass) field.ErrorList
• func MachineDeploymentClassesAreUnique(clusterClass *clusterv1.ClusterClass) field.ErrorList
• func MachineDeploymentTopologiesAreValidAndDefinedInClusterClass(desired *clusterv1.Cluster, clusterClass *clusterv1.ClusterClass) field.ErrorList
• func MachinePoolClassesAreCompatible(current, desired *clusterv1.ClusterClass) field.ErrorList
• func MachinePoolClassesAreUnique(clusterClass *clusterv1.ClusterClass) field.ErrorList
• func MachinePoolTopologiesAreValidAndDefinedInClusterClass(desired *clusterv1.Cluster, clusterClass *clusterv1.ClusterClass) field.ErrorList
• func ObjectsAreCompatible(current, desired client.Object) field.ErrorList
• func ObjectsAreInTheSameNamespace(current, desired client.Object) field.ErrorList
• func ObjectsAreStrictlyCompatible(current, desired client.Object) field.ErrorList

Functions

func ClusterClassReferencesAreValid

func ClusterClassReferencesAreValid(clusterClass *clusterv1.ClusterClass) field.ErrorList

ClusterClassReferencesAreValid checks that each template reference in the ClusterClass is valid .

func ClusterClassesAreCompatible

func ClusterClassesAreCompatible(current, desired *clusterv1.ClusterClass) field.ErrorList

ClusterClassesAreCompatible checks the compatibility between new and old versions of a Cluster Class. It checks that: 1) InfrastructureCluster Templates are compatible. 2) ControlPlane Templates are compatible. 3) ControlPlane InfrastructureMachineTemplates are compatible. 4) MachineDeploymentClasses are compatible. 5) MachinePoolClasses are compatible.

func IsMachineDeploymentUpgrading

func IsMachineDeploymentUpgrading(ctx context.Context, c client.Reader, md *clusterv1.MachineDeployment) (bool, error)

IsMachineDeploymentUpgrading determines if the MachineDeployment is upgrading. A machine deployment is considered upgrading if at least one of the Machines of this MachineDeployment has a different version.

func IsMachinePoolUpgrading

func IsMachinePoolUpgrading(ctx context.Context, c client.Reader, mp *expv1.MachinePool) (bool, error)

IsMachinePoolUpgrading determines if the MachinePool is upgrading. A machine pool is considered upgrading if at least one of the Machines of this MachinePool has a different version.

func LocalObjectTemplateIsValid

func LocalObjectTemplateIsValid(template *clusterv1.LocalObjectTemplate, namespace string, pathPrefix *field.Path) field.ErrorList

LocalObjectTemplateIsValid ensures the template is in the correct namespace, has no nil references, and has a valid Kind and GroupVersion.

func LocalObjectTemplatesAreCompatible

func LocalObjectTemplatesAreCompatible(current, desired clusterv1.LocalObjectTemplate, pathPrefix *field.Path) field.ErrorList

LocalObjectTemplatesAreCompatible checks if two referenced objects are compatible, meaning that they are of the same GroupKind and in the same namespace.

func LocalObjectTemplatesAreInSameNamespace

func LocalObjectTemplatesAreInSameNamespace(current, desired clusterv1.LocalObjectTemplate, pathPrefix *field.Path) field.ErrorList

LocalObjectTemplatesAreInSameNamespace checks if two referenced objects are in the same namespace.

func MachineDeploymentClassesAreCompatible

func MachineDeploymentClassesAreCompatible(current, desired *clusterv1.ClusterClass) field.ErrorList

MachineDeploymentClassesAreCompatible checks if each MachineDeploymentClass in the new ClusterClass is a compatible change from the previous ClusterClass. It checks if the MachineDeploymentClass.Template.Infrastructure reference has changed its Group or Kind.

func MachineDeploymentClassesAreUnique

func MachineDeploymentClassesAreUnique(clusterClass *clusterv1.ClusterClass) field.ErrorList

MachineDeploymentClassesAreUnique checks that no two MachineDeploymentClasses in a ClusterClass share a name.

func MachineDeploymentTopologiesAreValidAndDefinedInClusterClass

func MachineDeploymentTopologiesAreValidAndDefinedInClusterClass(desired *clusterv1.Cluster, clusterClass *clusterv1.ClusterClass) field.ErrorList

MachineDeploymentTopologiesAreValidAndDefinedInClusterClass checks that each MachineDeploymentTopology name is not empty and unique, and each class in use is defined in ClusterClass.spec.Workers.MachineDeployments.

func MachinePoolClassesAreCompatible

func MachinePoolClassesAreCompatible(current, desired *clusterv1.ClusterClass) field.ErrorList

MachinePoolClassesAreCompatible checks if each MachinePoolClass in the new ClusterClass is a compatible change from the previous ClusterClass. It checks if the MachinePoolClass.Template.Infrastructure reference has changed its Group or Kind.

func MachinePoolClassesAreUnique

func MachinePoolClassesAreUnique(clusterClass *clusterv1.ClusterClass) field.ErrorList

MachinePoolClassesAreUnique checks that no two MachinePoolClasses in a ClusterClass share a name.

func MachinePoolTopologiesAreValidAndDefinedInClusterClass

func MachinePoolTopologiesAreValidAndDefinedInClusterClass(desired *clusterv1.Cluster, clusterClass *clusterv1.ClusterClass) field.ErrorList

MachinePoolTopologiesAreValidAndDefinedInClusterClass checks that each MachinePoolTopology name is not empty and unique, and each class in use is defined in ClusterClass.spec.Workers.MachinePools.

func ObjectsAreCompatible

func ObjectsAreCompatible(current, desired client.Object) field.ErrorList

ObjectsAreCompatible checks if two referenced objects are compatible, meaning that they are of the same GroupKind and in the same namespace.

func ObjectsAreInTheSameNamespace

func ObjectsAreInTheSameNamespace(current, desired client.Object) field.ErrorList

ObjectsAreInTheSameNamespace checks if two referenced objects are in the same namespace.

func ObjectsAreStrictlyCompatible

func ObjectsAreStrictlyCompatible(current, desired client.Object) field.ErrorList

ObjectsAreStrictlyCompatible checks if two referenced objects are strictly compatible, meaning that they are compatible and the name of the objects do not change.