InfraClusterVersionPreflight [upgrade.alauda.io/v1alpha1]
- Description
- InfraClusterVersionPreflight is the provider's read-only evaluation of one platform upgrade for one cluster, covering every hop before anything changes. It holds no lock and is re-evaluated continuously; CVO gates setting an InfraClusterVersion's desired state on it. There is one per cluster and platform upgrade, named <cluster>-<kubernetesVersion>-<8 hex hash> so that the controller and the CLI derive the same name for the same upgrade and share one object.
- Type
object- Required
spec
Specification
.spec
- Description
- InfraClusterVersionPreflightSpec is the "upgrade to where" part of an InfraClusterVersion's spec.desired, plus the cluster's identity. It carries no starting version: the provider plans the path from whatever the cluster runs when it evaluates, so the result always reflects the current state. The whole spec is immutable, including whether an optional field is present. The object's name is derived from the spec, so a different spec under the same name is a conflict to report, never an edit to accept.
- Type
object- Required
clusterNameinfrastructureRefkubernetesVersionrelease
.spec.components
- Description
- components are hints only, under the same contract as on InfraClusterVersion.
- Type
array
.spec.components[]
- Description
- ComponentHint is a version hint for one component. It is only a hint: providers must not depend on its presence or value, and CVO does not promise to fill it.
- Type
object
.spec.infrastructureRef
- Description
- InfrastructureReference identifies the CAPI infrastructure cluster kind, copied from Cluster.spec.infrastructureRef. The kind decides which provider handles the object.
- Type
object- Required
apiVersionkind
.spec.release
- Description
- release is the target ACP release of this platform upgrade.
- Type
object- Required
version
.status
- Description
- InfraClusterVersionPreflightStatus is written only by the provider, on every evaluation. A result is fresh only when observedGeneration equals a non-zero metadata.generation and observedAt is recent; CVO trusts nothing else. resolvedImages and hops are extensions; the rest are core fields every provider must implement. All are optional in the schema.
- Type
object
.status.checks
- Type
array
.status.checks[]
- Description
- PreflightCheck is one provider-defined check.
- Type
object
.status.conditions
- Type
array
.status.conditions[]
- Description
- Condition contains details for one aspect of the current state of this API Resource.
- Type
object- Required
lastTransitionTimemessagereasonstatustype
.status.hops
- Description
- hops lists the versions the provider plans to pass, in order, with kubernetesVersion only.
- Type
array
.status.hops[]
- Description
- Hop is one Kubernetes version change of at most one minor that the provider performs inside a generation. An InfraClusterVersionPreflight lists hops with kubernetesVersion only.
- Type
object
.status.resolvedImages
- Description
- resolvedImages previews the image each hop will use, one entry per hop and per KubeadmControlPlane or MachineDeployment. CVO does not read it; image problems are reported as checks.
- Type
array
.status.resolvedImages[]
- Description
- ResolvedImage is the image one KubeadmControlPlane or MachineDeployment uses for one hop.
- Type
object
.status.resolvedImages[].machineTemplateRef
- Description
- machineTemplateRef is the MachineTemplate used for the hop. It may be omitted for a hop not yet entered, and on a preflight it is at most the expected name: the template need not exist.
- Type
object
.status.resolvedImages[].targetRef
- Description
- targetRef is the KubeadmControlPlane or a MachineDeployment.
- Type
object
API Endpoints
The following API endpoints are available:
/apis/upgrade.alauda.io/v1alpha1/namespaces/{namespace}/infraclusterversionpreflightsDELETE: delete collection of InfraClusterVersionPreflightGET: list objects of kind InfraClusterVersionPreflightPOST: create a new InfraClusterVersionPreflight
/apis/upgrade.alauda.io/v1alpha1/namespaces/{namespace}/infraclusterversionpreflights/{name}DELETE: delete the specified InfraClusterVersionPreflightGET: read the specified InfraClusterVersionPreflightPATCH: partially update the specified InfraClusterVersionPreflightPUT: replace the specified InfraClusterVersionPreflight
/apis/upgrade.alauda.io/v1alpha1/namespaces/{namespace}/infraclusterversionpreflights/{name}/statusGET: read status of the specified InfraClusterVersionPreflightPATCH: partially update status of the specified InfraClusterVersionPreflightPUT: replace status of the specified InfraClusterVersionPreflight
/apis/upgrade.alauda.io/v1alpha1/namespaces/{namespace}/infraclusterversionpreflights
- HTTP method
DELETE- Description
- delete collection of InfraClusterVersionPreflight
- HTTP responses
- HTTP method
GET- Description
- list objects of kind InfraClusterVersionPreflight
- HTTP responses
- HTTP method
POST- Description
- create a new InfraClusterVersionPreflight
- Query parameters
- Body parameters
- HTTP responses
/apis/upgrade.alauda.io/v1alpha1/namespaces/{namespace}/infraclusterversionpreflights/{name}
- HTTP method
DELETE- Description
- delete the specified InfraClusterVersionPreflight
- Query parameters
- HTTP responses
- HTTP method
GET- Description
- read the specified InfraClusterVersionPreflight
- HTTP responses
- HTTP method
PATCH- Description
- partially update the specified InfraClusterVersionPreflight
- Query parameters
- HTTP responses
- HTTP method
PUT- Description
- replace the specified InfraClusterVersionPreflight
- Query parameters
- Body parameters
- HTTP responses
/apis/upgrade.alauda.io/v1alpha1/namespaces/{namespace}/infraclusterversionpreflights/{name}/status
- HTTP method
GET- Description
- read status of the specified InfraClusterVersionPreflight
- HTTP responses
- HTTP method
PATCH- Description
- partially update status of the specified InfraClusterVersionPreflight
- Query parameters
- HTTP responses
- HTTP method
PUT- Description
- replace status of the specified InfraClusterVersionPreflight
- Query parameters
- Body parameters
- HTTP responses