RollingUpgradeUpdateDescription | @azure/servicefabric

Describes the parameters for updating a rolling upgrade of application or cluster.

Hierarchy

RollingUpgradeUpdateDescription

Index

Properties

Optional failureAction

The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically. Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode. Possible values include: 'Invalid', 'Rollback', 'Manual'

Optional forceRestart

forceRestart: undefined | false | true

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

Optional healthCheckRetryTimeoutInMilliseconds

healthCheckRetryTimeoutInMilliseconds: undefined | string

The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.

Optional healthCheckStableDurationInMilliseconds

healthCheckStableDurationInMilliseconds: undefined | string

The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.

Optional healthCheckWaitDurationInMilliseconds

healthCheckWaitDurationInMilliseconds: undefined | string

The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.

Optional replicaSetCheckTimeoutInMilliseconds

replicaSetCheckTimeoutInMilliseconds: undefined | number

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

rollingUpgradeMode

rollingUpgradeMode: UpgradeMode

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

Optional upgradeDomainTimeoutInMilliseconds

upgradeDomainTimeoutInMilliseconds: undefined | string

The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.

Optional upgradeTimeoutInMilliseconds

upgradeTimeoutInMilliseconds: undefined | string

The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.