مشاركة عبر

ReconfigurationInformation

  • مقالة

Information about current reconfiguration like phase, type, previous configuration role of replica and reconfiguration start date time.

Properties

Name Type Required
PreviousConfigurationRole string (enum) No
ReconfigurationPhase string (enum) No
ReconfigurationType string (enum) No
ReconfigurationStartTimeUtc string (date-time) No

PreviousConfigurationRole

Type: string (enum)
Required: No

Replica role before reconfiguration started.

The role of a replica of a stateful service.

Possible values are:

  • Unknown - Indicates the initial role that a replica is created in. The value is zero.
  • None - Specifies that the replica has no responsibility in regard to the replica set. The value is 1
  • Primary - Refers to the replica in the set on which all read and write operations are complete in order to enforce strong consistency semantics. Read operations are handled directly by the Primary replica, while write operations must be acknowledged by a quorum of the replicas in the replica set. There can only be one Primary replica in a replica set at a time. The value is 2.
  • IdleSecondary - Refers to a replica in the set that receives a state transfer from the Primary replica to prepare for becoming an active Secondary replica. There can be multiple Idle Secondary replicas in a replica set at a time. Idle Secondary replicas do not count as a part of a write quorum. The value is 3.
  • ActiveSecondary - Refers to a replica in the set that receives state updates from the Primary replica, applies them, and sends acknowledgements back. Secondary replicas must participate in the write quorum for a replica set. There can be multiple active Secondary replicas in a replica set at a time. The number of active Secondary replicas is configurable that the reliability subsystem should maintain. The value is 4.
  • IdleAuxiliary - Refers to a replica in the set that receives a state transfer from the Primary replica to prepare for becoming an ActiveAuxiliary replica. There can be multiple IdleAuxiliary replicas in a replica set at a time. IdleAuxiliary replicas do not count as a part of a write quorum. The value is 5.
  • ActiveAuxiliary - Refers to a replica in the set that receives state updates from the Primary replica, applies them, and sends acknowledgements back. ActiveAuxiliary replicas must participate in the write quorum for a replica set. There can be multiple active ActiveAuxiliary replicas in a replica set at a time. The number of active ActiveAuxiliary replicas is configurable that the reliability subsystem should maintain. The value is 6.
  • PrimaryAuxiliary - Refers to the replica in the set that is used to rebuild a new Secondary replica to relinquish primary status to. It cannot field read or write requests. The value is 7.

ReconfigurationPhase

Type: string (enum)
Required: No

Current phase of ongoing reconfiguration. If no reconfiguration is taking place then this value will be "None".

The reconfiguration phase of a replica of a stateful service.

Possible values are:

  • Unknown - Indicates the invalid reconfiguration phase.
  • None - Specifies that there is no reconfiguration in progress.
  • Phase0 - Refers to the phase where the reconfiguration is transferring data from the previous primary to the new primary.
  • Phase1 - Refers to the phase where the reconfiguration is querying the replica set for the progress.
  • Phase2 - Refers to the phase where the reconfiguration is ensuring that data from the current primary is present in a majority of the replica set.
  • Phase3 - This phase is for internal use only.
  • Phase4 - This phase is for internal use only.
  • AbortPhaseZero - This phase is for internal use only.

ReconfigurationType

Type: string (enum)
Required: No

Type of current ongoing reconfiguration. If no reconfiguration is taking place then this value will be "None".

The type of reconfiguration for replica of a stateful service.

Possible values are:

  • Unknown - Indicates the invalid reconfiguration type.
  • SwapPrimary - Specifies that the primary replica is being swapped with a different replica.
  • Failover - Reconfiguration triggered in response to a primary going down. This could be due to many reasons such as primary replica crashing etc.
  • Other - Reconfigurations where the primary replica is not changing.

ReconfigurationStartTimeUtc

Type: string (date-time)
Required: No

Start time (in UTC) of the ongoing reconfiguration. If no reconfiguration is taking place then this value will be zero date-time.