ClusterUpgradeProgressObject Class

Information about a cluster upgrade.

Inheritance

Model

ClusterUpgradeProgressObject

Constructor

ClusterUpgradeProgressObject(*, code_version: Optional[str] = None, config_version: Optional[str] = None, upgrade_domains=None, upgrade_units=None, upgrade_state=None, next_upgrade_domain: Optional[str] = None, rolling_upgrade_mode='UnmonitoredAuto', upgrade_description=None, upgrade_duration_in_milliseconds: Optional[str] = None, upgrade_domain_duration_in_milliseconds: Optional[str] = None, unhealthy_evaluations=None, current_upgrade_domain_progress=None, current_upgrade_units_progress=None, start_timestamp_utc: Optional[str] = None, failure_timestamp_utc: Optional[str] = None, failure_reason=None, upgrade_domain_progress_at_failure=None, is_node_by_node: bool = False, **kwargs)

Parameters

code_version

str

Required

The ServiceFabric code version of the cluster.

config_version

str

Required

The cluster configuration version (specified in the cluster manifest).

upgrade_domains

list[UpgradeDomainInfo]

Required

List of upgrade domains and their statuses. Not applicable to node-by-node upgrades.

upgrade_units

list[UpgradeUnitInfo]

Required

List of upgrade units and their statuses.

upgrade_state

str or UpgradeState

Required

The state of the upgrade domain. Possible values include: 'Invalid', 'RollingBackInProgress', 'RollingBackCompleted', 'RollingForwardPending', 'RollingForwardInProgress', 'RollingForwardCompleted', 'Failed'

next_upgrade_domain

str

Required

The name of the next upgrade domain to be processed. Not applicable to node-by-node upgrades.

rolling_upgrade_mode

str or UpgradeMode

Required

The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, Monitored, and UnmonitoredDeferred. Possible values include: 'Invalid', 'UnmonitoredAuto', 'UnmonitoredManual', 'Monitored', 'UnmonitoredDeferred'. Default value: "UnmonitoredAuto" .

upgrade_description

ClusterUpgradeDescriptionObject

Required

Represents a ServiceFabric cluster upgrade

upgrade_duration_in_milliseconds

str

Required

The estimated elapsed time spent processing the current overall upgrade.

upgrade_domain_duration_in_milliseconds

str

Required

The estimated elapsed time spent processing the current upgrade domain. Not applicable to node-by-node upgrades.

unhealthy_evaluations

list[HealthEvaluationWrapper]

Required

List of health evaluations that resulted in the current aggregated health state.

current_upgrade_domain_progress

CurrentUpgradeDomainProgressInfo

Required

Information about the current in-progress upgrade domain. Not applicable to node-by-node upgrades.

current_upgrade_units_progress

CurrentUpgradeUnitsProgressInfo

Required

Information about the current in-progress upgrade units.

start_timestamp_utc

str

Required

The start time of the upgrade in UTC.

failure_timestamp_utc

str

Required

The failure time of the upgrade in UTC.

failure_reason

str or FailureReason

Required

The cause of an upgrade failure that resulted in FailureAction being executed. Possible values include: 'None', 'Interrupted', 'HealthCheck', 'UpgradeDomainTimeout', 'OverallUpgradeTimeout'

upgrade_domain_progress_at_failure

FailedUpgradeDomainProgressObject

Required

The detailed upgrade progress for nodes in the current upgrade domain at the point of failure. Not applicable to node-by-node upgrades.

is_node_by_node

bool

Required

Indicates whether this upgrade is node-by-node. Default value: False .