ClusterUpgradeDescriptionObject

Represents a ServiceFabric cluster upgrade

Properties

ConfigVersion

Type: string
Required: No

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

CodeVersion

Type: string
Required: No

The ServiceFabric code version of the cluster.

UpgradeKind

Type: string (enum)
Required: No
Default: Rolling

The kind of upgrade out of the following possible values.

Possible values are:

• Invalid - Indicates the upgrade kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
• Rolling - The upgrade progresses one upgrade ___domain at a time. The value is 1

RollingUpgradeMode

Type: string (enum)
Required: No
Default: UnmonitoredAuto

The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, Monitored, and UnmonitoredDeferred.

Possible values are:

• Invalid - Indicates the upgrade mode is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
• UnmonitoredAuto - The upgrade will proceed automatically without performing any health monitoring. The value is 1
• UnmonitoredManual - The upgrade will stop after completing each upgrade ___domain, giving the opportunity to manually monitor health before proceeding. The value is 2
• Monitored - The upgrade will stop after completing each upgrade ___domain and automatically monitor health before proceeding. The value is 3
• UnmonitoredDeferred - Perform a node-by-node upgrade. No action is performed when upgrade starts; upgrade is applied on each node when it is deactivated with intent restart or higher. The value is 4

UpgradeReplicaSetCheckTimeoutInSeconds

Type: integer (int64)
Required: No

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

ForceRestart

Type: boolean
Required: No

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

SortOrder

Type: string (enum)
Required: No
Default: Default

Defines the order in which an upgrade proceeds through the cluster.

Possible values are:

• Invalid - Indicates that this sort order is not valid. All Service Fabric enumerations have the invalid type. The value is 0.
• Default - Indicates that the default sort order (as specified in cluster manifest) will be used. The value is 1.
• Numeric - Indicates that forward numeric sort order (UD names sorted as numbers) will be used. The value is 2.
• Lexicographical - Indicates that forward lexicographical sort order (UD names sorted as strings) will be used. The value is 3.
• ReverseNumeric - Indicates that reverse numeric sort order (UD names sorted as numbers) will be used. The value is 4.
• ReverseLexicographical - Indicates that reverse lexicographical sort order (UD names sorted as strings) will be used. The value is 5.

EnableDeltaHealthEvaluation

Type: boolean
Required: No

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

MonitoringPolicy

Type: MonitoringPolicyDescription
Required: No

Describes the parameters for monitoring an upgrade in Monitored mode.

ClusterHealthPolicy

Type: ClusterHealthPolicy
Required: No

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

ClusterUpgradeHealthPolicy

Type: ClusterUpgradeHealthPolicyObject
Required: No

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

ApplicationHealthPolicyMap

Type: ApplicationHealthPolicyMapObject
Required: No

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