ApplicationUpgradePolicy interface

Describes the policy for a monitored application upgrade.

Properties

applicationHealthPolicy

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

forceRestart

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

instanceCloseDelayDuration

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.

recreateApplication

Determines whether the application should be recreated on update. If value=true, the rest of the upgrade policy parameters are not allowed.

rollingUpgradeMonitoringPolicy

The policy used for monitoring the application upgrade

upgradeMode

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

upgradeReplicaSetCheckTimeout

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

Property Details

applicationHealthPolicy

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

applicationHealthPolicy?: ApplicationHealthPolicy

Property Value

forceRestart

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

forceRestart?: boolean

Property Value

boolean

instanceCloseDelayDuration

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.

instanceCloseDelayDuration?: number

Property Value

number

recreateApplication

Determines whether the application should be recreated on update. If value=true, the rest of the upgrade policy parameters are not allowed.

recreateApplication?: boolean

Property Value

boolean

rollingUpgradeMonitoringPolicy

The policy used for monitoring the application upgrade

rollingUpgradeMonitoringPolicy?: RollingUpgradeMonitoringPolicy

Property Value

upgradeMode

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

upgradeMode?: string

Property Value

string

upgradeReplicaSetCheckTimeout

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

upgradeReplicaSetCheckTimeout?: number

Property Value

number