# Packages

Package annotations implements annotation helper functions.
Package apiwarnings defines warning handlers used with API clients.
Package cache implements some cache utils.
Package certs implements cert handling utilities.
Package collections implements collection utilities.
Package conditions implements condition utilities.
Package container implements container utility functionality.
Package contract contains utils related to the Cluster API contract.
Package conversion implements conversion utilities.
Package defaulting implements defaulting webhook functionality.
Package failuredomains implements FailureDomain utility functions.
Package finalizers implements finalizer helper functions.
Package flags implements the manager options utilities.
Package kubeconfig implements utilities for working with kubeconfigs.
Package labels implements label utility functions.
Package log provides log utils.
Package patch implements patch utilities.
Package paused implements paused helper functions.
Package predicates implements predicate utilities.
Package record implements recording functionality.
Package resource implements resource utilites.
Package secret implements utilities for secret handling.
No description provided by the author
Package topology implements topology utility functions.
Package version implements version handling.
Package yaml implements yaml utility functions.

# Functions

ClusterToInfrastructureMapFunc returns a handler.ToRequestsFunc that watches for Cluster events and returns reconciliation requests for an infrastructure provider object.
ClusterToTypedObjectsMapper returns a mapper function that gets a cluster and lists all objects for the object passed in and returns a list of requests.
EnsureOwnerRef makes sure the slice contains the OwnerReference.
GetClusterByName finds and return a Cluster object using the specified params.
GetClusterFromMetadata returns the Cluster object (if present) using the object metadata.
GetGVKMetadata retrieves a CustomResourceDefinition metadata from the API server using partial object metadata.
GetMachineByName finds and return a Machine object using the specified params.
GetMachineIfExists gets a machine from the API server if it exists.
GetOwnerCluster returns the Cluster object owning the current resource.
GetOwnerMachine returns the Machine object owning the current resource.
HasExactOwnerRef returns true if the exact OwnerReference is already in the slice.
HasOwner checks if any of the references in the passed list match the given group from apiVersion and one of the given kinds.
HasOwnerRef returns true if the OwnerReference is already in the slice.
IsControlledBy differs from metav1.IsControlledBy.
IsControlPlaneMachine checks machine is a control plane node.
IsExternalManagedControlPlane returns a bool indicating whether the control plane referenced in the passed Unstructured resource is an externally managed control plane such as AKS, EKS, GKE, etc.
IsNil returns an error if the passed interface is equal to nil or if it has an interface value of nil.
IsNodeReady returns true if a node is ready.
IsOwnedByObject returns true if any of the owner references point to the given target.
IsSupportedVersionSkew will return true if a and b are no more than one minor version off from each other.
LowestNonZeroInt32 returns the lowest non-zero value of the two provided values.
LowestNonZeroResult compares two reconciliation results and returns the one with lowest requeue time.
MachineDeploymentToObjectsMapper returns a mapper function that gets a machinedeployment and lists all objects for the object passed in and returns a list of requests.
MachineSetToObjectsMapper returns a mapper function that gets a machineset and lists all objects for the object passed in and returns a list of requests.
MachineToInfrastructureMapFunc returns a handler.ToRequestsFunc that watches for Machine events and returns reconciliation requests for an infrastructure provider object.
MergeMap merges maps.
ObjectKey returns client.ObjectKey for the object.
ObjectReferenceToUnstructured converts an object reference to an unstructured object.
Ordinalize takes an int and returns the ordinalized version of it.
RandomString returns a random alphanumeric string.
RemoveOwnerRef returns the slice of owner references after removing the supplied owner ref.
ReplaceOwnerRef re-parents an object from one OwnerReference to another It compares strictly based on UID to avoid reparenting across an intentional deletion: if an object is deleted and re-created with the same name and namespace, the only way to tell there was an in-progress deletion is by comparing the UIDs.
Retry retries a given function with exponential backoff.
UnstructuredUnmarshalField is a wrapper around json and unstructured objects to decode and copy a specific field value into an object.

# Constants

CharSet defines the alphanumeric set for random string generation.

# Variables

ErrNoCluster is returned when the cluster label could not be found on the object passed in.
ErrUnstructuredFieldNotFound determines that a field in an unstructured object could not be found.

# Type aliases

KubeAwareAPIVersions is a sortable slice of kube-like version strings.