diff --git a/content/operate/rs/_index.md b/content/operate/rs/_index.md index 5e90601c77..413aa0a35b 100644 --- a/content/operate/rs/_index.md +++ b/content/operate/rs/_index.md @@ -21,40 +21,40 @@ With Redis Software, you get many enterprise-grade capabilities, including: 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. ## Get started Build a small-scale cluster with the Redis Software container image. -- [Linux quickstart]({{< relref "/operate/rs/installing-upgrading/quickstarts/redis-enterprise-software-quickstart" >}}) -- [Docker quickstart]({{< relref "/operate/rs/installing-upgrading/quickstarts/docker-quickstart" >}}) -- [Get started with Active-Active]({{< relref "/operate/rs/databases/active-active/get-started" >}}) +- [Linux quickstart](/content/operate/rs/installing-upgrading/quickstarts/redis-enterprise-software-quickstart.md) +- [Docker quickstart](/content/operate/rs/installing-upgrading/quickstarts/docker-quickstart.md) +- [Get started with Active-Active](/content/operate/rs/databases/active-active/get-started.md) ## Install & setup -[Install & set up]({{< relref "/operate/rs/installing-upgrading" >}}) a Redis Software cluster. -- [Networking]({{< relref "/operate/rs/networking" >}}) -- [Set up]({{< relref "/operate/rs/clusters/new-cluster-setup" >}}) & [configure]({{< relref "/operate/rs/clusters/configure" >}}) a [cluster]({{< relref "/operate/rs/clusters" >}}) -- [Release notes]({{< relref "/operate/rs/release-notes" >}}) +[Install & set up](/content/operate/rs/installing-upgrading/_index.md) a Redis Software cluster. +- [Networking](/content/operate/rs/networking/_index.md) +- [Set up](/content/operate/rs/clusters/new-cluster-setup.md) & [configure](/content/operate/rs/clusters/configure/_index.md) a [cluster](/content/operate/rs/clusters/_index.md) +- [Release notes](/content/operate/rs/release-notes/_index.md) ## Databases -Create and manage a [Redis database]({{< relref "/operate/rs/databases" >}}) on a cluster. -- [Create a Redis Software database]({{< relref "/operate/rs/databases/create" >}}) -- [Configure database]({{< relref "/operate/rs/databases/configure" >}}) -- [Create Active-Active database]({{< relref "/operate/rs/databases/active-active/create" >}}) -- [Edit Active-Active database]({{< relref "/operate/rs/databases/active-active/manage.md" >}}) +Create and manage a [Redis database](/content/operate/rs/databases/_index.md) on a cluster. +- [Create a Redis Software database](/content/operate/rs/databases/create.md) +- [Configure database](/content/operate/rs/databases/configure/_index.md) +- [Create Active-Active database](/content/operate/rs/databases/active-active/create.md) +- [Edit Active-Active database](/content/operate/rs/databases/active-active/manage.md) ## Security -[Manage secure connections]({{< relref "/operate/rs/security" >}}) to the cluster and databases. -- [Access control]({{< relref "/operate/rs/security/access-control" >}}) -- [Users]({{< relref "/operate/rs/security/access-control/manage-users" >}}) & [roles]({{< relref "/operate/rs/security/access-control" >}}) -- [Certificates]({{< relref "/operate/rs/security/certificates" >}}) -- [TLS]({{< relref "/operate/rs/security/encryption/tls" >}}) & [Encryption]({{< relref "/operate/rs/security/encryption" >}}) +[Manage secure connections](/content/operate/rs/security/_index.md) to the cluster and databases. +- [Access control](/content/operate/rs/security/access-control/_index.md) +- [Users](/content/operate/rs/security/access-control/manage-users/_index.md) & [roles](/content/operate/rs/security/access-control/_index.md) +- [Certificates](/content/operate/rs/security/certificates/_index.md) +- [TLS](/content/operate/rs/security/encryption/tls/_index.md) & [Encryption](/content/operate/rs/security/encryption/_index.md) ## Reference Use command-line utilities and the REST API to manage the cluster and databases. -- [rladmin]({{< relref "/operate/rs/references/cli-utilities/rladmin" >}}), [crdb-cli]({{< relref "/operate/rs/references/cli-utilities/crdb-cli" >}}), & [other utilities]({{< relref "/operate/rs/references/cli-utilities" >}}) +- [rladmin](/content/operate/rs/references/cli-utilities/rladmin/_index.md), [crdb-cli](/content/operate/rs/references/cli-utilities/crdb-cli/_index.md), & [other utilities](/content/operate/rs/references/cli-utilities/_index.md) - [`redisctl`](https://github.com/redis/redisctl) — a unified CLI for managing Redis Software and Redis Cloud from your terminal -- [REST API reference]({{< relref "/operate/rs/references/rest-api" >}}) & [examples]({{< relref "/operate/rs/references/rest-api/quick-start" >}}) -- [Redis commands]({{< relref "/commands" >}}) +- [REST API reference](/content/operate/rs/references/rest-api/_index.md) & [examples](/content/operate/rs/references/rest-api/quick-start.md) +- [Redis commands](/commands) ## Archive @@ -72,10 +72,10 @@ To view documentation earlier than version 7.4, see the archived website: ## Related info -- [Redis Cloud]({{< relref "/operate/rc" >}}) -- [Redis Open Source]({{< relref "/operate/oss_and_stack" >}}) -- [Redis Stack]({{< relref "/operate/oss_and_stack/stack-with-enterprise" >}}) -- [Glossary]({{< relref "/glossary" >}}) +- [Redis Cloud](/content/operate/rc/_index.md) +- [Redis Open Source](/content/operate/oss_and_stack/_index.md) +- [Redis Stack](/content/operate/oss_and_stack/stack-with-enterprise/_index.md) +- [Glossary](/content/glossary/_index.md) ## Continue learning with Redis University diff --git a/content/operate/rs/clusters/_index.md b/content/operate/rs/clusters/_index.md index b03c7b28e3..387f6a165d 100644 --- a/content/operate/rs/clusters/_index.md +++ b/content/operate/rs/clusters/_index.md @@ -15,5 +15,5 @@ weight: 36 You can manage your Redis Software clusters with several different tools: - Cluster Manager UI (the web-based user interface) -- Command-line tools ([rladmin]({{< relref "/operate/rs/references/cli-utilities/rladmin" >}}), [redis-cli]({{< relref "/develop/tools/cli" >}}), [crdb-cli]({{< relref "/operate/rs/references/cli-utilities/crdb-cli" >}})) -- [REST API]({{< relref "/operate/rs/references/rest-api/_index.md" >}}) +- Command-line tools ([rladmin](/content/operate/rs/references/cli-utilities/rladmin/_index.md), [redis-cli](/content/develop/tools/cli.md), [crdb-cli](/content/operate/rs/references/cli-utilities/crdb-cli/_index.md)) +- [REST API](/content/operate/rs/references/rest-api/_index.md) diff --git a/content/operate/rs/clusters/add-node.md b/content/operate/rs/clusters/add-node.md index 6eed5089fc..5638b87eb0 100644 --- a/content/operate/rs/clusters/add-node.md +++ b/content/operate/rs/clusters/add-node.md @@ -16,12 +16,12 @@ After you install the first node, you can add more nodes to the cluster. Before you add a node to the cluster: -- The clocks on all nodes must always be [synchronized]({{< relref "/operate/rs/clusters/configure/sync-clocks.md" >}}). +- The clocks on all nodes must always be [synchronized](/content/operate/rs/clusters/configure/sync-clocks.md). If the clock in the node you are trying to join to the cluster is not synchronized with the nodes already in the cluster, the action fails and an error message is shown indicating that you must synchronize the clocks first. -- You must [update the DNS records]({{< relref "/operate/rs/networking/cluster-dns" >}}) +- You must [update the DNS records](/content/operate/rs/networking/cluster-dns.md) each time a node is added or replaced. - We recommend that you add nodes one after the other rather than in parallel @@ -31,18 +31,17 @@ Before you add a node to the cluster: To add a node to an existing cluster: -1. [Install the Redis Software installation package]({{< relref "/operate/rs/installing-upgrading" >}}) on a clean installation - of a [supported operating system]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/supported-platforms.md" >}}). +1. [Install the Redis Software installation package](/content/operate/rs/installing-upgrading/_index.md) on a clean installation + of a [supported operating system](/content/operate/rs/installing-upgrading/install/plan-deployment/supported-platforms.md). 1. To connect to the Cluster Manager UI of the new Redis Software installation, go to: For example, if you installed Redis Software on a machine with IP address 10.0.1.34, go to `https://10.0.1.34:8443`. - {{< tip >}} -The management UI uses TLS encryption with a default certificate. -You can also [replace the TLS certificate]({{< relref "/operate/rs/security/certificates/updating-certificates" >}}) -with a custom certificate. - {{< /tip >}} + > [!TIP] + > The management UI uses TLS encryption with a default certificate. + > You can also [replace the TLS certificate](/content/operate/rs/security/certificates/updating-certificates.md) + > with a custom certificate. 1. Select **Join cluster**. @@ -58,15 +57,15 @@ with a custom certificate. 1. Configure storage and network settings: - 1. Enter a path for [*Ephemeral storage*]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage" >}}), or leave the default path. + 1. Enter a path for [*Ephemeral storage*](/content/operate/rs/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage.md), or leave the default path. - 1. Enter a path for [*Persistent storage*]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage" >}}), + 1. Enter a path for [*Persistent storage*](/content/operate/rs/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage.md), or leave the default path. - 1. To enable [*Redis Flex or Auto Tiering*]({{< relref "/operate/rs/databases/flash/" >}}), + 1. To enable [*Redis Flex or Auto Tiering*](/content/operate/rs/databases/flash/_index.md), select **Enable flash storage** and enter the path to the flash storage. - 1. If the cluster is configured to support [rack-zone awareness]({{< relref "/operate/rs/clusters/configure/rack-zone-awareness.md" >}}), set the **Rack-zone ID** for the new node. + 1. If the cluster is configured to support [rack-zone awareness](/content/operate/rs/clusters/configure/rack-zone-awareness.md), set the **Rack-zone ID** for the new node. 1. If your machine has multiple IP addresses, assign a single IPv4 type address for **Node-to-node communication (internal traffic)** and multiple IPv4/IPv6 type addresses for **External traffic**. @@ -91,4 +90,4 @@ We recommend that you verify the node is functioning properly using one of the f - Command-line method: - Run the [`rlcheck`]({{< relref "/operate/rs/references/cli-utilities/rlcheck" >}}) utility from the node's command line. + Run the [`rlcheck`](/content/operate/rs/references/cli-utilities/rlcheck/_index.md) utility from the node's command line. diff --git a/content/operate/rs/clusters/change-node-role.md b/content/operate/rs/clusters/change-node-role.md index 0f62723acf..a46affd7ae 100644 --- a/content/operate/rs/clusters/change-node-role.md +++ b/content/operate/rs/clusters/change-node-role.md @@ -40,14 +40,14 @@ To demote the primary node to a secondary node using the Cluster Manager UI: To demote the primary node to a secondary node using `rladmin`: -1. Identify the primary node's ID with [`rladmin cluster master`]({{}}): +1. Identify the primary node's ID with [`rladmin cluster master`](/content/operate/rs/references/cli-utilities/rladmin/cluster/master.md): ```sh $ rladmin cluster master Node is the cluster master node ``` -1. Run [`rladmin node enslave`]({{}}) with the `demote_node` option: +1. Run [`rladmin node enslave`](/content/operate/rs/references/cli-utilities/rladmin/node/enslave.md#node-enslave) with the `demote_node` option: ```sh rladmin node enslave demote_node @@ -78,7 +78,7 @@ To promote a secondary node to become the primary node using the Cluster Manager To promote a secondary node to become the primary node using `rladmin`: -1. To find the IDs of secondary nodes, run [`rladmin status nodes`]({{}}): +1. To find the IDs of secondary nodes, run [`rladmin status nodes`](/content/operate/rs/references/cli-utilities/rladmin/status.md#status-nodes): ```sh $ rladmin status nodes @@ -91,7 +91,7 @@ To promote a secondary node to become the primary node using `rladmin`: Nodes with the `slave` role are secondary nodes. -1. Run [`rladmin cluster master set`]({{}}): +1. Run [`rladmin cluster master set`](/content/operate/rs/references/cli-utilities/rladmin/cluster/master.md): ```sh rladmin cluster master set diff --git a/content/operate/rs/clusters/cluster-recovery.md b/content/operate/rs/clusters/cluster-recovery.md index 52e4cdcb57..6173d1632a 100644 --- a/content/operate/rs/clusters/cluster-recovery.md +++ b/content/operate/rs/clusters/cluster-recovery.md @@ -13,9 +13,8 @@ weight: 70 When a Redis Software cluster fails, you must use the cluster configuration file and database data to recover the cluster. -{{< note >}} -For cluster recovery in a Kubernetes deployment, see [Recover a Redis Enterprise cluster on Kubernetes]({{< relref "/operate/kubernetes/re-clusters/cluster-recovery" >}}). -{{< /note >}} +> [!NOTE] +> For cluster recovery in a Kubernetes deployment, see [Recover a Redis Enterprise cluster on Kubernetes](/content/operate/kubernetes/re-clusters/cluster-recovery.md). Cluster failure can be caused by: @@ -25,7 +24,7 @@ Cluster failure can be caused by: To recover a cluster and re-create it as it was before the failure, you must restore the cluster configuration `ccs-redis.rdb` to the cluster nodes. To recover databases in the new cluster, you must restore the databases from persistence files such as backup files, append-only files (AOF), or RDB snapshots. -These files are stored in the [persistent storage location]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage" >}}). +These files are stored in the [persistent storage location](/content/operate/rs/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage.md). The cluster recovery process includes: @@ -33,7 +32,7 @@ The cluster recovery process includes: 1. Mount the persistent storage with the recovery files from the original cluster to the nodes of the new cluster. 1. Recover the cluster configuration on the first node in the new cluster. 1. Join the remaining nodes to the new cluster. -1. [Recover the databases]({{< relref "/operate/rs/databases/recover.md" >}}). +1. [Recover the databases](/content/operate/rs/databases/recover.md). ## Prerequisites @@ -50,7 +49,7 @@ The cluster recovery process includes: 1. (Optional) If you want to recover the cluster to the original cluster nodes, uninstall Redis Software from the nodes. -1. [Install Redis Software]({{< relref "/operate/rs/installing-upgrading/install/install-on-linux" >}}) on the new cluster nodes. +1. [Install Redis Software](/content/operate/rs/installing-upgrading/install/install-on-linux.md) on the new cluster nodes. The new servers must have the same basic hardware and software configuration as the original servers, including: @@ -59,21 +58,19 @@ The cluster recovery process includes: - The same Redis Software version - The same installation user and paths - {{< note >}} -The cluster recovery can fail if these requirements are not met. - {{< /note >}} + > [!NOTE] + > The cluster recovery can fail if these requirements are not met. 1. Mount the persistent storage drives with the recovery files to the new nodes. These drives must contain the cluster configuration backup files and database persistence files. - {{< note >}} -Make sure that the user redislabs has permissions to access the storage location -of the configuration and persistence files on each of the nodes. - {{< /note >}} + > [!NOTE] + > Make sure that the user redislabs has permissions to access the storage location + > of the configuration and persistence files on each of the nodes. If you use local persistent storage, place all of the recovery files on each of the cluster nodes. -1. To recover the original cluster configuration, run [`rladmin cluster recover`]({{< relref "/operate/rs/references/cli-utilities/rladmin/cluster/recover" >}}) on the first node in the new cluster: +1. To recover the original cluster configuration, run [`rladmin cluster recover`](/content/operate/rs/references/cli-utilities/rladmin/cluster/recover.md) on the first node in the new cluster: ```sh rladmin cluster recover filename [ | ] node_uid rack_id @@ -88,7 +85,7 @@ of the configuration and persistence files on each of the nodes. When the recovery command succeeds, this node is configured as the node from the old cluster that has ID 1. -1. To join the remaining servers to the new cluster, run [`rladmin cluster join`]({{< relref "/operate/rs/references/cli-utilities/rladmin/cluster/join" >}}) from each new node: +1. To join the remaining servers to the new cluster, run [`rladmin cluster join`](/content/operate/rs/references/cli-utilities/rladmin/cluster/join.md) from each new node: ```sh rladmin cluster join nodes username password replace_node @@ -100,15 +97,14 @@ of the configuration and persistence files on each of the nodes. rladmin cluster join nodes 10.142.0.4 username admin@example.com password mysecret replace_node 2 ``` -1. Run [`rladmin status`]({{< relref "/operate/rs/references/cli-utilities/rladmin/status" >}}) to verify the recovered nodes are now active and the databases are pending recovery: +1. Run [`rladmin status`](/content/operate/rs/references/cli-utilities/rladmin/status.md) to verify the recovered nodes are now active and the databases are pending recovery: ```sh rladmin status ``` - {{< note >}} -Make sure that you update your [DNS records]({{< relref "/operate/rs/networking/cluster-dns" >}}) -with the IP addresses of the new nodes. - {{< /note >}} + > [!NOTE] + > Make sure that you update your [DNS records](/content/operate/rs/networking/cluster-dns.md) + > with the IP addresses of the new nodes. -After the cluster is recovered, you must [recover the databases]({{< relref "/operate/rs/databases/recover.md" >}}). +After the cluster is recovered, you must [recover the databases](/content/operate/rs/databases/recover.md). diff --git a/content/operate/rs/clusters/configure/_index.md b/content/operate/rs/clusters/configure/_index.md index 0ecc2811b1..fce145c25b 100644 --- a/content/operate/rs/clusters/configure/_index.md +++ b/content/operate/rs/clusters/configure/_index.md @@ -13,8 +13,8 @@ weight: 50 You can manage your Redis Software clusters with several different tools: - Cluster Manager UI (the web-based user interface) -- Command-line tools ([rladmin]({{< relref "/operate/rs/references/cli-utilities/rladmin" >}}), [redis-cli]({{< relref "/develop/tools/cli" >}}), [crdb-cli]({{< relref "/operate/rs/references/cli-utilities/crdb-cli" >}})) -- [REST API]({{< relref "/operate/rs/references/rest-api/_index.md" >}}) +- Command-line tools ([rladmin](/content/operate/rs/references/cli-utilities/rladmin/_index.md), [redis-cli](/content/develop/tools/cli.md), [crdb-cli](/content/operate/rs/references/cli-utilities/crdb-cli/_index.md)) +- [REST API](/content/operate/rs/references/rest-api/_index.md) diff --git a/content/operate/rs/clusters/configure/call-home.md b/content/operate/rs/clusters/configure/call-home.md index 7acb57f9f2..8637751361 100644 --- a/content/operate/rs/clusters/configure/call-home.md +++ b/content/operate/rs/clusters/configure/call-home.md @@ -54,7 +54,7 @@ The following example shows the data collected hourly for each database: The cluster collects usage data hourly by default. -To change the data collection schedule, [update job scheduler settings]({{}}) for `bdb_usage_report_job_settings` with a REST API request: +To change the data collection schedule, [update job scheduler settings](/content/operate/rs/references/rest-api/requests/job_scheduler/_index.md#put-job-scheduler) for `bdb_usage_report_job_settings` with a REST API request: ```sh PUT /v1/job_scheduler @@ -70,7 +70,7 @@ Replace `cron_expression`'s value with a [`cron` expression](https://en.wikipedi ## Turn off call home client -To stop the call home client from sending daily usage statistics to Redis, [update cluster services configuration]({{}}) for `call_home_agent` with a REST API request: +To stop the call home client from sending daily usage statistics to Redis, [update cluster services configuration](/content/operate/rs/references/rest-api/requests/cluster/services_configuration.md#put-cluster-services_config) for `call_home_agent` with a REST API request: ```sh PUT /v1/cluster/services_configuration diff --git a/content/operate/rs/clusters/configure/cluster-settings.md b/content/operate/rs/clusters/configure/cluster-settings.md index f659d091e6..57fb3a03bd 100644 --- a/content/operate/rs/clusters/configure/cluster-settings.md +++ b/content/operate/rs/clusters/configure/cluster-settings.md @@ -22,7 +22,7 @@ you can upload the cluster license key, either during initial cluster creation or at any time afterward. The license key defines various cluster settings, such as the maximum number of shards you can have in the cluster. For more detailed information see [Cluster license -keys]({{< relref "/operate/rs/clusters/configure/license-keys.md" >}}). +keys](/content/operate/rs/clusters/configure/license-keys.md). ### View max number of allowed shards @@ -43,7 +43,7 @@ You can change the **Time zone** field to ensure the date, time fields, and log The **Alert Settings** tab lets you configure alerts that are relevant to the entire cluster, such as alerts for cluster utilization, nodes, node utilization, security, and database utilization. -You can also configure email server settings and [send alerts by email]({{< relref "/operate/rs/monitoring/v1_monitoring#send-alerts-by-email" >}}) to relevant users. +You can also configure email server settings and [send alerts by email](/content/operate/rs/monitoring/v1_monitoring.md#send-alerts-by-email) to relevant users. ### Configure email server settings diff --git a/content/operate/rs/clusters/configure/license-keys.md b/content/operate/rs/clusters/configure/license-keys.md index e29255b459..c1318d46f8 100644 --- a/content/operate/rs/clusters/configure/license-keys.md +++ b/content/operate/rs/clusters/configure/license-keys.md @@ -21,21 +21,19 @@ Trial mode allows all features to be enabled during the trial period. Trial mode is limited to 30 days and 4 shards, including master and replica shards. A new Redis Software installation starts its 30-day trial period from the day you set up the cluster on the first node. -Trial mode requires a trial license. If you do not provide a license when you create a cluster using the Cluster Manager UI or a [bootstrapping REST API request]({{< relref "/operate/rs/references/rest-api/requests/bootstrap#post-bootstrap" >}}), a trial cluster license is generated by default. +Trial mode requires a trial license. If you do not provide a license when you create a cluster using the Cluster Manager UI or a [bootstrapping REST API request](/content/operate/rs/references/rest-api/requests/bootstrap/_index.md#post-bootstrap), a trial cluster license is generated by default. ## View cluster license key -To view the cluster license key, use a [`GET /v1/license`]({{< relref "/operate/rs/references/rest-api/requests/license#get-license" >}}) REST API request. For a list of returned fields, see the [response section]({{< relref "/operate/rs/references/rest-api/requests/license#get-response" >}}). +To view the cluster license key, use a [`GET /v1/license`](/content/operate/rs/references/rest-api/requests/license/_index.md#get-license) REST API request. For a list of returned fields, see the [response section](/content/operate/rs/references/rest-api/requests/license/_index.md#get-response). -{{}} -As of version 7.2, Redis Software enforces shard limits by shard types, RAM or flash, instead of the total number of shards. The flash shards limit only appears in the UI if Auto Tiering is enabled. -{{}} +> [!NOTE] +> As of version 7.2, Redis Software enforces shard limits by shard types, RAM or flash, instead of the total number of shards. The flash shards limit only appears in the UI if Auto Tiering is enabled. ## Update cluster license -{{< note >}} -After you add a cluster key, you cannot remove the key to return the cluster to trial mode. -{{< /note >}} +> [!NOTE] +> After you add a cluster key, you cannot remove the key to return the cluster to trial mode. You can update the cluster license key: @@ -104,7 +102,7 @@ To change the cluster license alert settings, use one of the following methods: 1. Click **Save**. -- [Update cluster]({{}}) REST API request: +- [Update cluster](/content/operate/rs/references/rest-api/requests/cluster/_index.md#put-cluster) REST API request: The following example changes the cluster license alert to occur 30 days before the cluster license expiration date: @@ -122,7 +120,7 @@ To change the cluster license alert settings, use one of the following methods: ## Monitor cluster license -As of version 7.2, Redis Software exposes the license quotas and the shards consumption metrics in the Cluster Manager UI or via the [Prometheus integration]({{< relref "/integrate/prometheus-with-redis-enterprise/" >}}). +As of version 7.2, Redis Software exposes the license quotas and the shards consumption metrics in the Cluster Manager UI or via the [Prometheus integration](/content/integrate/prometheus-with-redis-enterprise/_index.md). The `cluster_shards_limit` metric displays the total shard limit by shard type. diff --git a/content/operate/rs/clusters/configure/rack-zone-awareness.md b/content/operate/rs/clusters/configure/rack-zone-awareness.md index a83c0db903..61eb5a0d10 100644 --- a/content/operate/rs/clusters/configure/rack-zone-awareness.md +++ b/content/operate/rs/clusters/configure/rack-zone-awareness.md @@ -30,12 +30,11 @@ Rack-zone awareness affects various cluster, node, and database actions, such as The rack-zone ID must comply with the following rules: - Maximum length of 63 characters. -- Characters consist of letters, digits, and hyphens ('-'). Underscores ('_') are also accepted as of Redis Software [6.4.2-61]({{< relref "/operate/rs/release-notes/rs-6-4-2-releases/rs-6-4-2-61" >}}). +- Characters consist of letters, digits, and hyphens ('-'). Underscores ('_') are also accepted as of Redis Software [6.4.2-61](/content/operate/rs/release-notes/rs-6-4-2-releases/rs-6-4-2-61.md). - ID starts with a letter and ends with a letter or a digit. -{{< note >}} -Rack-zone IDs are **case-insensitive** (uppercase and lowercase letter are treated as the same). -{{< /note >}} +> [!NOTE] +> Rack-zone IDs are **case-insensitive** (uppercase and lowercase letter are treated as the same). ## Node layout guidelines @@ -52,15 +51,14 @@ If a Redis Software cluster consists of three nodes (the recommended minimum), f To enable rack-zone awareness, you need to configure it for the cluster, nodes, and [databases](#enable-database-rack-zone-awareness). -{{}} -- After rack-zone awareness is enabled for a cluster, it cannot be turned off. - -- After a rack ID is assigned to a node, it cannot be changed. -{{}} +> [!NOTE] +> - After rack-zone awareness is enabled for a cluster, it cannot be turned off. +> +> - After a rack ID is assigned to a node, it cannot be changed. ### New cluster -You can set up rack-zone awareness for the cluster and its nodes during [cluster creation]({{< relref "/operate/rs/clusters/new-cluster-setup" >}}): +You can set up rack-zone awareness for the cluster and its nodes during [cluster creation](/content/operate/rs/clusters/new-cluster-setup.md): 1. In the **Cluster** screen's **Configuration** section, enable **Rack zone awareness**. @@ -68,22 +66,22 @@ You can set up rack-zone awareness for the cluster and its nodes during [cluster 1. Enter a **Rack-zone ID** for the current node. -1. Finish [cluster setup]({{< relref "/operate/rs/clusters/new-cluster-setup" >}}). +1. Finish [cluster setup](/content/operate/rs/clusters/new-cluster-setup.md). -1. For every [node you add to the cluster]({{< relref "/operate/rs/clusters/add-node" >}}), assign a different **Rack-zone ID**. +1. For every [node you add to the cluster](/content/operate/rs/clusters/add-node.md), assign a different **Rack-zone ID**. ### Existing cluster -If you did not configure rack-zone awareness during cluster creation, you can configure rack-zone awareness for existing clusters using the [REST API]({{< relref "/operate/rs/references/rest-api" >}}): +If you did not configure rack-zone awareness during cluster creation, you can configure rack-zone awareness for existing clusters using the [REST API](/content/operate/rs/references/rest-api/_index.md): -1. For each node in the cluster, assign a different rack-zone ID using the REST API to [update the node]({{< relref "/operate/rs/references/rest-api/requests/nodes#put-node" >}}): +1. For each node in the cluster, assign a different rack-zone ID using the REST API to [update the node](/content/operate/rs/references/rest-api/requests/nodes/_index.md#put-node): ```sh PUT /v1/nodes/ { "rack_id": "rack-zone-ID" } ``` -1. [Update the cluster policy]({{< relref "/operate/rs/references/rest-api/requests/cluster/policy#put-cluster-policy" >}}) to enable rack-zone awareness: +1. [Update the cluster policy](/content/operate/rs/references/rest-api/requests/cluster/policy.md#put-cluster-policy) to enable rack-zone awareness: ```sh PUT /v1/cluster/policy @@ -98,11 +96,11 @@ You can use two-dimensional rack-zone awareness to create logical zones within a ### New clusters -To set up two-dimensional rack-zone awareness during cluster creation, assign a `second_rack_id` to each node in the cluster in addition to the `rack_id` using the [REST API]({{}}) or [rladmin]({{}}). +To set up two-dimensional rack-zone awareness during cluster creation, assign a `second_rack_id` to each node in the cluster in addition to the `rack_id` using the [REST API](/content/operate/rs/references/rest-api/_index.md) or [rladmin](/content/operate/rs/references/cli-utilities/rladmin/_index.md). #### REST API method -To create a new cluster with two-dimensional rack-zone awareness, you can use [bootstrap REST API requests]({{}}): +To create a new cluster with two-dimensional rack-zone awareness, you can use [bootstrap REST API requests](/content/operate/rs/references/rest-api/requests/bootstrap/_index.md#post-bootstrap): 1. Create the new cluster on the first node, set `rack_aware` to `true`, and assign a `rack_id` and `second_rack_id` to the first node: @@ -157,7 +155,7 @@ To create a new cluster with two-dimensional rack-zone awareness, you can use [b To create a new cluster with two-dimensional rack-zone awareness using the command line: -1. Run [`rladmin cluster create`]({{}}) to create the initial cluster on one node, enable rack-zone awareness, and assign a `rack_id` and `second_rack_id`: +1. Run [`rladmin cluster create`](/content/operate/rs/references/cli-utilities/rladmin/cluster/create.md) to create the initial cluster on one node, enable rack-zone awareness, and assign a `rack_id` and `second_rack_id`: ```sh $ rladmin cluster create name \ @@ -168,7 +166,7 @@ To create a new cluster with two-dimensional rack-zone awareness using the comma second_rack_id ``` -1. Run [`rladmin cluster join`]({{}}) for each new node you want to add to the cluster and assign a different `rack_id` and `second_rack_id`: +1. Run [`rladmin cluster join`](/content/operate/rs/references/cli-utilities/rladmin/cluster/join.md) for each new node you want to add to the cluster and assign a different `rack_id` and `second_rack_id`: ```sh $ rladmin cluster join nodes \ @@ -180,9 +178,9 @@ To create a new cluster with two-dimensional rack-zone awareness using the comma ### Existing clusters -You can configure two-dimensional rack-zone awareness for existing clusters using the [REST API]({{< relref "/operate/rs/references/rest-api" >}}). +You can configure two-dimensional rack-zone awareness for existing clusters using the [REST API](/content/operate/rs/references/rest-api/_index.md). -For each node in the cluster, assign a different `second_rack_id` using the REST API to [update the node]({{< relref "/operate/rs/references/rest-api/requests/nodes#put-node" >}}): +For each node in the cluster, assign a different `second_rack_id` using the REST API to [update the node](/content/operate/rs/references/rest-api/requests/nodes/_index.md#put-node): ```sh PUT /v1/nodes/ @@ -196,11 +194,11 @@ Before you can enable rack-zone awareness for a database, you must configure rac -To enable rack-zone awareness for a database, use a [REST API request]({{< relref "/operate/rs/references/rest-api/requests/bdbs#put-bdbs" >}}): +To enable rack-zone awareness for a database, use a [REST API request](/content/operate/rs/references/rest-api/requests/bdbs/_index.md#put-bdbs): ```sh PUT /v1/bdbs/ @@ -224,9 +221,9 @@ PUT /v1/bdbs/ ### Rearrange database shards -After you enable rack-zone awareness for an existing database, you should generate an optimized shard placement blueprint using the [REST API]({{< relref "/operate/rs/references/rest-api" >}}) and use it to rearrange the shards in different racks or zones. +After you enable rack-zone awareness for an existing database, you should generate an optimized shard placement blueprint using the [REST API](/content/operate/rs/references/rest-api/_index.md) and use it to rearrange the shards in different racks or zones. -1. [Generate an optimized shard placement blueprint]({{< relref "/operate/rs/references/rest-api/requests/bdbs/actions/optimize_shards_placement#get-bdbs-actions-optimize-shards-placement" >}}): +1. [Generate an optimized shard placement blueprint](/content/operate/rs/references/rest-api/requests/bdbs/actions/optimize_shards_placement.md#get-bdbs-actions-optimize-shards-placement): 1. Send the following `GET` request: @@ -238,7 +235,7 @@ After you enable rack-zone awareness for an existing database, you should genera 1. Copy the JSON response body, which represents the new shard placement blueprint. -1. [Rearrange the database shards]({{< relref "/operate/rs/references/rest-api/requests/bdbs/actions/optimize_shards_placement#put-bdbs-rearrange-shards" >}}) according to the new shard placement blueprint: +1. [Rearrange the database shards](/content/operate/rs/references/rest-api/requests/bdbs/actions/optimize_shards_placement.md#put-bdbs-rearrange-shards) according to the new shard placement blueprint: 1. In the request headers, include the `cluster-state-id` from the `optimize_shards_placement` response. diff --git a/content/operate/rs/clusters/configure/sch.md b/content/operate/rs/clusters/configure/sch.md index 8eadbc4bdd..ecfb4229c0 100644 --- a/content/operate/rs/clusters/configure/sch.md +++ b/content/operate/rs/clusters/configure/sch.md @@ -11,7 +11,7 @@ weight: 90 --- Smart client handoffs (SCH) is a feature of Redis Cloud and Redis Software servers that lets them actively notify clients about planned server maintenance shortly before it happens. This lets a client reconnect or otherwise respond gracefully without significant interruptions in service. -See [Smart client handoffs]({{< relref "/develop/clients/sch" >}}) for more information about SCH. +See [Smart client handoffs](/content/develop/clients/sch.md) for more information about SCH. SCH is supported for Redis Software from v8.0.2 on, and OSS Cluster API from v8.0.16 on. The degree of support for SCH depends on the specific upgrade method you use, as detailed in the table below. @@ -19,7 +19,7 @@ The degree of support for SCH depends on the specific upgrade method you use, as {{< embed-md "rs-sch-support.md" >}} To enable SCH on a Redis Software server, you must use the -[/v1/cluster]({{< relref "/operate/rs/references/rest-api/requests/cluster#put-cluster" >}}) +[/v1/cluster](/content/operate/rs/references/rest-api/requests/cluster/_index.md#put-cluster) REST API request to set the `client_maint_notifications` option to `true`. The example below shows how to do this using the [`curl`](https://curl.se/) command line utility: diff --git a/content/operate/rs/clusters/configure/sync-clocks.md b/content/operate/rs/clusters/configure/sync-clocks.md index 176e36db05..c5633261b5 100644 --- a/content/operate/rs/clusters/configure/sync-clocks.md +++ b/content/operate/rs/clusters/configure/sync-clocks.md @@ -129,5 +129,5 @@ For more details, refer to the official [RHEL 8 and 9 documentation](https://acc For more details, refer to the official [Amazon Linux 2 documentation](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/set-time.html). -If you are using Active-Active databases, you must use [Network Time Service (ntpd)]({{< relref "/operate/rs/databases/active-active/_index.md#network-time-service-ntp-or-chrony" >}}) +If you are using Active-Active databases, you must use [Network Time Service (ntpd)](/content/operate/rs/databases/active-active/_index.md#network-time-service-ntp-or-chrony) to synchronize OS clocks consistently across clusters to handle conflict resolution according to the OS time. diff --git a/content/operate/rs/clusters/logging/_index.md b/content/operate/rs/clusters/logging/_index.md index 39e053b5f5..b6689b74e0 100644 --- a/content/operate/rs/clusters/logging/_index.md +++ b/content/operate/rs/clusters/logging/_index.md @@ -31,8 +31,8 @@ events regarding alerts, notifications, and configuration. You can use the **Logs** screen to review what actions a user has performed, such as editing a database's configuration. - [Redis slow - log]({{< relref "/operate/rs/clusters/logging/redis-slow-log.md" >}}) -- [rsyslog logging]({{< relref "/operate/rs/clusters/logging/rsyslog-logging/" >}}) + log](/content/operate/rs/clusters/logging/redis-slow-log.md) +- [rsyslog logging](/content/operate/rs/clusters/logging/rsyslog-logging/_index.md) ## View logs in the UI diff --git a/content/operate/rs/clusters/logging/diagnostic-logging.md b/content/operate/rs/clusters/logging/diagnostic-logging.md index cadfa3e7bd..128a2c78f0 100644 --- a/content/operate/rs/clusters/logging/diagnostic-logging.md +++ b/content/operate/rs/clusters/logging/diagnostic-logging.md @@ -18,7 +18,7 @@ Diagnostic logs are collected at scheduled intervals and saved in the `/var/opt/ ## View log collector settings -To view the current log collection schedule and parameters for each log collector, use the REST API to [get the diagnostic logging service configuration]({{}}). +To view the current log collection schedule and parameters for each log collector, use the REST API to [get the diagnostic logging service configuration](/content/operate/rs/references/rest-api/requests/diagnostics/_index.md#get-diagnostics). ```sh GET /v1/diagnostics @@ -73,7 +73,7 @@ Example response: ## Change log collector settings -To change how often a log is collected, set the `cron_expression` when you [update the diagnostic logging service configuration]({{}}) with the REST API. +To change how often a log is collected, set the `cron_expression` when you [update the diagnostic logging service configuration](/content/operate/rs/references/rest-api/requests/diagnostics/_index.md#put-diagnostics) with the REST API. ```sh PUT /v1/diagnostics @@ -102,7 +102,7 @@ PUT /v1/diagnostics ## Turn off log collectors -To turn off a log collector, set its `cron_expression` to an empty string when you [update the diagnostic logging service configuration]({{}}) with the REST API. +To turn off a log collector, set its `cron_expression` to an empty string when you [update the diagnostic logging service configuration](/content/operate/rs/references/rest-api/requests/diagnostics/_index.md#put-diagnostics) with the REST API. ```sh PUT /v1/diagnostics @@ -127,16 +127,16 @@ Default `cron_expression` values: | Log collector | Description | |---------------|-------------| -| bdb | Logs database metadata similar to [`GET /bdbs`]({{}}). Each entry is in JSON format.
Default settings:
{{}}"cron_expression": "*/10 * * * *"{{}} | +| bdb | Logs database metadata similar to [`GET /bdbs`](/content/operate/rs/references/rest-api/requests/bdbs/_index.md). Each entry is in JSON format.
Default settings:
{{}}"cron_expression": "*/10 * * * *"{{}} | | bdb_client_list | Logs database client lists, with a separate file for each database. Each entry is in JSON format.
Default settings:
{{}}"cron_expression": "*/10 * * * *"{{}} | -| bdb_info | Logs the result of running [`INFO ALL`]({{}}) on a database, excluding `commandstats`, with a separate file for each database. Each entry is in JSON format.
Default settings:
{{}}"cron_expression": "*/10 * * * *"{{}} | -| command_stats | Logs [`INFO commandstats`]({{}}) for each database, with a separate file for each database. Each entry is in JSON format.
Default settings:
{{}}"cron_expression": "*/30 * * * *"{{}} | +| bdb_info | Logs the result of running [`INFO ALL`](/content/commands/info.md) on a database, excluding `commandstats`, with a separate file for each database. Each entry is in JSON format.
Default settings:
{{}}"cron_expression": "*/10 * * * *"{{}} | +| command_stats | Logs [`INFO commandstats`](/content/commands/info.md) for each database, with a separate file for each database. Each entry is in JSON format.
Default settings:
{{}}"cron_expression": "*/30 * * * *"{{}} | | network_stats | Logs the node's network statistics.
Default settings:
{{}}"cron_expression": "*/30 * * * *"{{}} | | persistent_files | Lists persistent files from `/var/opt/redislabs/persist/redis`
Default settings:
{{}}"cron_expression": "*/10 * * * *"{{}} | -| rladmin_status | Logs data about nodes, databases, endpoints, and shards from [`rladmin status`]({{}}). Each entry is in JSON format.
Default settings:
{{}}"cron_expression": "*/10 * * * *"{{}} | -| shard | Logs shard status similar to [`GET /shards`]({{}}). Each entry is in JSON format.
Default settings:
{{}}"cron_expression": "*/10 * * * *"{{}} | -| shard_info | Logs the result of running [INFO ALL]({{}}) on a shard, with a separate file for each shard. Each entry is in JSON format.
Default settings:
{{}}"cron_expression": "*/10 * * * *"{{}} | -| shard_latency | Logs the result of running [`latency latest`]({{}}) on a shard, with a separate file for each shard.
Default settings:
{{}}"cron_expression": "*/10 * * * *"{{}} | -| `shard_latency_histogram` | Logs the result of running [`latency histogram`]({{}}) on a shard, with a separate file for each shard.
Default settings:
{{}}"cron_expression": "*/10 * * * *"{{}} | -| slowlog | Logs slow commands from the databases using [`SLOWLOG GET`]({{}}), with a separate file for each database. Each entry is in JSON format. The log is sanitized, only the commands are visible.
Default settings:
{{}}"cron_expression": "*/10 * * * *",
"max_entries": 100{{}} | +| rladmin_status | Logs data about nodes, databases, endpoints, and shards from [`rladmin status`](/content/operate/rs/references/cli-utilities/rladmin/status.md). Each entry is in JSON format.
Default settings:
{{}}"cron_expression": "*/10 * * * *"{{}} | +| shard | Logs shard status similar to [`GET /shards`](/content/operate/rs/references/rest-api/requests/shards/_index.md). Each entry is in JSON format.
Default settings:
{{}}"cron_expression": "*/10 * * * *"{{}} | +| shard_info | Logs the result of running [INFO ALL](/content/commands/info.md) on a shard, with a separate file for each shard. Each entry is in JSON format.
Default settings:
{{}}"cron_expression": "*/10 * * * *"{{}} | +| shard_latency | Logs the result of running [`latency latest`](/content/commands/latency-latest.md) on a shard, with a separate file for each shard.
Default settings:
{{}}"cron_expression": "*/10 * * * *"{{}} | +| `shard_latency_histogram` | Logs the result of running [`latency histogram`](/content/commands/latency-histogram.md) on a shard, with a separate file for each shard.
Default settings:
{{}}"cron_expression": "*/10 * * * *"{{}} | +| slowlog | Logs slow commands from the databases using [`SLOWLOG GET`](/content/commands/slowlog-get.md), with a separate file for each database. Each entry is in JSON format. The log is sanitized, only the commands are visible.
Default settings:
{{}}"cron_expression": "*/10 * * * *",
"max_entries": 100{{}} | | socket_files | Lists socket files used by Redis Software.
Default settings:
{{}}"cron_expression": "*/10 * * * *"{{}} | diff --git a/content/operate/rs/clusters/logging/log-security.md b/content/operate/rs/clusters/logging/log-security.md index 3c9cda3a06..1f083dabdf 100644 --- a/content/operate/rs/clusters/logging/log-security.md +++ b/content/operate/rs/clusters/logging/log-security.md @@ -9,13 +9,13 @@ description: null linktitle: Manage logs weight: 50 --- -Redis Software comes with [a set of logs]({{< relref "/operate/rs/clusters/logging" >}}) on the server and available through the user interface to assist users in investigating actions taken on the server and to troubleshoot issues. +Redis Software comes with [a set of logs](/content/operate/rs/clusters/logging/_index.md) on the server and available through the user interface to assist users in investigating actions taken on the server and to troubleshoot issues. ## Send logs to a remote logging server Redis Software sends logs to syslog by default. You can send these logs to a remote logging server by configuring syslog. -To do this, modify the syslog or rsyslog configuration on your operating system to send logs in the `$logdir` directory (`/var/opt/redislabs/log` in default installations) to a remote monitoring server of your choice. See [rsyslog logging]({{< relref "/operate/rs/clusters/logging/rsyslog-logging/" >}}) for additional details. +To do this, modify the syslog or rsyslog configuration on your operating system to send logs in the `$logdir` directory (`/var/opt/redislabs/log` in default installations) to a remote monitoring server of your choice. See [rsyslog logging](/content/operate/rs/clusters/logging/rsyslog-logging/_index.md) for additional details. ## Log rotation @@ -77,6 +77,5 @@ ${logdir}/cluster_wd.log.long_retention { - `notifempty`: Don't rotate the log file if it is empty. -{{}} -For large scale deployments, you might need to rotate logs at faster intervals than daily. You can also use a cronjob or external vendor solutions. -{{}} +> [!NOTE] +> For large scale deployments, you might need to rotate logs at faster intervals than daily. You can also use a cronjob or external vendor solutions. diff --git a/content/operate/rs/clusters/logging/redis-slow-log.md b/content/operate/rs/clusters/logging/redis-slow-log.md index 857d8c9f98..c51c898df3 100644 --- a/content/operate/rs/clusters/logging/redis-slow-log.md +++ b/content/operate/rs/clusters/logging/redis-slow-log.md @@ -10,7 +10,7 @@ linkTitle: Slow log weight: $weight --- -[Redis slow log]({{}}) is one of the best +[Redis slow log](/content/commands/slowlog.md) is one of the best tools for debugging and tracing your Redis database, especially if you experience high latency and high CPU usage with Redis operations. Because Redis is based on a single threaded architecture, Redis slow log @@ -30,9 +30,9 @@ execution times of the same command, observe spikes in CPU usage, and more. This is especially useful with complex commands such as -[ZUNIONSTORE]({{}}), -[ZINTERSTORE]({{}}), and -[ZRANGEBYSCORE]({{}}). +[ZUNIONSTORE](/content/commands/zunionstore.md), +[ZINTERSTORE](/content/commands/zinterstore.md), and +[ZRANGEBYSCORE](/content/commands/zrangebyscore.md). The enhanced Redis Software slow log adds the **Complexity info** field to the output data. @@ -77,7 +77,7 @@ To view slow log entries for Redis Software databases, use one of the following - Cluster Manager UI: - 1. To access the slow log in the Cluster Manager UI, your [cluster management role]({{}}) must be Admin, Cluster Member, or DB Member. + 1. To access the slow log in the Cluster Manager UI, your [cluster management role](/content/operate/rs/security/access-control/create-cluster-roles.md) must be Admin, Cluster Member, or DB Member. 1. Select a database from the **Databases** list. @@ -85,7 +85,7 @@ To view slow log entries for Redis Software databases, use one of the following - Command line: - Use [`redis-cli`]({{}}) to run [`SLOWLOG GET`]({{}}): + Use [`redis-cli`](/content/operate/rs/references/cli-utilities/redis-cli/_index.md) to run [`SLOWLOG GET`](/content/commands/slowlog-get.md): ```sh redis-cli -h -p SLOWLOG GET @@ -93,15 +93,15 @@ To view slow log entries for Redis Software databases, use one of the following ## Change slow log threshold -The slow log includes all database commands that take longer than ten milliseconds (10,000 microseconds) by default. You can use [`redis-cli`]({{}}) to view or change this threshold. +The slow log includes all database commands that take longer than ten milliseconds (10,000 microseconds) by default. You can use [`redis-cli`](/content/operate/rs/references/cli-utilities/redis-cli/_index.md) to view or change this threshold. -To check the current threshold, run [`CONFIG GET`]({{}}): +To check the current threshold, run [`CONFIG GET`](/content/commands/config-get.md): ```sh redis-cli -h -p CONFIG GET slowlog-log-slower-than ``` -To change the threshold, run [`CONFIG SET`]({{}}): +To change the threshold, run [`CONFIG SET`](/content/commands/config-set.md): ```sh redis-cli -h -p CONFIG SET slowlog-log-slower-than @@ -109,15 +109,15 @@ redis-cli -h -p CONFIG SET slowlog-log-slower-than }}) to view or change the maximum number of entries. +The slow log retains the last 128 entries by default. You can use [`redis-cli`](/content/operate/rs/references/cli-utilities/redis-cli/_index.md) to view or change the maximum number of entries. -To check the current maximum, run [`CONFIG GET`]({{}}): +To check the current maximum, run [`CONFIG GET`](/content/commands/config-get.md): ```sh redis-cli -h -p CONFIG GET slowlog-max-len ``` -To change the maximum, run [`CONFIG SET`]({{}}): +To change the maximum, run [`CONFIG SET`](/content/commands/config-set.md): ```sh redis-cli -h -p CONFIG SET slowlog-max-len diff --git a/content/operate/rs/clusters/logging/rsyslog-logging/_index.md b/content/operate/rs/clusters/logging/rsyslog-logging/_index.md index 62f3203f8f..48121937b7 100644 --- a/content/operate/rs/clusters/logging/rsyslog-logging/_index.md +++ b/content/operate/rs/clusters/logging/rsyslog-logging/_index.md @@ -20,13 +20,13 @@ In some cases, a single action, such as removing a node from the cluster, may ac All log entries displayed in the Cluster Manager UI are also written to `syslog`. You can configure `rsyslog` to monitor `syslog`. Enabled alerts are logged to `syslog` and appear with other log entries. -You can also [manage your logs]({{< relref "/operate/rs/clusters/logging/log-security" >}}) with a remote logging server and log rotation. +You can also [manage your logs](/content/operate/rs/clusters/logging/log-security.md) with a remote logging server and log rotation. ### Types of log entries Log entries are categorized into events and alerts. Both types of entries appear in the logs, but alert log entries also include a boolean `"state"` parameter that indicates whether the alert is enabled or disabled. -Log entries include information about the specific event that occurred. See the log entry tables for [alerts and events]({{< relref "/operate/rs/clusters/logging/alerts-events" >}}) for more details. +Log entries include information about the specific event that occurred. See the log entry tables for [alerts and events](/content/operate/rs/clusters/logging/alerts-events.md) for more details. ### Severity @@ -63,7 +63,7 @@ The log entries have the following basic structure: - **process id­**: The ID of the logging process - **list of key-value pairs in any order**:­ A list of key-value pairs that describe the specific event. They can appear in any order. Some key­-value pairs are always shown, and some appear depending on the specific event. - **Key-­value pairs that always appear:** - - `"type"`: A unique code­ name for the logged event. For the list of codenames, see the [logged alerts and events]({{< relref "/operate/rs/clusters/logging/alerts-events" >}}) tables. + - `"type"`: A unique code­ name for the logged event. For the list of codenames, see the [logged alerts and events](/content/operate/rs/clusters/logging/alerts-events.md) tables. - `"object"`: Defines the object type and ID (if relevant) of the object this event relates to, such as cluster, node with ID, BDB with ID, etc. Has the format of `[:]`. - `"time"`: Unix epoch time but can be ignored in this context. - **Key-­value pairs that might appear depending on the specific entry:** @@ -105,7 +105,7 @@ In this example, the storage utilization on node 1 reached the value of ~90%, wh - `"object":"node:1"`­ - The object related to this alert - `"state":true­` - Current state of the alert - `"time":1434282560­` - Can be ignored -- `"type":"ephemeral_storage"` - The code name of this specific event. See [logged alerts and events]({{< relref "/operate/rs/clusters/logging/alerts-events" >}}) for more details. +- `"type":"ephemeral_storage"` - The code name of this specific event. See [logged alerts and events](/content/operate/rs/clusters/logging/alerts-events.md) for more details. #### "Alert off" log entry sample @@ -135,7 +135,7 @@ This log entry is an example of when the alert for the node with ID 1 "Ephemeral - `"object":"node:1"` -­ The object related to this alert - `"state":false­` - Current state of the alert - `"time":1434283480­` - Can be ignored -- `"type":"ephemeral_storage"` -­ The code name identifier of this specific event. See [logged alerts and events]({{< relref "/operate/rs/clusters/logging/alerts-events" >}}) for more details. +- `"type":"ephemeral_storage"` -­ The code name identifier of this specific event. See [logged alerts and events](/content/operate/rs/clusters/logging/alerts-events.md) for more details. ### Odd number of nodes with a minimum of three nodes alert @@ -165,7 +165,7 @@ This log entry is an example of when the alert for "True high availability requi - `"state":true` -­ Current state of the alert - `"time":1434284700­` - Can be ignored - `"node_count":1­` - The number of nodes in the cluster -- `"type":"even_node_count"­` - The code name identifier of this specific event. See [logged alerts and events]({{< relref "/operate/rs/clusters/logging/alerts-events" >}}) for more details. +- `"type":"even_node_count"­` - The code name identifier of this specific event. See [logged alerts and events](/content/operate/rs/clusters/logging/alerts-events.md) for more details. #### "Alert off" log entry sample @@ -193,7 +193,7 @@ This log entry is an example of when the alert for "True high availability requi - `"state":false­` - Current state of the alert - `"time":1434285200­` - Can be ignored - `"node_count":3­` - The number of nodes in the cluster -- `"type":"even_node_count"` -­ The code name of this specific event. See [logged alerts and events]({{< relref "/operate/rs/clusters/logging/alerts-events" >}}) for more details. +- `"type":"even_node_count"` -­ The code name of this specific event. See [logged alerts and events](/content/operate/rs/clusters/logging/alerts-events.md) for more details. ### Node has insufficient disk space for AOF rewrite @@ -232,7 +232,7 @@ This log entry is an example of when the alert for "Node has insufficient disk s - `"state":true­` - Current state of the alert - `"time":1434365483` -­ Can be ignored - `"disk":705667072­` - The total size in bytes of the persistent storage -- `"type":"insufficient_disk_aofrw"­` - The code name of this specific event. See [logged alerts and events]({{< relref "/operate/rs/clusters/logging/alerts-events" >}}) for more details. +- `"type":"insufficient_disk_aofrw"­` - The code name of this specific event. See [logged alerts and events](/content/operate/rs/clusters/logging/alerts-events.md) for more details. #### "Alert off" log entry sample @@ -265,4 +265,4 @@ daemon.info: Jun 15 13:51:11 node1 event_log[34252]: - `"state":false­` - Current state of the alert - `"time":1434365471­` - Can be ignored - `"disk":705667072­` - The total size in bytes of the persistent storage -- `"type":"insufficient_disk_aofrw"`­ - The code name of this specific event. See [logged alerts and events]({{< relref "/operate/rs/clusters/logging/alerts-events" >}}) for more details. +- `"type":"insufficient_disk_aofrw"`­ - The code name of this specific event. See [logged alerts and events](/content/operate/rs/clusters/logging/alerts-events.md) for more details. diff --git a/content/operate/rs/clusters/maintenance-mode.md b/content/operate/rs/clusters/maintenance-mode.md index e5e4fb187e..d03c88d845 100644 --- a/content/operate/rs/clusters/maintenance-mode.md +++ b/content/operate/rs/clusters/maintenance-mode.md @@ -18,15 +18,14 @@ When you activate maintenance mode, Redis Software does the following: 1. Checks whether the cluster has enough active nodes to maintain quorum if one goes down. If taking a node offline would cause quorum loss, maintenance mode will not activate. - {{}} -This check does not consider if other nodes are already in maintenance mode. Do not put the majority of nodes into maintenance mode and restart them simultaneously, as this can cause the cluster to lose quorum and lead to data loss. - {{}} + > [!WARNING] + > This check does not consider if other nodes are already in maintenance mode. Do not put the majority of nodes into maintenance mode and restart them simultaneously, as this can cause the cluster to lose quorum and lead to data loss. 1. If no maintenance mode snapshots already exist or if you use `overwrite_snapshot` when you activate maintenance mode, Redis Software creates a new node snapshot that records the node's shard and endpoint configuration. 1. Marks the node as a quorum node to prevent shards and endpoints from migrating to it. - At this point, [`rladmin status`]({{< relref "/operate/rs/references/cli-utilities/rladmin/status" >}}) displays the node's shards field in yellow, which indicates that shards cannot migrate to the node. + At this point, [`rladmin status`](/content/operate/rs/references/cli-utilities/rladmin/status.md) displays the node's shards field in yellow, which indicates that shards cannot migrate to the node. {{< image filename="/images/rs/maintenance_mode.png" >}} @@ -104,7 +103,7 @@ By default, a snapshot is required to deactivate maintenance mode. If the snaps ### Specify a snapshot -When you turn off maintenance mode, you can restore the node configuration from a maintenance mode snapshot or any snapshots previously created by [`rladmin node snapshot create`]({{< relref "/operate/rs/references/cli-utilities/rladmin/node/snapshot#node-snapshot-create" >}}). If you do not specify a snapshot, Redis Software uses the latest maintenance mode snapshot by default. +When you turn off maintenance mode, you can restore the node configuration from a maintenance mode snapshot or any snapshots previously created by [`rladmin node snapshot create`](/content/operate/rs/references/cli-utilities/rladmin/node/snapshot.md#node-snapshot-create). If you do not specify a snapshot, Redis Software uses the latest maintenance mode snapshot by default. To get a list of available snapshots, run: @@ -118,10 +117,9 @@ To specify a snapshot when you turn maintenance mode off, run: rladmin node maintenance_mode off snapshot_name ``` -{{}} -If an error occurs when you turn on maintenance mode, the snapshot is not deleted. -When you rerun the command, use the snapshot from the initial attempt since it contains the original state of the node. -{{}} +> [!NOTE] +> If an error occurs when you turn on maintenance mode, the snapshot is not deleted. +> When you rerun the command, use the snapshot from the initial attempt since it contains the original state of the node. ### Skip shard restoration @@ -146,7 +144,7 @@ Use these commands with caution. For best results, contact Support before runni ## Cluster status example -This example shows how the output of [`rladmin status`]({{< relref "/operate/rs/references/cli-utilities/rladmin/status" >}}) changes when you turn on maintenance mode for a node. +This example shows how the output of [`rladmin status`](/content/operate/rs/references/cli-utilities/rladmin/status.md) changes when you turn on maintenance mode for a node. The cluster status before turning on maintenance mode: @@ -183,7 +181,7 @@ Now node 2 has `0/0` shards because shards cannot migrate to it while it is in m ## Maintenance mode REST API -You can also turn maintenance mode on or off using [REST API requests]({{< relref "/operate/rs/references/rest-api" >}}) to [POST `/nodes/{node_uid}/actions/{action}`]({{< relref "/operate/rs/references/rest-api/requests/nodes/actions#post-node-action" >}}). +You can also turn maintenance mode on or off using [REST API requests](/content/operate/rs/references/rest-api/_index.md) to [POST `/nodes/{node_uid}/actions/{action}`](/content/operate/rs/references/rest-api/requests/nodes/actions.md#post-node-action). ### Activate maintenance mode (REST API) @@ -231,7 +229,7 @@ The `maintenance_off` request returns a JSON response body: ### Track action status -You can send a request to [GET `/nodes/{node_uid}/actions/{action}`]({{< relref "/operate/rs/references/rest-api/requests/nodes/actions#get-node-action" >}}) to track the [status]({{< relref "/operate/rs/references/rest-api/objects/action" >}}) of the `maintenance_on` and `maintenance_off` actions. +You can send a request to [GET `/nodes/{node_uid}/actions/{action}`](/content/operate/rs/references/rest-api/requests/nodes/actions.md#get-node-action) to track the [status](/content/operate/rs/references/rest-api/objects/action.md) of the `maintenance_on` and `maintenance_off` actions. This request returns the status of the `maintenance_on` action: diff --git a/content/operate/rs/clusters/new-cluster-setup.md b/content/operate/rs/clusters/new-cluster-setup.md index 4b89f04625..c8c4b5071f 100644 --- a/content/operate/rs/clusters/new-cluster-setup.md +++ b/content/operate/rs/clusters/new-cluster-setup.md @@ -12,24 +12,22 @@ weight: 10 A Redis Software cluster typically consists of several nodes. For production deployments, we recommend an uneven number of nodes, with a minimum of three. -{{< note >}} -In a cluster that consists of only one node, some features and capabilities are not enabled, -such as database replication that provides high availability. -{{< /note >}} +> [!NOTE] +> In a cluster that consists of only one node, some features and capabilities are not enabled, +> such as database replication that provides high availability. -To set up a new cluster, you must first [install the Redis Software package]({{< relref "/operate/rs/installing-upgrading" >}}) +To set up a new cluster, you must first [install the Redis Software package](/content/operate/rs/installing-upgrading/_index.md) and then set up the cluster as described below. -After the cluster is created you can [add multiple nodes to the cluster]({{< relref "/operate/rs/clusters/add-node.md" >}}). +After the cluster is created you can [add multiple nodes to the cluster](/content/operate/rs/clusters/add-node.md). To create a cluster: 1. In a browser, go to `https://:8443`. For example, if you installed Redis Software on a machine with IP address 10.0.1.34, go to . - {{< note >}} -- The management UI uses a [self-signed certificate for TLS encryption]({{< relref "/operate/rs/security/certificates/updating-certificates" >}}). -- If the machine has both an internal IP address and an external IP address, use the external IP address to access the setup UI. - {{< /note >}} + > [!NOTE] + > - The management UI uses a [self-signed certificate for TLS encryption](/content/operate/rs/security/certificates/updating-certificates.md). + > - If the machine has both an internal IP address and an external IP address, use the external IP address to access the setup UI. 1. Select **Create new cluster**. @@ -41,26 +39,26 @@ To create a cluster: 1. For **FQDN (Fully Qualified Domain Name)**, enter a unique name for the cluster. - See the [instructions for DNS setup]({{< relref "/operate/rs/networking/cluster-dns" >}}) + See the [instructions for DNS setup](/content/operate/rs/networking/cluster-dns.md) to make sure your cluster is reachable by name. - 1. Choose whether to [**Enable private & public endpoints support**]({{< relref "/operate/rs/networking/private-public-endpoints.md" >}}). + 1. Choose whether to [**Enable private & public endpoints support**](/content/operate/rs/networking/private-public-endpoints.md). - 1. Choose whether to [**Enable rack-zone awareness**]({{< relref "/operate/rs/clusters/configure/rack-zone-awareness.md" >}}). + 1. Choose whether to [**Enable rack-zone awareness**](/content/operate/rs/clusters/configure/rack-zone-awareness.md). 1. Click **Next**. 1. Configure storage and network settings: - 1. Enter a path for [*Ephemeral storage*]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage" >}}), or leave the default path. + 1. Enter a path for [*Ephemeral storage*](/content/operate/rs/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage.md), or leave the default path. - 1. Enter a path for [*Persistent storage*]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage" >}}), + 1. Enter a path for [*Persistent storage*](/content/operate/rs/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage.md), or leave the default path. - 1. To enable [*Redis Flex or Auto Tiering*]({{< relref "/operate/rs/databases/flash/" >}}), + 1. To enable [*Redis Flex or Auto Tiering*](/content/operate/rs/databases/flash/_index.md), select **Enable flash storage** and enter the path to the flash storage. - 1. If the cluster is configured to support [rack-zone awareness]({{< relref "/operate/rs/clusters/configure/rack-zone-awareness.md" >}}), set the **Rack-zone ID** for the new node. + 1. If the cluster is configured to support [rack-zone awareness](/content/operate/rs/clusters/configure/rack-zone-awareness.md), set the **Rack-zone ID** for the new node. 1. If your machine has multiple IP addresses, assign a single IPv4 type address for **Node-to-node communication (internal traffic)** and multiple IPv4/IPv6 type addresses for **External traffic**. @@ -73,5 +71,5 @@ After a short wait, your cluster is created and you can sign in to the Cluster M You can now access any of the management capabilities, including: -- [Creating a new database]({{< relref "/operate/rs/databases/create.md" >}}) -- [Joining a new node to a cluster]({{< relref "/operate/rs/clusters/add-node.md" >}}) +- [Creating a new database](/content/operate/rs/databases/create.md) +- [Joining a new node to a cluster](/content/operate/rs/clusters/add-node.md) diff --git a/content/operate/rs/clusters/optimize/disk-sizing-heavy-write-scenarios.md b/content/operate/rs/clusters/optimize/disk-sizing-heavy-write-scenarios.md index 77f1c8f531..280a9985ba 100644 --- a/content/operate/rs/clusters/optimize/disk-sizing-heavy-write-scenarios.md +++ b/content/operate/rs/clusters/optimize/disk-sizing-heavy-write-scenarios.md @@ -10,9 +10,9 @@ description: Sizing considerations for persistent disk space for heavy throughpu linktitle: Disk sizing weight: $weight --- -In extreme write scenarios when append-only files (AOF) are enabled, the AOF rewrite process can require considerably more disk space for [database persistence]({{}}). +In extreme write scenarios when append-only files (AOF) are enabled, the AOF rewrite process can require considerably more disk space for [database persistence](/content/operate/rs/databases/configure/database-persistence.md). -For disk size requirements for standard usage, see [Hardware requirements]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/hardware-requirements" >}}). +For disk size requirements for standard usage, see [Hardware requirements](/content/operate/rs/installing-upgrading/install/plan-deployment/hardware-requirements.md). ## Estimate required disk space diff --git a/content/operate/rs/clusters/optimize/memtier-benchmark.md b/content/operate/rs/clusters/optimize/memtier-benchmark.md index 13b67db97b..b97d93333f 100644 --- a/content/operate/rs/clusters/optimize/memtier-benchmark.md +++ b/content/operate/rs/clusters/optimize/memtier-benchmark.md @@ -19,7 +19,7 @@ Prerequisites: - A cluster configured - A database created -For help with the prerequisites, see the [Redis Software quickstart]({{< relref "/operate/rs/installing-upgrading/quickstarts/redis-enterprise-software-quickstart" >}}). +For help with the prerequisites, see the [Redis Software quickstart](/content/operate/rs/installing-upgrading/quickstarts/redis-enterprise-software-quickstart.md). It is recommended to run memtier_benchmark on a separate node that is not part of the cluster being tested. If you run it on a node of the diff --git a/content/operate/rs/clusters/optimize/optimization.md b/content/operate/rs/clusters/optimize/optimization.md index ce596402f2..54e11e80fc 100644 --- a/content/operate/rs/clusters/optimize/optimization.md +++ b/content/operate/rs/clusters/optimize/optimization.md @@ -35,7 +35,7 @@ configuration. ## Change failure detection sensitivity -To change the cluster's `failure_detection_sensitivity`, run one of the following [`rladmin`]({{< relref "/operate/rs/references/cli-utilities/rladmin/tune#tune-cluster" >}}) commands. +To change the cluster's `failure_detection_sensitivity`, run one of the following [`rladmin`](/content/operate/rs/references/cli-utilities/rladmin/tune.md#tune-cluster) commands. - For Redis Software version 6.4.2-69 and later, run: diff --git a/content/operate/rs/clusters/optimize/oss-cluster-api.md b/content/operate/rs/clusters/optimize/oss-cluster-api.md index cd938d1ed0..62c86e92d6 100644 --- a/content/operate/rs/clusters/optimize/oss-cluster-api.md +++ b/content/operate/rs/clusters/optimize/oss-cluster-api.md @@ -17,8 +17,8 @@ You can use the Redis OSS Cluster API along with other Redis Enterprise Software to get high performance with low latency and let applications stay current with cluster topology changes, including add node, remove node, and node failover. -For more about working with the OSS Cluster API in Redis Software, see [Enable OSS Cluster API]({{< relref "/operate/rs/databases/configure/oss-cluster-api" >}}). +For more about working with the OSS Cluster API in Redis Software, see [Enable OSS Cluster API](/content/operate/rs/databases/configure/oss-cluster-api.md). -To learn how to enable OSS Cluster API in Redis Cloud, see [Clustering Redis databases]({{< relref "/operate/rc/databases/configuration/clustering#cluster-api" >}}). +To learn how to enable OSS Cluster API in Redis Cloud, see [Clustering Redis databases](/content/operate/rc/databases/configuration/clustering.md#cluster-api). -To enable OSS Cluster API in Kubernetes, see [Enable cluster-aware clients (OSS Cluster API)]({{< relref "/operate/kubernetes/networking/cluster-aware-clients" >}}). +To enable OSS Cluster API in Kubernetes, see [Enable cluster-aware clients (OSS Cluster API)](/content/operate/kubernetes/networking/cluster-aware-clients.md). diff --git a/content/operate/rs/clusters/optimize/turn-off-services.md b/content/operate/rs/clusters/optimize/turn-off-services.md index 31ecee64ab..41b3a5b85c 100644 --- a/content/operate/rs/clusters/optimize/turn-off-services.md +++ b/content/operate/rs/clusters/optimize/turn-off-services.md @@ -21,9 +21,9 @@ The services that you can turn off are: - RS Admin Console - `cm_server` - Logs in CSV format - `stats_archiver` -- [LDAP authentication]({{< relref "/operate/rs/security/access-control/ldap" >}}) - `saslauthd` -- [Discovery service]({{< relref "/operate/rs/networking/cluster-dns.md" >}})- `mdns_server`, `pdns_server` -- [Active-Active databases]({{< relref "/operate/rs/databases/active-active" >}}) - `crdb_coordinator`, `crdb_worker` +- [LDAP authentication](/content/operate/rs/security/access-control/ldap/_index.md) - `saslauthd` +- [Discovery service](/content/operate/rs/networking/cluster-dns.md)- `mdns_server`, `pdns_server` +- [Active-Active databases](/content/operate/rs/databases/active-active/_index.md) - `crdb_coordinator`, `crdb_worker` - Alert Manager - `alert_mgr` (For best results, disable only if you have an alternate alert system.) To turn off a service with the `rladmin cluster config` command, use the `services` parameter and the name of the service, followed by `disabled`. @@ -32,7 +32,7 @@ To turn off a service with the `rladmin cluster config` command, use the `servic [ services ] ``` -To turn off a service with the API, use the [`PUT /v1/services_configuration`]({{< relref "/operate/rs/references/rest-api/requests/cluster/services_configuration#put-cluster-services_config" >}}) endpoint +To turn off a service with the API, use the [`PUT /v1/services_configuration`](/content/operate/rs/references/rest-api/requests/cluster/services_configuration.md#put-cluster-services_config) endpoint with the name of the service and the operating mode (enabled/disabled) in JSON format. For example: diff --git a/content/operate/rs/clusters/optimize/wait.md b/content/operate/rs/clusters/optimize/wait.md index 2ace345177..6e0a719d59 100644 --- a/content/operate/rs/clusters/optimize/wait.md +++ b/content/operate/rs/clusters/optimize/wait.md @@ -12,7 +12,7 @@ weight: $weight --- Redis Software comes with the ability to replicate data to another replica for high availability and persist in-memory data on -disk permanently for durability. With the [`WAIT`]({{}}) command, you can +disk permanently for durability. With the [`WAIT`](/content/commands/wait.md) command, you can control the consistency and durability guarantees for the replicated and persisted database. @@ -35,7 +35,7 @@ acknowledged within the replica. These are steps 7 and 8. ## Blocking write operation on replication -With the [`WAIT`]({{}}) or [`WAITAOF`]({{}}) commands, applications can ask to wait for +With the [`WAIT`](/content/commands/wait.md) or [`WAITAOF`](/content/commands/waitaof.md) commands, applications can ask to wait for acknowledgments only after replication or persistence is confirmed on the replica. The flow of a write operation with `WAIT` or `WAITAOF` is: @@ -51,4 +51,4 @@ The application only gets the acknowledgment from the write after durability is The `WAIT` command always returns the number of replicas that acknowledged the write commands sent by the current client before the `WAIT` command, both in the case where the specified number of replicas are reached, or when the timeout is reached. In Redis Software, the number of replicas is always 1 for databases with high availability enabled. -See the [`WAITAOF`]({{}}) command for details for enhanced data safety and durability capabilities introduced with Redis 7.2. +See the [`WAITAOF`](/content/commands/waitaof.md) command for details for enhanced data safety and durability capabilities introduced with Redis 7.2. diff --git a/content/operate/rs/clusters/quorum-node.md b/content/operate/rs/clusters/quorum-node.md index 74f9f98ec4..24c2bfe5c1 100644 --- a/content/operate/rs/clusters/quorum-node.md +++ b/content/operate/rs/clusters/quorum-node.md @@ -12,11 +12,11 @@ weight: 30 Clusters require an odd number of nodes to maintain [quorum](https://en.wikipedia.org/wiki/Quorum_(distributed_computing)) and avoid [split-brain](https://en.wikipedia.org/wiki/Split-brain_(computing)) scenarios when making decisions. If you need to add another node to a cluster for quorum but want to provision fewer resources and reduce infrastructure costs, you can set up a quorum node instead of a regular node. -Quorum nodes participate in cluster quorum decisions and can act as a tiebreaker. However, they do not host database shards or endpoints, which reduces their resource requirements. A quorum node should have at least 2 cores and 8 GB of RAM. See the [hardware requirements]({{}}) for more details and considerations. +Quorum nodes participate in cluster quorum decisions and can act as a tiebreaker. However, they do not host database shards or endpoints, which reduces their resource requirements. A quorum node should have at least 2 cores and 8 GB of RAM. See the [hardware requirements](/content/operate/rs/installing-upgrading/install/plan-deployment/hardware-requirements.md) for more details and considerations. ## Enable quorum_only setting -1. Run [`rladmin status nodes`]({{}}) and find a node with no shards. +1. Run [`rladmin status nodes`](/content/operate/rs/references/cli-utilities/rladmin/status.md#status-nodes) and find a node with no shards. In the following example, nodes without shards have `0/100` for the `SHARDS` column. @@ -29,7 +29,7 @@ Quorum nodes participate in cluster quorum decisions and can act as a tiebreaker *node:3 slave 203.0.113.0 fc7a3d332458 0/100 2 6.45GB/7.79GB 4.93GB/6.39GB 7.8.6-36 OK ``` -2. Enable `quorum_only` for the node using [`rladmin tune node`]({{}}): +2. Enable `quorum_only` for the node using [`rladmin tune node`](/content/operate/rs/references/cli-utilities/rladmin/tune.md#tune-node): ```bash $ rladmin tune node quorum_only enabled ``` diff --git a/content/operate/rs/clusters/remove-node.md b/content/operate/rs/clusters/remove-node.md index b68ec69060..a108960801 100644 --- a/content/operate/rs/clusters/remove-node.md +++ b/content/operate/rs/clusters/remove-node.md @@ -15,12 +15,11 @@ You might want to remove a node from a Redis Software cluster for one of the fol - To [replace a faulty node](#replace-a-faulty-node) with a healthy node. - To [replace a healthy node](#replace-a-healthy-node) with a different node. -You can configure [email alerts from the cluster]({{< relref "/operate/rs/monitoring/v1_monitoring#cluster-alerts" >}}) to notify you of cluster changes, including when a node is removed. +You can configure [email alerts from the cluster](/content/operate/rs/monitoring/v1_monitoring.md#cluster-alerts) to notify you of cluster changes, including when a node is removed. -{{}} -Read through these explanations thoroughly before taking -any action. -{{}} +> [!WARNING] +> Read through these explanations thoroughly before taking +> any action. ## Permanently remove a node @@ -50,7 +49,7 @@ existence of a faulty node and automatically replaces the faulty node with the new node. For guidelines, refer to [Replacing a faulty -node]({{< relref "/operate/rs/clusters/replace-node.md" >}}). +node](/content/operate/rs/clusters/replace-node.md). ## Replace a healthy node @@ -59,15 +58,14 @@ must first add the new node to the cluster, migrate all the resources from the node you would like to remove, and only then remove the node. For further guidance, refer to [adding a new node to a -cluster]({{< relref "/operate/rs/clusters/add-node.md" >}}). +cluster](/content/operate/rs/clusters/add-node.md). You can migrate resources by using the `rladmin` command-line interface (CLI). For guidelines, refer to [`rladmin` command-line interface -(CLI)]({{< relref "/operate/rs/references/cli-utilities/rladmin" >}}). +(CLI)](/content/operate/rs/references/cli-utilities/rladmin/_index.md). -{{< note >}} -The [DNS records]({{< relref "/operate/rs/networking/cluster-dns" >}}) must be updated each time a node is added or replaced. -{{< /note >}} +> [!NOTE] +> The [DNS records](/content/operate/rs/networking/cluster-dns.md) must be updated each time a node is added or replaced. ## Remove a node @@ -89,15 +87,14 @@ To remove a node using the Cluster Manager UI: Redis Software examines the node and the cluster, then takes the actions required to remove the node, such as migrating shards to other nodes. After the process finishes, the node is no longer shown in the UI. - {{}} -At any point, you can click the **Cancel removal** button to stop the process. When cancelled, the current internal action is completed, and then the process stops. - {{}} + > [!NOTE] + > At any point, you can click the **Cancel removal** button to stop the process. When cancelled, the current internal action is completed, and then the process stops. -To remove a node using the REST API, use [`POST /v1/nodes//actions/remove`]({{< relref "/operate/rs/references/rest-api/requests/nodes/actions#post-node-action" >}}). +To remove a node using the REST API, use [`POST /v1/nodes//actions/remove`](/content/operate/rs/references/rest-api/requests/nodes/actions.md#post-node-action). By default, the remove node action completes after all resources migrate off the removed node. Node removal does not wait for migrated shards' persistence files to be created on the new nodes. -To change node removal to wait for the creation of new persistence files for all migrated shards, set `wait_for_persistence` to `true` in the request body or [update the cluster policy]({{}}) `persistent_node_removal` to `true` to change the cluster's default behavior. +To change node removal to wait for the creation of new persistence files for all migrated shards, set `wait_for_persistence` to `true` in the request body or [update the cluster policy](/content/operate/rs/references/rest-api/requests/cluster/policy.md#put-cluster-policy) `persistent_node_removal` to `true` to change the cluster's default behavior. For example: @@ -108,8 +105,7 @@ POST https://:9443/v1/nodes//actions/remove } ``` -{{< note >}} -If you need to add a removed node back to the cluster, -you must [uninstall]({{< relref "/operate/rs/installing-upgrading/uninstalling.md" >}}) -and [reinstall]({{< relref "/operate/rs/installing-upgrading" >}}) the software on that node. -{{< /note >}} +> [!NOTE] +> If you need to add a removed node back to the cluster, +> you must [uninstall](/content/operate/rs/installing-upgrading/uninstalling.md) +> and [reinstall](/content/operate/rs/installing-upgrading/_index.md) the software on that node. diff --git a/content/operate/rs/clusters/replace-node.md b/content/operate/rs/clusters/replace-node.md index 002557743d..dba7796803 100644 --- a/content/operate/rs/clusters/replace-node.md +++ b/content/operate/rs/clusters/replace-node.md @@ -16,13 +16,12 @@ To replace a failed node: 1. Prepare a new node identical to the old one. 1. Install and - configure Redis Software on the node. See [Install and setup]({{< relref "/operate/rs/installing-upgrading" >}}) for more information. + configure Redis Software on the node. See [Install and setup](/content/operate/rs/installing-upgrading/_index.md) for more information. - {{< note >}} -If you are using [Redis Flex or Auto Tiering]({{< relref "/operate/rs/databases/flash/" >}}), make sure the required flash storage is set up on this new node. - {{< /note >}} + > [!NOTE] + > If you are using [Redis Flex or Auto Tiering](/content/operate/rs/databases/flash/_index.md), make sure the required flash storage is set up on this new node. -1. [Add the node]({{< relref "/operate/rs/clusters/add-node" >}}) to the cluster. Make sure the new node has as much available memory as the faulty +1. [Add the node](/content/operate/rs/clusters/add-node.md) to the cluster. Make sure the new node has as much available memory as the faulty node. If the new node does not have enough memory, you will be prompted to add a node with enough memory. @@ -30,8 +29,7 @@ If you are using [Redis Flex or Auto Tiering]({{< relref "/operate/rs/databases/ 1. A message will appear informing you that the cluster has a faulty node and that the new node will replace the faulty node. - {{< note >}} -- If there is a faulty node in the cluster to which you are adding a node, Redis Software will use the new node to replace the faulty one. -- Any existing [DNS records]({{< relref "/operate/rs/networking/cluster-dns" >}}) must be updated -each time a node is added or replaced. - {{< /note >}} + > [!NOTE] + > - If there is a faulty node in the cluster to which you are adding a node, Redis Software will use the new node to replace the faulty one. + > - Any existing [DNS records](/content/operate/rs/networking/cluster-dns.md) must be updated + > each time a node is added or replaced. diff --git a/content/operate/rs/new-features-redis-enterprise.md b/content/operate/rs/new-features-redis-enterprise.md index b49824c20f..ed852b60f2 100644 --- a/content/operate/rs/new-features-redis-enterprise.md +++ b/content/operate/rs/new-features-redis-enterprise.md @@ -26,7 +26,7 @@ provide smart and automatic conflict resolution based on the data type's intent. For more information, go here. For information, go to [Developing with -Active-Active databases]({{< relref "/operate/rs/developing/crdbs" >}}). +Active-Active databases](/operate/rs/developing/crdbs). ## Redis modules @@ -40,17 +40,17 @@ Enterprise is known for. Redis developed and certified these modules for use with Redis Enterprise Software: -- [RedisBloom]({{< relref "/operate/modules/redisbloom" >}}) +- [RedisBloom](/operate/modules/redisbloom) - Enables Redis to have a scalable bloom filter as a data type. Bloom filters are probabilistic data structures that quickly determine if something is contained within a set. - RedisGraph - RedisGraph is the first queryable Property Graph database to use sparse matrices to represent the adjacency matrix in graphs and linear algebra to query the graph. RedisGraph uses [Cypher](https://www.opencypher.org/) as its query language. -- [RedisJSON]({{< relref "/operate/modules/redisjson" >}}) +- [RedisJSON](/operate/modules/redisjson) - Now you have the convenience JSON as a built-in data type and easily able to address nested data via a path. -- [RediSearch]({{< relref "/operate/modules/redisearch" >}}) +- [RediSearch](/operate/modules/redisearch) - This module turns Redis into a distributed in-memory full-text indexing and search beast. @@ -69,7 +69,7 @@ easily and quickly test several containers to build the scalable and highly available cluster Redis Enterprise Software is famous for. For more information go to [quick start with Redis Enterprise Software -on Docker.]({{< relref "/operate/rs/installing-upgrading/get-started-docker.md" >}}) +on Docker.](/operate/rs/installing-upgrading/get-started-docker.md) ## LDAP integration @@ -80,4 +80,4 @@ accounts can be used for administering resources on the cluster via command line, Rest API, or admin console. For more information see [LDAP -Integration]({{< relref "/operate/rs/security/passwords-users-roles.md#setting-up-ldap" >}}). +Integration](/operate/rs/security/passwords-users-roles.md#setting-up-ldap). diff --git a/content/operate/rs/troubleshooting.md b/content/operate/rs/troubleshooting.md index f25cae606b..49c21fe92b 100644 --- a/content/operate/rs/troubleshooting.md +++ b/content/operate/rs/troubleshooting.md @@ -14,27 +14,27 @@ weight: 75 For general troubleshooting, see: -- [Create a support package]({{}}) to gather information about the cluster, nodes, and databases to help debug issues +- [Create a support package](/content/operate/rs/installing-upgrading/creating-support-package.md) to gather information about the cluster, nodes, and databases to help debug issues -- [Logging]({{}}) +- [Logging](/content/operate/rs/clusters/logging/_index.md) -- [`rladmin status`]({{}}) command, which displays the current status of nodes, databases, database endpoints, and shards on the cluster +- [`rladmin status`](/content/operate/rs/references/cli-utilities/rladmin/status.md) command, which displays the current status of nodes, databases, database endpoints, and shards on the cluster -- [`rlcheck`]({{}}) utility, which runs various tests to check node health and reports any discovered issues +- [`rlcheck`](/content/operate/rs/references/cli-utilities/rlcheck/_index.md) utility, which runs various tests to check node health and reports any discovered issues -- [Troubleshooting pocket guide]({{}}) +- [Troubleshooting pocket guide](/content/operate/rs/databases/connect/troubleshooting-guide.md) ## Troubleshooting by topic For troubleshooting specific issues, see: -- [Database connectivity troubleshooting]({{}}) +- [Database connectivity troubleshooting](/content/operate/rs/databases/connect/troubleshooting-guide.md#troubleshoot-connectivity) -- [Latency troubleshooting]({{}}) +- [Latency troubleshooting](/content/operate/rs/databases/connect/troubleshooting-guide.md#troubleshoot-latency) -- [Replica Of repeatedly fails]({{}}) +- [Replica Of repeatedly fails](/content/operate/rs/databases/import-export/replica-of/replicaof-repeatedly-fails.md) -- CRDT [INFO]({{}}) for troubleshooting Active-Active databases +- CRDT [INFO](/content/operate/rs/databases/active-active/develop/develop-for-aa.md#info) for troubleshooting Active-Active databases ## Knowledge base