ClusterUpgradePolicy interface
Describes the policy used when upgrading the cluster.
Properties
delta |
The cluster delta health policy used when upgrading the cluster. |
force |
If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). |
health |
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. |
health |
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. |
health |
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. |
health |
The cluster health policy used when upgrading the cluster. |
upgrade |
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. |
upgrade |
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. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. |
upgrade |
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. |
Property Details
deltaHealthPolicy
The cluster delta health policy used when upgrading the cluster.
deltaHealthPolicy?: ClusterUpgradeDeltaHealthPolicy
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
healthCheckRetryTimeout
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.
healthCheckRetryTimeout: string
Property Value
string
healthCheckStableDuration
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.
healthCheckStableDuration: string
Property Value
string
healthCheckWaitDuration
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.
healthCheckWaitDuration: string
Property Value
string
healthPolicy
The cluster health policy used when upgrading the cluster.
healthPolicy: ClusterHealthPolicy
Property Value
upgradeDomainTimeout
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.
upgradeDomainTimeout: 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. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.
upgradeReplicaSetCheckTimeout: string
Property Value
string
upgradeTimeout
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.
upgradeTimeout: string
Property Value
string