Replacing a dead node in a single-token architecture cluster

Steps for replacing nodes in single-token architecture clusters, not vnodes.

1. Run nodetool status to verify the node's status and state.
   In particular, for the node to be replaced:

   1. DataStax Enterprise (DSE) must not be running on the node; that is, the DSE Java process is stopped or the host itself is offline.
   2. The node should be seen in a normal (N) state from other nodes. Meaning, it should not be marked as joining (J) or leaving (L) the cluster. Note that the exact way of checking this status varies, and depends on your DSE version. Be sure to read the introductory text below and the multiple scenarios (ranges of DSE versions) that begin with Scenario 1.

   The output of the nodetool status command provides a two-letter output for each node. The output indicates the status and the state of nodes. For example, UN for a node that is Up (its status) and in a Normal state. Different releases of DSE provide different information in the state field when the status is D (Down).

   Let's first clarify what to expect when a node status is stopped. A node is in a stopped state if the command nodetool drain has been issued on the node itself, or if the disk policy was set to disk_failure_policy: stop, and the policy has been triggered due to disk issues. A stopped state means that the DSE process is still running and it still responds to JMX commands, but the gossip (port 7000) and client connections (port 9042) are stopped.

   The functionality depends on the DSE version. Because developers and administrators often compare functionality between DSE releases, we'll present scenarios that span specific releases of DSE 5.1.x, 6.0.x, 6.7.x, and 6.8.x.

   Scenario 1

   In the following releases:

   • DSE 6.7.0 up to 6.7.7
   • DSE 6.0.0 up to 6.0.11
   • DSE 5.1.0 up to 5.1.17

   If a node status is D (down) the state can be one of:

   • N - Normal
   • L - Leaving
   • J - Joining
   • M - Moving

   If a node enters in a stopped state, then the state+status of the node will be shown as:

   • UN on the node itself
   • DN from all the other nodes

   Scenario 2

   In the following releases:

   • DSE 6.8.0 up to 6.8.25
   • DSE 6.7.8 and higher 6.7.x
   • DSE 6.0.12 and higher 6.0.x
   • DSE 5.1.18 up to 5.1.32

   If a node status is D (down) the state can only be:

   S - Stopped

   In other words, if Gossip reports the node to be down, the state information doesn't provide details on the state of the node and always returns stopped. To find if a node with status Down is on a Normal state, or if it was in a transitioning state such as L (leaving the cluster), you can use the output of the command nodetool ring. Check the status reported for its IP on any token belonging to the node, as in the following example for node 1.2.3.12:

   Datacenter: DC1
   ==========
   Address   Rack        Status State   Load            Owns     Token
                                                                  8932492356975004956
   1.2.3.10  RACK3       Up     Normal  105.33 GiB      ?        -8332242847914492341
   1.2.3.11  RACK2       Up     Normal  102.20 GiB      ?        -8236178585342294604
   1.2.3.12  RACK1       Down   Leaving 110.43 GiB      ?        -8053138995941424636
   1.2.3.10  RACK3       Up     Normal  105.33 GiB      ?        -7195762468279176051
   ...

   Scenario 3

   In the following releases:

   • DSE 6.8.26 and higher 6.8.x
   • DSE 5.1.33 and higher 5.1.x

   If a node status is D (down) the state can be one of:

   • N - Normal
   • L - Leaving
   • J - Joining
   • M - Moving
   • S - Stopped

   If a node enters in a stopped state, then the state+status of the node will be shown as:

   • DS on the node itself
   • DN from all the other nodes
2. Record the datacenter, address, and rack settings of the dead node; you will use these later.
3. Record the existing initial_token setting from the dead node's cassandra.yaml.
4. Add the replacement node to the network and record its IP address.
5. If the dead node was a seed node, change the cluster's seed node configuration on each node:
   1. In the cassandra.yaml file for each node, remove the IP address of the dead node from the - seeds list in the seed-provider property.
   2. If the cluster needs a new seed node to replace the dead node, add the new node's IP address to the - seeds list of the other nodes.
      Attention: Making every node a seed node is not recommended because of increased maintenance and reduced gossip performance. Gossip optimization is not critical, but it is recommended to use a small seed list (approximately three nodes per datacenter).
6. On an existing node, gather setting information for the new node from the cassandra.yaml file:
   • cluster_name
   • endpoint_snitch
   • Other non-default settings: Use the diff tool to compare current settings with default settings.
7. Gather rack and datacenter information:
   • If the cluster uses the , record the rack and data assignments listed in the cassandra-topology.properties file, or copy the file to the new node.
   • If the cluster uses the GossipingPropertyFileSnitch, Configuring the Amazon EC2 single-region snitch, Configuring Amazon EC2 multi-region snitch, or Configuring the Google Cloud Platform snitch, record the rack and datacenter assignments in the dead node's cassandra-rackdc.properties file.
8. Make sure that the new node meets all prerequisites and then Install DataStax Enterprise on the new node, but do not start DataStax Enterprise.
   Note: Be sure to install the same version of DataStax Enterprise as is installed on the other nodes in the cluster, as described in the installation instructions.
9. If DataStax Enterprise automatically started on the node, stop and clear the data that was added automatically on startup.
10. Add values to the following properties in cassandra.yaml file from the information gathered earlier:
    • auto_bootstrap: If this setting exists and is set to false, set it to true. (This setting is not included in the default cassandra.yaml configuration file.)
    • cluster_name
    • initial token
    • seed list
      Warning: If the new node is a seed node, make sure it is not listed in its own - seeds list.
11. Add the rack and datacenter configuration:
    • If the cluster uses the GossipingPropertyFileSnitch, Configuring the Amazon EC2 single-region snitch, and Configuring Amazon EC2 multi-region snitch or Configuring the Google Cloud Platform snitch:
      1. Add the dead node's rack and datacenter assignments to the cassandra-rackdc.properties file on the replacement node.
         Note: Do not remove the entry for the dead node's IP address yet.
      2. Delete the cassandra-topology.properties file.
    • If the cluster uses the :
      1. Copy the cassandra-topology.properties file from an existing node, or add the settings to the local copy.
      2. Edit the file to add an entry with the new node's IP address and the dead node's rack and datacenter assignments.
12. Start the new node with with the required options:
    Package installations:

    1. Add the following option to jvm.options:

       -Dcassandra.replace_address_first_boot=address_of_dead_node

    2. If applications expect QUORUM or LOCAL_QUORUM consistency levels from the cluster, add the consistent_replace option to jvm.options using either QUORUM or LOCAL_QUORUM values to ensure data consistency on the replacement node, otherwise the node may stream from a potentially inconsistent replica, and reads may return stale data.

       For example:

       -Ddse.consistent_replace=LOCAL_QUORUM

       Tip: Other options that control repair during a consistent replace are:

       • consistent_replace.parallelism
       • consistent_replace.retries
       • consistent_replace.whitelist
    3. Start the node.
    4. After the node bootstraps, remove replace_address_first_boot and consistent_replace (if specified) from jvm.options.

    Tarball installations:

    1. Add the following parameter to the start up command line:

       sudo bin/dse cassandra -Dcassandra.replace_address_first_boot=address_of_dead_node

    2. If applications expect QUORUM or LOCAL_QUORUM consistency levels from the cluster, in addtion to replace_address_first_boot, add the consistent_replace parameter using either QUORUM or LOCAL_QUORUM values to ensure data consistency on the replacement node, otherwise the node may stream from a potentially inconsistent replica, and reads may return stale data.

       For example:

       sudo bin/dse cassandra -Dcassandra.replace_address_first_boot=address_of_dead_node -Ddse.consistent_replace=LOCAL_QUORUM

       Tip: Other options that control repair during a consistent replace are:

       • consistent_replace.parallelism
       • consistent_replace.retries
       • consistent_replace.whitelist
13. Run nodetool status to verify that the new node has bootstrapped successfully.
    Tarball path:

    installation_location/resources/cassandra/bin

14. In environments that use the PropertyFileSnitch, wait at least 72 hours and then remove the old node's IP address from the cassandra-topology.properties file.
    CAUTION: This ensures that old node's information is removed from gossip. If removed from the property file too soon, problems may result. Use nodetool gossipinfo to check the gossip status. The node is still in gossip until LEFT status disappears.

    Note: The cassandra-rackdc.properties file does not contain IP information; therefore this step is not required when using other snitches, such as GossipingPropertyFileSnitch.