From feebedd89726262ad7723cbccdfbbac1d63c3a62 Mon Sep 17 00:00:00 2001 From: Andy Stark Date: Wed, 23 Sep 2026 13:11:08 +0100 Subject: [PATCH] DOC-7104: Migrate content/operate/rs/installing-upgrading/ to render hooks Converts the relref and note/tip/warning/alert callout shortcodes under content/operate/rs/installing-upgrading/ (unit 4 of 15) to the DOC-6909 render-hook equivalents: plain Markdown links resolved by layouts/_default/_markup/render-link.html, and `> [!NOTE]` etc. blockquotes resolved by layouts/_default/_markup/render-blockquote.html. Purely mechanical -- no prose, terminology, or fact changes. 281 relref shortcodes and 24 callout shortcodes converted across 31 of the section's 33 files (configuring/_index.md and install/plan-deployment/supported-platforms.md had none to convert). Ran build/migrate_shortcode_links.py all over the full file list in one invocation, then verified with a before/after `hugo --minify` build and the DOC-7104-diff-hrefs-fix patched build/diff_rendered_hrefs.py, scoped to operate/rs/installing-upgrading: 0 href diffs, and no new build warnings/errors (the log diff was pure WARN-ordering/tempfile-name nondeterminism, plus the same pre-existing unrelated commands/cf.reserve fatal error in both builds). Found and hand-fixed 8 indented/list-nested callouts (a known gotcha from the earlier units of this ticket): the mechanical converter preserves indentation only on the callout's opening `> [!TYPE]` line, dropping it on every continuation line and leaving a stray trailing `>` line of pure whitespace. Verified by comparing rendered `
  • ` nesting before/after (not just the href set) for each of the 6 affected files (configuring/change-location-socket-files.md, install/_index.md, install/install-on-linux.md [2 instances], quickstarts/redis-enterprise-software-quickstart.md, upgrading/upgrade-active-active.md, upgrading/upgrade-cluster.md [2 instances]): nesting is identical, and in 3 of the 6 files the fixed markup renders byte-identical HTML to the pre-conversion shortcode. Also confirmed a distinct pre-existing pattern is harmless here: several relref paths end in `.md` (e.g. file-locations.md, manage-installation-questions.md), which the linkify stage can't canonicalize to /content/... form, but render-link.html strips a trailing `.md` before its own GetPage lookup, so these resolve identically pre- and post-conversion (confirmed via the 0-diff href comparison). No missing-paren relrefs, no no-slash-concatenation relrefs, and no literal HTML callout wrappers were found in this unit. build/diff_rendered_hrefs.py's own unquoted-href-attribute fix (DOC-7104-diff-hrefs-fix, PR #4087) was pulled into the worktree to run verification but is not part of this change and is excluded from this commit. Co-Authored-By: Claude Sonnet 5 --- .../operate/rs/installing-upgrading/_index.md | 44 ++++++------ .../configuring/centos-rhel-firewall.md | 9 ++- .../change-location-socket-files.md | 17 +++-- .../configuring/linux-swap.md | 2 +- .../creating-support-package.md | 19 +++--- .../rs/installing-upgrading/install/_index.md | 37 +++++----- .../install/customize-install-directories.md | 6 +- .../install/customize-user-and-group.md | 2 +- .../install/install-on-linux.md | 58 ++++++++-------- .../install/install-script.md | 16 ++--- .../install/manage-installation-questions.md | 14 ++-- .../install/offline-installation.md | 4 +- .../install/plan-deployment/_index.md | 28 ++++---- .../configuring-aws-instances.md | 31 +++++---- .../install/plan-deployment/file-locations.md | 16 ++--- .../plan-deployment/hardware-requirements.md | 19 +++--- .../persistent-ephemeral-storage.md | 15 ++--- .../install/prepare-install/_index.md | 16 ++--- .../download-install-package.md | 7 +- .../prepare-install/port-availability.md | 2 +- .../move-from-open-source.md | 43 ++++++------ .../installing-upgrading/product-lifecycle.md | 9 ++- .../quickstarts/_index.md | 10 +-- .../quickstarts/docker-quickstart.md | 28 ++++---- .../redis-enterprise-software-quickstart.md | 14 ++-- .../rs/installing-upgrading/uninstalling.md | 2 +- .../installing-upgrading/upgrading/_index.md | 16 ++--- .../upgrading/upgrade-active-active.md | 31 +++++---- .../upgrading/upgrade-cluster.md | 67 +++++++++---------- .../upgrading/upgrade-database.md | 26 +++---- .../upgrading/upgrade-os.md | 30 ++++----- 31 files changed, 307 insertions(+), 331 deletions(-) diff --git a/content/operate/rs/installing-upgrading/_index.md b/content/operate/rs/installing-upgrading/_index.md index 069405b3c1..b45af5e23f 100644 --- a/content/operate/rs/installing-upgrading/_index.md +++ b/content/operate/rs/installing-upgrading/_index.md @@ -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]({{}}) 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. diff --git a/content/operate/rs/installing-upgrading/configuring/centos-rhel-firewall.md b/content/operate/rs/installing-upgrading/configuring/centos-rhel-firewall.md index 9b749c56db..0d95e1efb1 100644 --- a/content/operate/rs/installing-upgrading/configuring/centos-rhel-firewall.md +++ b/content/operate/rs/installing-upgrading/configuring/centos-rhel-firewall.md @@ -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. -{{}} -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] +> 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. 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 818ae6c3aa..198488847c 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 @@ -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 - {{}} -The default location was changed in case you run any maintenance procedures that delete the `/tmp` directory. - {{}} + > [!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]({{}}) instructions, but use the `-s` [installation script option]({{}}): +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 @@ -43,15 +42,15 @@ 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]({{}}) instructions, but use the -s [installation script option]({{}}): +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 ``` -1. [Add the new 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]({{}}) 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. @@ -59,10 +58,10 @@ To change the socket file location for all nodes in a cluster, follow these step 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]({{}}) instructions, but use the `-s` [installation script option]({{}}): +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 ``` -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 Software clusters](/content/operate/rs/databases/import-export/replica-of/create.md#different-cluster). diff --git a/content/operate/rs/installing-upgrading/configuring/linux-swap.md b/content/operate/rs/installing-upgrading/configuring/linux-swap.md index 5f238b9c5e..03e29fcbd0 100644 --- a/content/operate/rs/installing-upgrading/configuring/linux-swap.md +++ b/content/operate/rs/installing-upgrading/configuring/linux-swap.md @@ -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. diff --git a/content/operate/rs/installing-upgrading/creating-support-package.md b/content/operate/rs/installing-upgrading/creating-support-package.md index 9d6f63ed34..084e0754c9 100644 --- a/content/operate/rs/installing-upgrading/creating-support-package.md +++ b/content/operate/rs/installing-upgrading/creating-support-package.md @@ -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 @@ -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 @@ -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: @@ -146,10 +145,10 @@ The following table describes the included files: | /database_/ | Directory that includes files for a specific database. is the database ID. | | database__ccs_info.txt | Database information from the cluster configuration store (CCS). Includes settings for databases, endpoints, shards, replicas, and CRDB. | | database_.clientlist | List of clients connected to the database when the support package was created. | -| database_.info | Redis information and statistics for the database. See [`INFO`]({{}}) for details about the collected fields. | -| database_.rladmin | Database information. See [`rladmin 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_.info | Redis information and statistics for the database. See [`INFO`](/content/commands/info.md) for details about the collected fields. | +| database_.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_.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_/redis_.txt | For each shard of the specified database only. Includes shard configuration and [information]({{}}), slowlog information, and latency information. | +| /node_/redis_.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 @@ -164,9 +163,9 @@ The following table describes the included files: | /logs/ | Directory that includes logs. | | node_.ccs | Includes cluster configuration, node configuration, and DMC proxy configuration. | | node__envoy_config.json | Envoy configuration. | -| node_.rladmin | Information about the cluster's nodes, databases, endpoints, and shards. See [`rladmin status`]({{}}) for example output. | +| node_.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__sys_info.txt | Node's system information including:
    • Socket files list
    • Log files list
    • Processes running on the node
    • Disk usage
    • Persistent files list
    • Memory usage
    • Network interfaces
    • Installed packages
    • Active iptables
    • OS and platform
    • Network connection
    • Status of Redis processes | -| redis_.txt | For each shard of the specified database only. Includes shard configuration and [information]({{}}), slowlog information, and latency information. | +| redis_.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: diff --git a/content/operate/rs/installing-upgrading/install/_index.md b/content/operate/rs/installing-upgrading/install/_index.md index 28833496ea..7f3e79bf13 100644 --- a/content/operate/rs/installing-upgrading/install/_index.md +++ b/content/operate/rs/installing-upgrading/install/_index.md @@ -11,13 +11,13 @@ linkTitle: Install weight: 35 --- -After you [plan your deployment]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment" >}}), [download a Redis Software installation package]({{< relref "/operate/rs/installing-upgrading/install/prepare-install/download-install-package" >}}), and finish [installation preparation]({{< relref "/operate/rs/installing-upgrading/install/prepare-install" >}}): +After you [plan your deployment](/content/operate/rs/installing-upgrading/install/plan-deployment/_index.md), [download a Redis Software installation package](/content/operate/rs/installing-upgrading/install/prepare-install/download-install-package.md), and finish [installation preparation](/content/operate/rs/installing-upgrading/install/prepare-install/_index.md): -1. [Install the Redis Software package]({{< relref "/operate/rs/installing-upgrading/install/install-on-linux" >}}) on one of the nodes in the cluster. +1. [Install the Redis Software package](/content/operate/rs/installing-upgrading/install/install-on-linux.md) on one of the nodes in the cluster. 1. Repeat this process for each node in the cluster. -For installation on machines without an internet connection, see [Offline installation]({{< relref "/operate/rs/installing-upgrading/install/offline-installation" >}}). +For installation on machines without an internet connection, see [Offline installation](/content/operate/rs/installing-upgrading/install/offline-installation.md). ## Permissions and access @@ -27,9 +27,8 @@ For installation on machines without an internet connection, see [Offline instal - Redis Software is certified to run with permissions set to `750`, an industry standard. - {{}} -Do not reduce permissions to `700`. This configuration has not been tested and is not supported. - {{}} + > [!WARNING] + > Do not reduce permissions to `700`. This configuration has not been tested and is not supported. - Redis Software requires `umask` to be `0022` during installation to correctly set permissions for the installed directories and files. @@ -37,26 +36,26 @@ Do not reduce permissions to `700`. This configuration has not been tested and i If you've already installed Redis Software, you can also: -- [Upgrade an existing deployment]({{< relref "/operate/rs/installing-upgrading/upgrading" >}}). +- [Upgrade an existing deployment](/content/operate/rs/installing-upgrading/upgrading/_index.md). -- [Uninstall an existing deployment]({{< relref "/operate/rs/installing-upgrading/uninstalling.md" >}}). +- [Uninstall an existing deployment](/content/operate/rs/installing-upgrading/uninstalling.md). To learn more about customization and find answers to related questions, see: -- [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" >}}) -- [Supported platforms]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/supported-platforms.md" >}}) -- [Manage installation questions]({{< relref "/operate/rs/installing-upgrading/install/manage-installation-questions.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) +- [Supported platforms](/content/operate/rs/installing-upgrading/install/plan-deployment/supported-platforms.md) +- [Manage installation questions](/content/operate/rs/installing-upgrading/install/manage-installation-questions.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 your cluster is set up with nodes, 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" >}}). -- [Create databases]({{< relref "/operate/rs/databases/create" >}}) to use with your applications. +- [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](/content/operate/rs/databases/create.md) to use with your applications. diff --git a/content/operate/rs/installing-upgrading/install/customize-install-directories.md b/content/operate/rs/installing-upgrading/install/customize-install-directories.md index 45aeaec341..068e83b9c3 100644 --- a/content/operate/rs/installing-upgrading/install/customize-install-directories.md +++ b/content/operate/rs/installing-upgrading/install/customize-install-directories.md @@ -54,7 +54,7 @@ These files are not in the custom directories: - /etc/opt/redislabs/redislabs_custom_install_version - /etc/opt/redislabs/redislabs_env_config.sh -To specify directories during [installation]({{< relref "/operate/rs/installing-upgrading/install/install-on-linux" >}}), include installer flags as [command-line options]({{< relref "/operate/rs/installing-upgrading/install/install-script" >}}) when you run the `install.sh` script. For example: +To specify directories during [installation](/content/operate/rs/installing-upgrading/install/install-on-linux.md), include installer flags as [command-line options](/content/operate/rs/installing-upgrading/install/install-script.md) when you run the `install.sh` script. For example: ```sh sudo ./install.sh --install-dir --config-dir --var-dir @@ -78,7 +78,7 @@ To configure different mount points for data and log directories, use symbolic l ## Customize storage paths -When you install Redis Software to custom directories, you can specify custom storage paths for persistent and ephemeral storage during [cluster setup]({{< relref "/operate/rs/clusters/new-cluster-setup" >}}) or when [adding nodes]({{< relref "/operate/rs/clusters/add-node" >}}). +When you install Redis Software to custom directories, you can specify custom storage paths for persistent and ephemeral storage during [cluster setup](/content/operate/rs/clusters/new-cluster-setup.md) or when [adding nodes](/content/operate/rs/clusters/add-node.md). 1. Specify the custom file location with the `--var-dir` option when you install Redis Software: @@ -104,7 +104,7 @@ When you install Redis Software to custom directories, you can specify custom st ls -l /path/to/custom/storage ``` -For more information about storage requirements, see [Persistent and ephemeral node storage]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage" >}}). +For more information about storage requirements, see [Persistent and ephemeral node storage](/content/operate/rs/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage.md). ## Limitations diff --git a/content/operate/rs/installing-upgrading/install/customize-user-and-group.md b/content/operate/rs/installing-upgrading/install/customize-user-and-group.md index 77ce7d7a0e..96ac36b289 100644 --- a/content/operate/rs/installing-upgrading/install/customize-user-and-group.md +++ b/content/operate/rs/installing-upgrading/install/customize-user-and-group.md @@ -30,7 +30,7 @@ During installation, you can specify the user and group that own all Redis Softw ## Install with custom user or group -To customize the user or group during [installation]({{< relref "/operate/rs/installing-upgrading/install/install-on-linux" >}}), include the `--os-user` or `--os-group` [command-line options]({{< relref "/operate/rs/installing-upgrading/install/install-script" >}}) when you run the `install.sh` script. +To customize the user or group during [installation](/content/operate/rs/installing-upgrading/install/install-on-linux.md), include the `--os-user` or `--os-group` [command-line options](/content/operate/rs/installing-upgrading/install/install-script.md) when you run the `install.sh` script. ```sh sudo ./install.sh --os-user --os-group diff --git a/content/operate/rs/installing-upgrading/install/install-on-linux.md b/content/operate/rs/installing-upgrading/install/install-on-linux.md index f68eea85ed..b2aaa4548c 100644 --- a/content/operate/rs/installing-upgrading/install/install-on-linux.md +++ b/content/operate/rs/installing-upgrading/install/install-on-linux.md @@ -10,9 +10,9 @@ linkTitle: Install on Linux weight: 10 --- -After you [download a Redis Software installation package]({{< relref "/operate/rs/installing-upgrading/install/prepare-install/download-install-package" >}}), install it on one of the nodes in the cluster. +After you [download a Redis Software installation package](/content/operate/rs/installing-upgrading/install/prepare-install/download-install-package.md), install it on one of the nodes in the cluster. -For installation on machines without an internet connection, see [Offline installation]({{< relref "/operate/rs/installing-upgrading/install/offline-installation" >}}). +For installation on machines without an internet connection, see [Offline installation](/content/operate/rs/installing-upgrading/install/offline-installation.md). ## Install on Linux @@ -48,7 +48,7 @@ To install Redis Software, use the command line: rpm --checksig ``` -1. To start the installation process, run the installation script. See [installation script options]({{< relref "/operate/rs/installing-upgrading/install/install-script" >}}) for a complete list of command-line options. +1. To start the installation process, run the installation script. See [installation script options](/content/operate/rs/installing-upgrading/install/install-script.md) for a complete list of command-line options. **For default installation:** ```sh @@ -63,22 +63,20 @@ To install Redis Software, use the command line: sudo ./install.sh --install-dir --config-dir --var-dir ``` - For detailed information about custom installations, see [Customize installation directories]({{< relref "/operate/rs/installing-upgrading/install/customize-install-directories" >}}). + For detailed information about custom installations, see [Customize installation directories](/content/operate/rs/installing-upgrading/install/customize-install-directories.md). - {{< note >}} -- The Redis Software files are installed in the default [file locations]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/file-locations.md" >}}) unless you specify custom directories. -- By default, Redis Software runs on the OS as the `redislabs` user and `redislabs` group. If needed, you can [specify a different user and group]({{< relref "/operate/rs/installing-upgrading/install/customize-user-and-group.md" >}}) during the installation. -- You must either be the root user or use `sudo` to run the installation script. - {{< /note >}} + > [!NOTE] + > - The Redis Software files are installed in the default [file locations](/content/operate/rs/installing-upgrading/install/plan-deployment/file-locations.md) unless you specify custom directories. + > - By default, Redis Software runs on the OS as the `redislabs` user and `redislabs` group. If needed, you can [specify a different user and group](/content/operate/rs/installing-upgrading/install/customize-user-and-group.md) during the installation. + > - You must either be the root user or use `sudo` to run the installation script. -1. Answer the [installation questions]({{< relref "/operate/rs/installing-upgrading/install/manage-installation-questions.md" >}}) when shown to complete the installation process. +1. Answer the [installation questions](/content/operate/rs/installing-upgrading/install/manage-installation-questions.md) when shown to complete the installation process. - {{< note >}} -To skip the installation questions, use one of the following methods: - -- Run `./install.sh -y` to answer yes to all of the questions. -- Create an [answer file]({{< relref "/operate/rs/installing-upgrading/install/manage-installation-questions#configure-file-to-answer" >}}) to answer installation questions automatically. - {{< /note >}} + > [!NOTE] + > To skip the installation questions, use one of the following methods: + > + > - Run `./install.sh -y` to answer yes to all of the questions. + > - Create an [answer file](/content/operate/rs/installing-upgrading/install/manage-installation-questions.md#configure-file-to-answer) to answer installation questions automatically. 1. When installation completes successfully, the output displays the Cluster Manager UI's IP address: @@ -98,7 +96,7 @@ To skip the installation questions, use one of the following methods: ## Redis Flex and Auto Tiering installation -If you want to use Redis Flex or Auto Tiering for your databases, review the prerequisites, storage requirements, and [other considerations]({{< relref "/operate/rs/databases/flash/" >}}) and prepare and format the flash memory. +If you want to use Redis Flex or Auto Tiering for your databases, review the prerequisites, storage requirements, and [other considerations](/content/operate/rs/databases/flash/_index.md) and prepare and format the flash memory. After you install Redis Software, use the `prepare_flash` script to prepare and format flash memory: @@ -118,17 +116,17 @@ sudo lsblk To learn more about customization and find answers to related questions, see: -- [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" >}}) -- [mDNS client prerequisites]({{< relref "/operate/rs/networking/mdns.md" >}}) -- [File locations]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/file-locations.md" >}}) -- [Supported platforms]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/supported-platforms.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) +- [mDNS client prerequisites](/content/operate/rs/networking/mdns.md) +- [File locations](/content/operate/rs/installing-upgrading/install/plan-deployment/file-locations.md) +- [Supported platforms](/content/operate/rs/installing-upgrading/install/plan-deployment/supported-platforms.md) ## Limitations -Several Redis Software installation reference files are installed to the directory `/etc/opt/redislabs/` even if you use [custom installation directories]({{< relref "/operate/rs/installing-upgrading/install/customize-install-directories" >}}). +Several Redis Software installation reference files are installed to the directory `/etc/opt/redislabs/` even if you use [custom installation directories](/content/operate/rs/installing-upgrading/install/customize-install-directories.md). As a workaround to install Redis Software without using any root directories, do the following before installing Redis Software: @@ -138,11 +136,11 @@ As a workaround to install Redis Software without using any root directories, do ## Next steps -1. [Create]({{< relref "/operate/rs/clusters/new-cluster-setup.md" >}}) - or [join]({{< relref "/operate/rs/clusters/add-node.md" >}}) an existing Redis Software cluster. +1. [Create](/content/operate/rs/clusters/new-cluster-setup.md) + or [join](/content/operate/rs/clusters/add-node.md) an existing Redis Software cluster. -1. [Create a database]({{< relref "/operate/rs/databases/create" >}}). +1. [Create a database](/content/operate/rs/databases/create.md). - For geo-distributed Active-Active replication, create an [Active-Active]({{< relref "/operate/rs/databases/active-active/create.md" >}}) database. + For geo-distributed Active-Active replication, create an [Active-Active](/content/operate/rs/databases/active-active/create.md) database. -1. [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" >}}). +1. [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). diff --git a/content/operate/rs/installing-upgrading/install/install-script.md b/content/operate/rs/installing-upgrading/install/install-script.md index c8a6b256ba..189a5fbbf7 100644 --- a/content/operate/rs/installing-upgrading/install/install-script.md +++ b/content/operate/rs/installing-upgrading/install/install-script.md @@ -16,13 +16,13 @@ The following options are supported: | Option | Description | |--------|-------------| -| `-y` | Automatically answers `yes` to all install prompts, accepting all default values
    See [Manage install questions]({{< relref "/operate/rs/installing-upgrading/install/manage-installation-questions" >}})| -| `-c ` | Specify answer file used to respond to install prompts
    See [Manage install questions]({{< relref "/operate/rs/installing-upgrading/install/manage-installation-questions" >}})| +| `-y` | Automatically answers `yes` to all install prompts, accepting all default values
    See [Manage install questions](/content/operate/rs/installing-upgrading/install/manage-installation-questions.md)| +| `-c ` | Specify answer file used to respond to install prompts
    See [Manage install questions](/content/operate/rs/installing-upgrading/install/manage-installation-questions.md)| | `-s ` | Specify directory for redislabs unix sockets _(new installs only)_| -| `--install-dir ` | Specifies installation directory _(new installs only)_
    See [Customize install locations]({{< relref "/operate/rs/installing-upgrading/install/customize-install-directories" >}})| -| `--config-dir ` | Configuration file directory *(new installs only)*
    See [Customize install locations]({{< relref "/operate/rs/installing-upgrading/install/customize-install-directories" >}})| -|     `--var-dir ` | Var directory used for installation *(new installs only)*
    See [Customize install locations]({{< relref "/operate/rs/installing-upgrading/install/customize-install-directories" >}})| -| `--os-user `| Operating system user account associated with install; default: `redislabs`
    See [Customize user and group]({{< relref "/operate/rs/installing-upgrading/install/customize-user-and-group" >}}) *(new installs only)*| -|    `--os-group ` | Operating system group associated with install; default: `redislabs`
    See [Customize user and group]({{< relref "/operate/rs/installing-upgrading/install/customize-user-and-group" >}}) *(new installs only)* | +|     `--install-dir ` | Specifies installation directory _(new installs only)_
    See [Customize install locations](/content/operate/rs/installing-upgrading/install/customize-install-directories.md)| +| `--config-dir ` | Configuration file directory *(new installs only)*
    See [Customize install locations](/content/operate/rs/installing-upgrading/install/customize-install-directories.md)| +|     `--var-dir ` | Var directory used for installation *(new installs only)*
    See [Customize install locations](/content/operate/rs/installing-upgrading/install/customize-install-directories.md)| +| `--os-user `| Operating system user account associated with install; default: `redislabs`
    See [Customize user and group](/content/operate/rs/installing-upgrading/install/customize-user-and-group.md) *(new installs only)*| +|    `--os-group ` | Operating system group associated with install; default: `redislabs`
    See [Customize user and group](/content/operate/rs/installing-upgrading/install/customize-user-and-group.md) *(new installs only)* | | `--skip-dns-port-verification` | Skip DNS port verification during installation | -|     `--update-env-path` | Add paths related to Redis Software to root's PATH environment variable
    See [Manage install questions]({{< relref "/operate/rs/installing-upgrading/install/manage-installation-questions" >}}) | +| `--update-env-path` | Add paths related to Redis Software to root's PATH environment variable
    See [Manage install questions](/content/operate/rs/installing-upgrading/install/manage-installation-questions.md) | diff --git a/content/operate/rs/installing-upgrading/install/manage-installation-questions.md b/content/operate/rs/installing-upgrading/install/manage-installation-questions.md index 6d19192084..7545f6fab0 100644 --- a/content/operate/rs/installing-upgrading/install/manage-installation-questions.md +++ b/content/operate/rs/installing-upgrading/install/manage-installation-questions.md @@ -21,7 +21,7 @@ Several questions appear during installation: - **Linux swap file** - `Swap is enabled. Do you want to proceed? [Y/N]?` - We recommend that you [disable Linux swap]({{< relref "/operate/rs/installing-upgrading/configuring/linux-swap.md" >}}) in the operating system configuration + We recommend that you [disable Linux swap](/content/operate/rs/installing-upgrading/configuring/linux-swap.md) in the operating system configuration to give Redis Software control of the memory allocation. - **Automatic OS tuning** - `Do you want to automatically tune the system for best performance [Y/N]?` @@ -35,15 +35,15 @@ Several questions appear during installation: Redis Software requires that all cluster nodes have synchronized time. You can either let the installation process configure NTP - or you can [configure NTP manually]({{< relref "/operate/rs/clusters/configure/sync-clocks.md" >}}). + or you can [configure NTP manually](/content/operate/rs/clusters/configure/sync-clocks.md). - **Firewall ports** - `Would you like to open RedisLabs cluster ports on the default firewall zone [Y/N]?` - Redis Software requires that all nodes have [specific network ports]({{< relref "/operate/rs/networking/port-configurations.md" >}}) open. + Redis Software requires that all nodes have [specific network ports](/content/operate/rs/networking/port-configurations.md) open. To open the ports, you can: - Answer `Y` to let the installation process open these ports. - - Answer `N` and configure the firewall manually for [RHEL/CentOS firewall]({{< relref "/operate/rs/installing-upgrading/configuring/centos-rhel-firewall" >}}). + - Answer `N` and configure the firewall manually for [RHEL/CentOS firewall](/content/operate/rs/installing-upgrading/configuring/centos-rhel-firewall.md). - Answer `N` and configure the firewall on the node manually for your OS. - **Installation verification (rlcheck)** - `Would you like to run rlcheck to verify proper configuration? [Y/N]?` @@ -63,11 +63,11 @@ Several questions appear during installation: ## Answer install questions automatically -To perform a silent (or automated) install, answer the questions when you start the [install]({{< relref "/operate/rs/installing-upgrading/install/install-on-linux" >}}). +To perform a silent (or automated) install, answer the questions when you start the [install](/content/operate/rs/installing-upgrading/install/install-on-linux.md). ### Answer yes to all questions -To automatically answer `yes` to all questions (which accepts the default values), run the [installation script]({{< relref "/operate/rs/installing-upgrading/install/install-script" >}}) with the `-y` parameter: +To automatically answer `yes` to all questions (which accepts the default values), run the [installation script](/content/operate/rs/installing-upgrading/install/install-script.md) with the `-y` parameter: ```bash ./install.sh -y @@ -105,7 +105,7 @@ Use an answer file to manage your response: ignore_master_version=no ``` -1. Run the [installation script]({{< relref "/operate/rs/installing-upgrading/install/install-script" >}}) with the `-c` command-line option and add the path to the answer file. +1. Run the [installation script](/content/operate/rs/installing-upgrading/install/install-script.md) with the `-c` command-line option and add the path to the answer file. For example: diff --git a/content/operate/rs/installing-upgrading/install/offline-installation.md b/content/operate/rs/installing-upgrading/install/offline-installation.md index 63e12f0bc5..fa6fb64cac 100644 --- a/content/operate/rs/installing-upgrading/install/offline-installation.md +++ b/content/operate/rs/installing-upgrading/install/offline-installation.md @@ -12,7 +12,7 @@ weight: 60 --- By default, the installation process requires an internet connection to enable installing dependency packages and for [synchronizing the -operating system clock]({{< relref "/operate/rs/clusters/configure/sync-clocks.md" >}}) against an NTP server. +operating system clock](/content/operate/rs/clusters/configure/sync-clocks.md) against an NTP server. If you install Redis Software on a machine without an internet connection, you need to perform two tasks manually. @@ -23,4 +23,4 @@ When you install Redis Software on a machine that is not connected to the intern ## Set up NTP time synchronization -At the end of the installation, the process asks if you want to set up NTP time synchronization. If you choose `Yes` while you are not connected to the internet, the action fails and displays the appropriate error message, but the installation completes successfully. Despite the successful completion of the installation, you still have to configure all nodes for [NTP time synchronization]({{< relref "/operate/rs/clusters/configure/sync-clocks.md" >}}). +At the end of the installation, the process asks if you want to set up NTP time synchronization. If you choose `Yes` while you are not connected to the internet, the action fails and displays the appropriate error message, but the installation completes successfully. Despite the successful completion of the installation, you still have to configure all nodes for [NTP time synchronization](/content/operate/rs/clusters/configure/sync-clocks.md). diff --git a/content/operate/rs/installing-upgrading/install/plan-deployment/_index.md b/content/operate/rs/installing-upgrading/install/plan-deployment/_index.md index b56e1461e0..bf1b443113 100644 --- a/content/operate/rs/installing-upgrading/install/plan-deployment/_index.md +++ b/content/operate/rs/installing-upgrading/install/plan-deployment/_index.md @@ -13,33 +13,33 @@ weight: 4 Before installing Redis Software, you need to: -- Set up your hardware. See [Hardware requirements]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/hardware-requirements.md" >}}) and [Persistent and ephemeral node storage -]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage" >}}) for more information. +- Set up your hardware. See [Hardware requirements](/content/operate/rs/installing-upgrading/install/plan-deployment/hardware-requirements.md) and [Persistent and ephemeral node storage +](/content/operate/rs/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage.md) for more information. -- Choose your [deployment platform]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/supported-platforms.md" >}}). +- Choose your [deployment platform](/content/operate/rs/installing-upgrading/install/plan-deployment/supported-platforms.md). Redis Software supports a variety of platforms, including: - Multiple Linux distributions (Ubuntu, Red Hat Enterprise Linux (RHEL), IBM CentOS, Oracle Linux) - - [Amazon AWS AMI]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/configuring-aws-instances" >}}) - - [Docker container]({{< relref "/operate/rs/installing-upgrading/quickstarts/docker-quickstart" >}}) (for development and testing only) - - [Kubernetes]({{< relref "/operate/kubernetes" >}}) + - [Amazon AWS AMI](/content/operate/rs/installing-upgrading/install/plan-deployment/configuring-aws-instances.md) + - [Docker container](/content/operate/rs/installing-upgrading/quickstarts/docker-quickstart.md) (for development and testing only) + - [Kubernetes](/content/operate/kubernetes/_index.md) - For more details, see [Supported platforms]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/supported-platforms.md" >}}). + For more details, see [Supported platforms](/content/operate/rs/installing-upgrading/install/plan-deployment/supported-platforms.md). -- Open appropriate [network ports]({{< relref "/operate/rs/networking/port-configurations.md" >}}) in the firewall to allow connections to the nodes. +- Open appropriate [network ports](/content/operate/rs/networking/port-configurations.md) in the firewall to allow connections to the nodes. -- Configure [cluster DNS]({{< relref "/operate/rs/networking/cluster-dns.md" >}}) so that cluster nodes can reach each other by DNS names. -- By default, the installation process requires an internet connection to install dependencies and synchronize the operating system clock. To learn more, see [Offline installation]({{< relref "/operate/rs/installing-upgrading/install/offline-installation" >}}). +- Configure [cluster DNS](/content/operate/rs/networking/cluster-dns.md) so that cluster nodes can reach each other by DNS names. +- By default, the installation process requires an internet connection to install dependencies and synchronize the operating system clock. To learn more, see [Offline installation](/content/operate/rs/installing-upgrading/install/offline-installation.md). -- [Configure different mount points for data and log directories]({{}}). +- [Configure different mount points for data and log directories](/content/operate/rs/installing-upgrading/install/customize-install-directories.md#config-diff-data-log-dirs). ## Next steps After you finish planning your deployment, you can: -- [Download an installation package]({{< relref "/operate/rs/installing-upgrading/install/prepare-install/download-install-package" >}}). +- [Download an installation package](/content/operate/rs/installing-upgrading/install/prepare-install/download-install-package.md). -- [Prepare to install]({{< relref "/operate/rs/installing-upgrading/install/prepare-install" >}}) Redis Software. +- [Prepare to install](/content/operate/rs/installing-upgrading/install/prepare-install/_index.md) Redis Software. -- [View installation questions]({{< relref "/operate/rs/installing-upgrading/install/manage-installation-questions" >}}) and prepare answers before installation. +- [View installation questions](/content/operate/rs/installing-upgrading/install/manage-installation-questions.md) and prepare answers before installation. diff --git a/content/operate/rs/installing-upgrading/install/plan-deployment/configuring-aws-instances.md b/content/operate/rs/installing-upgrading/install/plan-deployment/configuring-aws-instances.md index 22d779b6e4..b4faaa42ea 100644 --- a/content/operate/rs/installing-upgrading/install/plan-deployment/configuring-aws-instances.md +++ b/content/operate/rs/installing-upgrading/install/plan-deployment/configuring-aws-instances.md @@ -26,24 +26,23 @@ not be. If you require a persistent storage location for your database, the storage must be located outside of the instance. When you set up an instance, make sure it has a properly sized EBS-backed volume connected. When you set up Redis Software on the instance, make sure that [the -persistence storage]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage" >}}) is configured to use this volume. +persistence storage](/content/operate/rs/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage.md) is configured to use this volume. -{{< note >}} -After [installing the Redis Software package]({{< relref "/operate/rs/installing-upgrading" >}}) on the instance -and **before** running through [the setup process]({{< relref "/operate/rs/clusters/new-cluster-setup.md" >}}), -you must give the group `redislabs` permission to the EBS volume by -running the following command from the OS command-line interface (CLI): -```sh -chown redislabs:redislabs /< ebs folder name> -``` -{{< /note >}} +> [!NOTE] +> After [installing the Redis Software package](/content/operate/rs/installing-upgrading/_index.md) on the instance +> and **before** running through [the setup process](/content/operate/rs/clusters/new-cluster-setup.md), +> you must give the group `redislabs` permission to the EBS volume by +> running the following command from the OS command-line interface (CLI): +> ```sh +> chown redislabs:redislabs /< ebs folder name> +> ``` Another feature that may be of importance to you is the use of Provisioned IOPS for EBS-backed volumes. Provisioned IOPS guarantee a certain level of disk performance. There are two features in Redis Software where this feature could be critical to use: -1. When using [Redis Flex or Auto Tiering]({{< relref "/operate/rs/databases/flash/" >}}) +1. When using [Redis Flex or Auto Tiering](/content/operate/rs/databases/flash/_index.md) 1. When using AOF on every write and there is a high write load. In this case, the provisioned IOPS should be on the nodes used as replicas in the cluster. @@ -52,7 +51,7 @@ this feature could be critical to use: Choose an instance type that has (at minimum) enough free memory and disk space to meet the Redis Software [hardware -requirements]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/hardware-requirements.md" >}}). +requirements](/content/operate/rs/installing-upgrading/install/plan-deployment/hardware-requirements.md). In addition, some instance types are optimized for EBS-backed volumes and some are not. If you are using persistent storage, you should use an @@ -68,14 +67,14 @@ When configuring the security group: access the Cluster Manager UI. - If you are using the DNS resolving option with Redis Software, define a DNS UDP rule for port 53 to allow access to the databases' endpoints by - using the [DNS resolving mechanism]({{< relref "/operate/rs/networking/cluster-dns" >}}). + using the [DNS resolving mechanism](/content/operate/rs/networking/cluster-dns.md). - To create a cluster that has multiple nodes all running as instances on AWS, you need to define a security group that has an All TCP rule for all ports, 0 - 65535, and add it to all instances that are part of the cluster. This ensures that all nodes are able to communicate with each other. - To limit the number of open ports, you can open only the [ports used by Redis Software]({{< relref "/operate/rs/networking/port-configurations.md" >}}). + To limit the number of open ports, you can open only the [ports used by Redis Software](/content/operate/rs/networking/port-configurations.md). After successfully launching the instances: -1. Install Redis Software from the [Linux package or AWS AMI]({{< relref "/operate/rs/installing-upgrading" >}}). -2. [Set up the cluster]({{< relref "/operate/rs/clusters/new-cluster-setup.md" >}}). +1. Install Redis Software from the [Linux package or AWS AMI](/content/operate/rs/installing-upgrading/_index.md). +2. [Set up the cluster](/content/operate/rs/clusters/new-cluster-setup.md). diff --git a/content/operate/rs/installing-upgrading/install/plan-deployment/file-locations.md b/content/operate/rs/installing-upgrading/install/plan-deployment/file-locations.md index e74b7023ee..c7f5eb1a6a 100644 --- a/content/operate/rs/installing-upgrading/install/plan-deployment/file-locations.md +++ b/content/operate/rs/installing-upgrading/install/plan-deployment/file-locations.md @@ -9,9 +9,8 @@ description: Redis Software file installation locations. linkTitle: File locations weight: 60 --- -{{}} -To ensure that Redis Software functions properly, be careful with the files in the application directories. If you modify or delete the application files, Redis Software might not work as expected. -{{}} +> [!WARNING] +> To ensure that Redis Software functions properly, be careful with the files in the application directories. If you modify or delete the application files, Redis Software might not work as expected. ## Application directories @@ -20,7 +19,7 @@ The directories that Redis Software installs into are: | **Path** | **Description** | |------------|-----------------| | /opt/redislabs | Main installation directory for all Redis Software binaries | -| /opt/redislabs/bin | Binaries for all the utilities for command-line access and management, such as [`rladmin`]({{< relref "/operate/rs/references/cli-utilities/rladmin" >}}) or [`redis-cli`]({{< relref "/operate/rs/references/cli-utilities/redis-cli" >}}) | +| /opt/redislabs/bin | Binaries for all the utilities for command-line access and management, such as [`rladmin`](/content/operate/rs/references/cli-utilities/rladmin/_index.md) or [`redis-cli`](/content/operate/rs/references/cli-utilities/redis-cli/_index.md) | | /opt/redislabs/config | System configuration files | | /opt/redislabs/lib | System library files | | /opt/redislabs/sbin | System binaries for tweaking provisioning | @@ -39,9 +38,8 @@ The default directories that Redis Software uses for data and metadata are: You can change these file locations for: -- [Ephemeral and persistence storage]({{< relref "/operate/rs/clusters/new-cluster-setup.md" >}}) during cluster setup -- [Socket files]({{< relref "/operate/rs/installing-upgrading/configuring/change-location-socket-files.md" >}}) after cluster setup +- [Ephemeral and persistence storage](/content/operate/rs/clusters/new-cluster-setup.md) during cluster setup +- [Socket files](/content/operate/rs/installing-upgrading/configuring/change-location-socket-files.md) after cluster setup -{{< note >}} -To specify custom paths for ephemeral and persistent storage during cluster setup, you must install Redis Software using [custom installation directories]({{< relref "/operate/rs/installing-upgrading/install/customize-install-directories" >}}). If you use the default installation, you cannot specify custom storage paths and will receive a "path not mounted" error. -{{< /note >}} +> [!NOTE] +> To specify custom paths for ephemeral and persistent storage during cluster setup, you must install Redis Software using [custom installation directories](/content/operate/rs/installing-upgrading/install/customize-install-directories.md). If you use the default installation, you cannot specify custom storage paths and will receive a "path not mounted" error. diff --git a/content/operate/rs/installing-upgrading/install/plan-deployment/hardware-requirements.md b/content/operate/rs/installing-upgrading/install/plan-deployment/hardware-requirements.md index 5ccfdcc4a6..3ea5e231cc 100644 --- a/content/operate/rs/installing-upgrading/install/plan-deployment/hardware-requirements.md +++ b/content/operate/rs/installing-upgrading/install/plan-deployment/hardware-requirements.md @@ -22,25 +22,24 @@ Factors to consider when sizing your database. - **Dataset size** – Your limit should be greater than your dataset size to leave room for overhead. - **Database throughput** – High throughput needs more shards, leading to a higher memory limit. -- [**Modules**]({{< relref "/operate/oss_and_stack/stack-with-enterprise" >}}) – Using modules with your database consumes more memory. -- [**Database clustering**]({{< relref "/operate/rs/databases/durability-ha/clustering" >}}) – Allows you to spread your data into shards across multiple nodes. -- [**Database replication**]({{< relref "/operate/rs/databases/durability-ha/replication" >}}) – Enabling replication doubles memory consumption. +- [**Modules**](/content/operate/oss_and_stack/stack-with-enterprise/_index.md) – Using modules with your database consumes more memory. +- [**Database clustering**](/content/operate/rs/databases/durability-ha/clustering.md) – Allows you to spread your data into shards across multiple nodes. +- [**Database replication**](/content/operate/rs/databases/durability-ha/replication.md) – Enabling replication doubles memory consumption. ### Active-Active database sizing {#active-active-sizing} Additional factors for sizing Active-Active databases: -- [**Active-Active replication**]({{< relref "/operate/rs/databases/active-active" >}}) – Requires double the memory of regular replication, which can be up to two times (2x) the original data size per instance. -- [**Database replication backlog**]({{< relref "/operate/rs/databases/durability-ha/replication#database-replication-backlog" >}}) – For synchronization between shards. By default, this is set to 1% of the database size. -- [**Active-Active replication backlog**]({{< relref "/operate/rs/databases/active-active/manage#replication-backlog" >}}) – For synchronization between clusters. By default, this is set to 1% of the database size. +- [**Active-Active replication**](/content/operate/rs/databases/active-active/_index.md) – Requires double the memory of regular replication, which can be up to two times (2x) the original data size per instance. +- [**Database replication backlog**](/content/operate/rs/databases/durability-ha/replication.md#database-replication-backlog) – For synchronization between shards. By default, this is set to 1% of the database size. +- [**Active-Active replication backlog**](/content/operate/rs/databases/active-active/manage.md#replication-backlog) – For synchronization between clusters. By default, this is set to 1% of the database size. -{{}} -Active-Active databases have a lower threshold for activating the eviction policy, because it requires propagation to all participating clusters. The eviction policy starts to evict keys when one of the Active-Active instances reaches 80% of its memory limit. -{{}} +> [!NOTE] +> Active-Active databases have a lower threshold for activating the eviction policy, because it requires propagation to all participating clusters. The eviction policy starts to evict keys when one of the Active-Active instances reaches 80% of its memory limit. ### Sizing databases with Auto Tiering enabled {#redis-on-flash-sizing} Additional factors for sizing databases with Auto Tiering enabled: -- [**Database persistence**]({{< relref "/operate/rs/databases/configure/database-persistence#redis-on-flash-data-persistence" >}}) – Auto Tiering uses dual database persistence where both the primary and replica shards persist to disk. This may add some processor and network overhead, especially in cloud configurations with network-attached storage. +- [**Database persistence**](/content/operate/rs/databases/configure/database-persistence.md#redis-on-flash-data-persistence) – Auto Tiering uses dual database persistence where both the primary and replica shards persist to disk. This may add some processor and network overhead, especially in cloud configurations with network-attached storage. diff --git a/content/operate/rs/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage.md b/content/operate/rs/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage.md index b9270c3448..09ede64c65 100644 --- a/content/operate/rs/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage.md +++ b/content/operate/rs/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage.md @@ -12,12 +12,11 @@ toc: 'true' weight: 50 --- For each node in the cluster, you can configure paths for both persistent -storage and ephemeral storage. To do so, the volume must have full permissions for user and group `redislabs` or users:group `redislabs:redislabs`. See the [Customize system user and group]({{< relref "/operate/rs/installing-upgrading/install/customize-user-and-group" >}}) page for instructions. +storage and ephemeral storage. To do so, the volume must have full permissions for user and group `redislabs` or users:group `redislabs:redislabs`. See the [Customize system user and group](/content/operate/rs/installing-upgrading/install/customize-user-and-group.md) page for instructions. -{{< note >}} -The persistent storage and ephemeral storage discussed in this document are not related -to Redis persistence or AWS ephemeral drives. -{{< /note >}} +> [!NOTE] +> The persistent storage and ephemeral storage discussed in this document are not related +> to Redis persistence or AWS ephemeral drives. ## Persistent storage @@ -25,7 +24,7 @@ Persistent storage is mandatory. The cluster uses persistent storage to store information that needs to persist if a shard or a node fails, such as server logs, configurations, and files. -To set the frequency of syncs, you can configure [persistence]({{< relref "/operate/rs/databases/configure/database-persistence" >}}) +To set the frequency of syncs, you can configure [persistence](/content/operate/rs/databases/configure/database-persistence.md) options for a database. The persistent volume must be a storage area network (SAN) @@ -47,10 +46,10 @@ Ephemeral storage must be a locally attached volume on each node. For disk size requirements, see: - [Hardware - requirements]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/hardware-requirements" >}}) + requirements](/content/operate/rs/installing-upgrading/install/plan-deployment/hardware-requirements.md) for general guidelines regarding the ideal disk size for each type of storage. - [Disk size requirements for extreme write - scenarios]({{< relref "/operate/rs/clusters/optimize/disk-sizing-heavy-write-scenarios" >}}) + scenarios](/content/operate/rs/clusters/optimize/disk-sizing-heavy-write-scenarios.md) for special considerations when dealing with a high rate of write commands. diff --git a/content/operate/rs/installing-upgrading/install/prepare-install/_index.md b/content/operate/rs/installing-upgrading/install/prepare-install/_index.md index 6d820e3024..efaabde601 100644 --- a/content/operate/rs/installing-upgrading/install/prepare-install/_index.md +++ b/content/operate/rs/installing-upgrading/install/prepare-install/_index.md @@ -13,24 +13,24 @@ weight: 6 Before you install Redis Software: -- [Download an installation package]({{< relref "/operate/rs/installing-upgrading/install/prepare-install/download-install-package" >}}). +- [Download an installation package](/content/operate/rs/installing-upgrading/install/prepare-install/download-install-package.md). -- [View installation questions]({{< relref "/operate/rs/installing-upgrading/install/manage-installation-questions" >}}) and optionally prepare answers before installation. +- [View installation questions](/content/operate/rs/installing-upgrading/install/manage-installation-questions.md) and optionally prepare answers before installation. -- Review the [security considerations]({{< relref "/operate/rs/security/" >}}) for your deployment. +- Review the [security considerations](/content/operate/rs/security/_index.md) for your deployment. - Check that you have root-level access to each node, either directly or with `sudo`. -- Check that all [required ports are available]({{< relref "/operate/rs/installing-upgrading/install/prepare-install/port-availability" >}}). +- Check that all [required ports are available](/content/operate/rs/installing-upgrading/install/prepare-install/port-availability.md). -- [Turn off Linux swap]({{< relref "/operate/rs/installing-upgrading/configuring/linux-swap.md" >}}) on all cluster nodes. +- [Turn off Linux swap](/content/operate/rs/installing-upgrading/configuring/linux-swap.md) on all cluster nodes. - If you require the `redislabs` UID (user ID) and GID (group ID) numbers to be the same on all the nodes, create the `redislabs` user and group with the required numbers on each node. -- If you want to use Auto Tiering for your databases, see [Auto Tiering installation]({{< relref "/operate/rs/installing-upgrading/install/install-on-linux#auto-tiering-installation" >}}). +- If you want to use Auto Tiering for your databases, see [Auto Tiering installation](/content/operate/rs/installing-upgrading/install/install-on-linux.md#auto-tiering-installation). ## Next steps -- View [installation script options]({{< relref "/operate/rs/installing-upgrading/install/install-script" >}}) before starting the installation. +- View [installation script options](/content/operate/rs/installing-upgrading/install/install-script.md) before starting the installation. -- [Install Redis Software]({{< relref "/operate/rs/installing-upgrading/install" >}}). +- [Install Redis Software](/content/operate/rs/installing-upgrading/install/_index.md). diff --git a/content/operate/rs/installing-upgrading/install/prepare-install/download-install-package.md b/content/operate/rs/installing-upgrading/install/prepare-install/download-install-package.md index 976e5d5a13..02fa0d0b8f 100644 --- a/content/operate/rs/installing-upgrading/install/prepare-install/download-install-package.md +++ b/content/operate/rs/installing-upgrading/install/prepare-install/download-install-package.md @@ -16,7 +16,6 @@ To download the installation package for any of the supported platforms: 1. Sign in with your Redis credentials or create a new account. 1. In the **Downloads** section for Redis Software, select the installation package for your platform then select **Go**. -{{< note >}} -Before you install the Linux package or AWS AMI on an AWS EC2 instance, -review the [configuration requirements for AWS EC2 instances]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/configuring-aws-instances" >}}). -{{< /note >}} +> [!NOTE] +> Before you install the Linux package or AWS AMI on an AWS EC2 instance, +> review the [configuration requirements for AWS EC2 instances](/content/operate/rs/installing-upgrading/install/plan-deployment/configuring-aws-instances.md). diff --git a/content/operate/rs/installing-upgrading/install/prepare-install/port-availability.md b/content/operate/rs/installing-upgrading/install/prepare-install/port-availability.md index 8acf35865f..7062338749 100644 --- a/content/operate/rs/installing-upgrading/install/prepare-install/port-availability.md +++ b/content/operate/rs/installing-upgrading/install/prepare-install/port-availability.md @@ -10,7 +10,7 @@ linkTitle: Ensure port availability weight: 40 --- -Before [installing Redis Software]({{< relref "/operate/rs/installing-upgrading/install" >}}), make sure all required ports are available. +Before [installing Redis Software](/content/operate/rs/installing-upgrading/install/_index.md), make sure all required ports are available. {{}} diff --git a/content/operate/rs/installing-upgrading/move-from-open-source.md b/content/operate/rs/installing-upgrading/move-from-open-source.md index 523adcd5a7..6216d53cf7 100644 --- a/content/operate/rs/installing-upgrading/move-from-open-source.md +++ b/content/operate/rs/installing-upgrading/move-from-open-source.md @@ -14,11 +14,11 @@ Redis Software builds on Redis Open Source, so your data, commands, and client l This guide explains those differences and walks through planning a move from a self-managed Redis Open Source deployment to Redis Software. -For the exhaustive list of supported commands, configuration settings, and RESP versions, see [Redis Open Source compatibility]({{< relref "/operate/rs/references/compatibility" >}}). +For the exhaustive list of supported commands, configuration settings, and RESP versions, see [Redis Open Source compatibility](/content/operate/rs/references/compatibility/_index.md). ## How Redis Software differs from Redis Open Source -In Redis Open Source, you run one Redis server process per instance and configure it directly, typically through a `redis.conf` file or [`CONFIG SET`]({{< relref "/commands/config-set" >}}) at runtime. +In Redis Open Source, you run one Redis server process per instance and configure it directly, typically through a `redis.conf` file or [`CONFIG SET`](/content/commands/config-set.md) at runtime. Redis Software introduces two layers on top of that model: @@ -33,13 +33,13 @@ Redis Software splits configuration across two levels: | Level | What it controls | How you set it | |:------|:-----------------|:---------------| -| Cluster | Node roles, networking, security, and cluster-wide policies | During [cluster setup]({{< relref "/operate/rs/clusters/new-cluster-setup" >}}), then through the Cluster Manager UI, [`rladmin`]({{< relref "/operate/rs/references/cli-utilities/rladmin" >}}), or the [REST API]({{< relref "/operate/rs/references/rest-api" >}}) | -| Database | Memory limit, persistence, replication, clustering, eviction, and supported Redis Open Source settings | When you [create a database]({{< relref "/operate/rs/databases/create" >}}), then through the Cluster Manager UI, `rladmin`, or the REST API | +| Cluster | Node roles, networking, security, and cluster-wide policies | During [cluster setup](/content/operate/rs/clusters/new-cluster-setup.md), then through the Cluster Manager UI, [`rladmin`](/content/operate/rs/references/cli-utilities/rladmin/_index.md), or the [REST API](/content/operate/rs/references/rest-api/_index.md) | +| Database | Memory limit, persistence, replication, clustering, eviction, and supported Redis Open Source settings | When you [create a database](/content/operate/rs/databases/create.md), then through the Cluster Manager UI, `rladmin`, or the REST API | Key differences from a `redis.conf` workflow: - **No per-database configuration file.** You manage database settings through the Cluster Manager UI, `rladmin`, or the REST API, not a file you edit on disk. -- **Only a subset of Redis Open Source settings applies.** Redis Software supports a subset of Redis Open Source configuration settings. Using [`CONFIG GET`]({{< relref "/commands/config-get" >}}) or [`CONFIG SET`]({{< relref "/commands/config-set" >}}) with an unsupported setting returns an error. See [Compatibility with Redis Open Source configuration settings]({{< relref "/operate/rs/references/compatibility/config-settings" >}}) for the full list. +- **Only a subset of Redis Open Source settings applies.** Redis Software supports a subset of Redis Open Source configuration settings. Using [`CONFIG GET`](/content/commands/config-get.md) or [`CONFIG SET`](/content/commands/config-set.md) with an unsupported setting returns an error. See [Compatibility with Redis Open Source configuration settings](/content/operate/rs/references/compatibility/config-settings.md) for the full list. - **Some settings move to database-level controls.** A few settings that you'd set with `CONFIG SET` in Redis Open Source are instead set per database with `rladmin tune db` or the REST API. ## Plan your migration @@ -47,37 +47,36 @@ Key differences from a `redis.conf` workflow: Use this checklist to plan a move from Redis Open Source to Redis Software: 1. **Inventory your current configuration.** List the `redis.conf` settings and runtime `CONFIG` values your deployment relies on. -2. **Check compatibility.** Confirm that the [commands]({{< relref "/operate/rs/references/compatibility/commands" >}}), [configuration settings]({{< relref "/operate/rs/references/compatibility/config-settings" >}}), and [RESP version]({{< relref "/operate/rs/references/compatibility/resp" >}}) your application uses are supported. -3. **Choose a database topology.** Decide whether each database is a standard database or an [Active-Active database]({{< relref "/operate/rs/databases/active-active" >}}) for geo-distributed writes. -4. **Size your deployment.** Review [hardware requirements]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/hardware-requirements" >}}) and [supported platforms]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/supported-platforms" >}}) for the cluster. +2. **Check compatibility.** Confirm that the [commands](/content/operate/rs/references/compatibility/commands/_index.md), [configuration settings](/content/operate/rs/references/compatibility/config-settings.md), and [RESP version](/content/operate/rs/references/compatibility/resp.md) your application uses are supported. +3. **Choose a database topology.** Decide whether each database is a standard database or an [Active-Active database](/content/operate/rs/databases/active-active/_index.md) for geo-distributed writes. +4. **Size your deployment.** Review [hardware requirements](/content/operate/rs/installing-upgrading/install/plan-deployment/hardware-requirements.md) and [supported platforms](/content/operate/rs/installing-upgrading/install/plan-deployment/supported-platforms.md) for the cluster. 5. **Plan your data migration.** Decide whether to sync from a running source with Replica Of or import from a file. See [Migrate your data](#migrate-your-data). ## Installation and configuration flow Moving to Redis Software follows this sequence. Reviewing it before you install helps you plan the whole flow, not just the software install. -1. [Plan your deployment]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment" >}}) to choose platforms, size hardware, and plan networking. -2. [Prepare to install]({{< relref "/operate/rs/installing-upgrading/install/prepare-install" >}}) by meeting OS and system requirements on each node. -3. [Install Redis Software]({{< relref "/operate/rs/installing-upgrading/install" >}}) on each node. -4. [Set up the cluster]({{< relref "/operate/rs/clusters/new-cluster-setup" >}}) by creating a new cluster on the first node and joining the remaining nodes. -5. [Create a database]({{< relref "/operate/rs/databases/create" >}}) and configure its settings. +1. [Plan your deployment](/content/operate/rs/installing-upgrading/install/plan-deployment/_index.md) to choose platforms, size hardware, and plan networking. +2. [Prepare to install](/content/operate/rs/installing-upgrading/install/prepare-install/_index.md) by meeting OS and system requirements on each node. +3. [Install Redis Software](/content/operate/rs/installing-upgrading/install/_index.md) on each node. +4. [Set up the cluster](/content/operate/rs/clusters/new-cluster-setup.md) by creating a new cluster on the first node and joining the remaining nodes. +5. [Create a database](/content/operate/rs/databases/create.md) and configure its settings. 6. Connect your clients to the new database endpoint. -If you plan to deploy on Kubernetes, the flow maps to the same concepts through [Redis Software for Kubernetes]({{< relref "/operate/kubernetes" >}}): you declare the cluster and databases as custom resources, and the operator provisions them. Planning the configuration model up front matters most for Kubernetes deployments, where you define these objects declaratively rather than through the Cluster Manager UI. +If you plan to deploy on Kubernetes, the flow maps to the same concepts through [Redis Software for Kubernetes](/content/operate/kubernetes/_index.md): you declare the cluster and databases as custom resources, and the operator provisions them. Planning the configuration model up front matters most for Kubernetes deployments, where you define these objects declaratively rather than through the Cluster Manager UI. ## Migrate your data Redis Software offers two ways to move your existing data into a new database: -- **Sync from a running source with Replica Of.** [Replica Of]({{< relref "/operate/rs/databases/import-export/replica-of" >}}) (also called Active-Passive) synchronizes a Redis Software database with one or more source databases, including a Redis Open Source database that's external to the cluster. Point the replica at your source's `redis://` endpoint, wait for the initial sync to finish, then cut your applications over to the new database. Use this path to migrate a running deployment with minimal downtime. -- **Import from a file.** If you have an RDB or backup file, [import it]({{< relref "/operate/rs/databases/import-export/import-data" >}}) into the new database. +- **Sync from a running source with Replica Of.** [Replica Of](/content/operate/rs/databases/import-export/replica-of/_index.md) (also called Active-Passive) synchronizes a Redis Software database with one or more source databases, including a Redis Open Source database that's external to the cluster. Point the replica at your source's `redis://` endpoint, wait for the initial sync to finish, then cut your applications over to the new database. Use this path to migrate a running deployment with minimal downtime. +- **Import from a file.** If you have an RDB or backup file, [import it](/content/operate/rs/databases/import-export/import-data.md) into the new database. -{{< warning >}} -Importing data erases all existing content in the target database. Replica Of also overwrites the destination database during synchronization, so use an empty destination. -{{< /warning >}} +> [!WARNING] +> Importing data erases all existing content in the target database. Replica Of also overwrites the destination database during synchronization, so use an empty destination. ## Next steps -- See [Redis Open Source compatibility]({{< relref "/operate/rs/references/compatibility" >}}) for the full compatibility reference. -- [Create a database]({{< relref "/operate/rs/databases/create" >}}) to configure your first database. -- Try the [Redis Software quickstart]({{< relref "/operate/rs/installing-upgrading/quickstarts/redis-enterprise-software-quickstart" >}}) before you plan a full deployment. +- See [Redis Open Source compatibility](/content/operate/rs/references/compatibility/_index.md) for the full compatibility reference. +- [Create a database](/content/operate/rs/databases/create.md) to configure your first database. +- Try the [Redis Software quickstart](/content/operate/rs/installing-upgrading/quickstarts/redis-enterprise-software-quickstart.md) before you plan a full deployment. diff --git a/content/operate/rs/installing-upgrading/product-lifecycle.md b/content/operate/rs/installing-upgrading/product-lifecycle.md index a6af424f19..f19839041f 100644 --- a/content/operate/rs/installing-upgrading/product-lifecycle.md +++ b/content/operate/rs/installing-upgrading/product-lifecycle.md @@ -13,7 +13,7 @@ tocEmbedHeaders: true The Redis Software product lifecycle fully reflects the [subscription agreement](https://redis.io/legal/software-agreement/). However, for any discrepancy between the two policies, the subscription agreement prevails. -Redis Software modules follow the [modules lifecycle]({{< relref "/operate/oss_and_stack/stack-with-enterprise/modules-lifecycle" >}}). +Redis Software modules follow the [modules lifecycle](/content/operate/oss_and_stack/stack-with-enterprise/modules-lifecycle.md). ## Redis Software cluster version lifecycle @@ -78,11 +78,10 @@ The following timeline chart visualizes the Redis Software product lifecycle, sh {{}} -For detailed upgrade instructions, see [Upgrade a Redis Software cluster]({{}}). +For detailed upgrade instructions, see [Upgrade a Redis Software cluster](/content/operate/rs/installing-upgrading/upgrading/upgrade-cluster.md). -{{}} -Redis Enterprise for Kubernetes has its own support lifecycle, which accounts for the Kubernetes distribution lifecycle. For details, see [Supported Kubernetes distributions]({{}}). -{{}} +> [!NOTE] +> Redis Enterprise for Kubernetes has its own support lifecycle, which accounts for the Kubernetes distribution lifecycle. For details, see [Supported Kubernetes distributions](/content/operate/kubernetes/reference/supported_k8s_distributions.md). ## Bundled Redis database versions diff --git a/content/operate/rs/installing-upgrading/quickstarts/_index.md b/content/operate/rs/installing-upgrading/quickstarts/_index.md index 680272bd34..5492ec4bef 100644 --- a/content/operate/rs/installing-upgrading/quickstarts/_index.md +++ b/content/operate/rs/installing-upgrading/quickstarts/_index.md @@ -13,14 +13,14 @@ weight: 10 Try out Redis Software using one of 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) Additional quickstart guides are available to help you: -- Set up a [Redis Flex or Auto Tiering cluster]({{< relref "/operate/rs/databases/flash/quickstart" >}}) to optimize memory resources. +- Set up a [Redis Flex or Auto Tiering cluster](/content/operate/rs/databases/flash/quickstart.md) to optimize memory resources. -- Set up an [Active-Active cluster]({{< relref "/operate/rs/databases/active-active/get-started.md" >}}) to enable high availability. +- Set up an [Active-Active cluster](/content/operate/rs/databases/active-active/get-started.md) to enable high availability. -- [Benchmark]({{< relref "/operate/rs/clusters/optimize/memtier-benchmark.md" >}}) Redis Software performance. +- [Benchmark](/content/operate/rs/clusters/optimize/memtier-benchmark.md) Redis Software performance. diff --git a/content/operate/rs/installing-upgrading/quickstarts/docker-quickstart.md b/content/operate/rs/installing-upgrading/quickstarts/docker-quickstart.md index 6720e3198b..ce263694bc 100644 --- a/content/operate/rs/installing-upgrading/quickstarts/docker-quickstart.md +++ b/content/operate/rs/installing-upgrading/quickstarts/docker-quickstart.md @@ -11,9 +11,8 @@ linkTitle: Docker quickstart weight: 2 aliases: /operate/rs/installing-upgrading/get-started-docker/ --- -{{< warning >}} -Docker containers are currently only supported for development and test environments, not for production. Use [Redis Enterprise on Kubernetes]({{< relref "/operate/kubernetes" >}}) for a supported containerized deployment. -{{< /warning >}} +> [!WARNING] +> Docker containers are currently only supported for development and test environments, not for production. Use [Redis Enterprise on Kubernetes](/content/operate/kubernetes/_index.md) for a supported containerized deployment. For testing purposes, you can run Redis Software on Docker containers on Linux, Windows, or MacOS. @@ -45,9 +44,8 @@ Follow the Docker installation instructions for your operating system: To download and start the Redis Software Docker container, run the following [`docker run`](https://docs.docker.com/engine/reference/commandline/run/) command in the terminal or command line for your operating system. -{{< note >}} -On Windows, make sure Docker is configured to run Linux-based containers. -{{< /note >}} +> [!NOTE] +> On Windows, make sure Docker is configured to run Linux-based containers. ```sh docker run -d --cap-add sys_resource --name RE -p 8443:8443 -p 9443:9443 -p 12000:12000 redislabs/redis @@ -57,11 +55,11 @@ The example command runs the Docker container with Redis Software on `localhost` - Port 8443 for HTTPS connections -- Port 9443 for [REST API]({{< relref "/operate/rs/references/rest-api" >}}) connections +- Port 9443 for [REST API](/content/operate/rs/references/rest-api/_index.md) connections - Port 12000 configured Redis database port allowing client connections -You can publish other [ports]({{< relref "/operate/rs/networking/port-configurations.md" >}}) +You can publish other [ports](/content/operate/rs/networking/port-configurations.md) with `-p :` or use the `--network host` option to open all ports to the host network. ## Set up a cluster @@ -72,9 +70,8 @@ with `-p :` or use the `--network host` option to ope {{}} -{{< note >}} -{{< embed-md "docker-memory-limitation.md" >}} -{{< /note >}} +> [!NOTE] +> {{< embed-md "docker-memory-limitation.md" >}} ## Connect to your database @@ -82,7 +79,7 @@ After you create the Redis database, you can connect to it to begin storing data ### Use redis-cli inside Docker {#connect-inside-docker} -Every installation of Redis Software includes the command-line tool [`redis-cli`]({{< relref "/operate/rs/references/cli-utilities/redis-cli" >}}) to interact with your Redis database. You can use `redis-cli` to connect to your database from within the same Docker network. +Every installation of Redis Software includes the command-line tool [`redis-cli`](/content/operate/rs/references/cli-utilities/redis-cli/_index.md) to interact with your Redis database. You can use `redis-cli` to connect to your database from within the same Docker network. Use [`docker exec`](https://docs.docker.com/engine/reference/commandline/exec/) to start an interactive `redis-cli` session in the running Redis Software container: @@ -98,13 +95,12 @@ To find the container name or ID, use [`docker ps`](https://docs.docker.com/refe ### Connect from the host environment {#connect-outside-docker} -The database you created uses port `12000`, which is also mapped from the Docker container back to the host environment. This lets you use any method you have available locally to [connect to a Redis database]({{< relref "/operate/rs/databases/connect/" >}}). Use `localhost` as the `host` and `12000` as the port. +The database you created uses port `12000`, which is also mapped from the Docker container back to the host environment. This lets you use any method you have available locally to [connect to a Redis database](/content/operate/rs/databases/connect/_index.md). Use `localhost` as the `host` and `12000` as the port. ## Test different topologies -{{< warning >}} -Docker containers are currently only supported for development and test environments, not for production. Use [Redis Enterprise on Kubernetes]({{< relref "/operate/kubernetes" >}}) for a supported containerized deployment. -{{< /warning >}} +> [!WARNING] +> Docker containers are currently only supported for development and test environments, not for production. Use [Redis Enterprise on Kubernetes](/content/operate/kubernetes/_index.md) for a supported containerized deployment. When deploying Redis Software using Docker for testing, several common topologies are available, according to your requirements: diff --git a/content/operate/rs/installing-upgrading/quickstarts/redis-enterprise-software-quickstart.md b/content/operate/rs/installing-upgrading/quickstarts/redis-enterprise-software-quickstart.md index d462f8a173..9f7b6e0d03 100644 --- a/content/operate/rs/installing-upgrading/quickstarts/redis-enterprise-software-quickstart.md +++ b/content/operate/rs/installing-upgrading/quickstarts/redis-enterprise-software-quickstart.md @@ -23,10 +23,9 @@ When finished, you'll have a simple cluster with a single node: 1. [Connect to your Redis database](#connect-to-your-database) -{{< note >}} -**This quickstart is designed for local testing only.** -For production environments, see the [install and setup]({{< relref "/operate/rs/installing-upgrading#install-redis-enterprise-software" >}}) guide for deployment options and instructions. -{{< /note >}} +> [!NOTE] +> **This quickstart is designed for local testing only.** +> For production environments, see the [install and setup](/content/operate/rs/installing-upgrading/_index.md#install-redis-enterprise-software) guide for deployment options and instructions. ## Ensure port availability @@ -64,9 +63,8 @@ To install Redis Software: 1. Download the installation files from the [Redis Software Download Center](https://redis.io/downloads/#Redis_Software) and copy the download package to a machine with a Linux-based OS. - {{< note >}} -You are required to create a free account to access the download center. - {{< /note >}} + > [!NOTE] + > You are required to create a free account to access the download center. 1. Extract the installation files: @@ -93,7 +91,7 @@ To set up your machine as a Redis Software cluster: ## Connect to your database After you create the Redis database, you can connect to it and store data. -See [Test client connection]({{< relref "/operate/rs/databases/connect/test-client-connectivity" >}}) for connection options and examples. +See [Test client connection](/content/operate/rs/databases/connect/test-client-connectivity.md) for connection options and examples. ## Supported web browsers diff --git a/content/operate/rs/installing-upgrading/uninstalling.md b/content/operate/rs/installing-upgrading/uninstalling.md index 0d7e888314..0c7e3d5606 100644 --- a/content/operate/rs/installing-upgrading/uninstalling.md +++ b/content/operate/rs/installing-upgrading/uninstalling.md @@ -12,7 +12,7 @@ weight: 70 Use the script `rl_uninstall.sh` to uninstall Redis Software and remove its files from a node. The script also deletes all Redis data and configuration from the node. -The uninstall script does not remove the node from the cluster, but the node's status changes to down. For node removal instructions, see [Remove a cluster node]({{}}). +The uninstall script does not remove the node from the cluster, but the node's status changes to down. For node removal instructions, see [Remove a cluster node](/content/operate/rs/clusters/remove-node.md). ## Uninstall Redis Software diff --git a/content/operate/rs/installing-upgrading/upgrading/_index.md b/content/operate/rs/installing-upgrading/upgrading/_index.md index 65de27a1b6..284cbe0757 100644 --- a/content/operate/rs/installing-upgrading/upgrading/_index.md +++ b/content/operate/rs/installing-upgrading/upgrading/_index.md @@ -15,28 +15,28 @@ weight: 60 To upgrade Redis Software: -1. Verify appropriate [network ports]({{< relref "/operate/rs/networking/port-configurations.md" >}}) are either open or used by Redis Software. +1. Verify appropriate [network ports](/content/operate/rs/networking/port-configurations.md) are either open or used by Redis Software. -1. Complete all [prerequisites]({{}}) before starting the upgrade. +1. Complete all [prerequisites](/content/operate/rs/installing-upgrading/upgrading/upgrade-cluster.md#upgrade-prerequisites) before starting the upgrade. 1. Upgrade the software on all nodes of the cluster using one of the following methods: - - [In-place upgrade]({{}}) - Directly upgrade Redis Software on each node in the cluster. Although this method is simpler than the rolling upgrade method, it might cause brief service interruptions as each node is upgraded. + - [In-place upgrade](/content/operate/rs/installing-upgrading/upgrading/upgrade-cluster.md#in-place-upgrade) - Directly upgrade Redis Software on each node in the cluster. Although this method is simpler than the rolling upgrade method, it might cause brief service interruptions as each node is upgraded. - - [Rolling upgrade]({{}}) - Minimize downtime by adding new nodes with an updated Redis Software version to the cluster, one at a time, while keeping the rest of the cluster operational. This method is recommended for production environments that require continuous availability. + - [Rolling upgrade](/content/operate/rs/installing-upgrading/upgrading/upgrade-cluster.md#rolling-upgrade) - Minimize downtime by adding new nodes with an updated Redis Software version to the cluster, one at a time, while keeping the rest of the cluster operational. This method is recommended for production environments that require continuous availability. ## Upgrade Redis database -[Upgrade each database]({{< relref "/operate/rs/installing-upgrading/upgrading/upgrade-database" >}}) in the cluster or [upgrade an Active-Active database]({{< relref "/operate/rs/installing-upgrading/upgrading/upgrade-active-active" >}}) to enable new features and important fixes. +[Upgrade each database](/content/operate/rs/installing-upgrading/upgrading/upgrade-database.md) in the cluster or [upgrade an Active-Active database](/content/operate/rs/installing-upgrading/upgrading/upgrade-active-active.md) to enable new features and important fixes. ## Upgrade operating system To upgrade the cluster's operating system: -1. Complete all [prerequisites]({{}}) before starting the upgrade. +1. Complete all [prerequisites](/content/operate/rs/installing-upgrading/upgrading/upgrade-os.md#prerequisites) before starting the upgrade. 2. Use one of the following rolling upgrade methods: - - [Extra node method]({{}}) - Recommended if you have additional resources available. + - [Extra node method](/content/operate/rs/installing-upgrading/upgrading/upgrade-os.md#extra-node-upgrade) - Recommended if you have additional resources available. - - [Replace node method]({{}}) - Recommended if you cannot temporarily allocate additional resources. \ No newline at end of file + - [Replace node method](/content/operate/rs/installing-upgrading/upgrading/upgrade-os.md#replace-node-upgrade) - Recommended if you cannot temporarily allocate additional resources. \ No newline at end of file diff --git a/content/operate/rs/installing-upgrading/upgrading/upgrade-active-active.md b/content/operate/rs/installing-upgrading/upgrading/upgrade-active-active.md index 74c579c003..509e63911b 100644 --- a/content/operate/rs/installing-upgrading/upgrading/upgrade-active-active.md +++ b/content/operate/rs/installing-upgrading/upgrading/upgrade-active-active.md @@ -12,17 +12,17 @@ weight: 70 ## Upgrade an Active-Active database -To upgrade an [Active-Active (CRDB) database]({{< relref "/operate/rs/databases/active-active" >}}), you can upgrade all database instances with a single REST API request or upgrade each instance separately with `rladmin` and `crdb-cli`. The REST API method requires Redis Software version 8.0.18 or later. +To upgrade an [Active-Active (CRDB) database](/content/operate/rs/databases/active-active/_index.md), you can upgrade all database instances with a single REST API request or upgrade each instance separately with `rladmin` and `crdb-cli`. The REST API method requires Redis Software version 8.0.18 or later. {{< multitabs id="upgrade-active-active-db" tab1="REST API" tab2="rladmin and crdb-cli" >}} -1. [Upgrade Redis Software]({{< relref "/operate/rs/installing-upgrading/upgrading/upgrade-cluster" >}}) on each node in the clusters where the Active-Active instances are located. +1. [Upgrade Redis Software](/content/operate/rs/installing-upgrading/upgrading/upgrade-cluster.md) on each node in the clusters where the Active-Active instances are located. 1. [Check the status](#check-database-status) of all Active-Active database instances. -1. Find the `` of your Active-Active database with the [`crdb-cli crdb list`]({{}}) command: +1. Find the `` of your Active-Active database with the [`crdb-cli crdb list`](/content/operate/rs/references/cli-utilities/crdb-cli/crdb/list.md) command: ```sh crdb-cli crdb list @@ -30,7 +30,7 @@ To upgrade an [Active-Active (CRDB) database]({{< relref "/operate/rs/databases/ Look for the fully qualified domain name (`CLUSTER-FQDN`) of your cluster and use the associated `GUID`. -1. Use an [upgrade Active-Active database]({{< relref "/operate/rs/references/rest-api/requests/crdbs/upgrade" >}}) REST API request. The request upgrades the Redis version and modules of all database instances across regions, then upgrades the feature set version after all instances are upgraded. +1. Use an [upgrade Active-Active database](/content/operate/rs/references/rest-api/requests/crdbs/upgrade.md) REST API request. The request upgrades the Redis version and modules of all database instances across regions, then upgrades the feature set version after all instances are upgraded. ```sh POST https://:/v1/crdbs//upgrade @@ -40,9 +40,9 @@ To upgrade an [Active-Active (CRDB) database]({{< relref "/operate/rs/databases/ } ``` - For additional upgrade options, see the [request body]({{}}) section of the Active-Active database upgrade requests reference. + For additional upgrade options, see the [request body](/content/operate/rs/references/rest-api/requests/crdbs/upgrade.md#request-body) section of the Active-Active database upgrade requests reference. -1. Check the upgrade's progress with the ID of the [CRDB task]({{< relref "/operate/rs/references/rest-api/requests/crdb_tasks#get-crdb_task" >}}) returned by the upgrade request: +1. Check the upgrade's progress with the ID of the [CRDB task](/content/operate/rs/references/rest-api/requests/crdb_tasks/_index.md#get-crdb_task) returned by the upgrade request: ```sh GET https://:/v1/crdb_tasks/ @@ -52,7 +52,7 @@ To upgrade an [Active-Active (CRDB) database]({{< relref "/operate/rs/databases/ -tab-sep- -1. [Upgrade Redis Software]({{< relref "/operate/rs/installing-upgrading/upgrading/upgrade-cluster" >}}) on each node in the clusters where the Active-Active instances are located. +1. [Upgrade Redis Software](/content/operate/rs/installing-upgrading/upgrading/upgrade-cluster.md) on each node in the clusters where the Active-Active instances are located. 1. [Check the status](#check-database-status) of all Active-Active database instances. @@ -60,7 +60,7 @@ To upgrade an [Active-Active (CRDB) database]({{< relref "/operate/rs/databases/ 1. If the status indicates `OLD CRDB FEATURESET VERSION`, [upgrade the featureset version](#upgrade-featureset-version). See [Feature version guidelines](#feature-version-guidelines) for more information. -1. If your Active-Active database uses modules, [update module information](#update-module-information). To check if your database uses modules, run [`rladmin status modules`]({{}}): +1. If your Active-Active database uses modules, [update module information](#update-module-information). To check if your database uses modules, run [`rladmin status modules`](/content/operate/rs/references/cli-utilities/rladmin/status.md#status-modules): ```sh rladmin status modules db { db: | } @@ -70,7 +70,7 @@ To upgrade an [Active-Active (CRDB) database]({{< relref "/operate/rs/databases/ ## Check database status -To check the status of an Active-Active database instance, run [`rladmin status`]({{}}): +To check the status of an Active-Active database instance, run [`rladmin status`](/content/operate/rs/references/cli-utilities/rladmin/status.md): ```sh rladmin status @@ -90,7 +90,7 @@ The statuses of the Active-Active instances on the node can indicate: For each Active-Active database instance: -1. Upgrade the Redis database version and enabled modules with [`rladmin upgrade db`]({{}}): +1. Upgrade the Redis database version and enabled modules with [`rladmin upgrade db`](/content/operate/rs/references/cli-utilities/rladmin/upgrade.md#upgrade-db): ```sh rladmin upgrade db { db: | } @@ -102,11 +102,10 @@ For each Active-Active database instance: After confirmation, the Active-Active instance will use the new Redis version and CRDB protocol version. - {{}} -You can use the `keep_crdt_protocol_version` option to upgrade the database version without upgrading the CRDB protocol version. However, you must upgrade the CRDB protocol before you update the CRDB feature set version. - -If you use `keep_crdt_protocol_version`, make sure that you upgrade the CRDB protocol soon after with the [`rladmin upgrade db`]({{< relref "/operate/rs/references/cli-utilities/rladmin/upgrade#upgrade-db" >}}) command. - {{}} + > [!NOTE] + > You can use the `keep_crdt_protocol_version` option to upgrade the database version without upgrading the CRDB protocol version. However, you must upgrade the CRDB protocol before you update the CRDB feature set version. + > + > If you use `keep_crdt_protocol_version`, make sure that you upgrade the CRDB protocol soon after with the [`rladmin upgrade db`](/content/operate/rs/references/cli-utilities/rladmin/upgrade.md#upgrade-db) command. ### CRDB protocol version guidelines @@ -140,7 +139,7 @@ If the feature set version is old, as indicated by the `OLD CRDB FEATURESET VERS 1. Find the `` of your Active-Active database. - You can use the [`crdb-cli crdb list`]({{}}) command: + You can use the [`crdb-cli crdb list`](/content/operate/rs/references/cli-utilities/crdb-cli/crdb/list.md) command: ```sh crdb-cli crdb list diff --git a/content/operate/rs/installing-upgrading/upgrading/upgrade-cluster.md b/content/operate/rs/installing-upgrading/upgrading/upgrade-cluster.md index 6908626096..0bac2ee610 100644 --- a/content/operate/rs/installing-upgrading/upgrading/upgrade-cluster.md +++ b/content/operate/rs/installing-upgrading/upgrading/upgrade-cluster.md @@ -24,27 +24,26 @@ To upgrade a cluster's Redis Software version, use one of the following methods: {{}} -See the [Redis Software product lifecycle]({{}}) for more information about release numbers and the end-of-life schedule. +See the [Redis Software product lifecycle](/content/operate/rs/installing-upgrading/product-lifecycle.md) for more information about release numbers and the end-of-life schedule. -{{}} -Redis Enterprise for Kubernetes has its own support lifecycle, which accounts for the Kubernetes distribution lifecycle. For details, see [Supported Kubernetes distributions]({{}}). -{{}} +> [!NOTE] +> Redis Enterprise for Kubernetes has its own support lifecycle, which accounts for the Kubernetes distribution lifecycle. For details, see [Supported Kubernetes distributions](/content/operate/kubernetes/reference/supported_k8s_distributions.md). ## Upgrade prerequisites Before upgrading a cluster: -- Verify access to [rlcheck]({{< relref "/operate/rs/references/cli-utilities/rlcheck/" >}}) and [rladmin]({{< relref "/operate/rs/references/cli-utilities/rladmin/#use-the-rladmin-shell" >}}) commands. +- Verify access to [rlcheck](/content/operate/rs/references/cli-utilities/rlcheck/_index.md) and [rladmin](/content/operate/rs/references/cli-utilities/rladmin/_index.md#use-the-rladmin-shell) commands. -- Run [rlcheck]({{< relref "/operate/rs/references/cli-utilities/rlcheck/" >}}) on each node and verify there are no issues: +- Run [rlcheck](/content/operate/rs/references/cli-utilities/rlcheck/_index.md) on each node and verify there are no issues: ```sh rlcheck ``` -- Verify [maintenance mode]({{< relref "/operate/rs/clusters/maintenance-mode" >}}) is not enabled: +- Verify [maintenance mode](/content/operate/rs/clusters/maintenance-mode.md) is not enabled: - 1. On a node in the cluster, run [`rladmin status`]({{< relref "/operate/rs/references/cli-utilities/rladmin/status" >}}): + 1. On a node in the cluster, run [`rladmin status`](/content/operate/rs/references/cli-utilities/rladmin/status.md): ```sh rladmin status @@ -54,13 +53,13 @@ Before upgrading a cluster: {{< image filename="/images/rs/maintenance_mode.png" >}} - 1. To deactivate maintenance mode on a node, run the following [`rladmin node maintenance_mode off`]({{}}) command. See [Deactivate maintenance mode]({{}}) for additional details. + 1. To deactivate maintenance mode on a node, run the following [`rladmin node maintenance_mode off`](/content/operate/rs/references/cli-utilities/rladmin/node/maintenance-mode.md#node-maintenance_mode-off) command. See [Deactivate maintenance mode](/content/operate/rs/clusters/maintenance-mode.md#deactivate-maintenance-mode) for additional details. ```sh rladmin node maintenance_mode off ``` -- Verify that you meet the upgrade path requirements for the target cluster version and review the relevant [release notes]({{< relref "/operate/rs/release-notes" >}}) for any preparation instructions. +- Verify that you meet the upgrade path requirements for the target cluster version and review the relevant [release notes](/content/operate/rs/release-notes/_index.md) for any preparation instructions. - Before you upgrade a cluster from Redis Software version 6.2.x to 7.8.x, you must follow these steps if the cluster has any databases with Redis version 6.0: @@ -70,9 +69,9 @@ Before upgrading a cluster: rladmin tune cluster redis_upgrade_policy latest ``` - 1. [Upgrade Redis 6.0 databases]({{}}) to Redis 6.2. + 1. [Upgrade Redis 6.0 databases](/content/operate/rs/installing-upgrading/upgrading/upgrade-database.md) to Redis 6.2. -- [Upgrade your databases]({{}}) to a version that is supported by the target Redis Software version before upgrading the cluster. We recommend you upgrade the databases to the latest supported version if possible. Make sure to test the upgrade in a non-production environment to determine any impact. +- [Upgrade your databases](/content/operate/rs/installing-upgrading/upgrading/upgrade-database.md) to a version that is supported by the target Redis Software version before upgrading the cluster. We recommend you upgrade the databases to the latest supported version if possible. Make sure to test the upgrade in a non-production environment to determine any impact. - Avoid changing the database configuration or performing other cluster management operations during the cluster upgrade process, as this might cause unexpected results. @@ -80,9 +79,9 @@ Before upgrading a cluster: - **Nodes** screen in the new Cluster Manager UI (only available for Redis Software versions 7.2 and later) - - [`rladmin status nodes`]({{< relref "/operate/rs/references/cli-utilities/rladmin/status#status-nodes" >}}) command + - [`rladmin status nodes`](/content/operate/rs/references/cli-utilities/rladmin/status.md#status-nodes) command - - [`GET /nodes/status`]({{< relref "/operate/rs/references/rest-api/requests/nodes/status#get-all-nodes-status" >}}) REST API request + - [`GET /nodes/status`](/content/operate/rs/references/rest-api/requests/nodes/status.md#get-all-nodes-status) REST API request ## In-place upgrade @@ -97,9 +96,8 @@ Starting with the primary node, follow these steps for every node in the cluster $ rladmin status extra all ``` - {{}} -Do not proceed if any shard, node, or endpoint is not `OK`. - {{}} + > [!WARNING] + > Do not proceed if any shard, node, or endpoint is not `OK`. 1. Download the Redis Software installation package to the machine running the node from the Download Center on [https://cloud.redis.io](https://cloud.redis.io). @@ -109,11 +107,10 @@ Do not proceed if any shard, node, or endpoint is not `OK`. tar vxf ``` - {{}} -You cannot change the installation path or the user during the upgrade. - {{}} + > [!NOTE] + > You cannot change the installation path or the user during the upgrade. -1. Run the install command. See [installation script options]({{< relref "/operate/rs/installing-upgrading/install/install-script" >}}) for a list of command-line options you can add to the following command. You cannot use options marked as "new installs only" during an in-place upgrade. +1. Run the install command. See [installation script options](/content/operate/rs/installing-upgrading/install/install-script.md) for a list of command-line options you can add to the following command. You cannot use options marked as "new installs only" during an in-place upgrade. ``` shell sudo ./install.sh @@ -146,23 +143,23 @@ To perform a rolling upgrade of the cluster, use one of the following methods: 1. Complete all [prerequisites](#upgrade-prerequisites) before starting the rolling upgrade. -1. [Install a later version of Redis Software]({{< relref "/operate/rs/installing-upgrading/install/install-on-linux" >}}) on a new node. +1. [Install a later version of Redis Software](/content/operate/rs/installing-upgrading/install/install-on-linux.md) on a new node. -1. [Add the new node]({{< relref "/operate/rs/clusters/add-node" >}}) to the cluster. +1. [Add the new node](/content/operate/rs/clusters/add-node.md) to the cluster. -1. If the [cluster uses DNS]({{}}), add the new node’s IP address to the DNS records. +1. If the [cluster uses DNS](/content/operate/rs/networking/cluster-dns.md), add the new node’s IP address to the DNS records. -1. [Promote the first new node]({{}}) to become the primary node. +1. [Promote the first new node](/content/operate/rs/clusters/change-node-role.md#promote-secondary-node) to become the primary node. -1. [Remove one node]({{< relref "/operate/rs/clusters/remove-node#remove-a-node" >}}) running the earlier Redis Software version from the cluster. +1. [Remove one node](/content/operate/rs/clusters/remove-node.md#remove-a-node) running the earlier Redis Software version from the cluster. -1. Repeat the previous steps until all nodes with the earlier Redis Software version are removed. If the final node to remove from the cluster is the primary node, [demote it]({{}}) to a secondary node before you remove it. +1. Repeat the previous steps until all nodes with the earlier Redis Software version are removed. If the final node to remove from the cluster is the primary node, [demote it](/content/operate/rs/clusters/change-node-role.md#demote-primary-node) to a secondary node before you remove it. ### Replace node upgrade method {#replace-node-upgrade} 1. Complete all [prerequisites](#upgrade-prerequisites) before starting the rolling upgrade. -1. [Remove a node]({{< relref "/operate/rs/clusters/remove-node#remove-a-node" >}}) with the earlier Redis Software version from the cluster. +1. [Remove a node](/content/operate/rs/clusters/remove-node.md#remove-a-node) with the earlier Redis Software version from the cluster. 1. Uninstall Redis Software from the removed node: @@ -170,19 +167,19 @@ To perform a rolling upgrade of the cluster, use one of the following methods: sudo ./rl_uninstall.sh ``` -1. [Install a later version of Redis Software]({{< relref "/operate/rs/installing-upgrading/install/install-on-linux" >}}) on the removed node or a new node. +1. [Install a later version of Redis Software](/content/operate/rs/installing-upgrading/install/install-on-linux.md) on the removed node or a new node. -1. [Add the new node]({{< relref "/operate/rs/clusters/add-node" >}}) to the cluster. +1. [Add the new node](/content/operate/rs/clusters/add-node.md) to the cluster. - If you want to reuse the removed node's ID when you add the node to the cluster, run [`rladmin cluster join`]({{< relref "/operate/rs/references/cli-utilities/rladmin/cluster/join" >}}) with the `replace_node` flag: + If you want to reuse the removed node's ID when you add the node to the cluster, run [`rladmin cluster join`](/content/operate/rs/references/cli-utilities/rladmin/cluster/join.md) with the `replace_node` flag: ```sh rladmin cluster join nodes username password replace_node ``` -1. If the [cluster uses DNS]({{}}), add the new node’s IP address to the DNS records. +1. If the [cluster uses DNS](/content/operate/rs/networking/cluster-dns.md), add the new node’s IP address to the DNS records. -1. [Promote the first new node]({{}}) to become the primary node. +1. [Promote the first new node](/content/operate/rs/clusters/change-node-role.md#promote-secondary-node) to become the primary node. 1. Verify node health: @@ -208,7 +205,7 @@ To perform a rolling upgrade of the cluster, use one of the following methods: For healthy nodes, the expected output is `ALL TESTS PASSED`. - 1. Run [`rladmin status`]({{< relref "/operate/rs/references/cli-utilities/rladmin/status" >}}) on the new node: + 1. Run [`rladmin status`](/content/operate/rs/references/cli-utilities/rladmin/status.md) on the new node: ```sh rladmin status extra all @@ -224,7 +221,7 @@ To perform a rolling upgrade of the cluster, use one of the following methods: ... ``` -1. Repeat the previous steps until all nodes with the earlier Redis Software version are replaced. If the final node to remove from the cluster is the primary node, [demote it]({{}}) to a secondary node before you remove it. +1. Repeat the previous steps until all nodes with the earlier Redis Software version are replaced. If the final node to remove from the cluster is the primary node, [demote it](/content/operate/rs/clusters/change-node-role.md#demote-primary-node) to a secondary node before you remove it. ## After cluster upgrade diff --git a/content/operate/rs/installing-upgrading/upgrading/upgrade-database.md b/content/operate/rs/installing-upgrading/upgrading/upgrade-database.md index 347695a0b5..b45bf2449c 100644 --- a/content/operate/rs/installing-upgrading/upgrading/upgrade-database.md +++ b/content/operate/rs/installing-upgrading/upgrading/upgrade-database.md @@ -12,13 +12,13 @@ weight: 50 ## Default Redis database versions {#default-db-versions} -When you upgrade an existing database, it uses the latest bundled Redis version unless you specify a different version with the `redis_version` option in the [REST API]({{< relref "/operate/rs/references/rest-api/requests/bdbs" >}}) or [`rladmin upgrade db`]({{< relref "/operate/rs/references/cli-utilities/rladmin/upgrade#upgrade-db" >}}). +When you upgrade an existing database, it uses the latest bundled Redis version unless you specify a different version with the `redis_version` option in the [REST API](/content/operate/rs/references/rest-api/requests/bdbs/_index.md) or [`rladmin upgrade db`](/content/operate/rs/references/cli-utilities/rladmin/upgrade.md#upgrade-db). To view available Redis database versions: - In the Cluster Manager UI, see **Redis database versions** on the **Cluster > Configuration** screen. -- Send a [`GET /nodes` REST API request]({{< relref "/operate/rs/references/rest-api/requests/nodes" >}}) and see `supported_database_versions` in the response. +- Send a [`GET /nodes` REST API request](/content/operate/rs/references/rest-api/requests/nodes/_index.md) and see `supported_database_versions` in the response. The default Redis database version differs between Redis Software releases as follows: @@ -29,7 +29,7 @@ The default Redis database version differs between Redis Software releases as fo Before upgrading a database: -- Review the relevant [release notes]({{< relref "/operate/rs/release-notes" >}}) for any preparation instructions. +- Review the relevant [release notes](/content/operate/rs/release-notes/_index.md) for any preparation instructions. - Verify that both the [current database version and the target database version are supported](#db-versions-table) by the cluster's Redis Software version. @@ -37,7 +37,7 @@ Before upgrading a database: - Use the Cluster Manager UI to open the **Configuration** tab for the database and select {{< image filename="/images/rs/icons/info-icon.png#no-click" alt="The About database button" width="18px" class="inline" >}} **About**. - - _(Optional)_ Use the [`rladmin status extra all`]({{< relref "/operate/rs/references/cli-utilities/rladmin/status" >}}) command to display configuration details: + - _(Optional)_ Use the [`rladmin status extra all`](/content/operate/rs/references/cli-utilities/rladmin/status.md) command to display configuration details: ```sh rladmin status extra all @@ -49,15 +49,15 @@ Before upgrading a database: Use the Cluster Manager UI to display the **Configuration** tab for the cluster. The tab displays the cluster version information and the Redis database compatibility version. -- For [Replica Of databases]({{< relref "/operate/rs/databases/import-export/replica-of/" >}}), upgrade the destination database before the source database. +- For [Replica Of databases](/content/operate/rs/databases/import-export/replica-of/_index.md), upgrade the destination database before the source database. - Check client compatibility with the database version. - If you run Redis Stack commands with Go-Redis versions 9 and later or Lettuce versions 6 and later, set the client’s protocol version to RESP2 before upgrading your database to Redis version 7.2 to prevent potential application issues due to RESP3 breaking changes. See [Client prerequisites for Redis 7.2 upgrade]({{< relref "/operate/rs/references/compatibility/resp#client-prerequisites-for-redis-72-upgrade" >}}) for more details and examples. + If you run Redis Stack commands with Go-Redis versions 9 and later or Lettuce versions 6 and later, set the client’s protocol version to RESP2 before upgrading your database to Redis version 7.2 to prevent potential application issues due to RESP3 breaking changes. See [Client prerequisites for Redis 7.2 upgrade](/content/operate/rs/references/compatibility/resp.md#client-prerequisites-for-redis-72-upgrade) for more details and examples. -- To avoid data loss during the upgrade, [back up your data]({{< relref "/operate/rs/databases/import-export/schedule-backups" >}}). +- To avoid data loss during the upgrade, [back up your data](/content/operate/rs/databases/import-export/schedule-backups.md). - You can [export the data]({{< relref "/operate/rs/databases/import-export/export-data" >}}) to an external location, [enable replication]({{< relref "/operate/rs/databases/durability-ha/replication" >}}), or [enable persistence]({{< relref "/operate/rs/databases/configure/database-persistence" >}}). + You can [export the data](/content/operate/rs/databases/import-export/export-data.md) to an external location, [enable replication](/content/operate/rs/databases/durability-ha/replication.md), or [enable persistence](/content/operate/rs/databases/configure/database-persistence.md). When choosing how to back up data, keep the following in mind: @@ -116,7 +116,7 @@ To upgrade a database: 1. Optionally, back up the database to minimize the risk of data loss. -1. Upgrade the database using [`rladmin upgrade db`]({{< relref "/operate/rs/references/cli-utilities/rladmin/upgrade" >}}). During the upgrade process, the database will restart without losing any data. Use the `preserve_roles` option to keep the database's current state, including primary shard placement, and prevent the cluster from becoming unbalanced. +1. Upgrade the database using [`rladmin upgrade db`](/content/operate/rs/references/cli-utilities/rladmin/upgrade.md). During the upgrade process, the database will restart without losing any data. Use the `preserve_roles` option to keep the database's current state, including primary shard placement, and prevent the cluster from becoming unbalanced. To upgrade a database and its modules: @@ -142,9 +142,9 @@ To upgrade a database: rladmin upgrade db redis_version preserve_roles ``` - For module upgrade options, see [Upgrade modules]({{< relref "/operate/oss_and_stack/stack-with-enterprise/install/upgrade-module" >}}). + For module upgrade options, see [Upgrade modules](/content/operate/oss_and_stack/stack-with-enterprise/install/upgrade-module.md). -1. Use [`rladmin status databases extra all`]({{< relref "/operate/rs/references/cli-utilities/rladmin/status#status-databases" >}}) to display a list of the databases in your cluster and their current Redis database compatibility version. Verify that the Redis version is set to the expected value. +1. Use [`rladmin status databases extra all`](/content/operate/rs/references/cli-utilities/rladmin/status.md#status-databases) to display a list of the databases in your cluster and their current Redis database compatibility version. Verify that the Redis version is set to the expected value. ```sh rladmin status databases extra all @@ -156,7 +156,7 @@ To upgrade a database: 1. Optionally, back up the database to minimize the risk of data loss. -1. Use an [upgrade database]({{< relref "/operate/rs/references/rest-api/requests/bdbs/upgrade" >}}) REST API request. During the upgrade process, the database will restart without losing any data. Use the `preserve_roles` option to keep the database's current state, including primary shard placement, and prevent the cluster from becoming unbalanced. +1. Use an [upgrade database](/content/operate/rs/references/rest-api/requests/bdbs/upgrade.md) REST API request. During the upgrade process, the database will restart without losing any data. Use the `preserve_roles` option to keep the database's current state, including primary shard placement, and prevent the cluster from becoming unbalanced. ```sh POST https://:/v1/bdbs//upgrade @@ -166,6 +166,6 @@ To upgrade a database: } ``` - For additional database upgrade options, see the [request body]({{}}) section of the database upgrade requests reference. + For additional database upgrade options, see the [request body](/content/operate/rs/references/rest-api/requests/bdbs/upgrade.md#request-body) section of the database upgrade requests reference. {{< /multitabs >}} diff --git a/content/operate/rs/installing-upgrading/upgrading/upgrade-os.md b/content/operate/rs/installing-upgrading/upgrading/upgrade-os.md index 6c85344c2f..7cc74a0db2 100644 --- a/content/operate/rs/installing-upgrading/upgrading/upgrade-os.md +++ b/content/operate/rs/installing-upgrading/upgrading/upgrade-os.md @@ -18,12 +18,12 @@ To upgrade the operating system (OS) on a Redis Software cluster to a later majo Before you upgrade a cluster's operating system: -1. [Upgrade all nodes in the cluster]({{< relref "/operate/rs/installing-upgrading/upgrading/upgrade-cluster" >}}) to a Redis Software version that supports the OS's current version and upgrade version. +1. [Upgrade all nodes in the cluster](/content/operate/rs/installing-upgrading/upgrading/upgrade-cluster.md) to a Redis Software version that supports the OS's current version and upgrade version. - To learn which versions of Redis Software support specific OS versions, see [Supported platforms]({{< relref "/operate/rs/references/supported-platforms#supported-platforms" >}}). + To learn which versions of Redis Software support specific OS versions, see [Supported platforms](/content/operate/rs/references/supported-platforms.md#supported-platforms). -1. If the cluster uses custom directories, make sure the OS upgrade version also supports custom directories, and specify the same custom directories during installation for all nodes. See [Customize installation directories]({{< relref "/operate/rs/installing-upgrading/install/customize-install-directories" >}}) for details. +1. If the cluster uses custom directories, make sure the OS upgrade version also supports custom directories, and specify the same custom directories during installation for all nodes. See [Customize installation directories](/content/operate/rs/installing-upgrading/install/customize-install-directories.md) for details. ## Perform OS rolling upgrade @@ -39,21 +39,21 @@ To upgrade the cluster's operating system, use one of the following rolling upgr 1. Create a node with the OS upgrade version. -1. [Install the cluster's current Redis Software version]({{< relref "/operate/rs/installing-upgrading/install/install-on-linux" >}}) on the new node using the installation package for the OS upgrade version. +1. [Install the cluster's current Redis Software version](/content/operate/rs/installing-upgrading/install/install-on-linux.md) on the new node using the installation package for the OS upgrade version. -1. [Add the new node]({{< relref "/operate/rs/clusters/add-node" >}}) to the cluster. +1. [Add the new node](/content/operate/rs/clusters/add-node.md) to the cluster. -1. If the [cluster uses DNS]({{}}), add the new node’s IP address to the DNS records. +1. If the [cluster uses DNS](/content/operate/rs/networking/cluster-dns.md), add the new node’s IP address to the DNS records. -1. [Remove one node]({{< relref "/operate/rs/clusters/remove-node#remove-a-node" >}}) running the earlier OS version from the cluster. +1. [Remove one node](/content/operate/rs/clusters/remove-node.md#remove-a-node) running the earlier OS version from the cluster. -1. Repeat the previous steps until all nodes with the earlier OS version are removed. If the final node to remove from the cluster is the primary node, [demote it]({{}}) to a secondary node before you remove it. +1. Repeat the previous steps until all nodes with the earlier OS version are removed. If the final node to remove from the cluster is the primary node, [demote it](/content/operate/rs/clusters/change-node-role.md#demote-primary-node) to a secondary node before you remove it. ### Replace node upgrade method {#replace-node-upgrade} 1. Complete all [prerequisites](#prerequisites) before starting the rolling upgrade. -1. [Remove a node]({{< relref "/operate/rs/clusters/remove-node#remove-a-node" >}}) with the earlier OS version from the cluster. +1. [Remove a node](/content/operate/rs/clusters/remove-node.md#remove-a-node) with the earlier OS version from the cluster. 1. Uninstall Redis Software from the removed node: @@ -63,17 +63,17 @@ To upgrade the cluster's operating system, use one of the following rolling upgr 1. Either upgrade the existing node to the OS upgrade version, or create a new node with the OS upgrade version. -1. [Install the cluster's current Redis Software version]({{< relref "/operate/rs/installing-upgrading/install/install-on-linux" >}}) on the upgraded node using the installation package for the OS upgrade version. +1. [Install the cluster's current Redis Software version](/content/operate/rs/installing-upgrading/install/install-on-linux.md) on the upgraded node using the installation package for the OS upgrade version. -1. [Add the new node]({{< relref "/operate/rs/clusters/add-node" >}}) to the cluster. +1. [Add the new node](/content/operate/rs/clusters/add-node.md) to the cluster. - If you want to reuse the removed node's ID when you add the node to the cluster, run [`rladmin cluster join`]({{< relref "/operate/rs/references/cli-utilities/rladmin/cluster/join" >}}) with the `replace_node` flag: + If you want to reuse the removed node's ID when you add the node to the cluster, run [`rladmin cluster join`](/content/operate/rs/references/cli-utilities/rladmin/cluster/join.md) with the `replace_node` flag: ```sh rladmin cluster join nodes username password replace_node ``` -1. If the [cluster uses DNS]({{}}), add the new node’s IP address to the DNS records. +1. If the [cluster uses DNS](/content/operate/rs/networking/cluster-dns.md), add the new node’s IP address to the DNS records. 1. Verify node health: @@ -99,7 +99,7 @@ To upgrade the cluster's operating system, use one of the following rolling upgr For healthy nodes, the expected output is `ALL TESTS PASSED`. - 1. Run [`rladmin status`]({{< relref "/operate/rs/references/cli-utilities/rladmin/status" >}}) on the new node: + 1. Run [`rladmin status`](/content/operate/rs/references/cli-utilities/rladmin/status.md) on the new node: ```sh rladmin status extra all @@ -115,4 +115,4 @@ To upgrade the cluster's operating system, use one of the following rolling upgr ... ``` -1. Repeat the previous steps until all nodes with the earlier OS version are replaced. If the final node to remove from the cluster is the primary node, [demote it]({{}}) to a secondary node before you remove it. +1. Repeat the previous steps until all nodes with the earlier OS version are replaced. If the final node to remove from the cluster is the primary node, [demote it](/content/operate/rs/clusters/change-node-role.md#demote-primary-node) to a secondary node before you remove it.