ClusterVersionShadow [config.alauda.io/v1]

Type
object

Specification

PropertyTypeDescription
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

spec is the desired state of the cluster upgrade.

statusobject

status contains information about cluster upgrade.

.spec

Description
spec is the desired state of the cluster upgrade.
Type
object
PropertyTypeDescription
desiredUpdateobject

desiredUpdate is an optional field that indicates the desired value of the cluster version. Setting this value will trigger an upgrade (if the current version does not match the desired version).

.spec.desiredUpdate

Description
desiredUpdate is an optional field that indicates the desired value of the cluster version. Setting this value will trigger an upgrade (if the current version does not match the desired version).
Type
object
PropertyTypeDescription
forceboolean

force allows an administrator to update to an image that has failed checks that are designed to keep the cluster safe.

Use only if:

  • testing
  • working around a known bug
imagestring

image is a container image reference that contains the update.

versionstring

version is the container image tag that identifies the update.

.status

Description
status contains information about cluster upgrade.
Type
object
PropertyTypeDescription
availableUpdatesarray

availableUpdates contains available updates. This list may be

conditionsarray

conditions provides information about the cluster version. The condition "Ready" is set to true if the desiredUpdate has been reached. The condition "Reconciling" is set to true if an update is being applied. The condition "Degraded" is set to true if an update is currently blocked by a temporary or permanent error.

Conditions are only valid for the current desiredUpdate when metadata.generation is equal to status.generation.

currentobject

current is the currently applied release version and image of the cluster.

desiredobject

desired is the version that the cluster is reconciling towards. If the cluster is not yet fully initialized, desired will be set with the information available, which may be an image or a tag.

historyarray

history contains a list of the most recent versions applied to the cluster. This value may be empty during cluster startup, and then will be updated when a new update is being applied. The newest update is first in the list and it is ordered by recency. Updates in the history have state Completed if the rollout completed - if an update was failing or halfway applied the state will be Partial. Only a limited amount of update history is preserved.

observedGenerationinteger

observedGeneration of the object. When this matches the object's metadata.generation, it indicates the status is up-to-date.

preflightobject

preflight records information used during an in-progress upgrade to support deterministic preflight reentry behavior.

stagesarray

stages expose the execution stages and per-operation DAG for the current update. Stages are executed sequentially; operations within a stage form a DAG.

.status.availableUpdates

Description
availableUpdates contains available updates. This list may be
Type
array

.status.availableUpdates[]

Description
Release represents an ACP release image and associated metadata.
Type
object
PropertyTypeDescription
imagestring

image is a container image location that contains the update. When this field is part of spec, image is optional if version is specified.

versionstring

version is a semantic version identifying the update version. When this field is part of spec, version is optional if image is specified.

.status.conditions

Description
conditions provides information about the cluster version. The condition "Ready" is set to true if the desiredUpdate has been reached. The condition "Reconciling" is set to true if an update is being applied. The condition "Degraded" is set to true if an update is currently blocked by a temporary or permanent error. Conditions are only valid for the current desiredUpdate when metadata.generation is equal to status.generation.
Type
array

.status.conditions[]

Description
Condition contains details for one aspect of the current state of this API Resource.
Type
object
Required
lastTransitionTimemessagereasonstatustype
PropertyTypeDescription
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.current

Description
current is the currently applied release version and image of the cluster.
Type
object
PropertyTypeDescription
imagestring

image is a container image location that contains the update. When this field is part of spec, image is optional if version is specified.

versionstring

version is a semantic version identifying the update version. When this field is part of spec, version is optional if image is specified.

.status.desired

Description
desired is the version that the cluster is reconciling towards. If the cluster is not yet fully initialized, desired will be set with the information available, which may be an image or a tag.
Type
object
PropertyTypeDescription
imagestring

image is a container image location that contains the update. When this field is part of spec, image is optional if version is specified.

versionstring

version is a semantic version identifying the update version. When this field is part of spec, version is optional if image is specified.

.status.history

Description
history contains a list of the most recent versions applied to the cluster. This value may be empty during cluster startup, and then will be updated when a new update is being applied. The newest update is first in the list and it is ordered by recency. Updates in the history have state Completed if the rollout completed - if an update was failing or halfway applied the state will be Partial. Only a limited amount of update history is preserved.
Type
array

.status.history[]

Description
UpdateHistory is a single attempted update to the cluster.
Type
object
Required
imagestartedTimestate
PropertyTypeDescription
acceptedRisksstring

acceptedRisks records risks which were accepted to initiate the update.

completionTimestring

completionTime if set, is when the update was fully applied. The update that is currently being applied will have a null completion time. Completion time will always be set for entries that are not the current update (usually to the started time of the next update).

imagestring

image is a container image location that contains the update. This value is always populated.

startedTimestring

startedTime is the time at which the update was started.

statestring

state reflects whether the update was fully applied. The Partial state indicates the update is not fully applied, while the Completed state indicates the update was successfully rolled out at least once (all parts of the update successfully applied).

versionstring

version is a semantic version identifying the update version. If the requested image does not define a version, or if a failure occurs retrieving the image, this value may be empty.

.status.preflight

Description
preflight records information used during an in-progress upgrade to support deterministic preflight reentry behavior.
Type
object
PropertyTypeDescription
checksarray

checks records the latest evaluation result for each preflight check.

observedAtstring

observedAt is the time when preflight was last evaluated.

.status.preflight.checks

Description
checks records the latest evaluation result for each preflight check.
Type
array

.status.preflight.checks[]

Description
PreflightCheckStatus records the latest result of a single preflight check.
Type
object
Required
name
PropertyTypeDescription
messagestring

message contains human-readable details for the last result.

namestring

name is the preflight check name.

policystring

policy indicates how the check behaves on reentry.

reasonstring

reason is a programmatic identifier for the last result.

statestring

state is the latest result state for the check.

.status.stages

Description
stages expose the execution stages and per-operation DAG for the current update. Stages are executed sequentially; operations within a stage form a DAG.
Type
array

.status.stages[]

Type
object
Required
name
PropertyTypeDescription
namestring

name is the stage display name.

operationsarray

operations are the DAG nodes in this stage.

phasestring

phase is the lifecycle status of this stage.

priorityinteger

priority is the stage execution order (ascending).

.status.stages[].operations

Description
operations are the DAG nodes in this stage.
Type
array

.status.stages[].operations[]

Type
object
Required
name
PropertyTypeDescription
actionstring

action is Install/Upgrade/Delete (omit for no-op/unknown).

currentVersionstring

currentVersion is the observed value at build/progress time.

dependsOnarray

dependsOn lists direct predecessor operation names within this stage.

moduleInfostring

moduleInfo is the backing ModuleInfo name (if any).

namestring

name is the operation/component identifier (stable ID).

phasestring

phase is the current operation phase string (e.g. Running/UpgradePending/Failed).

targetVersionstring

targetVersion is the desired value at build/progress time.

.status.stages[].operations[].dependsOn

Description
dependsOn lists direct predecessor operation names within this stage.
Type
array

.status.stages[].operations[].dependsOn[]

Type
string

API Endpoints

The following API endpoints are available:

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

/apis/config.alauda.io/v1/namespaces/{namespace}/clusterversionshadows

HTTP method
DELETE
Description
delete collection of ClusterVersionShadow
HTTP responses
HTTP codeResponse body
200 - OKStatus schema
401 - UnauthorizedEmpty
HTTP method
GET
Description
list objects of kind ClusterVersionShadow
HTTP responses
HTTP codeResponse body
200 - OKClusterVersionShadowList schema
401 - UnauthorizedEmpty
HTTP method
POST
Description
create a new ClusterVersionShadow
Query parameters
ParameterTypeDescription
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.
Body parameters
ParameterTypeDescription
bodyClusterVersionShadow schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKClusterVersionShadow schema
201 - CreatedClusterVersionShadow schema
202 - AcceptedClusterVersionShadow schema
401 - UnauthorizedEmpty

/apis/config.alauda.io/v1/namespaces/{namespace}/clusterversionshadows/{name}

HTTP method
DELETE
Description
delete the specified ClusterVersionShadow
Query parameters
ParameterTypeDescription
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 responses
HTTP codeResponse body
200 - OKStatus schema
202 - AcceptedStatus schema
401 - UnauthorizedEmpty
HTTP method
GET
Description
read the specified ClusterVersionShadow
HTTP responses
HTTP codeResponse body
200 - OKClusterVersionShadow schema
401 - UnauthorizedEmpty
HTTP method
PATCH
Description
partially update the specified ClusterVersionShadow
Query parameters
ParameterTypeDescription
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 responses
HTTP codeResponse body
200 - OKClusterVersionShadow schema
401 - UnauthorizedEmpty
HTTP method
PUT
Description
replace the specified ClusterVersionShadow
Query parameters
ParameterTypeDescription
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.
Body parameters
ParameterTypeDescription
bodyClusterVersionShadow schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKClusterVersionShadow schema
201 - CreatedClusterVersionShadow schema
401 - UnauthorizedEmpty

/apis/config.alauda.io/v1/namespaces/{namespace}/clusterversionshadows/{name}/status

HTTP method
GET
Description
read status of the specified ClusterVersionShadow
HTTP responses
HTTP codeResponse body
200 - OKClusterVersionShadow schema
401 - UnauthorizedEmpty
HTTP method
PATCH
Description
partially update status of the specified ClusterVersionShadow
Query parameters
ParameterTypeDescription
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 responses
HTTP codeResponse body
200 - OKClusterVersionShadow schema
401 - UnauthorizedEmpty
HTTP method
PUT
Description
replace status of the specified ClusterVersionShadow
Query parameters
ParameterTypeDescription
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.
Body parameters
ParameterTypeDescription
bodyClusterVersionShadow schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKClusterVersionShadow schema
201 - CreatedClusterVersionShadow schema
401 - UnauthorizedEmpty