Module cartridge.failover

get_coordinator ()

Get current stateful failover coordinator

Returns:

(table) coordinator

Or

(nil)

(table) Error description

schedule_clear ()

Cancel all pending reconfigure_all tasks.

schedule_add ()

Schedule new reconfigure_all task.

_get_appointments_disabled_mode ()

Generate appointments according to clusterwide configuration. Used in ‘disabled’ failover mode.

_get_appointments_eventual_mode ()

Generate appointments according to membership status. Used in ‘eventual’ failover mode.

_get_appointments_stateful_mode ()

Get appointments from external storage. Used in ‘stateful’ failover mode.

accept_appointments (replicaset_uuid)

Accept new appointments.

Get appointments wherever they come from and put them into cache. Cached active_leaders table is never modified, but overriden by it’s modified copy (if necessary).

Parameters:

• replicaset_uuid: ({[string]=string}) to leader_uuid map

Returns:

(boolean) Whether leadership map has changed

fencing_check ()

Perform the fencing healthcheck.

Fencing is actuated when the instance disconnects from both the state provider and a replica, i.e. the check returns false.

Returns:

(boolean) true / false

check_suppressing_lock ()

Lock failover if failover suppressing is on.

failover_loop ()

Repeatedly fetch new appointments and reconfigure roles.

cfg ()

Initialize the failover module.

get_active_leaders ()

Get map of replicaset leaders.

Returns:

{[replicaset_uuid] = instance_uuid,…}

is_leader ()

Check current instance leadership.

Returns:

(boolean) true / false

is_rw ()

Check current instance writability.

Returns:

(boolean) true / false

is_vclockkeeper ()

Check if current instance has persisted his vclock.

Returns:

(boolean) true / false

is_paused ()

Check if failover paused on current instance.

Returns:

(boolean) true / false

failover_suppressed ()

Check if failover suppressed on current instance.

Returns:

(boolean) true / false

is_synchro_mode_enabled ()

Check if failover synchro mode enabled.

Returns:

(boolean) true / false

consistency_needed ()

Check if current configuration implies consistent switchover.

Returns:

(boolean) true / false

mode ()

Get failover mode.

Returns:

(string)

force_inconsistency (replicaset_uuid)

Force inconsistent leader switching. Do it by resetting vclockkeepers in state provider.

Parameters:

• replicaset_uuid: ({[string]=string,…}) to leader_uuid mapping

Returns:

(boolean) true

Or

(nil)

(table) Error description

wait_consistency (replicaset_uuid)

Wait when promoted instances become vclockkeepers.

Parameters:

• replicaset_uuid: ({[string]=string,…}) to leader_uuid mapping

Returns:

(boolean) true

Or

(nil)

(table) Error description

set_options ()

Set internal failover options.

Available options are: WAITLSN_PAUSE, WAITLSN_TIMEOUT, LONGPOLL_TIMEOUT, NETBOX_CALL_TIMEOUT

Returns:

(boolean) true

Or

(nil)

(table) Error description