From 09256c9b8f3213684cae0f47aa6824ec6f11ae3e Mon Sep 17 00:00:00 2001 From: Rachel Elledge Date: Fri, 6 Dec 2024 14:14:03 -0600 Subject: [PATCH 1/5] DOC-4192 RS: New procedure for change socket file location without rlutil --- .../import-export/replica-of/create.md | 16 +++---- .../change-location-socket-files.md | 42 +++++-------------- 2 files changed, 19 insertions(+), 39 deletions(-) diff --git a/content/operate/rs/databases/import-export/replica-of/create.md b/content/operate/rs/databases/import-export/replica-of/create.md index 65fe884dcf..647af1a746 100644 --- a/content/operate/rs/databases/import-export/replica-of/create.md +++ b/content/operate/rs/databases/import-export/replica-of/create.md @@ -15,8 +15,8 @@ To create a replica connection, you define a database as a replica of a source d Sources databases can be: -- Located in the same Redis Enterprise Software cluster -- Located in a different Redis Enterprise cluster +- Located in the same Redis Software cluster +- Located in a different Redis Software cluster - Hosted by a different deployment, e.g. Redis Cloud - Redis Community Edition databases @@ -33,9 +33,9 @@ When you change the replica status of a database by adding, removing, or changin You can configure a database as a Replica Of, where the source database is in one of the following clusters: -- [Same Redis Enterprise cluster](#same-cluster) +- [Same Redis Software cluster](#same-cluster) -- [Different Redis Enterprise cluster](#different-cluster) +- [Different Redis Software cluster](#different-cluster) - [Redis Community Edition cluster](#source-available-cluster) @@ -47,9 +47,9 @@ For best results when using the [Multicast DNS](https://en.wikipedia.org/wiki/Mu As long as Replica Of is enabled, data in the target database will not expire and will not be evicted regardless of the set [data eviction policy]({{< relref "/operate/rs/databases/memory-performance/eviction-policy.md" >}}). {{< /note >}} -### Same Redis Enterprise cluster {#same-cluster} +### Same Redis Software cluster {#same-cluster} -To configure a Replica Of database in the same Redis Enterprise cluster as the source database: +To configure a Replica Of database in the same Redis Software cluster as the source database: 1. [Create a new database]({{< relref "/operate/rs/databases/create" >}}) or select an existing database from the **Databases** screen. @@ -67,9 +67,9 @@ To configure a Replica Of database in the same Redis Enterprise cluster as the s 1. Select **Save**. -### Different Redis Enterprise cluster {#different-cluster} +### Different Redis Software cluster {#different-cluster} -To configure a Replica Of database in a different Redis Enterprise cluster from the source database: +To configure a Replica Of database in a different Redis Software cluster from the source database: 1. Sign in to the Cluster Manager UI of the cluster hosting the source database. diff --git a/content/operate/rs/installing-upgrading/configuring/change-location-socket-files.md b/content/operate/rs/installing-upgrading/configuring/change-location-socket-files.md index a765fed9c9..7cdb6f6b73 100644 --- a/content/operate/rs/installing-upgrading/configuring/change-location-socket-files.md +++ b/content/operate/rs/installing-upgrading/configuring/change-location-socket-files.md @@ -21,44 +21,24 @@ There are two default locations for the socket files in Redis Enterprise Softwar The default location was changed in case you run any maintenance procedures that delete the `/tmp` directory. {{}} -When you upgrade Redis Enterprise Software from an earlier version to 5.2.2 or later, the socket files -are not moved to the new location by default. You need to either specify a custom location -for the socket files during [installation]({{< relref "/operate/rs/installing-upgrading" >}}) or use the [following procedure](#change-socket-file-locations) after installation. +When you upgrade Redis Enterprise Software from an earlier version to 5.2.2 or later, the socket files are not moved to the new location by default. You need to specify the socket file location [during installation](#during-install) or change the location [after cluster setup](#after-cluster-setup). -## Change socket file locations +## Specify socket file location during install {#during-install} -To change the location of the socket files: +To specify the socket file location during a new installation, follow the [Install Redis Enterprise Software on Linux]({{}}) instructions, but use the `-s` [installation script option]({{}}): -1. On each node in the cluster, run: +```sh +sudo ./install.sh -s +``` - ```sh - sudo rlutil create_socket_path socket_path=/var/opt/redislabs/run - ``` - -1. Identify the node with the `master` role by running the following command on any node in the cluster: - - ```sh - rladmin status nodes - ``` +## Change socket file location after cluster setup {#after-cluster-setup} -1. On the master node, change the socket file location: +To change the socket file location for an existing cluster: - ```sh - sudo rlutil set_socket_path socket_path=/var/opt/redislabs/run - ``` - -1. To update the socket file location for all other nodes, restart Redis Enterprise Software on each node in the cluster, one at a time: +1. Create a new cluster with the new socket file path. To do so, follow the [Install Redis Enterprise Software on Linux]({{}}) instructions, but use the `-s` [installation script option]({{}}): - ```sh - sudo service rlec_supervisor restart ``` - -1. Restart each database in the cluster to update the socket file location: - - ```sh - rladmin restart db + sudo ./install.sh -s ``` - {{< warning >}} -Restarting databases can cause interruptions in data traffic. - {{< /warning >}} +1. Use Replica Of to migrate your databases from the original cluster to the new cluster. For detailed steps, see the procedure to [configure Replica Of with different Redis Software clusters]({{}}). From 743e1a36466a23b7cf92012f3bbcd3d099f2e5c2 Mon Sep 17 00:00:00 2001 From: Rachel Elledge Date: Thu, 2 Jan 2025 15:07:41 -0600 Subject: [PATCH 2/5] DOC-4192 Edits to address feedback --- .../configuring/change-location-socket-files.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/content/operate/rs/installing-upgrading/configuring/change-location-socket-files.md b/content/operate/rs/installing-upgrading/configuring/change-location-socket-files.md index 7cdb6f6b73..f1b1b07c98 100644 --- a/content/operate/rs/installing-upgrading/configuring/change-location-socket-files.md +++ b/content/operate/rs/installing-upgrading/configuring/change-location-socket-files.md @@ -21,7 +21,7 @@ There are two default locations for the socket files in Redis Enterprise Softwar The default location was changed in case you run any maintenance procedures that delete the `/tmp` directory. {{}} -When you upgrade Redis Enterprise Software from an earlier version to 5.2.2 or later, the socket files are not moved to the new location by default. You need to specify the socket file location [during installation](#during-install) or change the location [after cluster setup](#after-cluster-setup). +When you upgrade Redis Enterprise Software from an earlier version to 5.2.2 or later, the socket files are not moved to the new location by default. You need to specify the socket file location [during installation](#during-install). ## Specify socket file location during install {#during-install} @@ -31,7 +31,9 @@ To specify the socket file location during a new installation, follow the [Insta sudo ./install.sh -s ``` -## Change socket file location after cluster setup {#after-cluster-setup} +## Change socket file location for an existing cluster {#after-cluster-setup} + +Changing the socket file location is not supported for bootstrapped nodes. To change the socket file location for an existing cluster: From 477c0c9bcdc451cfd2584abe3515bc6dae8746e2 Mon Sep 17 00:00:00 2001 From: Rachel Elledge Date: Wed, 22 Jan 2025 15:49:01 -0600 Subject: [PATCH 3/5] Revert Redis Software back to Redis Enterprise Software --- .../databases/import-export/replica-of/create.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/content/operate/rs/databases/import-export/replica-of/create.md b/content/operate/rs/databases/import-export/replica-of/create.md index 647af1a746..4bd2b1b1b4 100644 --- a/content/operate/rs/databases/import-export/replica-of/create.md +++ b/content/operate/rs/databases/import-export/replica-of/create.md @@ -15,8 +15,8 @@ To create a replica connection, you define a database as a replica of a source d Sources databases can be: -- Located in the same Redis Software cluster -- Located in a different Redis Software cluster +- Located in the same Redis Enterprise Software cluster +- Located in a different Redis Enterprise Software cluster - Hosted by a different deployment, e.g. Redis Cloud - Redis Community Edition databases @@ -33,9 +33,9 @@ When you change the replica status of a database by adding, removing, or changin You can configure a database as a Replica Of, where the source database is in one of the following clusters: -- [Same Redis Software cluster](#same-cluster) +- [Same Redis Enterprise Software cluster](#same-cluster) -- [Different Redis Software cluster](#different-cluster) +- [Different Redis Enterprise Software cluster](#different-cluster) - [Redis Community Edition cluster](#source-available-cluster) @@ -47,9 +47,9 @@ For best results when using the [Multicast DNS](https://en.wikipedia.org/wiki/Mu As long as Replica Of is enabled, data in the target database will not expire and will not be evicted regardless of the set [data eviction policy]({{< relref "/operate/rs/databases/memory-performance/eviction-policy.md" >}}). {{< /note >}} -### Same Redis Software cluster {#same-cluster} +### Same Redis Enterprise Software cluster {#same-cluster} -To configure a Replica Of database in the same Redis Software cluster as the source database: +To configure a Replica Of database in the same Redis Enterprise Software cluster as the source database: 1. [Create a new database]({{< relref "/operate/rs/databases/create" >}}) or select an existing database from the **Databases** screen. @@ -67,9 +67,9 @@ To configure a Replica Of database in the same Redis Software cluster as the sou 1. Select **Save**. -### Different Redis Software cluster {#different-cluster} +### Different Redis Enterprise Software cluster {#different-cluster} -To configure a Replica Of database in a different Redis Software cluster from the source database: +To configure a Replica Of database in a different Redis Enterprise Software cluster from the source database: 1. Sign in to the Cluster Manager UI of the cluster hosting the source database. From b70c04a181ab37e5bdaa69e10e60d487aa671a3e Mon Sep 17 00:00:00 2001 From: Rachel Elledge Date: Wed, 22 Jan 2025 15:50:02 -0600 Subject: [PATCH 4/5] DOC-4192 Added replace node method to change socket file location --- .../change-location-socket-files.md | 30 ++++++++++++++++--- 1 file changed, 26 insertions(+), 4 deletions(-) diff --git a/content/operate/rs/installing-upgrading/configuring/change-location-socket-files.md b/content/operate/rs/installing-upgrading/configuring/change-location-socket-files.md index f1b1b07c98..b7df2b48b3 100644 --- a/content/operate/rs/installing-upgrading/configuring/change-location-socket-files.md +++ b/content/operate/rs/installing-upgrading/configuring/change-location-socket-files.md @@ -33,14 +33,36 @@ sudo ./install.sh -s ## Change socket file location for an existing cluster {#after-cluster-setup} -Changing the socket file location is not supported for bootstrapped nodes. +Directly changing the socket file location directly is not supported for bootstrapped nodes. If you need to change the socket file location for an existing cluster, use one of the following methods instead: -To change the socket file location for an existing cluster: +- [Replace nodes](#replace-nodes) -1. Create a new cluster with the new socket file path. To do so, follow the [Install Redis Enterprise Software on Linux]({{}}) instructions, but use the `-s` [installation script option]({{}}): +- [Migrate the cluster using Replica Of](#migrate-replica-of) + +### Replace nodes {#replace-nodes} + +To change the socket file location for all nodes in a cluster, follow these steps: + +1. Install Redis Enterprise Software on a new node with the new socket file location. Follow the [Install Redis Enterprise Software on Linux]({{}}) instructions, but use the -s [installation script option]({{}}): + + ```sh + sudo ./install.sh -s + ``` + +1. [Add the new node]({{}}) to the existing cluster. + +1. [Remove a node]({{}}) with the old socket file location. + +1. Repeat the previous steps until all nodes with the old socket file location have been replaced. + +### Migrate cluster using Replica Of {#migrate-replica-of} + +To migrate an existing cluster to a new cluster with a different socket file location: + +1. Create a new cluster with the new socket file location. To do so, follow the [Install Redis Enterprise Software on Linux]({{}}) instructions, but use the `-s` [installation script option]({{}}): ``` sudo ./install.sh -s ``` -1. Use Replica Of to migrate your databases from the original cluster to the new cluster. For detailed steps, see the procedure to [configure Replica Of with different Redis Software clusters]({{}}). +1. Use Replica Of to migrate your databases from the original cluster to the new cluster. For detailed steps, see the procedure to [configure Replica Of with different Redis Enterprise Software clusters]({{}}). From cd70c76a1106daaf9a38caa8aa44712b168acba7 Mon Sep 17 00:00:00 2001 From: Rachel Elledge Date: Wed, 22 Jan 2025 15:55:42 -0600 Subject: [PATCH 5/5] Revert changes to Redis Enterprise name in Create Replica Of doc --- .../databases/import-export/replica-of/create.md | 14 +++++++------- .../configuring/change-location-socket-files.md | 2 +- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/content/operate/rs/databases/import-export/replica-of/create.md b/content/operate/rs/databases/import-export/replica-of/create.md index 4bd2b1b1b4..65fe884dcf 100644 --- a/content/operate/rs/databases/import-export/replica-of/create.md +++ b/content/operate/rs/databases/import-export/replica-of/create.md @@ -16,7 +16,7 @@ To create a replica connection, you define a database as a replica of a source d Sources databases can be: - Located in the same Redis Enterprise Software cluster -- Located in a different Redis Enterprise Software cluster +- Located in a different Redis Enterprise cluster - Hosted by a different deployment, e.g. Redis Cloud - Redis Community Edition databases @@ -33,9 +33,9 @@ When you change the replica status of a database by adding, removing, or changin You can configure a database as a Replica Of, where the source database is in one of the following clusters: -- [Same Redis Enterprise Software cluster](#same-cluster) +- [Same Redis Enterprise cluster](#same-cluster) -- [Different Redis Enterprise Software cluster](#different-cluster) +- [Different Redis Enterprise cluster](#different-cluster) - [Redis Community Edition cluster](#source-available-cluster) @@ -47,9 +47,9 @@ For best results when using the [Multicast DNS](https://en.wikipedia.org/wiki/Mu As long as Replica Of is enabled, data in the target database will not expire and will not be evicted regardless of the set [data eviction policy]({{< relref "/operate/rs/databases/memory-performance/eviction-policy.md" >}}). {{< /note >}} -### Same Redis Enterprise Software cluster {#same-cluster} +### Same Redis Enterprise cluster {#same-cluster} -To configure a Replica Of database in the same Redis Enterprise Software cluster as the source database: +To configure a Replica Of database in the same Redis Enterprise cluster as the source database: 1. [Create a new database]({{< relref "/operate/rs/databases/create" >}}) or select an existing database from the **Databases** screen. @@ -67,9 +67,9 @@ To configure a Replica Of database in the same Redis Enterprise Software cluster 1. Select **Save**. -### Different Redis Enterprise Software cluster {#different-cluster} +### Different Redis Enterprise cluster {#different-cluster} -To configure a Replica Of database in a different Redis Enterprise Software cluster from the source database: +To configure a Replica Of database in a different Redis Enterprise cluster from the source database: 1. Sign in to the Cluster Manager UI of the cluster hosting the source database. diff --git a/content/operate/rs/installing-upgrading/configuring/change-location-socket-files.md b/content/operate/rs/installing-upgrading/configuring/change-location-socket-files.md index b7df2b48b3..286b052925 100644 --- a/content/operate/rs/installing-upgrading/configuring/change-location-socket-files.md +++ b/content/operate/rs/installing-upgrading/configuring/change-location-socket-files.md @@ -65,4 +65,4 @@ To migrate an existing cluster to a new cluster with a different socket file loc sudo ./install.sh -s ``` -1. Use Replica Of to migrate your databases from the original cluster to the new cluster. For detailed steps, see the procedure to [configure Replica Of with different Redis Enterprise Software clusters]({{}}). +1. Use Replica Of to migrate your databases from the original cluster to the new cluster. For detailed steps, see the procedure to [configure Replica Of with different Redis Enterprise clusters]({{}}).