Back to Redis

Join

content/operate/rs/7.22/references/cli-utilities/rladmin/cluster/join.md

latest2.8 KB
Original Source

Adds a node to an existing cluster.

sh
rladmin cluster join
        nodes <node IP address>
        username <admin user email>
        password <admin password>
        [ ephemeral_path <path> ]
        [ persistent_path <path> ]
        [ ccs_persistent_path <path> ]
        [ rack_id <node rack ID> ]
        [ second_rack_id <node's second rack ID> ]
        [ override_rack_id ]
        [ replace_node <node UID> ]
        [ flash_enabled ]
        [ flash_path <path> ]
        [ addr <IP.address> ]
        [ external_addr <IP.address.1> [<IP.address.2> ... <IP.address.N>] ]
        [ override_repair ]
        [ accept_servers { enabled | disabled } ]
        [ cnm_http_port <port> ]

Parameters

ParameterType/ValueDescription
accept_servers'enabled'
'disabled'Allows allocation of resources on the new node when enabled (optional)
addrIP addressSets a node's internal IP address. If not provided, the node sets the address automatically. (optional)
ccs_persistent_pathfilepath (default: /var/opt/redislabs/persist)Path to the CCS snapshot location (the default is the same as persistent_path) (optional)
cnm_http_portintegerJoins a cluster that has a non-default cnm_http_port (optional)
ephemeral_pathfilepathPath to the ephemeral storage location (optional)
external_addrlist of IP addressesSets a node's external IP addresses (space-delimited list). If not provided, the node sets the address automatically. (optional)
flash_enabledEnables flash capabilities for a database (optional)
flash_pathfilepath (default: /var/opt/redislabs/flash)Path to the flash storage location in case the node does not support CAPI (required if flash_enabled)
nodesIP addressInternal IP address of an existing node in the cluster
override_rack_idChanges to a new rack, specified by rack_id (optional)
override_repairEnables joining a cluster with a dead node (optional)
passwordstringAdmin user's password
persistent_pathfilepath (default: /var/opt/redislabs/persist)Path to the persistent storage location (optional)
rack_idstringMoves the node to the specified rack (optional)
replace_nodeintegerReplaces the specified node with the new node (optional)
second_rack_idstringThe unique identifier of the node's second rack ID for two-dimensional rack awareness (optional)
usernameemail addressAdmin user's email address

Returns

Returns ok if the node joined the cluster successfully. Otherwise, it returns an error message.

Example

sh
$ rladmin cluster join nodes 192.0.2.2 \
        username [email protected] \
        password admin-password
Joining cluster... ok