InfraClusterVersion [upgrade.alauda.io/v1alpha1]
- Description
- InfraClusterVersion is the long-lived desired Kubernetes and OS state of one immutable cluster. CVO sets it once per platform upgrade; the cluster's provider converges it and reports status. There is one per immutable cluster, in the Global cluster's cpaas-system, named after the cluster: the API server then guarantees at most one per cluster, and a repeated create returns AlreadyExists instead of a duplicate. Each generation is one platform upgrade.
- Type
object- Required
spec
Specification
.spec
- Description
- InfraClusterVersionSpec is written only by CVO.
- Type
object- Required
clusterNamedesiredinfrastructureRef
.spec.desired
- Description
- desired is the target of the current platform upgrade.
- Type
object- Required
kubernetesVersionrelease
.spec.desired.components
- Description
- components are hints only; see ComponentHint.
- Type
array
.spec.desired.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.desired.preflightRef
- Description
- preflightRef names the InfraClusterVersionPreflight this generation was gated on. CVO always sets it in automatic mode and leaves it empty in manual mode. Providers treat it as informational.
- Type
object
.spec.desired.release
- Description
- release is the target ACP release of this platform upgrade.
- Type
object- Required
version
.spec.infrastructureRef
- Description
- infrastructureRef is copied from the CAPI Cluster.
- Type
object- Required
apiVersionkind
.status
- Description
- InfraClusterVersionStatus is written only by the provider, and describes the generation in observedGeneration. Core fields -- observedGeneration, phase, conditions, lock, current, startedTime and completionTime -- are what CVO reads and every provider must implement. The rest are extensions for observability that CVO does not read. All are optional in the schema: CVO creates the object with an empty status.
- Type
object
.status.components
- Type
array
.status.components[]
- Description
- ComponentStatus is informational only: neither CVO nor any component may base a decision on it.
- 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.current
- Description
- current is what the cluster has actually reached. kubernetesVersion advances with every completed hop, intermediate minors included; releaseVersion is written only when a whole generation succeeds.
- Type
object
.status.generationStart
- Description
- generationStart is the version at the start of the current generation. The history entry appended on success copies it into from: by then current.kubernetesVersion has moved on with every hop. The provider writes it once, when it observes a new generation and moves it to Preparing: kubernetesVersion from the KubeadmControlPlane's spec.version, releaseVersion from current, which is empty on a new object. It does not change it again within the generation -- not across hops, restarts, leader changes or provider upgrades -- and the next generation overwrites it, except a retargeted generation, one in which CVO replaced the target of an unfinished generation: that one keeps it, so it stays the start of the whole platform upgrade. On an object created while the cluster was already mid-upgrade, for example after a disaster-recovery switchover, it is what the provider observed when it took over, which may be an intermediate version. It is for audit only; providers do not decide their next step from it, except that in a retargeted generation they use it to tell this upgrade's own rollouts, those whose spec.version is at or above its kubernetesVersion, from external ones.
- Type
object
.status.history
- Description
- history gains one entry per completed generation, oldest first. Providers keep at most 20 entries, dropping the oldest. The schema does not enforce that limit: a cap would reject the provider's write rather than let it trim.
- Type
array
.status.history[]
- Description
- HistoryEntry records one completed generation, that is one platform upgrade; intermediate hops are not recorded separately.
- Type
object
.status.history[].from
- Description
- from is the version at the start of the generation, copied from status.generationStart.
- Type
object
.status.history[].to
- Description
- to is the final version of the generation.
- Type
object
.status.hops
- Description
- hops is the path the provider plans to walk, in order. Reset when a new generation starts; empty for a no-op generation.
- 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.lock
- Description
- LockStatus records which provider is executing the current generation. The cluster is locked while the current generation is unfinished, Stalled included; the lock is released when it succeeds and the record stays for audit until the next generation is taken over. There is no renewal and no time-based takeover.
- Type
object
.status.resolvedImages
- Description
- resolvedImages has one entry per hop and per KubeadmControlPlane or MachineDeployment, the same shape as on InfraClusterVersionPreflight.
- 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
.status.rollout
- Type
array
.status.rollout[]
- Description
- RolloutStatus counts machines for one KubeadmControlPlane or MachineDeployment. There is deliberately no per-machine detail.
- Type
object
.status.rollout[].ref
- Description
- TypedLocalReference names an object in the same namespace by kind and name, for example a KubeadmControlPlane, a MachineDeployment or a MachineTemplate.
- Type
object
.status.steps
- Description
- steps is the progress inside the current hop. Reset on entering each hop and when a new generation starts.
- Type
array
.status.steps[]
- Description
- Step is one provider-defined step inside the current hop, for example KubeOVN, ControlPlane or Workers/<machinedeployment>.
- Type
object
API Endpoints
The following API endpoints are available:
/apis/upgrade.alauda.io/v1alpha1/namespaces/{namespace}/infraclusterversionsDELETE: delete collection of InfraClusterVersionGET: list objects of kind InfraClusterVersionPOST: create a new InfraClusterVersion
/apis/upgrade.alauda.io/v1alpha1/namespaces/{namespace}/infraclusterversions/{name}DELETE: delete the specified InfraClusterVersionGET: read the specified InfraClusterVersionPATCH: partially update the specified InfraClusterVersionPUT: replace the specified InfraClusterVersion
/apis/upgrade.alauda.io/v1alpha1/namespaces/{namespace}/infraclusterversions/{name}/statusGET: read status of the specified InfraClusterVersionPATCH: partially update status of the specified InfraClusterVersionPUT: replace status of the specified InfraClusterVersion
/apis/upgrade.alauda.io/v1alpha1/namespaces/{namespace}/infraclusterversions
- HTTP method
DELETE- Description
- delete collection of InfraClusterVersion
- HTTP responses
- HTTP method
GET- Description
- list objects of kind InfraClusterVersion
- HTTP responses
- HTTP method
POST- Description
- create a new InfraClusterVersion
- Query parameters
- Body parameters
- HTTP responses
/apis/upgrade.alauda.io/v1alpha1/namespaces/{namespace}/infraclusterversions/{name}
- HTTP method
DELETE- Description
- delete the specified InfraClusterVersion
- Query parameters
- HTTP responses
- HTTP method
GET- Description
- read the specified InfraClusterVersion
- HTTP responses
- HTTP method
PATCH- Description
- partially update the specified InfraClusterVersion
- Query parameters
- HTTP responses
- HTTP method
PUT- Description
- replace the specified InfraClusterVersion
- Query parameters
- Body parameters
- HTTP responses
/apis/upgrade.alauda.io/v1alpha1/namespaces/{namespace}/infraclusterversions/{name}/status
- HTTP method
GET- Description
- read status of the specified InfraClusterVersion
- HTTP responses
- HTTP method
PATCH- Description
- partially update status of the specified InfraClusterVersion
- Query parameters
- HTTP responses
- HTTP method
PUT- Description
- replace status of the specified InfraClusterVersion
- Query parameters
- Body parameters
- HTTP responses