ClusterUpgradePolicy interface

Describes the policy used when upgrading the cluster.

Properties

deltaHealthPolicy

The cluster delta health policy defines a health policy used to evaluate the health of the cluster during a cluster upgrade.

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

healthPolicy

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

monitoringPolicy

The cluster monitoring policy describes the parameters for monitoring an upgrade in Monitored mode.

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. This value must be between 00:00:00 and 49710.06:28:15 (unsigned 32 bit integer for seconds)

Property Details

deltaHealthPolicy

The cluster delta health policy defines a health policy used to evaluate the health of the cluster during a cluster upgrade.

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

healthPolicy

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

healthPolicy?: ClusterHealthPolicy

Property Value

monitoringPolicy

The cluster monitoring policy describes the parameters for monitoring an upgrade in Monitored mode.

monitoringPolicy?: ClusterMonitoringPolicy

Property Value

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. This value must be between 00:00:00 and 49710.06:28:15 (unsigned 32 bit integer for seconds)

upgradeReplicaSetCheckTimeout?: string

Property Value

string