Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 22 additions & 22 deletions content/operate/rs/installing-upgrading/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,62 +14,62 @@ weight: 35

You can run self-managed Redis Software in an on-premises data center or on your preferred cloud platform.

If you prefer a fully managed Redis database-as-a-service, available on major public cloud services, consider setting up a [Redis Cloud]({{<relref "/operate/rc">}}) subscription. You can [try Redis Cloud](https://redis.io/try-free/) for free.
If you prefer a fully managed Redis database-as-a-service, available on major public cloud services, consider setting up a [Redis Cloud](/content/operate/rc/_index.md) subscription. You can [try Redis Cloud](https://redis.io/try-free/) for free.

## Quickstarts

If you want to try out Redis Software, see the following quickstarts:

- [Redis Software quickstart]({{< relref "/operate/rs/installing-upgrading/quickstarts/redis-enterprise-software-quickstart" >}})
- [Redis Software quickstart](/content/operate/rs/installing-upgrading/quickstarts/redis-enterprise-software-quickstart.md)

- [Docker quickstart for Redis Software]({{< relref "/operate/rs/installing-upgrading/quickstarts/docker-quickstart" >}})
- [Docker quickstart for Redis Software](/content/operate/rs/installing-upgrading/quickstarts/docker-quickstart.md)

## Install Redis Software

To install Redis Software on a [supported platform]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/supported-platforms" >}}), you need to:
To install Redis Software on a [supported platform](/content/operate/rs/installing-upgrading/install/plan-deployment/supported-platforms.md), you need to:

1. [Plan your deployment]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment" >}}).
1. [Plan your deployment](/content/operate/rs/installing-upgrading/install/plan-deployment/_index.md).

1. [Prepare to install]({{< relref "/operate/rs/installing-upgrading/install/prepare-install" >}}).
1. [Prepare to install](/content/operate/rs/installing-upgrading/install/prepare-install/_index.md).

1. [Perform the install]({{< relref "/operate/rs/installing-upgrading/install" >}}).
1. [Perform the install](/content/operate/rs/installing-upgrading/install/_index.md).

Depending on your needs, you may also want to [customize the installation](#more-info-and-options).

If you're moving from a self-managed Redis Open Source deployment, see [Move from Redis Open Source to Redis Software]({{< relref "/operate/rs/installing-upgrading/move-from-open-source" >}}) for how configuration and deployment differ.
If you're moving from a self-managed Redis Open Source deployment, see [Move from Redis Open Source to Redis Software](/content/operate/rs/installing-upgrading/move-from-open-source.md) for how configuration and deployment differ.

## Upgrade existing deployment

If you already installed Redis Software, you can:

- [Upgrade a cluster]({{< relref "/operate/rs/installing-upgrading/upgrading/upgrade-cluster" >}})
- [Upgrade a cluster](/content/operate/rs/installing-upgrading/upgrading/upgrade-cluster.md)

- [Upgrade a database]({{< relref "/operate/rs/installing-upgrading/upgrading/upgrade-database" >}})
- [Upgrade a database](/content/operate/rs/installing-upgrading/upgrading/upgrade-database.md)

- [Upgrade an Active-Active database]({{< relref "/operate/rs/installing-upgrading/upgrading/upgrade-active-active" >}})
- [Upgrade an Active-Active database](/content/operate/rs/installing-upgrading/upgrading/upgrade-active-active.md)

## Uninstall Redis Software

- [Uninstall existing deployment]({{< relref "/operate/rs/installing-upgrading/uninstalling" >}})
- [Uninstall existing deployment](/content/operate/rs/installing-upgrading/uninstalling.md)

## More info and options

More information is available to help with customization and related questions:

- [CentOS/RHEL firewall configuration]({{< relref "/operate/rs/installing-upgrading/configuring/centos-rhel-firewall.md" >}})
- [Change socket file location]({{< relref "/operate/rs/installing-upgrading/configuring/change-location-socket-files.md" >}})
- [Cluster DNS configuration]({{< relref "/operate/rs/networking/cluster-dns.md" >}})
- [Cluster load balancer setup]({{< relref "/operate/rs/networking/cluster-lba-setup.md" >}})
- [File locations]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/file-locations.md" >}})
- [Linux swap space configuration]({{< relref "/operate/rs/installing-upgrading/configuring/linux-swap.md" >}})
- [mDNS client prerequisites]({{< relref "/operate/rs/networking/mdns.md" >}})
- [User and group ownership]({{< relref "/operate/rs/installing-upgrading/install/customize-user-and-group.md" >}})
- [CentOS/RHEL firewall configuration](/content/operate/rs/installing-upgrading/configuring/centos-rhel-firewall.md)
- [Change socket file location](/content/operate/rs/installing-upgrading/configuring/change-location-socket-files.md)
- [Cluster DNS configuration](/content/operate/rs/networking/cluster-dns.md)
- [Cluster load balancer setup](/content/operate/rs/networking/cluster-lba-setup.md)
- [File locations](/content/operate/rs/installing-upgrading/install/plan-deployment/file-locations.md)
- [Linux swap space configuration](/content/operate/rs/installing-upgrading/configuring/linux-swap.md)
- [mDNS client prerequisites](/content/operate/rs/networking/mdns.md)
- [User and group ownership](/content/operate/rs/installing-upgrading/install/customize-user-and-group.md)

## Next steps

After you install Redis Software and set up your cluster, you can:

- [Add users]({{< relref "/operate/rs/security/access-control/create-users" >}}) to the cluster with specific permissions. To begin, start with [Access control]({{< relref "/operate/rs/security/access-control" >}}).
- [Add users](/content/operate/rs/security/access-control/create-users.md) to the cluster with specific permissions. To begin, start with [Access control](/content/operate/rs/security/access-control/_index.md).

- [Create databases]({{< relref "/operate/rs/databases/create" >}}) to use with your applications.
- [Create databases](/content/operate/rs/databases/create.md) to use with your applications.

Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,13 @@ When you install Redis Software on CentOS or RHEL, it automatically creates two
- A service named **redislabs-clients**, which includes the ports and protocols needed for external communication (outside of the cluster).

These services are defined but not allowed through the firewall by default.
During Redis Software installation, the [installer prompts]({{< relref "/operate/rs/installing-upgrading/install/manage-installation-questions" >}}) you to confirm auto-configuration of a default (public) zone
During Redis Software installation, the [installer prompts](/content/operate/rs/installing-upgrading/install/manage-installation-questions.md) you to confirm auto-configuration of a default (public) zone
to allow the **redislabs** service.

Although automatic firewall configuration simplifies installation, your deployment might not be secure if you did not use other methods to secure the host machine's network, such as external firewall rules or security groups.
You can use firewalld configuration tools such as **firewall-cmd** (command line) or **firewall-config** (UI)
to create more specific firewall policies that allow these two services through the firewall, as necessary.

{{<note>}}
If databases are created with non-standard [Redis Software ports]({{< relref "/operate/rs/networking/port-configurations" >}}),
you need to explicitly configure firewalld to make sure those ports are not blocked.
{{</note>}}
> [!NOTE]
> If databases are created with non-standard [Redis Software ports](/content/operate/rs/networking/port-configurations.md),
> you need to explicitly configure firewalld to make sure those ports are not blocked.
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,14 @@ There are two default locations for the socket files in Redis Software:
- `/tmp` - In clean installations of Redis Software version earlier than 5.2.2
- `/var/opt/redislabs/run` - In clean installations of Redis Software version 5.2.2 and later

{{<note>}}
The default location was changed in case you run any maintenance procedures that delete the `/tmp` directory.
{{</note>}}
> [!NOTE]
> The default location was changed in case you run any maintenance procedures that delete the `/tmp` directory.

When you upgrade Redis 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}

To specify the socket file location during a new installation, follow the [Install Redis Software on Linux]({{<relref "/operate/rs/installing-upgrading/install/install-on-linux">}}) instructions, but use the `-s` [installation script option]({{<relref "/operate/rs/installing-upgrading/install/install-script">}}):
To specify the socket file location during a new installation, follow the [Install Redis Software on Linux](/content/operate/rs/installing-upgrading/install/install-on-linux.md) instructions, but use the `-s` [installation script option](/content/operate/rs/installing-upgrading/install/install-script.md):

```sh
sudo ./install.sh -s </path/to/socket/files>
Expand All @@ -43,26 +42,26 @@ Directly changing the socket file location directly is not supported for bootstr

To change the socket file location for all nodes in a cluster, follow these steps:

1. Install Redis Software on a new node with the new socket file location. Follow the [Install Redis Software on Linux]({{<relref "/operate/rs/installing-upgrading/install/install-on-linux">}}) instructions, but use the -s [installation script option]({{<relref "/operate/rs/installing-upgrading/install/install-script">}}):
1. Install Redis Software on a new node with the new socket file location. Follow the [Install Redis Software on Linux](/content/operate/rs/installing-upgrading/install/install-on-linux.md) instructions, but use the -s [installation script option](/content/operate/rs/installing-upgrading/install/install-script.md):

```sh
sudo ./install.sh -s </path/to/socket/files>
```

1. [Add the new node]({{<relref "/operate/rs/clusters/add-node">}}) to the existing cluster.
1. [Add the new node](/content/operate/rs/clusters/add-node.md) to the existing cluster.

1. [Remove a node]({{<relref "/operate/rs/clusters/remove-node#remove-a-node">}}) with the old socket file location.
1. [Remove a node](/content/operate/rs/clusters/remove-node.md#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 Software on Linux]({{<relref "/operate/rs/installing-upgrading/install/install-on-linux">}}) instructions, but use the `-s` [installation script option]({{<relref "/operate/rs/installing-upgrading/install/install-script">}}):
1. Create a new cluster with the new socket file location. To do so, follow the [Install Redis Software on Linux](/content/operate/rs/installing-upgrading/install/install-on-linux.md) instructions, but use the `-s` [installation script option](/content/operate/rs/installing-upgrading/install/install-script.md):

```
sudo ./install.sh -s </path/to/socket/files>
```

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]({{<relref "/operate/rs/databases/import-export/replica-of/create#different-cluster">}}).
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](/content/operate/rs/databases/import-export/replica-of/create.md#different-cluster).
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ weight: $weight
---
Linux operating systems use swap space, which is enabled by default, to help manage memory (pages) by
copying pages from RAM to disk. Due to the way Redis Software
utilizes and manages memory, it is best to prevent OS swapping. For more details, see [memory limits]({{< relref "/operate/rs/databases/memory-performance/memory-limit.md" >}}). The
utilizes and manages memory, it is best to prevent OS swapping. For more details, see [memory limits](/content/operate/rs/databases/memory-performance/memory-limit.md). The
recommendation is to turn off Linux swap completely in the OS.

When you install or build the OS on the machine intended to host your Redis Software cluster, avoid configuring swap partitions if possible.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,8 @@ If you encounter any issues that you are not able to resolve yourself
and need to [contact Redis support](https://redis.io/support/) for assistance, you can [create a support package](#create-support-package) that gathers all essential information to help debug
your issues.

{{< note >}}
The process of creating the support package can take several minutes and generates load on the system.
{{< /note >}}
> [!NOTE]
> The process of creating the support package can take several minutes and generates load on the system.

## Create support package

Expand Down Expand Up @@ -62,7 +61,7 @@ To create a support package from the Cluster Manager UI:

-tab-sep-

If package creation fails with `internal error` or if you cannot access the UI, create a support package for the cluster from the command line on any node in the cluster using the [`rladmin cluster debug_info`]({{< relref "/operate/rs/references/cli-utilities/rladmin/cluster/debug_info" >}}) command:
If package creation fails with `internal error` or if you cannot access the UI, create a support package for the cluster from the command line on any node in the cluster using the [`rladmin cluster debug_info`](/content/operate/rs/references/cli-utilities/rladmin/cluster/debug_info.md) command:

```sh
/opt/redislabs/bin/rladmin cluster debug_info
Expand Down Expand Up @@ -94,7 +93,7 @@ Upload the tar file to [Redis support](https://redis.com/company/support/). The

-tab-sep-

You can use `debuginfo` [REST API]({{< relref "/operate/rs/references/rest-api" >}}) requests to create and download support packages.
You can use `debuginfo` [REST API](/content/operate/rs/references/rest-api/_index.md) requests to create and download support packages.

To download debug info from all nodes and databases:

Expand Down Expand Up @@ -146,10 +145,10 @@ The following table describes the included files:
| /database_<bdb_uid>/ | Directory that includes files for a specific database.<bdb_uid> is the database ID. |
| database_<bdb_uid>_ccs_info.txt | Database information from the cluster configuration store (CCS). Includes settings for databases, endpoints, shards, replicas, and CRDB. |
| database_<bdb_uid>.clientlist | List of clients connected to the database when the support package was created. |
| database_<bdb_uid>.info | Redis information and statistics for the database. See [`INFO`]({{<relref "/commands/info">}}) for details about the collected fields. |
| database_<bdb_uid>.rladmin | Database information. See [`rladmin info db`]({{<relref "/operate/rs/references/cli-utilities/rladmin/info#info-db">}}) for an example of collected fields. Also includes creation time, last changed time, Redis version, memory limit, persistence type, eviction policy, hashing policy, and whether SSL, backups, and email alerts are enabled. |
| database_<bdb_uid>.info | Redis information and statistics for the database. See [`INFO`](/content/commands/info.md) for details about the collected fields. |
| database_<bdb_uid>.rladmin | Database information. See [`rladmin info db`](/content/operate/rs/references/cli-utilities/rladmin/info.md#info-db) for an example of collected fields. Also includes creation time, last changed time, Redis version, memory limit, persistence type, eviction policy, hashing policy, and whether SSL, backups, and email alerts are enabled. |
| database_<bdb_uid>.slowlog | Contains slowlog output, which includes commands that took longer than 10 milliseconds. Only included if `slowlog_in_sanitized_support` is `true` in cluster settings. |
| /node_<node_uid>/redis_<shard_uid>.txt | For each shard of the specified database only. Includes shard configuration and [information]({{<relref "/commands/info">}}), slowlog information, and latency information. |
| /node_<node_uid>/redis_<shard_uid>.txt | For each shard of the specified database only. Includes shard configuration and [information](/content/commands/info.md), slowlog information, and latency information. |

### Node support package files

Expand All @@ -164,9 +163,9 @@ The following table describes the included files:
| /logs/ | Directory that includes logs. |
| node_<node_uid>.ccs | Includes cluster configuration, node configuration, and DMC proxy configuration. |
| node_<node_uid>_envoy_config.json | Envoy configuration. |
| node_<node_uid>.rladmin | Information about the cluster's nodes, databases, endpoints, and shards. See [`rladmin status`]({{<relref "/operate/rs/references/cli-utilities/rladmin/status">}}) for example output. |
| node_<node_uid>.rladmin | Information about the cluster's nodes, databases, endpoints, and shards. See [`rladmin status`](/content/operate/rs/references/cli-utilities/rladmin/status.md) for example output. |
| node_<node_uid>_sys_info.txt | Node's system information including:<br />• Socket files list<br />• Log files list<br />• Processes running on the node<br />• Disk usage<br />• Persistent files list<br />• Memory usage<br />• Network interfaces<br />• Installed packages<br />• Active iptables<br />• OS and platform<br />• Network connection<br />• Status of Redis processes |
| redis_<shard_uid>.txt | For each shard of the specified database only. Includes shard configuration and [information]({{<relref "/commands/info">}}), slowlog information, and latency information. |
| redis_<shard_uid>.txt | For each shard of the specified database only. Includes shard configuration and [information](/content/commands/info.md), slowlog information, and latency information. |

Each node's `/conf/` directory contains the following files:

Expand Down
Loading
Loading