Share via

StartClusterUpgradeDescription

  • Article

Describes the parameters for starting a cluster upgrade.

Properties

Name Type Required
CodeVersion string No
ConfigVersion string No
UpgradeKind string (enum) No
RollingUpgradeMode string (enum) No
UpgradeReplicaSetCheckTimeoutInSeconds integer (int64) No
ForceRestart boolean No
SortOrder string (enum) No
MonitoringPolicy MonitoringPolicyDescription No
ClusterHealthPolicy ClusterHealthPolicy No
EnableDeltaHealthEvaluation boolean No
ClusterUpgradeHealthPolicy ClusterUpgradeHealthPolicyObject No
ApplicationHealthPolicyMap ApplicationHealthPolicies No
InstanceCloseDelayDurationInSeconds integer (int64) No

CodeVersion

Type: string
Required: No

The cluster code version.

ConfigVersion

Type: string
Required: No

The cluster configuration version.

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.

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.

EnableDeltaHealthEvaluation

Type: boolean
Required: No

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

ClusterUpgradeHealthPolicy

Type: ClusterUpgradeHealthPolicyObject
Required: No

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

ApplicationHealthPolicyMap

Type: ApplicationHealthPolicies
Required: No

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

InstanceCloseDelayDurationInSeconds

Type: integer (int64)
Required: No

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.