Package google.cloud.gkehub.clusterupgrade.v1

Index

• FleetSpec (message)
• FleetState (message)
• GKEUpgrade (message)
• GKEUpgradeFeatureCondition (message)
• GKEUpgradeFeatureState (message)
• GKEUpgradeOverride (message)
• GKEUpgradeState (message)
• IgnoredMembership (message)
• MembershipGKEUpgradeState (message)
• MembershipState (message)
• PostConditions (message)
• UpgradeStatus (message)
• UpgradeStatus.Code (enum)

FleetSpec

ClusterUpgrade: The configuration for the fleet-level ClusterUpgrade feature.

Fields
upstream_fleets[]	string This fleet consumes upgrades that have COMPLETE status code in the upstream fleets. See UpgradeStatus.Code for code definitions. The fleet name should be either fleet project number or id. This is defined as repeated for future proof reasons. Initial implementation will enforce at most one upstream fleet.
post_conditions	PostConditions Required. Post conditions to evaluate to mark an upgrade COMPLETE. Required.
gke_upgrade_overrides[]	GKEUpgradeOverride Allow users to override some properties of each GKE upgrade.

FleetState

ClusterUpgrade: The state for the fleet-level ClusterUpgrade feature.

Fields
downstream_fleets[]	string This fleets whose upstream_fleets contain the current fleet. The fleet name should be either fleet project number or id.
ignored	map<string, IgnoredMembership> A list of memberships ignored by the feature. For example, manually upgraded clusters can be ignored if they are newer than the default versions of its release channel. The membership resource is in the format: projects/{p}/locations/{l}/membership/{m}.
gke_state	GKEUpgradeFeatureState Feature state for GKE clusters.

GKEUpgrade

GKEUpgrade represents a GKE provided upgrade, e.g., control plane upgrade.

Fields
name	string Name of the upgrade, e.g., "k8s_control_plane". It should be a valid upgrade name. It must not exceet 99 characters.
version	string Version of the upgrade, e.g., "1.22.1-gke.100". It should be a valid version. It must not exceet 99 characters.

GKEUpgradeFeatureCondition

GKEUpgradeFeatureCondition describes the condition of the feature for GKE clusters at a certain point of time.

Fields
type	string Type of the condition, for example, "ready".
status	string Status of the condition, one of True, False, Unknown.
reason	string Reason why the feature is in this status.
update_time	Timestamp Last timestamp the condition was updated.

GKEUpgradeFeatureState

GKEUpgradeFeatureState contains feature states for GKE clusters in the scope.

Fields
upgrade_state[]	GKEUpgradeState Upgrade state. It will eventually replace state.
conditions[]	GKEUpgradeFeatureCondition Current conditions of the feature.

GKEUpgradeOverride

Properties of a GKE upgrade that can be overridden by the user. For example, a user can skip soaking by overriding the soaking to 0.

Fields
upgrade	GKEUpgrade Required. Which upgrade to override. Required.
post_conditions	PostConditions Required. Post conditions to override for the specified upgrade (name + version). Required.

GKEUpgradeState

GKEUpgradeState is a GKEUpgrade and its state at the scope and fleet level.

Fields
stats	map<string, int64> Number of GKE clusters in each status code.
upgrade	GKEUpgrade Which upgrade to track the state.
status	UpgradeStatus Status of the upgrade.

IgnoredMembership

IgnoredMembership represents a membership ignored by the feature. A membership can be ignored because it was manually upgraded to a newer version than RC default.

Fields
reason	string Reason why the membership is ignored.
ignored_time	Timestamp Time when the membership was first set to ignored.

MembershipGKEUpgradeState

ScopeGKEUpgradeState is a GKEUpgrade and its state per-membership.

Fields
upgrade	GKEUpgrade Which upgrade to track the state.
status	UpgradeStatus Status of the upgrade.

MembershipState

Per-membership state for this feature.

Fields
upgrades[]	MembershipGKEUpgradeState Actual upgrade state against desired.
ignored	IgnoredMembership Whether this membership is ignored by the feature. For example, manually upgraded clusters can be ignored if they are newer than the default versions of its release channel.

PostConditions

Post conditional checks after an upgrade has been applied on all eligible clusters.

Fields
soaking	Duration Required. Amount of time to "soak" after a rollout has been finished before marking it COMPLETE. Cannot exceed 30 days. Required.

UpgradeStatus

UpgradeStatus provides status information for each upgrade.

Fields
code	UpgradeStatus.Code Status code of the upgrade.
reason	string Reason for this status.
update_time	Timestamp Last timestamp the status was updated.

Code

Status code of an upgrade.

Enums
CODE_UNSPECIFIED	Required by https://linter.aip.dev/126/unspecified.
INELIGIBLE	The upgrade is ineligible. At the scope level, this means the upgrade is ineligible for all the clusters in the scope.
PENDING	The upgrade is pending. At the scope level, this means the upgrade is pending for all the clusters in the scope.
IN_PROGRESS	The upgrade is in progress. At the scope level, this means the upgrade is in progress for at least one cluster in the scope.
SOAKING	The upgrade has finished and is soaking until the soaking time is up. At the scope level, this means at least one cluster is in soaking while the rest are either soaking or complete.
FORCED_SOAKING	A cluster will be forced to enter soaking if an upgrade doesn't finish within a certain limit, despite it's actual status.
COMPLETE	The upgrade has passed all post conditions (soaking). At the scope level, this means all eligible clusters are in COMPLETE status.