ClusterUpgradeDescriptionObject Class

Represents a ServiceFabric cluster upgrade.

Inheritance

Model

ClusterUpgradeDescriptionObject

Constructor

ClusterUpgradeDescriptionObject(*, config_version: Optional[str] = None, code_version: Optional[str] = None, upgrade_kind='Rolling', rolling_upgrade_mode='UnmonitoredAuto', upgrade_replica_set_check_timeout_in_seconds: Optional[int] = None, force_restart: Optional[bool] = None, sort_order='Default', enable_delta_health_evaluation: Optional[bool] = None, monitoring_policy=None, cluster_health_policy=None, cluster_upgrade_health_policy=None, application_health_policy_map=None, **kwargs)

Parameters

config_version

str

Required

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

code_version

str

Required

The ServiceFabric code version of the cluster.

upgrade_kind

str or UpgradeKind

Required

The kind of upgrade out of the following possible values. Possible values include: 'Invalid', 'Rolling'. Default value: "Rolling" .

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_replica_set_check_timeout_in_seconds

<xref:long>

Required

The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer).

force_restart

bool

Required

If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).

sort_order

str or UpgradeSortOrder

Required

Defines the order in which an upgrade proceeds through the cluster. Possible values include: 'Invalid', 'Default', 'Numeric', 'Lexicographical', 'ReverseNumeric', 'ReverseLexicographical'. Default value: "Default" .

enable_delta_health_evaluation

bool

Required

When true, enables delta health evaluation rather than absolute health evaluation after completion of each upgrade domain.

monitoring_policy

MonitoringPolicyDescription

Required

Describes the parameters for monitoring an upgrade in Monitored mode.

cluster_health_policy

ClusterHealthPolicy

Required

Defines a health policy used to evaluate the health of the cluster or of a cluster node.

cluster_upgrade_health_policy

ClusterUpgradeHealthPolicyObject

Required

Defines a health policy used to evaluate the health of the cluster during a cluster upgrade.

application_health_policy_map

ApplicationHealthPolicyMapObject

Required

Represents the map of application health policies for a ServiceFabric cluster upgrade