InfraClusterVersionPreflight [upgrade.alauda.io/v1alpha1]

描述
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.
类型
object
必填
spec

规格

属性类型描述
apiVersionstring

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kindstring

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadataObjectMeta

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

specobject

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.

statusobject

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.

.spec

描述
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.
类型
object
必填
clusterNameinfrastructureRefkubernetesVersionrelease
属性类型描述
clusterNamestring
componentsarray

components are hints only, under the same contract as on InfraClusterVersion.

infrastructureRefobject

InfrastructureReference identifies the CAPI infrastructure cluster kind, copied from Cluster.spec.infrastructureRef. The kind decides which provider handles the object.

kubernetesVersionstring

kubernetesVersion is the final target of this platform upgrade; the provider expands the intermediate versions when it evaluates.

releaseobject

release is the target ACP release of this platform upgrade.

.spec.components

描述
components are hints only, under the same contract as on InfraClusterVersion.
类型
array

.spec.components[]

描述
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.
类型
object
属性类型描述
namestring
versionstring

.spec.infrastructureRef

描述
InfrastructureReference identifies the CAPI infrastructure cluster kind, copied from Cluster.spec.infrastructureRef. The kind decides which provider handles the object.
类型
object
必填
apiVersionkind
属性类型描述
apiVersionstring
kindstring

.spec.release

描述
release is the target ACP release of this platform upgrade.
类型
object
必填
version
属性类型描述
imagestring

image is the digest-pinned release payload, for audit and tracing.

versionstring

version is the target ACP release without a leading v, for example 4.3.3, as CVO and the ClusterVersionShadow write it.

.status

描述
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.
类型
object
属性类型描述
checksarray
conditionsarray
hopsarray

hops lists the versions the provider plans to pass, in order, with kubernetesVersion only.

observedAtstring

observedAt is when the latest evaluation completed.

observedGenerationinteger
resolvedImagesarray

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.

.status.checks

类型
array

.status.checks[]

描述
PreflightCheck is one provider-defined check.
类型
object
属性类型描述
canBypassCheckboolean

canBypassCheck says whether a forced upgrade may accept this check's failure as a risk. It only matters for Blocking checks, and absent means false: a check is non-bypassable unless the provider says otherwise, because the rollout it gates cannot be rolled back.

messagestring
namestring

name is chosen by the provider, in PascalCase.

reasonstring

reason is PascalCase, for example ImageNotFound.

severitystring

PreflightCheckSeverity says whether a failed check blocks the upgrade.

statestring

PreflightCheckState is the result of the latest evaluation. A check that cannot be evaluated for now is Failed, with the reason saying why.

.status.conditions

类型
array

.status.conditions[]

描述
Condition contains details for one aspect of the current state of this API Resource.
类型
object
必填
lastTransitionTimemessagereasonstatustype
属性类型描述
lastTransitionTimestring

lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

messagestring

message is a human readable message indicating details about the transition. This may be an empty string.

observedGenerationinteger

observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

reasonstring

reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

statusstring

status of the condition, one of True, False, Unknown.

typestring

type of condition in CamelCase or in foo.example.com/CamelCase.

.status.hops

描述
hops lists the versions the provider plans to pass, in order, with kubernetesVersion only.
类型
array

.status.hops[]

描述
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.
类型
object
属性类型描述
completionTimestring
kubernetesVersionstring
phasestring

HopPhase is the progress of one hop.

startedTimestring

.status.resolvedImages

描述
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.
类型
array

.status.resolvedImages[]

描述
ResolvedImage is the image one KubeadmControlPlane or MachineDeployment uses for one hop.
类型
object
属性类型描述
imagestring

image is opaque and private to the provider: a VM template name, an ECS image name, an OCI reference, and so on.

kubernetesVersionstring

kubernetesVersion is the hop the entry belongs to, intermediate or final.

machineTemplateRefobject

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.

targetRefobject

targetRef is the KubeadmControlPlane or a MachineDeployment.

.status.resolvedImages[].machineTemplateRef

描述
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.
类型
object
属性类型描述
kindstring
namestring

.status.resolvedImages[].targetRef

描述
targetRef is the KubeadmControlPlane or a MachineDeployment.
类型
object
属性类型描述
kindstring
namestring

API 端点

可用的 API 端点如下:

  • /apis/upgrade.alauda.io/v1alpha1/namespaces/{namespace}/infraclusterversionpreflights
    • DELETE: delete collection of InfraClusterVersionPreflight
    • GET: list objects of kind InfraClusterVersionPreflight
    • POST: create a new InfraClusterVersionPreflight
  • /apis/upgrade.alauda.io/v1alpha1/namespaces/{namespace}/infraclusterversionpreflights/{name}
    • DELETE: delete the specified InfraClusterVersionPreflight
    • GET: read the specified InfraClusterVersionPreflight
    • PATCH: partially update the specified InfraClusterVersionPreflight
    • PUT: replace the specified InfraClusterVersionPreflight
  • /apis/upgrade.alauda.io/v1alpha1/namespaces/{namespace}/infraclusterversionpreflights/{name}/status
    • GET: read status of the specified InfraClusterVersionPreflight
    • PATCH: partially update status of the specified InfraClusterVersionPreflight
    • PUT: replace status of the specified InfraClusterVersionPreflight

/apis/upgrade.alauda.io/v1alpha1/namespaces/{namespace}/infraclusterversionpreflights

HTTP 方法
DELETE
描述
delete collection of InfraClusterVersionPreflight
HTTP 响应
HTTP 状态码响应体
200 - OKStatus schema
401 - UnauthorizedEmpty
HTTP 方法
GET
描述
list objects of kind InfraClusterVersionPreflight
HTTP 响应
HTTP 状态码响应体
200 - OKInfraClusterVersionPreflightList schema
401 - UnauthorizedEmpty
HTTP 方法
POST
描述
create a new InfraClusterVersionPreflight
查询参数
参数类型描述
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
请求体参数
参数类型描述
bodyInfraClusterVersionPreflight schemaapplication/json formatted
HTTP 响应
HTTP 状态码响应体
200 - OKInfraClusterVersionPreflight schema
201 - CreatedInfraClusterVersionPreflight schema
202 - AcceptedInfraClusterVersionPreflight schema
401 - UnauthorizedEmpty

/apis/upgrade.alauda.io/v1alpha1/namespaces/{namespace}/infraclusterversionpreflights/{name}

HTTP 方法
DELETE
描述
delete the specified InfraClusterVersionPreflight
查询参数
参数类型描述
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
HTTP 响应
HTTP 状态码响应体
200 - OKStatus schema
202 - AcceptedStatus schema
401 - UnauthorizedEmpty
HTTP 方法
GET
描述
read the specified InfraClusterVersionPreflight
HTTP 响应
HTTP 状态码响应体
200 - OKInfraClusterVersionPreflight schema
401 - UnauthorizedEmpty
HTTP 方法
PATCH
描述
partially update the specified InfraClusterVersionPreflight
查询参数
参数类型描述
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
HTTP 响应
HTTP 状态码响应体
200 - OKInfraClusterVersionPreflight schema
401 - UnauthorizedEmpty
HTTP 方法
PUT
描述
replace the specified InfraClusterVersionPreflight
查询参数
参数类型描述
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
请求体参数
参数类型描述
bodyInfraClusterVersionPreflight schemaapplication/json formatted
HTTP 响应
HTTP 状态码响应体
200 - OKInfraClusterVersionPreflight schema
201 - CreatedInfraClusterVersionPreflight schema
401 - UnauthorizedEmpty

/apis/upgrade.alauda.io/v1alpha1/namespaces/{namespace}/infraclusterversionpreflights/{name}/status

HTTP 方法
GET
描述
read status of the specified InfraClusterVersionPreflight
HTTP 响应
HTTP 状态码响应体
200 - OKInfraClusterVersionPreflight schema
401 - UnauthorizedEmpty
HTTP 方法
PATCH
描述
partially update status of the specified InfraClusterVersionPreflight
查询参数
参数类型描述
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
HTTP 响应
HTTP 状态码响应体
200 - OKInfraClusterVersionPreflight schema
401 - UnauthorizedEmpty
HTTP 方法
PUT
描述
replace status of the specified InfraClusterVersionPreflight
查询参数
参数类型描述
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
请求体参数
参数类型描述
bodyInfraClusterVersionPreflight schemaapplication/json formatted
HTTP 响应
HTTP 状态码响应体
200 - OKInfraClusterVersionPreflight schema
201 - CreatedInfraClusterVersionPreflight schema
401 - UnauthorizedEmpty