ClusterUpgradePolicy

Describes the policy used when upgrading the cluster.

Properties

Name Type Required
forceRestart boolean No
upgradeReplicaSetCheckTimeout string Yes
healthCheckWaitDuration string Yes
healthCheckStableDuration string Yes
healthCheckRetryTimeout string Yes
upgradeTimeout string Yes
upgradeDomainTimeout string Yes
healthPolicy ClusterHealthPolicy Yes
deltaHealthPolicy ClusterUpgradeDeltaHealthPolicy No

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


upgradeReplicaSetCheckTimeout

Type: string
Required: Yes

The maximum amount of time to block processing of an upgrade domain and revent 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. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.


healthCheckWaitDuration

Type: string
Required: Yes

The length of time to wait after completing an upgrade domain before performing health checks. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format.


healthCheckStableDuration

Type: string
Required: Yes

The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format.


healthCheckRetryTimeout

Type: string
Required: Yes

The amount of time to retry health evaluation when the application or cluster is unhealthy before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.


upgradeTimeout

Type: string
Required: Yes

The amount of time the overall upgrade has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.


upgradeDomainTimeout

Type: string
Required: Yes

The amount of time each upgrade domain has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.


healthPolicy

Type: ClusterHealthPolicy
Required: Yes

The cluster health policy used when upgrading the cluster.


deltaHealthPolicy

Type: ClusterUpgradeDeltaHealthPolicy
Required: No

The cluster delta health policy used when upgrading the cluster.