Module cartridge.lua-api.edit-topology

Administration functions (edit-topology implementation).

Editing topology

edit_topology (args) Edit cluster topology.
EditReplicasetParams Replicatets modifications.
JoinServerParams Parameters required for joining a new server.
EditServerParams Servers modifications.


Editing topology

edit_topology (args)
Edit cluster topology. This function can be used for:

  • bootstrapping cluster from scratch
  • joining a server to an existing replicaset
  • creating new replicaset with one or more servers
  • editing uri/labels of servers
  • disabling and expelling servers

(Added in v1.0.0-17)

Parameters:

EditReplicasetParams
Replicatets modifications.

Fields:

JoinServerParams
Parameters required for joining a new server.

Fields:

EditServerParams
Servers modifications.

Fields:

  • uri optional string
  • uuid string
  • labels optional table
  • disabled optional boolean
  • expelled optional boolean Expelling an instance is permanent and can't be undone. It's suitable for situations when the hardware is destroyed, snapshots are lost and there is no hope to bring it back to life.
generated by LDoc 1.4.6 Last updated 2020-04-24 16:23:15