StartClusterUpgradeDescription Class

Describes the parameters for starting a cluster upgrade.

Inheritance

Model

StartClusterUpgradeDescription

Constructor

StartClusterUpgradeDescription(*, code_version: Optional[str] = None, config_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', monitoring_policy=None, cluster_health_policy=None, enable_delta_health_evaluation: Optional[bool] = None, cluster_upgrade_health_policy=None, application_health_policy_map=None, instance_close_delay_duration_in_seconds: Optional[int] = None, **kwargs)

Parameters

code_version

str

Required

The cluster code version.

config_version

str

Required

The cluster configuration version.

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" .

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.

enable_delta_health_evaluation

bool

Required

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

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

ApplicationHealthPolicies

Required

Defines the application health policy map used to evaluate the health of an application or one of its children entities.

instance_close_delay_duration_in_seconds

<xref:long>

Required

Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance is closing during the application/cluster upgrade, only for those instances which have a non-zero delay duration configured in the service description. See InstanceCloseDelayDurationSeconds property in $ref: "#/definitions/StatelessServiceDescription.yaml" for details. Note, the default value of InstanceCloseDelayDurationInSeconds is 4294967295, which indicates that the behavior will entirely depend on the delay configured in the stateless service description.