diff --git a/.github/workflows/main-staging.yml b/.github/workflows/main-staging.yml index bb4c7fbe1e..911f7269a9 100644 --- a/.github/workflows/main-staging.yml +++ b/.github/workflows/main-staging.yml @@ -87,8 +87,12 @@ jobs: rm -r "content/operate/kubernetes/${version_to_remove}" done - cp -r "content/operate/kubernetes/${version}"/* content/operate/kubernetes/ - rm -r "content/operate/kubernetes/${version}" + # relrefs should not include version + find "content/operate/kubernetes/${version}" -type f | while read file; do + awk '{gsub(/\(\{\{< relref "\/operate\/kubernetes\/'${version}'/, "({{< relref \"/operate/kubernetes") }1' "$file" > tmpfile && mv tmpfile "$file" + done + + rsync -a --delete-after "content/operate/kubernetes/${version}"/ content/operate/kubernetes/ sed -i 's/id="versionSelectorKubernetesValue" class="version-selector-control">latest/id="versionSelectorKubernetesValue" class="version-selector-control">v'"${version}"'/' layouts/partials/docs-nav.html sed -i 's/linkTitle: '"${version}"'/linkTitle: Redis for Kubernetes/' content/operate/kubernetes/_index.md @@ -110,8 +114,12 @@ jobs: rm -r "content/operate/rs/${version_to_remove}" done - cp -r "content/operate/rs/${version}"/* content/operate/rs/ - rm -r "content/operate/rs/${version}" + # relrefs should not include version + find "content/operate/rs/${version}" -type f | while read file; do + awk '{gsub(/\(\{\{< relref "\/operate\/rs\/'${version}'/, "({{< relref \"/operate/rs") }1' "$file" > tmpfile && mv tmpfile "$file" + done + + rsync -a --delete-after "content/operate/rs/${version}"/ content/operate/rs/ sed -i 's/id="versionSelectorRsValue" class="version-selector-control">latest/id="versionSelectorRsValue" class="version-selector-control">v'"${version}"'/' layouts/partials/docs-nav.html sed -i 's/linkTitle: '"${version}"'/linkTitle: Redis Software/' content/operate/rs/_index.md @@ -133,8 +141,12 @@ jobs: rm -r "content/integrate/redis-data-integration/${version_to_remove}" done - cp -r "content/integrate/redis-data-integration/${version}"/* content/integrate/redis-data-integration/ - rm -r "content/integrate/redis-data-integration/${version}" + # relrefs should not include version + find "content/operate/redis-data-integration/${version}" -type f | while read file; do + awk '{gsub(/\(\{\{< relref "\/operate\/redis-data-integration\/'${version}'/, "({{< relref \"/operate/redis-data-integration") }1' "$file" > tmpfile && mv tmpfile "$file" + done + + rsync -a --delete-after "content/operate/redis-data-integration/${version}"/ content/operate/redis-data-integration/ sed -i 's/id="versionSelectorRedis-Data-IntegrationValue" class="version-selector-control">latest/id="versionSelectorRedis-Data-IntegrationValue" class="version-selector-control">v'"${version}"'/' layouts/partials/docs-nav.html sed -i 's/linkTitle: '"${version}"'/linkTitle: Redis Data Integration/' content/integrate/redis-data-integration/_index.md @@ -181,9 +193,9 @@ jobs: for versioned_build in "${versioned_builds[@]}"; do product=$(awk 'BEGIN{FS=OFS="-"}{NF--; print}' <<< $versioned_build) if [[ "${product}" == "redis-data-integration" ]]; then - gsutil -m rsync -r -c -j html -d "${{ github.workspace }}/${versioned_build}/integrate/${product}" "gs://${BUCKET}/${versioned_build}/integrate/${product}" + gsutil -m rsync -r -c -j html -d "${{ github.workspace }}/${versioned_build}/integrate/${product}/" "gs://${BUCKET}/${bucket_path}/${versioned_build}/integrate/${product}" else - gsutil -m rsync -r -c -j html -d "${{ github.workspace }}/${versioned_build}/operate/${product}" "gs://${BUCKET}/${versioned_build}/operate/${product}" + gsutil -m rsync -r -c -j html -d "${{ github.workspace }}/${versioned_build}/operate/${product}/" "gs://${BUCKET}/${bucket_path}/${versioned_build}/operate/${product}" fi done diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index b1aace0cb5..b653332eec 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -87,8 +87,12 @@ jobs: rm -r "content/operate/kubernetes/${version_to_remove}" done - cp -r "content/operate/kubernetes/${version}"/* content/operate/kubernetes/ - rm -r "content/operate/kubernetes/${version}" + # relrefs should not include version + find "content/operate/kubernetes/${version}" -type f | while read file; do + awk '{gsub(/\(\{\{< relref "\/operate\/kubernetes\/'${version}'/, "({{< relref \"/operate/kubernetes") }1' "$file" > tmpfile && mv tmpfile "$file" + done + + rsync -a --delete-after "content/operate/kubernetes/${version}"/ content/operate/kubernetes/ sed -i 's/id="versionSelectorKubernetesValue" class="version-selector-control">latest/id="versionSelectorKubernetesValue" class="version-selector-control">v'"${version}"'/' layouts/partials/docs-nav.html sed -i 's/linkTitle: '"${version}"'/linkTitle: Redis for Kubernetes/' content/operate/kubernetes/_index.md @@ -110,8 +114,12 @@ jobs: rm -r "content/operate/rs/${version_to_remove}" done - cp -r "content/operate/rs/${version}"/* content/operate/rs/ - rm -r "content/operate/rs/${version}" + # relrefs should not include version + find "content/operate/rs/${version}" -type f | while read file; do + awk '{gsub(/\(\{\{< relref "\/operate\/rs\/'${version}'/, "({{< relref \"/operate/rs") }1' "$file" > tmpfile && mv tmpfile "$file" + done + + rsync -a --delete-after "content/operate/rs/${version}"/ content/operate/rs/ sed -i 's/id="versionSelectorRsValue" class="version-selector-control">latest/id="versionSelectorRsValue" class="version-selector-control">v'"${version}"'/' layouts/partials/docs-nav.html sed -i 's/linkTitle: '"${version}"'/linkTitle: Redis Software/' content/operate/rs/_index.md @@ -133,8 +141,12 @@ jobs: rm -r "content/integrate/redis-data-integration/${version_to_remove}" done - cp -r "content/integrate/redis-data-integration/${version}"/* content/integrate/redis-data-integration/ - rm -r "content/integrate/redis-data-integration/${version}" + # relrefs should not include version + find "content/operate/redis-data-integration/${version}" -type f | while read file; do + awk '{gsub(/\(\{\{< relref "\/operate\/redis-data-integration\/'${version}'/, "({{< relref \"/operate/redis-data-integration") }1' "$file" > tmpfile && mv tmpfile "$file" + done + + rsync -a --delete-after "content/operate/redis-data-integration/${version}"/ content/operate/redis-data-integration/ sed -i 's/id="versionSelectorRedis-Data-IntegrationValue" class="version-selector-control">latest/id="versionSelectorRedis-Data-IntegrationValue" class="version-selector-control">v'"${version}"'/' layouts/partials/docs-nav.html sed -i 's/linkTitle: '"${version}"'/linkTitle: Redis Data Integration/' content/integrate/redis-data-integration/_index.md diff --git a/content/operate/kubernetes/7.4.6/active-active/_index.md b/content/operate/kubernetes/7.4.6/active-active/_index.md index bbf2e5c1b6..c966d86e0f 100644 --- a/content/operate/kubernetes/7.4.6/active-active/_index.md +++ b/content/operate/kubernetes/7.4.6/active-active/_index.md @@ -30,9 +30,9 @@ Versions 6.4.2-6 or later fully support the Active-Active controller. Some of th This setup method includes the following steps: -1. Gather REC credentials and [prepare participating clusters]({{< relref "/operate/kubernetes/active-active/prepare-clusters.md" >}}). -2. Create [`RedisEnterpriseRemoteCluster` (RERC)]({{< relref "/operate/kubernetes/active-active/create-reaadb#create-rerc" >}}) resources. -3. Create [`RedisEnterpriseActiveActiveDatabase` (REAADB)]({{< relref "/operate/kubernetes/active-active/create-reaadb#create-reaadb" >}}) resource. +1. Gather REC credentials and [prepare participating clusters]({{< relref "/operate/kubernetes/7.4.6/active-active/prepare-clusters.md" >}}). +2. Create [`RedisEnterpriseRemoteCluster` (RERC)]({{< relref "/operate/kubernetes/7.4.6/active-active/create-reaadb#create-rerc" >}}) resources. +3. Create [`RedisEnterpriseActiveActiveDatabase` (REAADB)]({{< relref "/operate/kubernetes/7.4.6/active-active/create-reaadb#create-reaadb" >}}) resource. ### `crdb-cli` method @@ -49,7 +49,7 @@ For versions 6.4.2 or earlier, this Active-Active setup method includes the foll [Active-Active]({{< relref "/operate/rs/databases/active-active/" >}}) databases give you read-and-write access to Redis Enterprise clusters (REC) in different Kubernetes clusters or namespaces. Active-Active deployments managed by the Redis Enterprise operator require two additional custom resources: Redis Enterprise Active-Active database (REAADB) and Redis Enterprise remote cluster (RERC). -To create an Active-Active Redis Enterprise deployment for Kubernetes with these new features, first [prepare participating clusters]({{< relref "/operate/kubernetes/active-active/prepare-clusters.md" >}}) then [create an Active-Active database]({{< relref "/operate/kubernetes/active-active/create-reaadb.md" >}}). +To create an Active-Active Redis Enterprise deployment for Kubernetes with these new features, first [prepare participating clusters]({{< relref "/operate/kubernetes/7.4.6/active-active/prepare-clusters.md" >}}) then [create an Active-Active database]({{< relref "/operate/kubernetes/7.4.6/active-active/create-reaadb.md" >}}). ### Preview versions @@ -76,13 +76,13 @@ If you are using a preview version of these features (operator version 6.4.2-4 o Redis Enterprise Active-Active database (REAADB) contains a link to the RERC for each participating cluster, and provides configuration and status to the management plane. -For a full list of fields and options, see the [REAADB API reference]({{}}). +For a full list of fields and options, see the [REAADB API reference]({{}}). ### RERC custom resource Redis Enterprise remote cluster (RERC) custom resource contains configuration details for all the participating clusters. -For a full list of fields and options, see the [RERC API reference]({{}}). +For a full list of fields and options, see the [RERC API reference]({{}}). ### Limitations diff --git a/content/operate/kubernetes/7.4.6/active-active/create-aa-crdb-cli.md b/content/operate/kubernetes/7.4.6/active-active/create-aa-crdb-cli.md index 404cb4e17f..5ba85d7a3d 100644 --- a/content/operate/kubernetes/7.4.6/active-active/create-aa-crdb-cli.md +++ b/content/operate/kubernetes/7.4.6/active-active/create-aa-crdb-cli.md @@ -11,11 +11,11 @@ linkTitle: Create Active-Active with crdb-cli weight: 99 url: '/operate/kubernetes/7.4.6/active-active/create-aa-crdb-cli/' --- -{{}} Versions 6.4.2 and later support the Active-Active database controller. This controller allows you to create Redis Enterprise Active-Active databases (REAADB) and Redis Enterprise remote clusters (RERC) with custom resources. We recommend using the [REAADB method for creating Active-Active databases]({{< relref "/operate/kubernetes/active-active/create-reaadb.md" >}}).{{}} +{{}} Versions 6.4.2 and later support the Active-Active database controller. This controller allows you to create Redis Enterprise Active-Active databases (REAADB) and Redis Enterprise remote clusters (RERC) with custom resources. We recommend using the [REAADB method for creating Active-Active databases]({{< relref "/operate/kubernetes/7.4.6/active-active/create-reaadb.md" >}}).{{}} On Kubernetes, Redis Enterprise [Active-Active]({{< relref "/operate/rs/databases/active-active/" >}}) databases provide read-and-write access to the same dataset from different Kubernetes clusters. For more general information about Active-Active, see the [Redis Enterprise Software docs]({{< relref "/operate/rs/databases/active-active/" >}}). -Creating an Active-Active database requires routing [network access]({{< relref "/operate/kubernetes/networking/" >}}) between two Redis Enterprise clusters residing in different Kubernetes clusters. Without the proper access configured for each cluster, syncing between the databases instances will fail. +Creating an Active-Active database requires routing [network access]({{< relref "/operate/kubernetes/7.4.6/networking/" >}}) between two Redis Enterprise clusters residing in different Kubernetes clusters. Without the proper access configured for each cluster, syncing between the databases instances will fail. This process consists of: @@ -27,8 +27,8 @@ This process consists of: Before creating Active-Active databases, you'll need admin access to two or more working Kubernetes clusters that each have: -- Routing for external access with an [ingress resources]({{< relref "/operate/kubernetes/networking/ingress.md" >}}) (or [route resources]({{< relref "/operate/kubernetes/networking/routes.md" >}}) on OpenShift). -- A working [Redis Enterprise cluster (REC)]({{< relref "/operate/kubernetes/reference/redis_enterprise_cluster_api" >}}) with a unique name. +- Routing for external access with an [ingress resources]({{< relref "/operate/kubernetes/7.4.6/networking/ingress.md" >}}) (or [route resources]({{< relref "/operate/kubernetes/7.4.6/networking/routes.md" >}}) on OpenShift). +- A working [Redis Enterprise cluster (REC)]({{< relref "/operate/kubernetes/7.4.6/reference/redis_enterprise_cluster_api" >}}) with a unique name. - Enough memory resources available for the database (see [hardware requirements]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/hardware-requirements.md" >}})). {{}} The `activeActive` field and the `ingressOrRouteSpec` field cannot coexist in the same REC. If you configured your ingress via the `ingressOrRouteSpec` field in the REC, create your Active-Active database with the RedisEnterpriseActiveActiveDatabase (REAADB) custom resource.{{}} @@ -70,7 +70,7 @@ You'll need to create DNS aliases to resolve your API hostname ``, - Description: Combined with database name to create the Active-Active database hostname - Format: string - Example value: `-cluster.ijk.example.com` -- [**REC admin credentials**]({{< relref "/operate/kubernetes/security/manage-rec-credentials.md" >}}) ` `: +- [**REC admin credentials**]({{< relref "/operate/kubernetes/7.4.6/security/manage-rec-credentials.md" >}}) ` `: - Description: Admin username and password for the REC stored in a secret - Format: string - Example value: username: `user@example.com`, password: `something` @@ -100,7 +100,7 @@ From inside your K8s cluster, edit your Redis Enterprise cluster (REC) resource ### Using ingress controller -1. If your cluster uses an [ingress controller]({{< relref "/operate/kubernetes/networking/ingress.md" >}}), add the following to the `spec` section of your REC resource file. +1. If your cluster uses an [ingress controller]({{< relref "/operate/kubernetes/7.4.6/networking/ingress.md" >}}), add the following to the `spec` section of your REC resource file. Nginx: @@ -147,7 +147,7 @@ HAproxy: #### If using Istio Gateway and VirtualService -No changes are required to the REC spec if you are using [Istio]({{< relref "/operate/kubernetes/networking/istio-ingress.md" >}}) in place of an ingress controller. The `activeActive` section added above creates ingress resources. The two custom resources used to configure Istio (Gateway and VirtualService) replace the need for ingress resources. +No changes are required to the REC spec if you are using [Istio]({{< relref "/operate/kubernetes/7.4.6/networking/istio-ingress.md" >}}) in place of an ingress controller. The `activeActive` section added above creates ingress resources. The two custom resources used to configure Istio (Gateway and VirtualService) replace the need for ingress resources. {{}} These custom resources are not controlled by the operator and will need to be configured and maintained manually. @@ -174,7 +174,7 @@ For each cluster, verify the VirtualService resource has two `- match:` blocks i 1. Make sure you have DNS aliases for each database that resolve your API hostname ``,``, `` to the route IP address. To avoid entering multiple DNS records, you can use a wildcard in your alias (such as `*.ijk.example.com`). -1. If your cluster uses [OpenShift routes]({{< relref "/operate/kubernetes/networking/routes.md" >}}), add the following to the `spec` section of your Redis Enterprise cluster (REC) resource file. +1. If your cluster uses [OpenShift routes]({{< relref "/operate/kubernetes/7.4.6/networking/routes.md" >}}), add the following to the `spec` section of your Redis Enterprise cluster (REC) resource file. ```sh activeActive: @@ -195,7 +195,7 @@ For each cluster, verify the VirtualService resource has two `- match:` blocks i ## Create an Active-Active database with `crdb-cli` -The `crdb-cli` command can be run from any Redis Enterprise pod hosted on any participating K8s cluster. You'll need the values for the [required parameters]({{< relref "/operate/kubernetes/active-active/create-aa-crdb-cli#document-required-parameters" >}}) for each Redis Enterprise cluster. +The `crdb-cli` command can be run from any Redis Enterprise pod hosted on any participating K8s cluster. You'll need the values for the [required parameters]({{< relref "/operate/kubernetes/7.4.6/active-active/create-aa-crdb-cli#document-required-parameters" >}}) for each Redis Enterprise cluster. ```sh crdb-cli crdb create \ @@ -214,4 +214,4 @@ See the [`crdb-cli` reference]({{< relref "/operate/rs/references/cli-utilities/ The easiest way to test your Active-Active database is to set a key-value pair in one database and retrieve it from the other. -You can connect to your databases with the instructions in [Manage databases]({{< relref "/operate/kubernetes/re-databases/db-controller#connect-to-a-database" >}}). Set a test key with `SET foo bar` in the first database. If your Active-Active deployment is working properly, when connected to your second database, `GET foo` should output `bar`. +You can connect to your databases with the instructions in [Manage databases]({{< relref "/operate/kubernetes/7.4.6/re-databases/db-controller#connect-to-a-database" >}}). Set a test key with `SET foo bar` in the first database. If your Active-Active deployment is working properly, when connected to your second database, `GET foo` should output `bar`. diff --git a/content/operate/kubernetes/7.4.6/active-active/create-reaadb.md b/content/operate/kubernetes/7.4.6/active-active/create-reaadb.md index a47886b761..2e205d2a2d 100644 --- a/content/operate/kubernetes/7.4.6/active-active/create-reaadb.md +++ b/content/operate/kubernetes/7.4.6/active-active/create-reaadb.md @@ -17,18 +17,18 @@ url: '/operate/kubernetes/7.4.6/active-active/create-reaadb/' To create an Active-Active database, make sure you've completed all the following steps and have gathered the information listed below each step. -1. Configure the [admission controller and ValidatingWebhook]({{< relref "/operate/kubernetes/deployment/quick-start.md#enable-the-admission-controller/" >}}). +1. Configure the [admission controller and ValidatingWebhook]({{< relref "/operate/kubernetes/7.4.6/deployment/quick-start.md#enable-the-admission-controller/" >}}). {{}}These are installed and enabled by default on clusters created via the OpenShift OperatorHub. {{}} -2. Create two or more [RedisEnterpriseCluster (REC) custom resources]({{< relref "/operate/kubernetes/deployment/quick-start#create-a-redis-enterprise-cluster-rec" >}}) with enough [memory resources]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/hardware-requirements.md" >}}). +2. Create two or more [RedisEnterpriseCluster (REC) custom resources]({{< relref "/operate/kubernetes/7.4.6/deployment/quick-start#create-a-redis-enterprise-cluster-rec" >}}) with enough [memory resources]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/hardware-requirements.md" >}}). * Name of each REC (``) * Namespace for each REC (``) -3. Configure the REC [`ingressOrRoutes` field]({{< relref "/operate/kubernetes/networking/ingressorroutespec.md" >}}) and [create DNS records]({{< relref "/operate/kubernetes/networking/ingressorroutespec#configure-dns/" >}}). +3. Configure the REC [`ingressOrRoutes` field]({{< relref "/operate/kubernetes/7.4.6/networking/ingressorroutespec.md" >}}) and [create DNS records]({{< relref "/operate/kubernetes/7.4.6/networking/ingressorroutespec#configure-dns/" >}}). * REC API hostname (`api--.`) * Database hostname suffix (`-db--.`) -4. [Prepare participating clusters]({{< relref "/operate/kubernetes/active-active/prepare-clusters.md" >}}) +4. [Prepare participating clusters]({{< relref "/operate/kubernetes/7.4.6/active-active/prepare-clusters.md" >}}) * RERC name (`) * RERC secret name (`redis-enterprise-`) @@ -70,7 +70,7 @@ For a list of example values used throughout this article, see the [Example valu secretName: redis-enterprise-rerc-reagan ``` - For more details on RERC fields, see the [RERC API reference]({{}}). + For more details on RERC fields, see the [RERC API reference]({{}}). 1. Create a Redis Enterprise remote cluster from each RERC custom resource file. @@ -124,7 +124,7 @@ For a list of example values used throughout this article, see the [Example valu {{}}Sharding is disabled on Active-Active databases created with a `shardCount` of 1. Sharding cannot be enabled after database creation. {{}} - For more details on RERC fields, see the [RERC API reference]({{}}). + For more details on RERC fields, see the [RERC API reference]({{}}). 1. Create a Redis Enterprise Active-Active database from the REAADB custom resource file. diff --git a/content/operate/kubernetes/7.4.6/active-active/edit-clusters.md b/content/operate/kubernetes/7.4.6/active-active/edit-clusters.md index 2907ec069a..933003bd17 100644 --- a/content/operate/kubernetes/7.4.6/active-active/edit-clusters.md +++ b/content/operate/kubernetes/7.4.6/active-active/edit-clusters.md @@ -19,7 +19,7 @@ Use the following steps to add a participating cluster to an existing Redis Ente ### Prerequisites -To prepare the Redis Enterprise cluster (REC) to participate in an Active-Active database, perform the following tasks from [Prepare participating clusters]({{< relref "/operate/kubernetes/active-active/prepare-clusters.md" >}}): +To prepare the Redis Enterprise cluster (REC) to participate in an Active-Active database, perform the following tasks from [Prepare participating clusters]({{< relref "/operate/kubernetes/7.4.6/active-active/prepare-clusters.md" >}}): - Make sure the cluster meets the hardware and naming requirements. - Enable the Active-Active controllers. diff --git a/content/operate/kubernetes/7.4.6/active-active/edit-rerc.md b/content/operate/kubernetes/7.4.6/active-active/edit-rerc.md index a5ccfb5fcb..6212cd08ec 100644 --- a/content/operate/kubernetes/7.4.6/active-active/edit-rerc.md +++ b/content/operate/kubernetes/7.4.6/active-active/edit-rerc.md @@ -17,11 +17,11 @@ Before a RedisEnterpriseCluster (REC) can participate in an Active-Active databa The RERC controller periodically connects to the local REC endpoint via its external address, to ensure it’s setup correctly. For this to work, the external load balancer must support [NAT hairpinning](https://en.wikipedia.org/wiki/Network_address_translation#NAT_loopback). In some cloud environments, this may involve disabling IP preservation for the load balancer target groups. -For more details, see the [RERC API reference]({{}}). +For more details, see the [RERC API reference]({{}}). ## Edit RERC -Use the `kubectl patch rerc --type merge --patch` command to patch the local RERC custom resource with your changes. For a full list of available fields, see the [RERC API reference]({{}}). +Use the `kubectl patch rerc --type merge --patch` command to patch the local RERC custom resource with your changes. For a full list of available fields, see the [RERC API reference]({{}}). The following example edits the `dbFqdnSuffix` field for the RERC named `rerc-ohare`. @@ -68,7 +68,7 @@ If the credentials are changed or updated for a REC participating cluster, you n rerc-ohare Active Valid true ``` - To troubleshoot invalid configurations, view the RERC custom resource events and the [Redis Enterprise operator logs]({{< relref "/operate/kubernetes/logs/" >}}). + To troubleshoot invalid configurations, view the RERC custom resource events and the [Redis Enterprise operator logs]({{< relref "/operate/kubernetes/7.4.6/logs/" >}}). 1. Verify the status of each REAADB using that RERC is "Active" and the spec status is "Valid." @@ -79,6 +79,6 @@ If the credentials are changed or updated for a REC participating cluster, you n reaadb-boeing active Valid up ``` - To troubleshoot invalid configurations, view the RERC custom resource events and the [Redis Enterprise operator logs]({{< relref "/operate/kubernetes/logs/" >}}). + To troubleshoot invalid configurations, view the RERC custom resource events and the [Redis Enterprise operator logs]({{< relref "/operate/kubernetes/7.4.6/logs/" >}}). 1. Repeat the above steps on all other participating clusters. diff --git a/content/operate/kubernetes/7.4.6/active-active/global-config.md b/content/operate/kubernetes/7.4.6/active-active/global-config.md index 012825995c..a1ab585fad 100644 --- a/content/operate/kubernetes/7.4.6/active-active/global-config.md +++ b/content/operate/kubernetes/7.4.6/active-active/global-config.md @@ -15,7 +15,7 @@ url: '/operate/kubernetes/7.4.6/active-active/global-config/' The Redis Enterprise Active-Active database (REAADB) custom resource contains the field `.spec.globalConfigurations`. This field sets configurations for the Active-Active database across all participating clusters, such as memory size, shard count, and the global database secrets. -The [REAADB API reference]({{}}) contains a full list of available fields. +The [REAADB API reference]({{}}) contains a full list of available fields. ## Edit global configurations @@ -47,7 +47,7 @@ The [REAADB API reference]({{}}). +This section edits the secrets under the REAADB `.spec.globalConfigurations` section. For more information and all available fields, see the [REAADB API reference]({{}}). 1. On an existing participating cluster, generate a YAML file containing the database secret with the relevant data. diff --git a/content/operate/kubernetes/7.4.6/active-active/global-db-secret.md b/content/operate/kubernetes/7.4.6/active-active/global-db-secret.md index 5039795eab..dd20d09e23 100644 --- a/content/operate/kubernetes/7.4.6/active-active/global-db-secret.md +++ b/content/operate/kubernetes/7.4.6/active-active/global-db-secret.md @@ -17,7 +17,7 @@ url: '/operate/kubernetes/7.4.6/active-active/global-db-secret/' One of the fields available for `globalConfigurations` is `databaseSecretName` which can point to a secret containing the database password. To set the database secret name and sync the data to all participating clusters, follow the steps below. -To edit other global configruations, see [global configuration]({{< relref "/operate/kubernetes/active-active/global-config.md" >}}) +To edit other global configruations, see [global configuration]({{< relref "/operate/kubernetes/7.4.6/active-active/global-config.md" >}}) 1. On an existing participating cluster, generate a YAML file containing the database secret with the database password. diff --git a/content/operate/kubernetes/7.4.6/active-active/prepare-clusters.md b/content/operate/kubernetes/7.4.6/active-active/prepare-clusters.md index 795f38c1a9..7e5367c480 100644 --- a/content/operate/kubernetes/7.4.6/active-active/prepare-clusters.md +++ b/content/operate/kubernetes/7.4.6/active-active/prepare-clusters.md @@ -18,13 +18,13 @@ url: '/operate/kubernetes/7.4.6/active-active/prepare-clusters/' Before you prepare your clusters to participate in an Active-Active database, make sure you've completed all the following steps and have gathered the information listed below each step. -1. Configure the [admission controller and ValidatingWebhook]({{< relref "/operate/kubernetes/deployment/quick-start.md#enable-the-admission-controller/" >}}). +1. Configure the [admission controller and ValidatingWebhook]({{< relref "/operate/kubernetes/7.4.6/deployment/quick-start.md#enable-the-admission-controller/" >}}). -2. Create two or more [RedisEnterpriseCluster (REC) custom resources]({{< relref "/operate/kubernetes/deployment/quick-start#create-a-redis-enterprise-cluster-rec" >}}) with enough [memory resources]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/hardware-requirements.md" >}}). +2. Create two or more [RedisEnterpriseCluster (REC) custom resources]({{< relref "/operate/kubernetes/7.4.6/deployment/quick-start#create-a-redis-enterprise-cluster-rec" >}}) with enough [memory resources]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/hardware-requirements.md" >}}). * Name of each REC (``) * Namespace for each REC (``) -3. Configure the REC [`ingressOrRoutes` field]({{< relref "/operate/kubernetes/networking/ingressorroutespec.md" >}}) and [create DNS records]({{< relref "/operate/kubernetes/networking/ingressorroutespec#configure-dns/" >}}). +3. Configure the REC [`ingressOrRoutes` field]({{< relref "/operate/kubernetes/7.4.6/networking/ingressorroutespec.md" >}}) and [create DNS records]({{< relref "/operate/kubernetes/7.4.6/networking/ingressorroutespec#configure-dns/" >}}). * REC API hostname (`api--.`) * Database hostname suffix (`-db--.`) @@ -141,7 +141,7 @@ To communicate with other clusters, all participating clusters will need access ## Next steps -Now you are ready to [create your Redis Enterprise Active-Active database]({{< relref "/operate/kubernetes/active-active/create-reaadb.md" >}}). +Now you are ready to [create your Redis Enterprise Active-Active database]({{< relref "/operate/kubernetes/7.4.6/active-active/create-reaadb.md" >}}). ## Example values diff --git a/content/operate/kubernetes/7.4.6/delete-custom-resources.md b/content/operate/kubernetes/7.4.6/delete-custom-resources.md index 04e8113700..dd3762e346 100644 --- a/content/operate/kubernetes/7.4.6/delete-custom-resources.md +++ b/content/operate/kubernetes/7.4.6/delete-custom-resources.md @@ -67,7 +67,7 @@ kubectl delete -f admission-service.yaml kubectl delete -f operator.yaml ``` -You will also need to remove [the `namespaceSelector` section from the validating webhook]({{< relref "/operate/kubernetes/deployment/quick-start#webhook" >}}). +You will also need to remove [the `namespaceSelector` section from the validating webhook]({{< relref "/operate/kubernetes/7.4.6/deployment/quick-start#webhook" >}}). ## Delete an Active-Active database (REAADB) diff --git a/content/operate/kubernetes/7.4.6/deployment/_index.md b/content/operate/kubernetes/7.4.6/deployment/_index.md index 06408c25a7..05ac4ec30f 100644 --- a/content/operate/kubernetes/7.4.6/deployment/_index.md +++ b/content/operate/kubernetes/7.4.6/deployment/_index.md @@ -35,6 +35,6 @@ The operator currently runs within a single namespace and is scoped to operate o ## Compatibility -Before installing, check [Supported Kubernetes distributions]({{< relref "/operate/kubernetes/reference/supported_k8s_distributions" >}}) to see which Redis Enterprise operator version supports your Kubernetes distribution. +Before installing, check [Supported Kubernetes distributions]({{< relref "/operate/kubernetes/7.4.6/reference/supported_k8s_distributions" >}}) to see which Redis Enterprise operator version supports your Kubernetes distribution. diff --git a/content/operate/kubernetes/7.4.6/deployment/container-images.md b/content/operate/kubernetes/7.4.6/deployment/container-images.md index 2c1f5ec10a..af418b52ef 100644 --- a/content/operate/kubernetes/7.4.6/deployment/container-images.md +++ b/content/operate/kubernetes/7.4.6/deployment/container-images.md @@ -127,7 +127,7 @@ require authentication. If you do need authentication, add a [pull secret](https The operator bundle contains the operator deployment and the reference to the operator image (`redislabs/operator`). To use a private container registry, you must change this image reference in your operator deployment file **before** you deploy the operator. If you apply this change to modify an existing operator deployment, the operator's pod will restart. -In the operator deployment file, 'containers:image' should point to the same repository and tag you used when [pushing]({{< relref "/operate/kubernetes/deployment/container-images.md#push-images-to-a-private-container-registry" >}}) to the private container registry: +In the operator deployment file, 'containers:image' should point to the same repository and tag you used when [pushing]({{< relref "/operate/kubernetes/7.4.6/deployment/container-images.md#push-images-to-a-private-container-registry" >}}) to the private container registry: ```sh ${PRIVATE_REPO}/redislabs/operator:${OPERATOR_VERSION} diff --git a/content/operate/kubernetes/7.4.6/deployment/deployment-options.md b/content/operate/kubernetes/7.4.6/deployment/deployment-options.md index faa5028675..69b58d8592 100644 --- a/content/operate/kubernetes/7.4.6/deployment/deployment-options.md +++ b/content/operate/kubernetes/7.4.6/deployment/deployment-options.md @@ -23,13 +23,13 @@ The Redis Enterprise cluster (REC) custom resource must reside in the same names ## Single REC and single namespace (one-to-one) -The standard and simplest deployment deploys your Redis Enterprise databases (REDB) in the same namespace as the Redis Enterprise cluster (REC). No additional configuration is required for this, since there is no communication required to cross namespaces. See [Deploy Redis Enterprise for Kubernetes]({{< relref "/operate/kubernetes/deployment/quick-start.md" >}}). +The standard and simplest deployment deploys your Redis Enterprise databases (REDB) in the same namespace as the Redis Enterprise cluster (REC). No additional configuration is required for this, since there is no communication required to cross namespaces. See [Deploy Redis Enterprise for Kubernetes]({{< relref "/operate/kubernetes/7.4.6/deployment/quick-start.md" >}}). {{< image filename="/images/k8s/k8s-deploy-one-to-one.png" >}} ## Single REC and multiple namespaces (one-to-many) -Multiple Redis Enterprise databases (REDB) spread across multiple namespaces within the same K8s cluster can be associated with the same Redis Enterprise cluster (REC). See [Manage databases in multiple namespaces]({{< relref "/operate/kubernetes/re-clusters/multi-namespace.md" >}}) for more information. +Multiple Redis Enterprise databases (REDB) spread across multiple namespaces within the same K8s cluster can be associated with the same Redis Enterprise cluster (REC). See [Manage databases in multiple namespaces]({{< relref "/operate/kubernetes/7.4.6/re-clusters/multi-namespace.md" >}}) for more information. {{< image filename="/images/k8s/k8s-deploy-one-to-many.png" >}} @@ -39,7 +39,7 @@ A single Kubernetes cluster can contain multiple Redis Enterprise clusters (REC) You have the flexibility to create databases in separate namespaces, or in the same namespace as the REC, or combine any of the supported deployment options above. This configuration is geared towards use cases that require multiple Redis Enterprise clusters with greater isolation or different cluster configurations. -See [Manage databases in multiple namespaces]({{< relref "/operate/kubernetes/re-clusters/multi-namespace.md" >}}) for more information. +See [Manage databases in multiple namespaces]({{< relref "/operate/kubernetes/7.4.6/re-clusters/multi-namespace.md" >}}) for more information. {{< image filename="/images/k8s/k8s-deploy-many-to-many.png" >}} diff --git a/content/operate/kubernetes/7.4.6/deployment/openshift/_index.md b/content/operate/kubernetes/7.4.6/deployment/openshift/_index.md index a89f46e026..129dbce545 100644 --- a/content/operate/kubernetes/7.4.6/deployment/openshift/_index.md +++ b/content/operate/kubernetes/7.4.6/deployment/openshift/_index.md @@ -28,11 +28,11 @@ workloads can use: ## For OpenShift via the OperatorHub -To [create a database on an OpenShift 4.x cluster via the OperatorHub]({{< relref "/operate/kubernetes/deployment/openshift/openshift-operatorhub" >}}) you only need to have the [OpenShift 4.x cluster installed](https://docs.openshift.com/container-platform/4.3/welcome/index.html) with at least three nodes that each meet the [minimum requirements for a development installation]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/hardware-requirements.md" >}}). +To [create a database on an OpenShift 4.x cluster via the OperatorHub]({{< relref "/operate/kubernetes/7.4.6/deployment/openshift/openshift-operatorhub" >}}) you only need to have the [OpenShift 4.x cluster installed](https://docs.openshift.com/container-platform/4.3/welcome/index.html) with at least three nodes that each meet the [minimum requirements for a development installation]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/hardware-requirements.md" >}}). ## For OpenShift via the CLI -To [create a database on an OpenShift cluster via the CLI]({{< relref "/operate/kubernetes/deployment/openshift/openshift-cli.md" >}}), you need: +To [create a database on an OpenShift cluster via the CLI]({{< relref "/operate/kubernetes/7.4.6/deployment/openshift/openshift-cli.md" >}}), you need: 1. An [OpenShift cluster installed](https://docs.openshift.com/container-platform/4.3/welcome/index.html) with at least three nodes that each meet the [minimum requirements for a development installation]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/hardware-requirements.md" >}}). 1. The [kubectl package installed](https://kubernetes.io/docs/tasks/tools/install-kubectl/) at version 1.9 or higher @@ -40,4 +40,4 @@ To [create a database on an OpenShift cluster via the CLI]({{< relref "/operate/ ## Version compatibility -To see which version of Redis Enterprise for Kubernetes supports your OpenShift version, see [Supported Kubernetes distributions]({{< relref "/operate/kubernetes/reference/supported_k8s_distributions" >}}). +To see which version of Redis Enterprise for Kubernetes supports your OpenShift version, see [Supported Kubernetes distributions]({{< relref "/operate/kubernetes/7.4.6/reference/supported_k8s_distributions" >}}). diff --git a/content/operate/kubernetes/7.4.6/deployment/openshift/openshift-cli.md b/content/operate/kubernetes/7.4.6/deployment/openshift/openshift-cli.md index efab1ab1a9..4b198fb45a 100644 --- a/content/operate/kubernetes/7.4.6/deployment/openshift/openshift-cli.md +++ b/content/operate/kubernetes/7.4.6/deployment/openshift/openshift-cli.md @@ -18,7 +18,7 @@ Use these steps to set up a Redis Enterprise Software cluster with OpenShift. - [OpenShift cluster](https://docs.openshift.com/container-platform/4.8/installing/index.html) with at least 3 nodes (each meeting the [minimum requirements for a development installation]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/hardware-requirements" >}})) - [OpenShift CLI](https://docs.openshift.com/container-platform/latest/cli_reference/openshift_cli/getting-started-cli.html) -To see which version of Redis Enterprise for Kubernetes supports your OpenShift version, see [Supported Kubernetes distributions]({{< relref "/operate/kubernetes/reference/supported_k8s_distributions" >}}). +To see which version of Redis Enterprise for Kubernetes supports your OpenShift version, see [Supported Kubernetes distributions]({{< relref "/operate/kubernetes/7.4.6/reference/supported_k8s_distributions" >}}). ## Deploy the operator @@ -113,7 +113,7 @@ system:serviceaccount::redis-enterprise-operator 1. Apply the `RedisEnterpriseCluster` resource file ([rec_rhel.yaml](https://github.com/RedisLabs/redis-enterprise-k8s-docs/blob/master/openshift/rec_rhel.yaml)). - You can rename the file to `.yaml`, but it is not required. Examples below use `.yaml`. [Options for Redis Enterprise clusters]({{< relref "/operate/kubernetes/reference/redis_enterprise_cluster_api" >}}) has more info about the Redis Enterprise cluster (REC) custom resource, or see the [Redis Enterprise cluster API]({{}}) for a full list of options. + You can rename the file to `.yaml`, but it is not required. Examples below use `.yaml`. [Options for Redis Enterprise clusters]({{< relref "/operate/kubernetes/7.4.6/reference/redis_enterprise_cluster_api" >}}) has more info about the Redis Enterprise cluster (REC) custom resource, or see the [Redis Enterprise cluster API]({{}}) for a full list of options. The REC name cannot be changed after cluster creation. @@ -223,7 +223,7 @@ The operator uses the instructions in the Redis Enterprise database (REDB) custo 1. Create a `RedisEnterpriseDatabase` custom resource. - This example creates a test database. For production databases, see [create a database]({{< relref "/operate/kubernetes/re-databases/db-controller.md#create-a-database" >}}) and [RedisEnterpriseDatabase API reference]({{< relref "/operate/kubernetes/reference/redis_enterprise_database_api" >}}). + This example creates a test database. For production databases, see [create a database]({{< relref "/operate/kubernetes/7.4.6/re-databases/db-controller.md#create-a-database" >}}) and [RedisEnterpriseDatabase API reference]({{< relref "/operate/kubernetes/7.4.6/reference/redis_enterprise_database_api" >}}). ```sh cat << EOF > /tmp/redis-enterprise-database.yml @@ -244,5 +244,5 @@ The operator uses the instructions in the Redis Enterprise database (REDB) custo ## More info -- [Redis Enterprise cluster API]({{}}) -- [Redis Enterprise database API]({{}}) +- [Redis Enterprise cluster API]({{}}) +- [Redis Enterprise database API]({{}}) diff --git a/content/operate/kubernetes/7.4.6/deployment/openshift/openshift-operatorhub.md b/content/operate/kubernetes/7.4.6/deployment/openshift/openshift-operatorhub.md index 71e54ebb84..43a4f09ebe 100644 --- a/content/operate/kubernetes/7.4.6/deployment/openshift/openshift-operatorhub.md +++ b/content/operate/kubernetes/7.4.6/deployment/openshift/openshift-operatorhub.md @@ -14,7 +14,7 @@ url: '/operate/kubernetes/7.4.6/deployment/openshift/openshift-operatorhub/' You can deploy Redis Enterprise for Kubernetes from the Red Hat OpenShift CLI. You can also use a UI, [OperatorHub](https://docs.openshift.com/container-platform/4.11/operators/index.html) (Red Hat) to install operators and create custom resources. -To see which version of Redis Enterprise for Kubernetes supports your OpenShift version, see [Supported Kubernetes distributions]({{< relref "/operate/kubernetes/reference/supported_k8s_distributions" >}}). +To see which version of Redis Enterprise for Kubernetes supports your OpenShift version, see [Supported Kubernetes distributions]({{< relref "/operate/kubernetes/7.4.6/reference/supported_k8s_distributions" >}}). ## Install the Redis Enterprise operator @@ -89,4 +89,4 @@ Use the YAML view to create a custom resource file or let OperatorHub generate t {{}} In versions 6.4.2-4 and 6.4.2-5, REC creation might fail when using the form view due to an error related to the cluster level LDAP. To avoid this, use the YAML view. {{}} -For more information on creating and maintaining Redis Enterprise custom resources, see [Redis Enterprise clusters (REC)]({{< relref "/operate/kubernetes/re-clusters/" >}}) and [Redis Enterprise databases (REDB)]({{< relref "/operate/kubernetes/re-databases/" >}}). +For more information on creating and maintaining Redis Enterprise custom resources, see [Redis Enterprise clusters (REC)]({{< relref "/operate/kubernetes/7.4.6/re-clusters/" >}}) and [Redis Enterprise databases (REDB)]({{< relref "/operate/kubernetes/7.4.6/re-databases/" >}}). diff --git a/content/operate/kubernetes/7.4.6/deployment/quick-start.md b/content/operate/kubernetes/7.4.6/deployment/quick-start.md index aadf1b8be5..00bda5ff4b 100644 --- a/content/operate/kubernetes/7.4.6/deployment/quick-start.md +++ b/content/operate/kubernetes/7.4.6/deployment/quick-start.md @@ -18,13 +18,13 @@ To deploy Redis Enterprise Software for Kubernetes and start your Redis Enterpri - Apply the operator bundle and verify it's running. - Create a Redis Enterprise cluster (REC). -This guide works with most supported Kubernetes distributions. If you're using OpenShift, see [Redis Enterprise on OpenShift]({{< relref "/operate/kubernetes/deployment/openshift" >}}). For details on what is currently supported, see [supported distributions]({{< relref "/operate/kubernetes/reference/supported_k8s_distributions.md" >}}). +This guide works with most supported Kubernetes distributions. If you're using OpenShift, see [Redis Enterprise on OpenShift]({{< relref "/operate/kubernetes/7.4.6/deployment/openshift" >}}). For details on what is currently supported, see [supported distributions]({{< relref "/operate/kubernetes/7.4.6/reference/supported_k8s_distributions.md" >}}). ## Prerequisites To deploy Redis Enterprise for Kubernetes, you'll need: -- Kubernetes cluster in a [supported distribution]({{< relref "/operate/kubernetes/reference/supported_k8s_distributions.md" >}}) +- Kubernetes cluster in a [supported distribution]({{< relref "/operate/kubernetes/7.4.6/reference/supported_k8s_distributions.md" >}}) - minimum of three worker nodes - Kubernetes client (kubectl) - access to DockerHub, RedHat Container Catalog, or a private repository that can hold the required images. @@ -56,7 +56,7 @@ Redis Enterprise for Kubernetes bundle is published as a container image. A list The operator [definition and reference materials](https://github.com/RedisLabs/redis-enterprise-k8s-docs) are available on GitHub. The operator definitions are [packaged as a single generic YAML file](https://github.com/RedisLabs/redis-enterprise-k8s-docs/blob/master/bundle.yaml). {{}} -If you do not pull images from DockerHub or another public registry, you need to use a [private container registry]({{< relref "/operate/kubernetes/deployment/container-images#manage-image-sources" >}}). +If you do not pull images from DockerHub or another public registry, you need to use a [private container registry]({{< relref "/operate/kubernetes/7.4.6/deployment/container-images#manage-image-sources" >}}). {{}} ### Download the operator bundle @@ -112,7 +112,7 @@ redis-enterprise-operator 1/1 1 1 0m36s A Redis Enterprise cluster (REC) is created from a `RedisEnterpriseCluster` custom resource that contains cluster specifications. -The following example creates a minimal Redis Enterprise cluster. See the [RedisEnterpriseCluster API reference]({{}}) for more information on the various options available. +The following example creates a minimal Redis Enterprise cluster. See the [RedisEnterpriseCluster API reference]({{}}) for more information on the various options available. 1. Create a file that defines a Redis Enterprise cluster with three nodes. @@ -257,4 +257,4 @@ The operator bundle includes a webhook file. The webhook will intercept requests You can create multiple databases within the same namespace as your REC or in other namespaces. -See [manage Redis Enterprise databases for Kubernetes]({{< relref "/operate/kubernetes/re-databases/db-controller.md" >}}) to create a new REDB. +See [manage Redis Enterprise databases for Kubernetes]({{< relref "/operate/kubernetes/7.4.6/re-databases/db-controller.md" >}}) to create a new REDB. diff --git a/content/operate/kubernetes/7.4.6/faqs/_index.md b/content/operate/kubernetes/7.4.6/faqs/_index.md index 4719601f3f..3cbe831eb2 100644 --- a/content/operate/kubernetes/7.4.6/faqs/_index.md +++ b/content/operate/kubernetes/7.4.6/faqs/_index.md @@ -15,7 +15,7 @@ Here are some frequently asked questions about Redis Enterprise on integration p ## What is an Operator? -An operator is a [Kubernetes custom controller](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources#custom-controllers) which extends the native K8s API. Refer to the article [Redis Enterprise K8s Operator-based deployments – Overview]({{< relref "/operate/kubernetes/architecture/operator" >}}). +An operator is a [Kubernetes custom controller](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources#custom-controllers) which extends the native K8s API. Refer to the article [Redis Enterprise K8s Operator-based deployments – Overview]({{< relref "/operate/kubernetes/7.4.6/architecture/operator" >}}). ## Does Redis Enterprise operator support multiple RECs per namespace? @@ -39,7 +39,7 @@ kubectl describe rec The cluster admin user password is created by the operator during the deployment of the Redis Enterprise cluster (REC) and is stored in a Kubernetes [secret](https://kubernetes.io/docs/concepts/configuration/secret/). -See [Manage REC credentials]({{< relref "/operate/kubernetes/security/manage-rec-credentials" >}}) for instructions on changing the admin password. +See [Manage REC credentials]({{< relref "/operate/kubernetes/7.4.6/security/manage-rec-credentials" >}}) for instructions on changing the admin password. ## How is using Redis Enterprise operator superior to using Helm charts? @@ -65,7 +65,7 @@ Connect to the UI by pointing your browser to `https://localhost:8443` For nodes hosting the Redis Enterprise cluster [statefulSet](https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/) [pods](https://kubernetes.io/docs/concepts/workloads/pods/), follow the guidelines provided for Redis Enterprise in the [hardware requirements]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/hardware-requirements.md" >}}). -For additional information please also refer to [Kubernetes operator deployment – persistent volumes]({{< relref "/operate/kubernetes/recommendations/persistent-volumes.md" >}}). +For additional information please also refer to [Kubernetes operator deployment – persistent volumes]({{< relref "/operate/kubernetes/7.4.6/recommendations/persistent-volumes.md" >}}). ## How to retrieve the username/password for a Redis Enterprise Cluster? diff --git a/content/operate/kubernetes/7.4.6/networking/_index.md b/content/operate/kubernetes/7.4.6/networking/_index.md index 1aac680e94..79f84192e5 100644 --- a/content/operate/kubernetes/7.4.6/networking/_index.md +++ b/content/operate/kubernetes/7.4.6/networking/_index.md @@ -16,7 +16,7 @@ Redis Enterprise for Kubernetes supports several ways to route external traffic - Ingress controllers [HAProxy](https://haproxy-ingress.github.io/) and [NGINX](https://kubernetes.github.io/ingress-nginx/) require an `ingress` API resource. - [Istio](https://istio.io/latest/docs/setup/getting-started/) requires `Gateway` and `VirtualService` API resources. -- OpenShift uses [routes]({{< relref "/operate/kubernetes/networking/routes.md" >}}) to route external traffic. +- OpenShift uses [routes]({{< relref "/operate/kubernetes/7.4.6/networking/routes.md" >}}) to route external traffic. - The RedisEnterpriseActiveActiveDatabase (REAADB) requires any of the above routing methods to be configured in the RedisEnterpriseCluster (REC) with the `ingressOrRouteSpec` field. ## External routing using Redis Enterprise for Kubernetes @@ -27,13 +27,13 @@ Redis Enterprise supports three [types of services](https://kubernetes.io/docs/c By default, the operator creates a `ClusterIP` type service, which exposes a cluster-internal IP and that can only be accessed from within the K8s cluster. For requests to be routed from outside the K8s cluster, you need an [Ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/) (or [route](https://docs.openshift.com/container-platform/4.12/networking/routes/route-configuration.html) if you are using OpenShift). See [kubernetes.io](https://kubernetes.io/docs/) for more details on [Ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/) and [Ingress controllers](https://kubernetes.io/docs/concepts/services-networking/ingress-controllers/). -* To use NGINX or HAProxy Ingress controllers, see [Ingress routing]({{< relref "/operate/kubernetes/networking/ingress.md" >}}). -* To use OpenShift routes, see [OpenShift routes]({{< relref "/operate/kubernetes/networking/routes.md" >}}). -* To use Istio as an Ingress controller, see [Istio Ingress routing]({{< relref "/operate/kubernetes/networking/istio-ingress.md" >}}) +* To use NGINX or HAProxy Ingress controllers, see [Ingress routing]({{< relref "/operate/kubernetes/7.4.6/networking/ingress.md" >}}). +* To use OpenShift routes, see [OpenShift routes]({{< relref "/operate/kubernetes/7.4.6/networking/routes.md" >}}). +* To use Istio as an Ingress controller, see [Istio Ingress routing]({{< relref "/operate/kubernetes/7.4.6/networking/istio-ingress.md" >}}) ## `ingressOrRouteSpec` for Active-Active databases -Versions 6.4.2 or later of Redis Enterprise for Kubernetes include a feature for ingress configuration. The `ingressOrRouteSpec` field is available in the RedisEnterpriseCluster spec to automatically create an Ingress (or route) for the API service and databases (REAADB) on that REC. See [REC external routing]({{< relref "/operate/kubernetes/networking/ingressorroutespec.md" >}}) for more details. +Versions 6.4.2 or later of Redis Enterprise for Kubernetes include a feature for ingress configuration. The `ingressOrRouteSpec` field is available in the RedisEnterpriseCluster spec to automatically create an Ingress (or route) for the API service and databases (REAADB) on that REC. See [REC external routing]({{< relref "/operate/kubernetes/7.4.6/networking/ingressorroutespec.md" >}}) for more details. This feature only supports automatic Ingress creation for Active-Active databases created and managed with the RedisEnterpriseActiveActiveDatabase (REAADB) custom resource. Use with the standard Redis Enterprise database (REDB) is not currently supported. diff --git a/content/operate/kubernetes/7.4.6/networking/ingress.md b/content/operate/kubernetes/7.4.6/networking/ingress.md index f95eee6a02..6c7f30ee57 100644 --- a/content/operate/kubernetes/7.4.6/networking/ingress.md +++ b/content/operate/kubernetes/7.4.6/networking/ingress.md @@ -21,7 +21,7 @@ Before creating an Ingress, you'll need: - [Ingress-NGINX Controller](https://kubernetes.github.io/ingress-nginx/deploy/) - Be sure to use the `kubernetes/ingress-nginx` controller and NOT the `nginxinc/kubernetes-ingress` controller. - [HAProxy Ingress](https://haproxy-ingress.github.io/docs/getting-started/) - - To use Istio for your Ingress resources, see [Configure Istio for external routing]({{< relref "/operate/kubernetes/networking/istio-ingress.md" >}}) + - To use Istio for your Ingress resources, see [Configure Istio for external routing]({{< relref "/operate/kubernetes/7.4.6/networking/istio-ingress.md" >}}) {{}}Make sure your Ingress controller has `ssl-passthrough`enabled. This is enabled by default for HAProxy, but disabled by default for NGINX. See the [NGINX User Guide](https://kubernetes.github.io/ingress-nginx/user-guide/tls/#ssl-passthrough) for details. {{}} diff --git a/content/operate/kubernetes/7.4.6/networking/ingressorroutespec.md b/content/operate/kubernetes/7.4.6/networking/ingressorroutespec.md index 739fbe4954..daf1ca803c 100644 --- a/content/operate/kubernetes/7.4.6/networking/ingressorroutespec.md +++ b/content/operate/kubernetes/7.4.6/networking/ingressorroutespec.md @@ -19,7 +19,7 @@ Redis Enterprise for Kubernetes supports the Ingress controllers below: * [NGINX](https://kubernetes.github.io/ingress-nginx/) * [Istio](https://istio.io/latest/docs/setup/getting-started/) -OpenShift users can use [routes]({{< relref "/operate/kubernetes/networking/routes.md" >}}) instead of an Ingress. +OpenShift users can use [routes]({{< relref "/operate/kubernetes/7.4.6/networking/routes.md" >}}) instead of an Ingress. Install your chosen Ingress controller, making sure `ssl-passthrough` is enabled. `ssl-passthrough` is turned off by default for NGINX but enabled by default for HAProxy. diff --git a/content/operate/kubernetes/7.4.6/networking/istio-ingress.md b/content/operate/kubernetes/7.4.6/networking/istio-ingress.md index fbd88d87b7..e1e09ec859 100644 --- a/content/operate/kubernetes/7.4.6/networking/istio-ingress.md +++ b/content/operate/kubernetes/7.4.6/networking/istio-ingress.md @@ -149,10 +149,10 @@ To configure Istio to work with the Redis Kubernetes operator, we will use two c redis-vs ["redis-gateway"] ["*.istio.k8s.my.example.com"] 3h33m ``` -1. [Deploy the operator]({{< relref "/operate/kubernetes/deployment/quick-start.md" >}}), Redis Enterprise Cluster (REC), and Redis Enterprise Database (REDB) on the same namespace as the gateway and virtual service. +1. [Deploy the operator]({{< relref "/operate/kubernetes/7.4.6/deployment/quick-start.md" >}}), Redis Enterprise Cluster (REC), and Redis Enterprise Database (REDB) on the same namespace as the gateway and virtual service. ## Test your external access to the database -To [test your external access]({{< relref "/operate/kubernetes/networking/ingress.md" >}}) to the database, you need a client that supports [TLS](https://en.wikipedia.org/wiki/Transport_Layer_Security) and [SNI](https://en.wikipedia.org/wiki/Server_Name_Indication). +To [test your external access]({{< relref "/operate/kubernetes/7.4.6/networking/ingress.md" >}}) to the database, you need a client that supports [TLS](https://en.wikipedia.org/wiki/Transport_Layer_Security) and [SNI](https://en.wikipedia.org/wiki/Server_Name_Indication). -See [Test your access with Openssl]({{< relref "/operate/kubernetes/networking/ingress#test-your-access-with-openssl" >}}) or [Test your access with Python]({{< relref "/operate/kubernetes/networking/ingress#test-your-access-with-python" >}}) for more info. +See [Test your access with Openssl]({{< relref "/operate/kubernetes/7.4.6/networking/ingress#test-your-access-with-openssl" >}}) or [Test your access with Python]({{< relref "/operate/kubernetes/7.4.6/networking/ingress#test-your-access-with-python" >}}) for more info. diff --git a/content/operate/kubernetes/7.4.6/re-clusters/auto-tiering.md b/content/operate/kubernetes/7.4.6/re-clusters/auto-tiering.md index e2adbef309..62c353ff24 100644 --- a/content/operate/kubernetes/7.4.6/re-clusters/auto-tiering.md +++ b/content/operate/kubernetes/7.4.6/re-clusters/auto-tiering.md @@ -32,7 +32,7 @@ For more information on node storage, see [Node persistent and ephemeral storage ## Create a Redis Enterprise cluster -To deploy a Redis Enterprise cluster (REC) with Auto Tiering, you'll need to specify the following in the `redisOnFlashSpec` section of your [REC custom resource]({{< relref "/operate/kubernetes/reference/redis_enterprise_cluster_api" >}}): +To deploy a Redis Enterprise cluster (REC) with Auto Tiering, you'll need to specify the following in the `redisOnFlashSpec` section of your [REC custom resource]({{< relref "/operate/kubernetes/7.4.6/reference/redis_enterprise_cluster_api" >}}): - enable Auto Tiering (`enabled: true`) - flash storage driver (`bigStoreDriver`) diff --git a/content/operate/kubernetes/7.4.6/re-clusters/cluster-recovery.md b/content/operate/kubernetes/7.4.6/re-clusters/cluster-recovery.md index 974d8227db..93b2db5184 100644 --- a/content/operate/kubernetes/7.4.6/re-clusters/cluster-recovery.md +++ b/content/operate/kubernetes/7.4.6/re-clusters/cluster-recovery.md @@ -27,7 +27,7 @@ The Redis Enterprise for Kubernetes automates these recovery steps: ## Prerequisites -- For cluster recovery, the cluster must be [deployed with persistence]({{< relref "/operate/kubernetes/recommendations/persistent-volumes.md" >}}). +- For cluster recovery, the cluster must be [deployed with persistence]({{< relref "/operate/kubernetes/7.4.6/recommendations/persistent-volumes.md" >}}). ## Recover a cluster diff --git a/content/operate/kubernetes/7.4.6/re-clusters/connect-prometheus-operator.md b/content/operate/kubernetes/7.4.6/re-clusters/connect-prometheus-operator.md index 3866f5d677..8e823d089f 100644 --- a/content/operate/kubernetes/7.4.6/re-clusters/connect-prometheus-operator.md +++ b/content/operate/kubernetes/7.4.6/re-clusters/connect-prometheus-operator.md @@ -18,9 +18,9 @@ To collect metrics data from your databases and Redis Enterprise cluster (REC), Before connecting Redis Enterprise to Prometheus on your Kubernetes cluster, make sure you've done the following: -- [Deploy Redis Enterprise for Kubernetes]({{< relref "/operate/kubernetes/deployment/quick-start.md" >}}) (version 6.2.10-4 or newer) +- [Deploy Redis Enterprise for Kubernetes]({{< relref "/operate/kubernetes/7.4.6/deployment/quick-start.md" >}}) (version 6.2.10-4 or newer) - [Deploy the Prometheus operator](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/user-guides/getting-started.md) (version 0.19.0 or newer) -- [Create a Redis Enterprise cluster]({{< relref "/operate/kubernetes/deployment/quick-start#create-a-redis-enterprise-cluster-rec" >}}) +- [Create a Redis Enterprise cluster]({{< relref "/operate/kubernetes/7.4.6/deployment/quick-start#create-a-redis-enterprise-cluster-rec" >}}) ## Create a `ServiceMonitor` custom resource diff --git a/content/operate/kubernetes/7.4.6/re-clusters/multi-namespace.md b/content/operate/kubernetes/7.4.6/re-clusters/multi-namespace.md index 1b943a61b5..ac1dd51731 100644 --- a/content/operate/kubernetes/7.4.6/re-clusters/multi-namespace.md +++ b/content/operate/kubernetes/7.4.6/re-clusters/multi-namespace.md @@ -15,19 +15,19 @@ url: '/operate/kubernetes/7.4.6/re-clusters/multi-namespace/' Multiple Redis Enterprise database resources (REDBs) can be associated with a single Redis Enterprise cluster resource (REC) even if they reside in different namespaces. -To learn more about designing a multi-namespace Redis Enterprise cluster, see [flexible deployment options]({{< relref "/operate/kubernetes/deployment/deployment-options" >}}). +To learn more about designing a multi-namespace Redis Enterprise cluster, see [flexible deployment options]({{< relref "/operate/kubernetes/7.4.6/deployment/deployment-options" >}}). {{}} Multi-namespace installations don't support Active-Active databases (REEADB). Only databases created with the REDB resource are supported in multi-namespace deployments at this time.{{}} ## Prerequisites -Before configuring a multi-namespace deployment, you must have a running [Redis Enterprise cluster (REC)]({{< relref "/operate/kubernetes/deployment/quick-start.md" >}}). See more information in the [deployment]({{< relref "/operate/kubernetes/deployment/" >}}) section. +Before configuring a multi-namespace deployment, you must have a running [Redis Enterprise cluster (REC)]({{< relref "/operate/kubernetes/7.4.6/deployment/quick-start.md" >}}). See more information in the [deployment]({{< relref "/operate/kubernetes/7.4.6/deployment/" >}}) section. ## Create role and role binding for managed namespaces Both the operator and the RedisEnterpriseCluster (REC) resource need access to each namespace the REC will manage. For each **managed** namespace, create a `role.yaml` and `role_binding.yaml` file within the managed namespace, as shown in the examples below. -{{}}These will need to be reapplied each time you [upgrade]({{< relref "/operate/kubernetes/upgrade/upgrade-redis-cluster.md" >}}). {{}} +{{}}These will need to be reapplied each time you [upgrade]({{< relref "/operate/kubernetes/7.4.6/upgrade/upgrade-redis-cluster.md" >}}). {{}} Replace `` with the namespace the REC resides in. Replace `` with your own value (defaults to the REC name). diff --git a/content/operate/kubernetes/7.4.6/re-databases/db-controller.md b/content/operate/kubernetes/7.4.6/re-databases/db-controller.md index 630edd642e..f01bbc3250 100644 --- a/content/operate/kubernetes/7.4.6/re-databases/db-controller.md +++ b/content/operate/kubernetes/7.4.6/re-databases/db-controller.md @@ -27,13 +27,13 @@ the custom resource with default values to create a full specification. It then database on the specified Redis Enterprise cluster (REC). Once the database is created, it is exposed with the same service mechanisms by the service rigger for the Redis Enterprise cluster. -If the database [custom resource is deleted]({{< relref "/operate/kubernetes/delete-custom-resources" >}}), the database and its services are deleted from the cluster. +If the database [custom resource is deleted]({{< relref "/operate/kubernetes/7.4.6/delete-custom-resources" >}}), the database and its services are deleted from the cluster. ### Flexible deployment options -Databases in multiple namespaces can be managed by the same operator. To learn more, see [Manage databases in multiple namespaces]({{< relref "/operate/kubernetes/re-clusters/multi-namespace" >}}). +Databases in multiple namespaces can be managed by the same operator. To learn more, see [Manage databases in multiple namespaces]({{< relref "/operate/kubernetes/7.4.6/re-clusters/multi-namespace" >}}). -To learn more about designing a multi-namespace Redis Enterprise cluster, see [flexible deployment options]({{< relref "/operate/kubernetes/deployment/deployment-options" >}}). +To learn more about designing a multi-namespace Redis Enterprise cluster, see [flexible deployment options]({{< relref "/operate/kubernetes/7.4.6/deployment/deployment-options" >}}). ## Create a database @@ -85,7 +85,7 @@ To modify the database: ``` 1. Change the specification (only properties in `spec` section) and save the changes. - For more details, see [RedisEnterpriseDatabaseSpec](https://github.com/RedisLabs/redis-enterprise-k8s-docs/blob/master/redis_enterprise_database_api.md#redisenterprisedatabasespec) or [Options for Redis Enterprise databases]({{< relref "/operate/kubernetes/reference/redis_enterprise_database_api" >}}). + For more details, see [RedisEnterpriseDatabaseSpec](https://github.com/RedisLabs/redis-enterprise-k8s-docs/blob/master/redis_enterprise_database_api.md#redisenterprisedatabasespec) or [Options for Redis Enterprise databases]({{< relref "/operate/kubernetes/7.4.6/reference/redis_enterprise_database_api" >}}). 1. Monitor the status to see when the changes take effect: @@ -119,7 +119,7 @@ Connection information for the database is stored in a Kubernetes [secret](https The name of that secret is stored in the database custom resource. {{}} -Use these steps to connect to your database from within your K8s cluster. To access your database from outside the K8s cluster, set up the [Ingress]({{< relref "/operate/kubernetes/networking/ingress.md" >}}) controller or use OpenShift routes. +Use these steps to connect to your database from within your K8s cluster. To access your database from outside the K8s cluster, set up the [Ingress]({{< relref "/operate/kubernetes/7.4.6/networking/ingress.md" >}}) controller or use OpenShift routes. {{}} 1. Retrieve the secret name. diff --git a/content/operate/kubernetes/7.4.6/recommendations/node-selection.md b/content/operate/kubernetes/7.4.6/recommendations/node-selection.md index 9f3f8d0fc5..424dcc457b 100644 --- a/content/operate/kubernetes/7.4.6/recommendations/node-selection.md +++ b/content/operate/kubernetes/7.4.6/recommendations/node-selection.md @@ -29,7 +29,7 @@ Here are the ways that you can control the pod scheduling: ## Using node selectors -The [`nodeSelector`]({{}}) +The [`nodeSelector`]({{}}) property of the cluster specification uses the same values and structures as the [Kubernetes `nodeSelector`](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#nodeselector). In general, node labels are a simple way to make sure that specific nodes are used for Redis Enterprise pods. diff --git a/content/operate/kubernetes/7.4.6/recommendations/persistent-volumes.md b/content/operate/kubernetes/7.4.6/recommendations/persistent-volumes.md index 7a69bceb75..431f18428d 100644 --- a/content/operate/kubernetes/7.4.6/recommendations/persistent-volumes.md +++ b/content/operate/kubernetes/7.4.6/recommendations/persistent-volumes.md @@ -50,7 +50,7 @@ requirements]({{< relref "/operate/rs/installing-upgrading/install/plan-deployme To explicitly specify the persistent storage size, use the *volumeSize* property as described in the example above. -Persistent volume claims can be expanded, but not reduced after creation. See [Expand PersistentVolumeClaim (PVC)]({{}}) for details. +Persistent volume claims can be expanded, but not reduced after creation. See [Expand PersistentVolumeClaim (PVC)]({{}}) for details. {{< note >}} We recommend that you omit the volumeSize definition from the REC declaration diff --git a/content/operate/kubernetes/7.4.6/recommendations/sizing-on-kubernetes.md b/content/operate/kubernetes/7.4.6/recommendations/sizing-on-kubernetes.md index ce776262fc..ab3fb8b1d1 100644 --- a/content/operate/kubernetes/7.4.6/recommendations/sizing-on-kubernetes.md +++ b/content/operate/kubernetes/7.4.6/recommendations/sizing-on-kubernetes.md @@ -117,5 +117,5 @@ Then, apply the file by running: When adjusting compute resources, make sure the ratio of persistent volume size and the new memory size are in accordance to the [Hardware requirements]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/hardware-requirements.md" >}}). -Persistent volume claims can be expanded, but not reduced after creation. See [Expand PersistentVolumeClaim (PVC)]({{}}) for details. +Persistent volume claims can be expanded, but not reduced after creation. See [Expand PersistentVolumeClaim (PVC)]({{}}) for details. {{< /warning >}} diff --git a/content/operate/kubernetes/7.4.6/reference/supported_k8s_distributions.md b/content/operate/kubernetes/7.4.6/reference/supported_k8s_distributions.md index 40a017b51f..7a8ce62fd8 100644 --- a/content/operate/kubernetes/7.4.6/reference/supported_k8s_distributions.md +++ b/content/operate/kubernetes/7.4.6/reference/supported_k8s_distributions.md @@ -234,4 +234,4 @@ For details on this platform, see the [TKGI documentation](https://docs.vmware.c ## Supported upgrade paths - If you are using a version earlier than 6.2.10-45, [you must upgrade]({{< relref "/operate/kubernetes/upgrade" >}}) to 6.2.10-45 before you can upgrade to versions 6.2.18 or later. + If you are using a version earlier than 6.2.10-45, [you must upgrade]({{< relref "/operate/kubernetes/7.4.6/upgrade" >}}) to 6.2.10-45 before you can upgrade to versions 6.2.18 or later. diff --git a/content/operate/kubernetes/7.4.6/security/manage-rec-credentials.md b/content/operate/kubernetes/7.4.6/security/manage-rec-credentials.md index a5a1b8a1ad..62e4fa47b9 100644 --- a/content/operate/kubernetes/7.4.6/security/manage-rec-credentials.md +++ b/content/operate/kubernetes/7.4.6/security/manage-rec-credentials.md @@ -9,7 +9,7 @@ linkTitle: Manage REC credentials weight: 93 url: '/operate/kubernetes/7.4.6/security/manage-rec-credentials/' --- -Redis Enterprise for Kubernetes uses a custom resource called [`RedisEnterpriseCluster`]({{< relref "/operate/kubernetes/reference/redis_enterprise_cluster_api" >}}) to create a Redis Enterprise cluster (REC). During creation it generates random credentials for the operator to use. The credentials are saved in a Kubernetes (K8s) [secret](https://kubernetes.io/docs/concepts/configuration/secret/). The secret name defaults to the name of the cluster. +Redis Enterprise for Kubernetes uses a custom resource called [`RedisEnterpriseCluster`]({{< relref "/operate/kubernetes/7.4.6/reference/redis_enterprise_cluster_api" >}}) to create a Redis Enterprise cluster (REC). During creation it generates random credentials for the operator to use. The credentials are saved in a Kubernetes (K8s) [secret](https://kubernetes.io/docs/concepts/configuration/secret/). The secret name defaults to the name of the cluster. {{}} This procedure is only supported for operator versions 6.0.20-12 and above. @@ -109,7 +109,7 @@ The credentials can be used to access the Redis Enterprise admin console or the ### Change both the REC username and password -1. [Connect to the admin console]({{< relref "/operate/kubernetes/re-clusters/connect-to-admin-console.md" >}}) +1. [Connect to the admin console]({{< relref "/operate/kubernetes/7.4.6/re-clusters/connect-to-admin-console.md" >}}) 1. [Add another admin user]({{< relref "/operate/rs/security/access-control/create-users" >}}) and choose a new password. diff --git a/content/operate/kubernetes/7.4.6/upgrade/_index.md b/content/operate/kubernetes/7.4.6/upgrade/_index.md index f34d642f2b..391d252f22 100644 --- a/content/operate/kubernetes/7.4.6/upgrade/_index.md +++ b/content/operate/kubernetes/7.4.6/upgrade/_index.md @@ -18,9 +18,9 @@ Redis implements rolling updates for software upgrades in Kubernetes deployments 2. Upgrade the Redis Enterprise cluster (REC) 3. Upgrade Redis Enterprise databases (REDB) -To use OpenShift container platform CLI to upgrade your Redis Enterprise, see [Upgrade Redis Enterprise with OpenShift CLI]({{< relref "/operate/kubernetes/upgrade/openshift-cli.md" >}}). +To use OpenShift container platform CLI to upgrade your Redis Enterprise, see [Upgrade Redis Enterprise with OpenShift CLI]({{< relref "/operate/kubernetes/7.4.6/upgrade/openshift-cli.md" >}}). -For all other Kubernetes distributions, see [Upgrade Redis Enterprise for Kubernetes]({{< relref "/operate/kubernetes/upgrade/upgrade-redis-cluster.md" >}}). +For all other Kubernetes distributions, see [Upgrade Redis Enterprise for Kubernetes]({{< relref "/operate/kubernetes/7.4.6/upgrade/upgrade-redis-cluster.md" >}}). ## Upgrade compatibility diff --git a/content/operate/kubernetes/7.4.6/upgrade/openshift-cli.md b/content/operate/kubernetes/7.4.6/upgrade/openshift-cli.md index 0e6a3bd5d1..08d40a00f2 100644 --- a/content/operate/kubernetes/7.4.6/upgrade/openshift-cli.md +++ b/content/operate/kubernetes/7.4.6/upgrade/openshift-cli.md @@ -20,7 +20,7 @@ Redis implements rolling updates for software upgrades in Kubernetes deployments ## Before upgrading -1. Check [Supported Kubernetes distributions]({{< relref "/operate/kubernetes/reference/supported_k8s_distributions" >}}) to make sure your Kubernetes distribution is supported. +1. Check [Supported Kubernetes distributions]({{< relref "/operate/kubernetes/7.4.6/reference/supported_k8s_distributions" >}}) to make sure your Kubernetes distribution is supported. 2. Use `oc get rec` and verify the `LICENSE STATE` is valid on your REC before you start the upgrade process. @@ -103,7 +103,7 @@ redis-enterprise-operator 1/1 1 1 0m36s ### Reapply the SCC -If you are using OpenShift, you will also need to manually reapply the [security context constraints](https://docs.openshift.com/container-platform/4.8/authentication/managing-security-context-constraints.html) file ([`scc.yaml`]({{< relref "/operate/kubernetes/deployment/openshift/openshift-cli#deploy-the-operator" >}})) and bind it to your service account. +If you are using OpenShift, you will also need to manually reapply the [security context constraints](https://docs.openshift.com/container-platform/4.8/authentication/managing-security-context-constraints.html) file ([`scc.yaml`]({{< relref "/operate/kubernetes/7.4.6/deployment/openshift/openshift-cli#deploy-the-operator" >}})) and bind it to your service account. ```sh oc apply -f openshift/scc.yaml @@ -153,7 +153,7 @@ After the operator upgrade is complete, you can upgrade Redis Enterprise cluster ### Reapply roles and role bindings -If your operator is monitoring multiple namespaces, you'll need to [reapply your role and role bindings]({{< relref "/operate/kubernetes/re-clusters/multi-namespace#create-role-and-role-binding-for-managed-namespaces" >}}) for each managed namespace. See [Manage databases in multiple namespaces]({{< relref "/operate/kubernetes/re-clusters/multi-namespace" >}}) for more details. +If your operator is monitoring multiple namespaces, you'll need to [reapply your role and role bindings]({{< relref "/operate/kubernetes/7.4.6/re-clusters/multi-namespace#create-role-and-role-binding-for-managed-namespaces" >}}) for each managed namespace. See [Manage databases in multiple namespaces]({{< relref "/operate/kubernetes/7.4.6/re-clusters/multi-namespace" >}}) for more details. ### Monitor the upgrade @@ -206,7 +206,7 @@ If all of your clusters have been upgraded to operator version 6.4.2-6 or later, After the cluster is upgraded, you can upgrade your databases. The process for upgrading databases is the same for both Kubernetes and non-Kubernetes deployments. For more details on how to [upgrade a database]({{< relref "/operate/rs/installing-upgrading/upgrading/upgrade-database" >}}), see the [Upgrade an existing Redis Enterprise Software deployment]({{< relref "/operate/rs/installing-upgrading/upgrading" >}}) documentation. -Note that if your cluster [`redisUpgradePolicy`]({{< relref "/operate/kubernetes/reference/redis_enterprise_cluster_api#redisupgradepolicy" >}}) or your database [`redisVersion`]({{< relref "/operate/kubernetes/reference/redis_enterprise_database_api#redisversion" >}}) are set to `major`, you won't be able to upgrade those databases to minor versions. See [Redis upgrade policy]({{< relref "/operate/rs/installing-upgrading/upgrading#redis-upgrade-policy" >}}) for more details. +Note that if your cluster [`redisUpgradePolicy`]({{< relref "/operate/kubernetes/7.4.6/reference/redis_enterprise_cluster_api#redisupgradepolicy" >}}) or your database [`redisVersion`]({{< relref "/operate/kubernetes/7.4.6/reference/redis_enterprise_database_api#redisversion" >}}) are set to `major`, you won't be able to upgrade those databases to minor versions. See [Redis upgrade policy]({{< relref "/operate/rs/installing-upgrading/upgrading#redis-upgrade-policy" >}}) for more details. diff --git a/content/operate/kubernetes/7.4.6/upgrade/upgrade-olm.md b/content/operate/kubernetes/7.4.6/upgrade/upgrade-olm.md index 4a0272893c..ed7bae92d2 100644 --- a/content/operate/kubernetes/7.4.6/upgrade/upgrade-olm.md +++ b/content/operate/kubernetes/7.4.6/upgrade/upgrade-olm.md @@ -14,7 +14,7 @@ url: '/operate/kubernetes/7.4.6/upgrade/upgrade-olm/' ## Before upgrading -1. Check [Supported Kubernetes distributions]({{< relref "/operate/kubernetes/reference/supported_k8s_distributions" >}}) to make sure your Kubernetes distribution is supported. +1. Check [Supported Kubernetes distributions]({{< relref "/operate/kubernetes/7.4.6/reference/supported_k8s_distributions" >}}) to make sure your Kubernetes distribution is supported. 2. Use `oc get rec` and verify the `LICENSE STATE` is valid on your REC before you start the upgrade process. @@ -38,7 +38,7 @@ You can monitor the upgrade from the **Installed Operators** page. A new Redis E ## Reapply the SCC -If you are using OpenShift, you will also need to manually reapply the [security context constraints](https://docs.openshift.com/container-platform/4.8/authentication/managing-security-context-constraints.html) file ([`scc.yaml`]({{< relref "/operate/kubernetes/deployment/openshift/openshift-cli#deploy-the-operator" >}})) and bind it to your service account. +If you are using OpenShift, you will also need to manually reapply the [security context constraints](https://docs.openshift.com/container-platform/4.8/authentication/managing-security-context-constraints.html) file ([`scc.yaml`]({{< relref "/operate/kubernetes/7.4.6/deployment/openshift/openshift-cli#deploy-the-operator" >}})) and bind it to your service account. ```sh oc apply -f openshift/scc.yaml @@ -49,4 +49,4 @@ oc adm policy add-scc-to-user redis-enterprise-scc-v2 \ system:serviceaccount:: ``` -If you are upgrading from operator version 6.4.2-6 or before, see the [after upgrading section in the OpenShift CLI upgrade]({{}}) to delete the old SCC and role binding after all clusters are running 6.4.2-6 or later. +If you are upgrading from operator version 6.4.2-6 or before, see the [after upgrading section in the OpenShift CLI upgrade]({{}}) to delete the old SCC and role binding after all clusters are running 6.4.2-6 or later. diff --git a/content/operate/kubernetes/7.4.6/upgrade/upgrade-redis-cluster.md b/content/operate/kubernetes/7.4.6/upgrade/upgrade-redis-cluster.md index 86c89bb643..7da2872261 100644 --- a/content/operate/kubernetes/7.4.6/upgrade/upgrade-redis-cluster.md +++ b/content/operate/kubernetes/7.4.6/upgrade/upgrade-redis-cluster.md @@ -20,7 +20,7 @@ Redis implements rolling updates for software upgrades in Kubernetes deployments ## Prerequisites -1. Check [Supported Kubernetes distributions]({{< relref "/operate/kubernetes/reference/supported_k8s_distributions" >}}) to make sure your Kubernetes distribution is supported. +1. Check [Supported Kubernetes distributions]({{< relref "/operate/kubernetes/7.4.6/reference/supported_k8s_distributions" >}}) to make sure your Kubernetes distribution is supported. 1. Use `kubectl get rec` and verify the `LICENSE STATE` is valid on your REC before you start the upgrade process. @@ -142,7 +142,7 @@ If you are upgrading from a preview version of the Active-Active controller, you ### Reapply roles and role bindings -If your operator is monitoring multiple namespaces, you'll need to [reapply your role and role bindings]({{< relref "/operate/kubernetes/re-clusters/multi-namespace#create-role-and-role-binding-for-managed-namespaces" >}}) for each managed namespace. See [Manage databases in multiple namespaces]({{< relref "/operate/kubernetes/re-clusters/multi-namespace" >}}) for more details. +If your operator is monitoring multiple namespaces, you'll need to [reapply your role and role bindings]({{< relref "/operate/kubernetes/7.4.6/re-clusters/multi-namespace#create-role-and-role-binding-for-managed-namespaces" >}}) for each managed namespace. See [Manage databases in multiple namespaces]({{< relref "/operate/kubernetes/7.4.6/re-clusters/multi-namespace" >}}) for more details. ### Monitor the upgrade @@ -172,4 +172,4 @@ For more details on how to [upgrade a database]({{< relref "/operate/rs/installi For Active-Active databases, see [Upgrade an Active-Active database]({{}}). -Note that if your cluster [`redisUpgradePolicy`]({{< relref "/operate/kubernetes/reference/redis_enterprise_cluster_api#redisupgradepolicy" >}}) or your database [`redisVersion`]({{< relref "/operate/kubernetes/reference/redis_enterprise_database_api#redisversion" >}}) are set to `major`, you won't be able to upgrade those databases to minor versions. See [Redis upgrade policy]({{< relref "/operate/rs/installing-upgrading/upgrading#redis-upgrade-policy" >}}) for more details. +Note that if your cluster [`redisUpgradePolicy`]({{< relref "/operate/kubernetes/7.4.6/reference/redis_enterprise_cluster_api#redisupgradepolicy" >}}) or your database [`redisVersion`]({{< relref "/operate/kubernetes/7.4.6/reference/redis_enterprise_database_api#redisversion" >}}) are set to `major`, you won't be able to upgrade those databases to minor versions. See [Redis upgrade policy]({{< relref "/operate/rs/installing-upgrading/upgrading#redis-upgrade-policy" >}}) for more details. diff --git a/content/operate/kubernetes/7.8.4/active-active/_index.md b/content/operate/kubernetes/7.8.4/active-active/_index.md index 3a8502c6cc..db671e877b 100644 --- a/content/operate/kubernetes/7.8.4/active-active/_index.md +++ b/content/operate/kubernetes/7.8.4/active-active/_index.md @@ -30,9 +30,9 @@ Versions 6.4.2-6 or later fully support the Active-Active controller. Some of th This setup method includes the following steps: -1. Gather REC credentials and [prepare participating clusters]({{< relref "/operate/kubernetes/active-active/prepare-clusters.md" >}}). -2. Create [`RedisEnterpriseRemoteCluster` (RERC)]({{< relref "/operate/kubernetes/active-active/create-reaadb#create-rerc" >}}) resources. -3. Create [`RedisEnterpriseActiveActiveDatabase` (REAADB)]({{< relref "/operate/kubernetes/active-active/create-reaadb#create-reaadb" >}}) resource. +1. Gather REC credentials and [prepare participating clusters]({{< relref "/operate/kubernetes/7.8.4/active-active/prepare-clusters.md" >}}). +2. Create [`RedisEnterpriseRemoteCluster` (RERC)]({{< relref "/operate/kubernetes/7.8.4/active-active/create-reaadb#create-rerc" >}}) resources. +3. Create [`RedisEnterpriseActiveActiveDatabase` (REAADB)]({{< relref "/operate/kubernetes/7.8.4/active-active/create-reaadb#create-reaadb" >}}) resource. ### `crdb-cli` method @@ -49,7 +49,7 @@ For versions 6.4.2 or earlier, this Active-Active setup method includes the foll [Active-Active]({{< relref "/operate/rs/databases/active-active/" >}}) databases give you read-and-write access to Redis Enterprise clusters (REC) in different Kubernetes clusters or namespaces. Active-Active deployments managed by the Redis Enterprise operator require two additional custom resources: Redis Enterprise Active-Active database (REAADB) and Redis Enterprise remote cluster (RERC). -To create an Active-Active Redis Enterprise deployment for Kubernetes with these new features, first [prepare participating clusters]({{< relref "/operate/kubernetes/active-active/prepare-clusters.md" >}}) then [create an Active-Active database]({{< relref "/operate/kubernetes/active-active/create-reaadb.md" >}}). +To create an Active-Active Redis Enterprise deployment for Kubernetes with these new features, first [prepare participating clusters]({{< relref "/operate/kubernetes/7.8.4/active-active/prepare-clusters.md" >}}) then [create an Active-Active database]({{< relref "/operate/kubernetes/7.8.4/active-active/create-reaadb.md" >}}). ### Preview versions @@ -76,13 +76,13 @@ If you are using a preview version of these features (operator version 6.4.2-4 o Redis Enterprise Active-Active database (REAADB) contains a link to the RERC for each participating cluster, and provides configuration and status to the management plane. -For a full list of fields and options, see the [REAADB API reference]({{}}). +For a full list of fields and options, see the [REAADB API reference]({{}}). ### RERC custom resource Redis Enterprise remote cluster (RERC) custom resource contains configuration details for all the participating clusters. -For a full list of fields and options, see the [RERC API reference]({{}}). +For a full list of fields and options, see the [RERC API reference]({{}}). ### Limitations diff --git a/content/operate/kubernetes/7.8.4/active-active/create-aa-crdb-cli.md b/content/operate/kubernetes/7.8.4/active-active/create-aa-crdb-cli.md index c32aa38eee..5a798c7fca 100644 --- a/content/operate/kubernetes/7.8.4/active-active/create-aa-crdb-cli.md +++ b/content/operate/kubernetes/7.8.4/active-active/create-aa-crdb-cli.md @@ -11,11 +11,11 @@ linkTitle: Create Active-Active with crdb-cli weight: 99 url: '/operate/kubernetes/7.8.4/active-active/create-aa-crdb-cli/' --- -{{}} Versions 6.4.2 and later support the Active-Active database controller. This controller allows you to create Redis Enterprise Active-Active databases (REAADB) and Redis Enterprise remote clusters (RERC) with custom resources. We recommend using the [REAADB method for creating Active-Active databases]({{< relref "/operate/kubernetes/active-active/create-reaadb.md" >}}).{{}} +{{}} Versions 6.4.2 and later support the Active-Active database controller. This controller allows you to create Redis Enterprise Active-Active databases (REAADB) and Redis Enterprise remote clusters (RERC) with custom resources. We recommend using the [REAADB method for creating Active-Active databases]({{< relref "/operate/kubernetes/7.8.4/active-active/create-reaadb.md" >}}).{{}} On Kubernetes, Redis Enterprise [Active-Active]({{< relref "/operate/rs/databases/active-active/" >}}) databases provide read-and-write access to the same dataset from different Kubernetes clusters. For more general information about Active-Active, see the [Redis Enterprise Software docs]({{< relref "/operate/rs/databases/active-active/" >}}). -Creating an Active-Active database requires routing [network access]({{< relref "/operate/kubernetes/networking/" >}}) between two Redis Enterprise clusters residing in different Kubernetes clusters. Without the proper access configured for each cluster, syncing between the databases instances will fail. +Creating an Active-Active database requires routing [network access]({{< relref "/operate/kubernetes/7.8.4/networking/" >}}) between two Redis Enterprise clusters residing in different Kubernetes clusters. Without the proper access configured for each cluster, syncing between the databases instances will fail. This process consists of: @@ -27,8 +27,8 @@ This process consists of: Before creating Active-Active databases, you'll need admin access to two or more working Kubernetes clusters that each have: -- Routing for external access with an [ingress resources]({{< relref "/operate/kubernetes/networking/ingress.md" >}}) (or [route resources]({{< relref "/operate/kubernetes/networking/routes.md" >}}) on OpenShift). -- A working [Redis Enterprise cluster (REC)]({{< relref "/operate/kubernetes/reference/redis_enterprise_cluster_api" >}}) with a unique name. +- Routing for external access with an [ingress resources]({{< relref "/operate/kubernetes/7.8.4/networking/ingress.md" >}}) (or [route resources]({{< relref "/operate/kubernetes/7.8.4/networking/routes.md" >}}) on OpenShift). +- A working [Redis Enterprise cluster (REC)]({{< relref "/operate/kubernetes/7.8.4/reference/redis_enterprise_cluster_api" >}}) with a unique name. - Enough memory resources available for the database (see [hardware requirements]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/hardware-requirements.md" >}})). {{}} The `activeActive` field and the `ingressOrRouteSpec` field cannot coexist in the same REC. If you configured your ingress via the `ingressOrRouteSpec` field in the REC, create your Active-Active database with the RedisEnterpriseActiveActiveDatabase (REAADB) custom resource.{{}} @@ -70,7 +70,7 @@ You'll need to create DNS aliases to resolve your API hostname ``, - Description: Combined with database name to create the Active-Active database hostname - Format: string - Example value: `-cluster.ijk.example.com` -- [**REC admin credentials**]({{< relref "/operate/kubernetes/security/manage-rec-credentials.md" >}}) ` `: +- [**REC admin credentials**]({{< relref "/operate/kubernetes/7.8.4/security/manage-rec-credentials.md" >}}) ` `: - Description: Admin username and password for the REC stored in a secret - Format: string - Example value: username: `user@example.com`, password: `something` @@ -100,7 +100,7 @@ From inside your K8s cluster, edit your Redis Enterprise cluster (REC) resource ### Using ingress controller -1. If your cluster uses an [ingress controller]({{< relref "/operate/kubernetes/networking/ingress.md" >}}), add the following to the `spec` section of your REC resource file. +1. If your cluster uses an [ingress controller]({{< relref "/operate/kubernetes/7.8.4/networking/ingress.md" >}}), add the following to the `spec` section of your REC resource file. Nginx: @@ -147,7 +147,7 @@ HAproxy: #### If using Istio Gateway and VirtualService -No changes are required to the REC spec if you are using [Istio]({{< relref "/operate/kubernetes/networking/istio-ingress.md" >}}) in place of an ingress controller. The `activeActive` section added above creates ingress resources. The two custom resources used to configure Istio (Gateway and VirtualService) replace the need for ingress resources. +No changes are required to the REC spec if you are using [Istio]({{< relref "/operate/kubernetes/7.8.4/networking/istio-ingress.md" >}}) in place of an ingress controller. The `activeActive` section added above creates ingress resources. The two custom resources used to configure Istio (Gateway and VirtualService) replace the need for ingress resources. {{}} These custom resources are not controlled by the operator and will need to be configured and maintained manually. @@ -174,7 +174,7 @@ For each cluster, verify the VirtualService resource has two `- match:` blocks i 1. Make sure you have DNS aliases for each database that resolve your API hostname ``,``, `` to the route IP address. To avoid entering multiple DNS records, you can use a wildcard in your alias (such as `*.ijk.example.com`). -1. If your cluster uses [OpenShift routes]({{< relref "/operate/kubernetes/networking/routes.md" >}}), add the following to the `spec` section of your Redis Enterprise cluster (REC) resource file. +1. If your cluster uses [OpenShift routes]({{< relref "/operate/kubernetes/7.8.4/networking/routes.md" >}}), add the following to the `spec` section of your Redis Enterprise cluster (REC) resource file. ```sh activeActive: @@ -195,7 +195,7 @@ For each cluster, verify the VirtualService resource has two `- match:` blocks i ## Create an Active-Active database with `crdb-cli` -The `crdb-cli` command can be run from any Redis Enterprise pod hosted on any participating K8s cluster. You'll need the values for the [required parameters]({{< relref "/operate/kubernetes/active-active/create-aa-crdb-cli#document-required-parameters" >}}) for each Redis Enterprise cluster. +The `crdb-cli` command can be run from any Redis Enterprise pod hosted on any participating K8s cluster. You'll need the values for the [required parameters]({{< relref "/operate/kubernetes/7.8.4/active-active/create-aa-crdb-cli#document-required-parameters" >}}) for each Redis Enterprise cluster. ```sh crdb-cli crdb create \ @@ -214,4 +214,4 @@ See the [`crdb-cli` reference]({{< relref "/operate/rs/references/cli-utilities/ The easiest way to test your Active-Active database is to set a key-value pair in one database and retrieve it from the other. -You can connect to your databases with the instructions in [Manage databases]({{< relref "/operate/kubernetes/re-databases/db-controller#connect-to-a-database" >}}). Set a test key with `SET foo bar` in the first database. If your Active-Active deployment is working properly, when connected to your second database, `GET foo` should output `bar`. +You can connect to your databases with the instructions in [Manage databases]({{< relref "/operate/kubernetes/7.8.4/re-databases/db-controller#connect-to-a-database" >}}). Set a test key with `SET foo bar` in the first database. If your Active-Active deployment is working properly, when connected to your second database, `GET foo` should output `bar`. diff --git a/content/operate/kubernetes/7.8.4/active-active/create-reaadb.md b/content/operate/kubernetes/7.8.4/active-active/create-reaadb.md index 4e9bd33178..c41019ab78 100644 --- a/content/operate/kubernetes/7.8.4/active-active/create-reaadb.md +++ b/content/operate/kubernetes/7.8.4/active-active/create-reaadb.md @@ -17,18 +17,18 @@ url: '/operate/kubernetes/7.8.4/active-active/create-reaadb/' To create an Active-Active database, make sure you've completed all the following steps and have gathered the information listed below each step. -1. Configure the [admission controller and ValidatingWebhook]({{< relref "/operate/kubernetes/deployment/quick-start.md#enable-the-admission-controller/" >}}). +1. Configure the [admission controller and ValidatingWebhook]({{< relref "/operate/kubernetes/7.8.4/deployment/quick-start.md#enable-the-admission-controller/" >}}). {{}}These are installed and enabled by default on clusters created via the OpenShift OperatorHub. {{}} -2. Create two or more [RedisEnterpriseCluster (REC) custom resources]({{< relref "/operate/kubernetes/deployment/quick-start#create-a-redis-enterprise-cluster-rec" >}}) with enough [memory resources]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/hardware-requirements.md" >}}). +2. Create two or more [RedisEnterpriseCluster (REC) custom resources]({{< relref "/operate/kubernetes/7.8.4/deployment/quick-start#create-a-redis-enterprise-cluster-rec" >}}) with enough [memory resources]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/hardware-requirements.md" >}}). * Name of each REC (``) * Namespace for each REC (``) -3. Configure the REC [`ingressOrRoutes` field]({{< relref "/operate/kubernetes/networking/ingressorroutespec.md" >}}) and [create DNS records]({{< relref "/operate/kubernetes/networking/ingressorroutespec#configure-dns/" >}}). +3. Configure the REC [`ingressOrRoutes` field]({{< relref "/operate/kubernetes/7.8.4/networking/ingressorroutespec.md" >}}) and [create DNS records]({{< relref "/operate/kubernetes/7.8.4/networking/ingressorroutespec#configure-dns/" >}}). * REC API hostname (`api--.`) * Database hostname suffix (`-db--.`) -4. [Prepare participating clusters]({{< relref "/operate/kubernetes/active-active/prepare-clusters.md" >}}) +4. [Prepare participating clusters]({{< relref "/operate/kubernetes/7.8.4/active-active/prepare-clusters.md" >}}) * RERC name (`) * RERC secret name (`redis-enterprise-`) @@ -70,7 +70,7 @@ For a list of example values used throughout this article, see the [Example valu secretName: redis-enterprise-rerc-reagan ``` - For more details on RERC fields, see the [RERC API reference]({{}}). + For more details on RERC fields, see the [RERC API reference]({{}}). 1. Create a Redis Enterprise remote cluster from each RERC custom resource file. @@ -124,7 +124,7 @@ For a list of example values used throughout this article, see the [Example valu {{}}Sharding is disabled on Active-Active databases created with a `shardCount` of 1. Sharding cannot be enabled after database creation. {{}} - For more details on RERC fields, see the [RERC API reference]({{}}). + For more details on RERC fields, see the [RERC API reference]({{}}). 1. Create a Redis Enterprise Active-Active database from the REAADB custom resource file. diff --git a/content/operate/kubernetes/7.8.4/active-active/edit-clusters.md b/content/operate/kubernetes/7.8.4/active-active/edit-clusters.md index f3633ba30a..11d338cad4 100644 --- a/content/operate/kubernetes/7.8.4/active-active/edit-clusters.md +++ b/content/operate/kubernetes/7.8.4/active-active/edit-clusters.md @@ -19,7 +19,7 @@ Use the following steps to add a participating cluster to an existing Redis Ente ### Prerequisites -To prepare the Redis Enterprise cluster (REC) to participate in an Active-Active database, perform the following tasks from [Prepare participating clusters]({{< relref "/operate/kubernetes/active-active/prepare-clusters.md" >}}): +To prepare the Redis Enterprise cluster (REC) to participate in an Active-Active database, perform the following tasks from [Prepare participating clusters]({{< relref "/operate/kubernetes/7.8.4/active-active/prepare-clusters.md" >}}): - Make sure the cluster meets the hardware and naming requirements. - Enable the Active-Active controllers. diff --git a/content/operate/kubernetes/7.8.4/active-active/edit-rerc.md b/content/operate/kubernetes/7.8.4/active-active/edit-rerc.md index 123ab99657..18a5502a25 100644 --- a/content/operate/kubernetes/7.8.4/active-active/edit-rerc.md +++ b/content/operate/kubernetes/7.8.4/active-active/edit-rerc.md @@ -17,11 +17,11 @@ Before a RedisEnterpriseCluster (REC) can participate in an Active-Active databa The RERC controller periodically connects to the local REC endpoint via its external address, to ensure it’s setup correctly. For this to work, the external load balancer must support [NAT hairpinning](https://en.wikipedia.org/wiki/Network_address_translation#NAT_loopback). In some cloud environments, this may involve disabling IP preservation for the load balancer target groups. -For more details, see the [RERC API reference]({{}}). +For more details, see the [RERC API reference]({{}}). ## Edit RERC -Use the `kubectl patch rerc --type merge --patch` command to patch the local RERC custom resource with your changes. For a full list of available fields, see the [RERC API reference]({{}}). +Use the `kubectl patch rerc --type merge --patch` command to patch the local RERC custom resource with your changes. For a full list of available fields, see the [RERC API reference]({{}}). The following example edits the `dbFqdnSuffix` field for the RERC named `rerc-ohare`. @@ -68,7 +68,7 @@ If the credentials are changed or updated for a REC participating cluster, you n rerc-ohare Active Valid true ``` - To troubleshoot invalid configurations, view the RERC custom resource events and the [Redis Enterprise operator logs]({{< relref "/operate/kubernetes/logs/" >}}). + To troubleshoot invalid configurations, view the RERC custom resource events and the [Redis Enterprise operator logs]({{< relref "/operate/kubernetes/7.8.4/logs/" >}}). 1. Verify the status of each REAADB using that RERC is "Active" and the spec status is "Valid." @@ -79,6 +79,6 @@ If the credentials are changed or updated for a REC participating cluster, you n reaadb-boeing active Valid up ``` - To troubleshoot invalid configurations, view the RERC custom resource events and the [Redis Enterprise operator logs]({{< relref "/operate/kubernetes/logs/" >}}). + To troubleshoot invalid configurations, view the RERC custom resource events and the [Redis Enterprise operator logs]({{< relref "/operate/kubernetes/7.8.4/logs/" >}}). 1. Repeat the above steps on all other participating clusters. diff --git a/content/operate/kubernetes/7.8.4/active-active/global-config.md b/content/operate/kubernetes/7.8.4/active-active/global-config.md index ebf5ab5372..f74ea34096 100644 --- a/content/operate/kubernetes/7.8.4/active-active/global-config.md +++ b/content/operate/kubernetes/7.8.4/active-active/global-config.md @@ -15,7 +15,7 @@ url: '/operate/kubernetes/7.8.4/active-active/global-config/' The Redis Enterprise Active-Active database (REAADB) custom resource contains the field `.spec.globalConfigurations`. This field sets configurations for the Active-Active database across all participating clusters, such as memory size, shard count, and the global database secrets. -The [REAADB API reference]({{}}) contains a full list of available fields. +The [REAADB API reference]({{}}) contains a full list of available fields. ## Edit global configurations @@ -47,7 +47,7 @@ The [REAADB API reference]({{}}). +This section edits the secrets under the REAADB `.spec.globalConfigurations` section. For more information and all available fields, see the [REAADB API reference]({{}}). 1. On an existing participating cluster, generate a YAML file containing the database secret with the relevant data. diff --git a/content/operate/kubernetes/7.8.4/active-active/global-db-secret.md b/content/operate/kubernetes/7.8.4/active-active/global-db-secret.md index a2fd9df558..fdc2d62341 100644 --- a/content/operate/kubernetes/7.8.4/active-active/global-db-secret.md +++ b/content/operate/kubernetes/7.8.4/active-active/global-db-secret.md @@ -17,7 +17,7 @@ url: '/operate/kubernetes/7.8.4/active-active/global-db-secret/' One of the fields available for `globalConfigurations` is `databaseSecretName` which can point to a secret containing the database password. To set the database secret name and sync the data to all participating clusters, follow the steps below. -To edit other global configruations, see [global configuration]({{< relref "/operate/kubernetes/active-active/global-config.md" >}}) +To edit other global configruations, see [global configuration]({{< relref "/operate/kubernetes/7.8.4/active-active/global-config.md" >}}) 1. On an existing participating cluster, generate a YAML file containing the database secret with the database password. diff --git a/content/operate/kubernetes/7.8.4/active-active/prepare-clusters.md b/content/operate/kubernetes/7.8.4/active-active/prepare-clusters.md index 5384ce8679..2b4ac5c555 100644 --- a/content/operate/kubernetes/7.8.4/active-active/prepare-clusters.md +++ b/content/operate/kubernetes/7.8.4/active-active/prepare-clusters.md @@ -18,13 +18,13 @@ url: '/operate/kubernetes/7.8.4/active-active/prepare-clusters/' Before you prepare your clusters to participate in an Active-Active database, make sure you've completed all the following steps and have gathered the information listed below each step. -1. Configure the [admission controller and ValidatingWebhook]({{< relref "/operate/kubernetes/deployment/quick-start.md#enable-the-admission-controller/" >}}). +1. Configure the [admission controller and ValidatingWebhook]({{< relref "/operate/kubernetes/7.8.4/deployment/quick-start.md#enable-the-admission-controller/" >}}). -2. Create two or more [RedisEnterpriseCluster (REC) custom resources]({{< relref "/operate/kubernetes/deployment/quick-start#create-a-redis-enterprise-cluster-rec" >}}) with enough [memory resources]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/hardware-requirements.md" >}}). +2. Create two or more [RedisEnterpriseCluster (REC) custom resources]({{< relref "/operate/kubernetes/7.8.4/deployment/quick-start#create-a-redis-enterprise-cluster-rec" >}}) with enough [memory resources]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/hardware-requirements.md" >}}). * Name of each REC (``) * Namespace for each REC (``) -3. Configure the REC [`ingressOrRoutes` field]({{< relref "/operate/kubernetes/networking/ingressorroutespec.md" >}}) and [create DNS records]({{< relref "/operate/kubernetes/networking/ingressorroutespec#configure-dns/" >}}). +3. Configure the REC [`ingressOrRoutes` field]({{< relref "/operate/kubernetes/7.8.4/networking/ingressorroutespec.md" >}}) and [create DNS records]({{< relref "/operate/kubernetes/7.8.4/networking/ingressorroutespec#configure-dns/" >}}). * REC API hostname (`api--.`) * Database hostname suffix (`-db--.`) @@ -141,7 +141,7 @@ To communicate with other clusters, all participating clusters will need access ## Next steps -Now you are ready to [create your Redis Enterprise Active-Active database]({{< relref "/operate/kubernetes/active-active/create-reaadb.md" >}}). +Now you are ready to [create your Redis Enterprise Active-Active database]({{< relref "/operate/kubernetes/7.8.4/active-active/create-reaadb.md" >}}). ## Example values diff --git a/content/operate/kubernetes/7.8.4/architecture/_index.md b/content/operate/kubernetes/7.8.4/architecture/_index.md index 640b6ee362..974eb32d9f 100644 --- a/content/operate/kubernetes/7.8.4/architecture/_index.md +++ b/content/operate/kubernetes/7.8.4/architecture/_index.md @@ -17,11 +17,11 @@ Redis Enterprise for Kubernetes gives you the speed and durability of [Redis Ent ## Lifecycle -Kubernetes is a rapidly evolving platform with a short release cycle (around 4 months). This frequent influx of new features, enhancements and bug fixes means Kubernetes distributions move in and out of support quickly. Redis Enterprise is also a fast-moving product, and is compatible and tested only on distributions listed as [supported distributions.]({{}}) +Kubernetes is a rapidly evolving platform with a short release cycle (around 4 months). This frequent influx of new features, enhancements and bug fixes means Kubernetes distributions move in and out of support quickly. Redis Enterprise is also a fast-moving product, and is compatible and tested only on distributions listed as [supported distributions.]({{}}) -Each version of Redis Enterprise for Kubernetes is tested to ensure the version of Redis Enterprise works with the [supported Kubernetes distributions]({{}}) at the time. Both the Kubernetes version and the Redis Enterprise version must be supported for the operator to function correctly. We encourage you to upgrade Redis Enterprise for Kubernetes frequently, not only to get the benefit of enhancements and bug fixes, but to keep your software supported. +Each version of Redis Enterprise for Kubernetes is tested to ensure the version of Redis Enterprise works with the [supported Kubernetes distributions]({{}}) at the time. Both the Kubernetes version and the Redis Enterprise version must be supported for the operator to function correctly. We encourage you to upgrade Redis Enterprise for Kubernetes frequently, not only to get the benefit of enhancements and bug fixes, but to keep your software supported. -Supported platforms are listed in the [release notes]({{}}) and in the [supported platforms reference.]({{}}) +Supported platforms are listed in the [release notes]({{}}) and in the [supported platforms reference.]({{}}) ## Architecture @@ -47,15 +47,15 @@ When the operator is installed, the following resources are created: The Redis Enterprise [operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) is deployed within a [namespace](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/). Each namespace can host only one operator and one [RedisEnterpriseCluster (REC)](#redisenterprisecluster-rec). Namespaces create logical boundaries between resources, allowing organization and security. Some resources are limited to a namespace, while others are cluster-wide. -Redis Enterprise for Kubernetes also supports [multi-namespace deployments]({{}}), meaning the operator can monitor other namespaces (that host applications) for custom resources and apply any changes. +Redis Enterprise for Kubernetes also supports [multi-namespace deployments]({{}}), meaning the operator can monitor other namespaces (that host applications) for custom resources and apply any changes. ## Custom resources Kubernetes [custom resources (CRs)](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) are commonly used by databases and other applications to extend the cluster's behavior without changing its underlying code. [Custom resources (CRs)](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) extend the Kubernetes API, enabling users to manage Redis databases the Kubernetes way. Custom resources are created and managed using YAML configuration files. -This [declarative configuration approach](https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/) allows you to specify the desired state for your resources, and the operator makes the necessary changes to achieve that state. This simplifies [installation]({{}}), [upgrades]({{}}), and [scaling]({{}}) both vertically and horizontally. +This [declarative configuration approach](https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/) allows you to specify the desired state for your resources, and the operator makes the necessary changes to achieve that state. This simplifies [installation]({{}}), [upgrades]({{}}), and [scaling]({{}}) both vertically and horizontally. -The operator continuously monitors CRs for changes, automatically reconciling any differences between the desired state you specified in your YAML configuration file, and the actual state of your resources. Custom resources can also reside in separate namespaces from the operator managing them, such as in [multi-namespace installations]({{}}). +The operator continuously monitors CRs for changes, automatically reconciling any differences between the desired state you specified in your YAML configuration file, and the actual state of your resources. Custom resources can also reside in separate namespaces from the operator managing them, such as in [multi-namespace installations]({{}}). ## Custom resource definitions @@ -69,41 +69,41 @@ A Redis Enterprise cluster is a set of Redis Enterprise nodes pooling resources. {{< image filename="/images/k8s/k8s-node-arch.png">}} -A Redis cluster is created and managed by the [RedisEnterpriseCluster (REC)]({{}}) [custom resource](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/). Changes to the REC configuration file prompt the operator to make changes to the cluster. The REC is required for both standard databases ([REDB](#redisenterprisedatabase-redb)) and Active-Active databases ([REAADB](#redisenterpriseactiveactivedatabase-reaadb)). +A Redis cluster is created and managed by the [RedisEnterpriseCluster (REC)]({{}}) [custom resource](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/). Changes to the REC configuration file prompt the operator to make changes to the cluster. The REC is required for both standard databases ([REDB](#redisenterprisedatabase-redb)) and Active-Active databases ([REAADB](#redisenterpriseactiveactivedatabase-reaadb)). -See the [RedisEnterpriseCluster API Reference]({{}}) for a full list of fields and settings. +See the [RedisEnterpriseCluster API Reference]({{}}) for a full list of fields and settings. ## RedisEnterpriseDatabase REDB A Redis Enterprise database is a logical entity that manages your entire dataset across multiple Redis instances. A Redis instance is a single-threaded database process ([commonly referred to as a shard]({{}})). -Redis databases are created and managed by the [RedisEnterpriseDatabase (REDB)]({{}}) [custom resource (CR)](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/). Changes to the REDB YAML configuration file prompt the operator to make changes to the database. +Redis databases are created and managed by the [RedisEnterpriseDatabase (REDB)]({{}}) [custom resource (CR)](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/). Changes to the REDB YAML configuration file prompt the operator to make changes to the database. -An operator can manage a database in the same namespace, or a different namespace. See ["Flexible deployment"]({{}}) options and ["Manage databases in multiple namespaces"]({{}}) for more information. +An operator can manage a database in the same namespace, or a different namespace. See ["Flexible deployment"]({{}}) options and ["Manage databases in multiple namespaces"]({{}}) for more information. -See the [RedisEnterpriseDatabase (REDB) API Reference]({{}}) for a full list of fields and settings. +See the [RedisEnterpriseDatabase (REDB) API Reference]({{}}) for a full list of fields and settings. ## Security -Redis Enterprise for Kubernetes uses [secrets](https://kubernetes.io/docs/concepts/configuration/secret/) to manage your cluster credentials, cluster certificates, and client certificates. You can configure [LDAP]({{}}) and [internode encryption]({{}}) using the [RedisEnterpriseCluster (REC)](#redisenterprisecluster-rec) spec. +Redis Enterprise for Kubernetes uses [secrets](https://kubernetes.io/docs/concepts/configuration/secret/) to manage your cluster credentials, cluster certificates, and client certificates. You can configure [LDAP]({{}}) and [internode encryption]({{}}) using the [RedisEnterpriseCluster (REC)](#redisenterprisecluster-rec) spec. ### REC credentials -Redis Enterprise for Kubernetes uses the [RedisEnterpriseCluster (REC)]({{}}) [custom resource](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) to create a Redis Enterprise cluster. During creation it generates random credentials for the operator to use. The credentials are saved in a Kubernetes (K8s) [secret](https://kubernetes.io/docs/concepts/configuration/secret/). The secret name defaults to the name of the cluster. +Redis Enterprise for Kubernetes uses the [RedisEnterpriseCluster (REC)]({{}}) [custom resource](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) to create a Redis Enterprise cluster. During creation it generates random credentials for the operator to use. The credentials are saved in a Kubernetes (K8s) [secret](https://kubernetes.io/docs/concepts/configuration/secret/). The secret name defaults to the name of the cluster. -See [Manage REC credentials]({{}}) for more details. +See [Manage REC credentials]({{}}) for more details. ### REC certificates By default, Redis Enterprise Software for Kubernetes generates TLS certificates for the cluster during creation. These self-signed certificates are generated on the first node of each Redis Enterprise cluster (REC) and are copied to all other nodes in the cluster. -See [Manage REC certificates]({{}}) for more details. +See [Manage REC certificates]({{}}) for more details. ### Client certificates For each client certificate you want to use, you need to create a [Kubernetes secret](https://kubernetes.io/docs/concepts/configuration/secret/) to hold it. You can then reference that secret in your [Redis Enterprise database (REDB)](#redisenterprisedatabase-redb) custom resource. -See [Add client certificates]({{}}) for more details. +See [Add client certificates]({{}}) for more details. ## Storage @@ -115,7 +115,7 @@ PVCs are created with a specific size and [can be expanded](https://kubernetes.i ### Auto Tiering -Redis Enterprise Software for Kubernetes supports [Auto Tiering]({{}}) (previously known as Redis on Flash), which extends your node memory to use both RAM and flash storage. SSDs (solid state drives) can store infrequently used (warm) values while your keys and frequently used (hot) values are still stored in RAM. This improves performance and lowers costs for large datasets. +Redis Enterprise Software for Kubernetes supports [Auto Tiering]({{}}) (previously known as Redis on Flash), which extends your node memory to use both RAM and flash storage. SSDs (solid state drives) can store infrequently used (warm) values while your keys and frequently used (hot) values are still stored in RAM. This improves performance and lowers costs for large datasets. NVMe (non-volatile memory express) SSDs are strongly recommended to achieve the best performance. @@ -125,13 +125,13 @@ By default, Kubernetes doesn't allow you to access your Redis database from outs - Ingress controllers [HAProxy](https://haproxy-ingress.github.io/) and [NGINX](https://kubernetes.github.io/ingress-nginx/) require an `ingress` API resource. - [Istio](https://istio.io/latest/docs/setup/getting-started/) requires `Gateway` and `VirtualService` API resources. -- OpenShift uses [routes]({{< relref "/operate/kubernetes/networking/routes.md" >}}) to route external traffic. +- OpenShift uses [routes]({{< relref "/operate/kubernetes/7.8.4/networking/routes.md" >}}) to route external traffic. -The [Active-Active databases](#active-active-databases) require one of above routing methods to be configured in the REC with the [ingressOrRouteSpec field]({{}}). +The [Active-Active databases](#active-active-databases) require one of above routing methods to be configured in the REC with the [ingressOrRouteSpec field]({{}}). ## Services Rigger -The services rigger is responsible for creating and updating services related to database objects. It identifies database objects within the cluster and creates services in accordance with [`redisEnterpriseCluster.Spec.servicesRiggerSpec` setting]({{}}) to allow access to those databases. By default, each database has two services, a `cluster_ip` Service with the same name as the database and a `headless` Service with the same name as the database suffixed with `-headless`. It also creates other types of Services such as Ingress Services or OpenshiftRoutes (defined in `redisEnterpriseCluster.Spec.ingressOrRouteSpec`) meant to provide access to REAADB objects. +The services rigger is responsible for creating and updating services related to database objects. It identifies database objects within the cluster and creates services in accordance with [`redisEnterpriseCluster.Spec.servicesRiggerSpec` setting]({{}}) to allow access to those databases. By default, each database has two services, a `cluster_ip` Service with the same name as the database and a `headless` Service with the same name as the database suffixed with `-headless`. It also creates other types of Services such as Ingress Services or OpenshiftRoutes (defined in `redisEnterpriseCluster.Spec.ingressOrRouteSpec`) meant to provide access to REAADB objects. You can view a list of services with the `kubectl get services` command. @@ -139,22 +139,22 @@ Kubernetes is a dynamic environment, with nodes and pods changing as needed. The ## Active-Active databases -On Kubernetes, Redis Enterprise [Active-Active]({{< relref "/operate/rs/databases/active-active/" >}}) databases provide read and write access to the same dataset from different Kubernetes clusters. Creating an Active-Active database requires routing [network access]({{< relref "/operate/kubernetes/networking/" >}}) between two Redis Enterprise clusters residing in different Kubernetes clusters. Without the proper access configured for each cluster, syncing between the databases instances will fail.The admission controller is also required for Active-Active databases on Kubernetes, to validate changes to the custom resources. +On Kubernetes, Redis Enterprise [Active-Active]({{< relref "/operate/rs/databases/active-active/" >}}) databases provide read and write access to the same dataset from different Kubernetes clusters. Creating an Active-Active database requires routing [network access]({{< relref "/operate/kubernetes/7.8.4/networking/" >}}) between two Redis Enterprise clusters residing in different Kubernetes clusters. Without the proper access configured for each cluster, syncing between the databases instances will fail.The admission controller is also required for Active-Active databases on Kubernetes, to validate changes to the custom resources. -For more details and installation information, see [Active-Active databases]({{}}). For more general information about Active-Active, see the [Redis Enterprise Software docs]({{< relref "/operate/rs/databases/active-active/" >}}). +For more details and installation information, see [Active-Active databases]({{}}). For more general information about Active-Active, see the [Redis Enterprise Software docs]({{< relref "/operate/rs/databases/active-active/" >}}). ## RedisEnterpriseRemoteCluster RERC -The [RedisEnterpriseRemoteCluster (RERC)]({{}}) contains details allowing the REC to link to the RedisEnterpriseActiveActiveDatabase (REAADB). The RERC resource is listed in the [REAADB](#redisenterpriseactiveactivedatabase-reaadb) resource to become a participating cluster for the Active-Active database. +The [RedisEnterpriseRemoteCluster (RERC)]({{}}) contains details allowing the REC to link to the RedisEnterpriseActiveActiveDatabase (REAADB). The RERC resource is listed in the [REAADB](#redisenterpriseactiveactivedatabase-reaadb) resource to become a participating cluster for the Active-Active database. -See the [RERC API reference]({{}}) for a full list of fields and settings. +See the [RERC API reference]({{}}) for a full list of fields and settings. ## RedisEnterpriseActiveActiveDatabase REAADB The RedisEnterpriseActiveActiveDatabase (REAADB) resource creates and manages a database that spans more than one Kubernetes cluster. An REAADB requires [external routing](#networking), at least two [RECs](#redisenterprisecluster-rec), and at least two [RERCs](#redisenterpriseremotecluster-rerc). -See the [REAADB API reference]({{}}) for a full list of fields and settings. +See the [REAADB API reference]({{}}) for a full list of fields and settings. ## Metrics -To collect metrics data from your databases and Redis Enterprise cluster (REC), you can [connect your Prometheus]({{}}) server to an endpoint exposed on your REC. Redis Enterprise for Kubernetes creates a dedicated service to expose the `prometheus` port (8070) for data collection. A custom resource called `ServiceMonitor` allows the [Prometheus operator](https://github.com/prometheus-operator/prometheus-operator/tree/main/Documentation) to connect to this port and collect data from Redis Enterprise. +To collect metrics data from your databases and Redis Enterprise cluster (REC), you can [connect your Prometheus]({{}}) server to an endpoint exposed on your REC. Redis Enterprise for Kubernetes creates a dedicated service to expose the `prometheus` port (8070) for data collection. A custom resource called `ServiceMonitor` allows the [Prometheus operator](https://github.com/prometheus-operator/prometheus-operator/tree/main/Documentation) to connect to this port and collect data from Redis Enterprise. diff --git a/content/operate/kubernetes/7.8.4/architecture/deployment-options.md b/content/operate/kubernetes/7.8.4/architecture/deployment-options.md index 88abe7e8e9..59f1d92e53 100644 --- a/content/operate/kubernetes/7.8.4/architecture/deployment-options.md +++ b/content/operate/kubernetes/7.8.4/architecture/deployment-options.md @@ -23,13 +23,13 @@ The Redis Enterprise cluster (REC) custom resource must reside in the same names ## Single REC and single namespace (one-to-one) -The standard and simplest deployment deploys your Redis Enterprise databases (REDB) in the same namespace as the Redis Enterprise cluster (REC). No additional configuration is required for this, since there is no communication required to cross namespaces. See [Deploy Redis Enterprise for Kubernetes]({{< relref "/operate/kubernetes/deployment/quick-start.md" >}}). +The standard and simplest deployment deploys your Redis Enterprise databases (REDB) in the same namespace as the Redis Enterprise cluster (REC). No additional configuration is required for this, since there is no communication required to cross namespaces. See [Deploy Redis Enterprise for Kubernetes]({{< relref "/operate/kubernetes/7.8.4/deployment/quick-start.md" >}}). {{< image filename="/images/k8s/k8s-deploy-one-to-one.png" >}} ## Single REC and multiple namespaces (one-to-many) -Multiple Redis Enterprise databases (REDB) spread across multiple namespaces within the same K8s cluster can be associated with the same Redis Enterprise cluster (REC). See [Manage databases in multiple namespaces]({{< relref "/operate/kubernetes/re-clusters/multi-namespace.md" >}}) for more information. +Multiple Redis Enterprise databases (REDB) spread across multiple namespaces within the same K8s cluster can be associated with the same Redis Enterprise cluster (REC). See [Manage databases in multiple namespaces]({{< relref "/operate/kubernetes/7.8.4/re-clusters/multi-namespace.md" >}}) for more information. {{< image filename="/images/k8s/k8s-deploy-one-to-many.png" >}} @@ -39,7 +39,7 @@ A single Kubernetes cluster can contain multiple Redis Enterprise clusters (REC) You have the flexibility to create databases in separate namespaces, or in the same namespace as the REC, or combine any of the supported deployment options above. This configuration is geared towards use cases that require multiple Redis Enterprise clusters with greater isolation or different cluster configurations. -See [Manage databases in multiple namespaces]({{< relref "/operate/kubernetes/re-clusters/multi-namespace.md" >}}) for more information. +See [Manage databases in multiple namespaces]({{< relref "/operate/kubernetes/7.8.4/re-clusters/multi-namespace.md" >}}) for more information. {{< image filename="/images/k8s/k8s-deploy-many-to-many.png" >}} diff --git a/content/operate/kubernetes/7.8.4/deployment/_index.md b/content/operate/kubernetes/7.8.4/deployment/_index.md index 748832c79e..a6ee43506a 100644 --- a/content/operate/kubernetes/7.8.4/deployment/_index.md +++ b/content/operate/kubernetes/7.8.4/deployment/_index.md @@ -20,6 +20,6 @@ This section lists the different ways to set up and run Redis Enterprise for Kub ## Compatibility -Before installing, check [Supported Kubernetes distributions]({{< relref "/operate/kubernetes/reference/supported_k8s_distributions" >}}) to see which Redis Enterprise operator version supports your Kubernetes distribution. +Before installing, check [Supported Kubernetes distributions]({{< relref "/operate/kubernetes/7.8.4/reference/supported_k8s_distributions" >}}) to see which Redis Enterprise operator version supports your Kubernetes distribution. diff --git a/content/operate/kubernetes/7.8.4/deployment/container-images.md b/content/operate/kubernetes/7.8.4/deployment/container-images.md index 9b9abfbde4..fed9ab9229 100644 --- a/content/operate/kubernetes/7.8.4/deployment/container-images.md +++ b/content/operate/kubernetes/7.8.4/deployment/container-images.md @@ -127,7 +127,7 @@ require authentication. If you do need authentication, add a [pull secret](https The operator bundle contains the operator deployment and the reference to the operator image (`redislabs/operator`). To use a private container registry, you must change this image reference in your operator deployment file **before** you deploy the operator. If you apply this change to modify an existing operator deployment, the operator's pod will restart. -In the operator deployment file, 'containers:image' should point to the same repository and tag you used when [pushing]({{< relref "/operate/kubernetes/deployment/container-images.md#push-images-to-a-private-container-registry" >}}) to the private container registry: +In the operator deployment file, 'containers:image' should point to the same repository and tag you used when [pushing]({{< relref "/operate/kubernetes/7.8.4/deployment/container-images.md#push-images-to-a-private-container-registry" >}}) to the private container registry: ```sh ${PRIVATE_REPO}/redislabs/operator:${OPERATOR_VERSION} diff --git a/content/operate/kubernetes/7.8.4/deployment/openshift/_index.md b/content/operate/kubernetes/7.8.4/deployment/openshift/_index.md index cb4ba81fd8..dcf909d316 100644 --- a/content/operate/kubernetes/7.8.4/deployment/openshift/_index.md +++ b/content/operate/kubernetes/7.8.4/deployment/openshift/_index.md @@ -28,11 +28,11 @@ workloads can use: ## For OpenShift via the OperatorHub -To [create a database on an OpenShift 4.x cluster via the OperatorHub]({{< relref "/operate/kubernetes/deployment/openshift/openshift-operatorhub" >}}) you only need to have the [OpenShift 4.x cluster installed](https://docs.openshift.com/container-platform/4.3/welcome/index.html) with at least three nodes that each meet the [minimum requirements for a development installation]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/hardware-requirements.md" >}}). +To [create a database on an OpenShift 4.x cluster via the OperatorHub]({{< relref "/operate/kubernetes/7.8.4/deployment/openshift/openshift-operatorhub" >}}) you only need to have the [OpenShift 4.x cluster installed](https://docs.openshift.com/container-platform/4.3/welcome/index.html) with at least three nodes that each meet the [minimum requirements for a development installation]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/hardware-requirements.md" >}}). ## For OpenShift via the CLI -To [create a database on an OpenShift cluster via the CLI]({{< relref "/operate/kubernetes/deployment/openshift/openshift-cli.md" >}}), you need: +To [create a database on an OpenShift cluster via the CLI]({{< relref "/operate/kubernetes/7.8.4/deployment/openshift/openshift-cli.md" >}}), you need: 1. An [OpenShift cluster installed](https://docs.openshift.com/container-platform/4.3/welcome/index.html) with at least three nodes that each meet the [minimum requirements for a development installation]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/hardware-requirements.md" >}}). 1. The [kubectl package installed](https://kubernetes.io/docs/tasks/tools/install-kubectl/) at version 1.9 or higher @@ -40,4 +40,4 @@ To [create a database on an OpenShift cluster via the CLI]({{< relref "/operate/ ## Version compatibility -To see which version of Redis Enterprise for Kubernetes supports your OpenShift version, see [Supported Kubernetes distributions]({{< relref "/operate/kubernetes/reference/supported_k8s_distributions" >}}). +To see which version of Redis Enterprise for Kubernetes supports your OpenShift version, see [Supported Kubernetes distributions]({{< relref "/operate/kubernetes/7.8.4/reference/supported_k8s_distributions" >}}). diff --git a/content/operate/kubernetes/7.8.4/deployment/openshift/openshift-cli.md b/content/operate/kubernetes/7.8.4/deployment/openshift/openshift-cli.md index b66f1934d0..a351682267 100644 --- a/content/operate/kubernetes/7.8.4/deployment/openshift/openshift-cli.md +++ b/content/operate/kubernetes/7.8.4/deployment/openshift/openshift-cli.md @@ -18,7 +18,7 @@ Use these steps to set up a Redis Enterprise Software cluster with OpenShift. - [OpenShift cluster](https://docs.openshift.com/container-platform/4.8/installing/index.html) with at least 3 nodes (each meeting the [minimum requirements for a development installation]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/hardware-requirements" >}})) - [OpenShift CLI](https://docs.openshift.com/container-platform/latest/cli_reference/openshift_cli/getting-started-cli.html) -To see which version of Redis Enterprise for Kubernetes supports your OpenShift version, see [Supported Kubernetes distributions]({{< relref "/operate/kubernetes/reference/supported_k8s_distributions" >}}). +To see which version of Redis Enterprise for Kubernetes supports your OpenShift version, see [Supported Kubernetes distributions]({{< relref "/operate/kubernetes/7.8.4/reference/supported_k8s_distributions" >}}). ## Deploy the operator @@ -113,7 +113,7 @@ system:serviceaccount::redis-enterprise-operator 1. Apply the `RedisEnterpriseCluster` resource file ([rec_rhel.yaml](https://github.com/RedisLabs/redis-enterprise-k8s-docs/blob/master/openshift/rec_rhel.yaml)). - You can rename the file to `.yaml`, but it is not required. Examples below use `.yaml`. [Options for Redis Enterprise clusters]({{< relref "/operate/kubernetes/reference/redis_enterprise_cluster_api" >}}) has more info about the Redis Enterprise cluster (REC) custom resource, or see the [Redis Enterprise cluster API]({{}}) for a full list of options. + You can rename the file to `.yaml`, but it is not required. Examples below use `.yaml`. [Options for Redis Enterprise clusters]({{< relref "/operate/kubernetes/7.8.4/reference/redis_enterprise_cluster_api" >}}) has more info about the Redis Enterprise cluster (REC) custom resource, or see the [Redis Enterprise cluster API]({{}}) for a full list of options. The REC name cannot be changed after cluster creation. @@ -223,7 +223,7 @@ The operator uses the instructions in the Redis Enterprise database (REDB) custo 1. Create a `RedisEnterpriseDatabase` custom resource. - This example creates a test database. For production databases, see [create a database]({{< relref "/operate/kubernetes/re-databases/db-controller.md#create-a-database" >}}) and [RedisEnterpriseDatabase API reference]({{< relref "/operate/kubernetes/reference/redis_enterprise_database_api" >}}). + This example creates a test database. For production databases, see [create a database]({{< relref "/operate/kubernetes/7.8.4/re-databases/db-controller.md#create-a-database" >}}) and [RedisEnterpriseDatabase API reference]({{< relref "/operate/kubernetes/7.8.4/reference/redis_enterprise_database_api" >}}). ```sh cat << EOF > /tmp/redis-enterprise-database.yml @@ -244,5 +244,5 @@ The operator uses the instructions in the Redis Enterprise database (REDB) custo ## More info -- [Redis Enterprise cluster API]({{}}) -- [Redis Enterprise database API]({{}}) +- [Redis Enterprise cluster API]({{}}) +- [Redis Enterprise database API]({{}}) diff --git a/content/operate/kubernetes/7.8.4/deployment/openshift/openshift-operatorhub.md b/content/operate/kubernetes/7.8.4/deployment/openshift/openshift-operatorhub.md index 61aee1de10..50333a655d 100644 --- a/content/operate/kubernetes/7.8.4/deployment/openshift/openshift-operatorhub.md +++ b/content/operate/kubernetes/7.8.4/deployment/openshift/openshift-operatorhub.md @@ -14,7 +14,7 @@ url: '/operate/kubernetes/7.8.4/deployment/openshift/openshift-operatorhub/' You can deploy Redis Enterprise for Kubernetes from the Red Hat OpenShift CLI. You can also use a UI, [OperatorHub](https://docs.openshift.com/container-platform/4.11/operators/index.html) (Red Hat) to install operators and create custom resources. -To see which version of Redis Enterprise for Kubernetes supports your OpenShift version, see [Supported Kubernetes distributions]({{< relref "/operate/kubernetes/reference/supported_k8s_distributions" >}}). +To see which version of Redis Enterprise for Kubernetes supports your OpenShift version, see [Supported Kubernetes distributions]({{< relref "/operate/kubernetes/7.8.4/reference/supported_k8s_distributions" >}}). ## Install the Redis Enterprise operator @@ -89,4 +89,4 @@ Use the YAML view to create a custom resource file or let OperatorHub generate t {{}} In versions 6.4.2-4 and 6.4.2-5, REC creation might fail when using the form view due to an error related to the cluster level LDAP. To avoid this, use the YAML view. {{}} -For more information on creating and maintaining Redis Enterprise custom resources, see [Redis Enterprise clusters (REC)]({{< relref "/operate/kubernetes/re-clusters/" >}}) and [Redis Enterprise databases (REDB)]({{< relref "/operate/kubernetes/re-databases/" >}}). +For more information on creating and maintaining Redis Enterprise custom resources, see [Redis Enterprise clusters (REC)]({{< relref "/operate/kubernetes/7.8.4/re-clusters/" >}}) and [Redis Enterprise databases (REDB)]({{< relref "/operate/kubernetes/7.8.4/re-databases/" >}}). diff --git a/content/operate/kubernetes/7.8.4/deployment/quick-start.md b/content/operate/kubernetes/7.8.4/deployment/quick-start.md index d006f484fe..3735a75832 100644 --- a/content/operate/kubernetes/7.8.4/deployment/quick-start.md +++ b/content/operate/kubernetes/7.8.4/deployment/quick-start.md @@ -18,13 +18,13 @@ To deploy Redis Enterprise Software for Kubernetes and start your Redis Enterpri - Apply the operator bundle and verify it's running. - Create a Redis Enterprise cluster (REC). -This guide works with most supported Kubernetes distributions. If you're using OpenShift, see [Redis Enterprise on OpenShift]({{< relref "/operate/kubernetes/deployment/openshift" >}}). For details on what is currently supported, see [supported distributions]({{< relref "/operate/kubernetes/reference/supported_k8s_distributions.md" >}}). +This guide works with most supported Kubernetes distributions. If you're using OpenShift, see [Redis Enterprise on OpenShift]({{< relref "/operate/kubernetes/7.8.4/deployment/openshift" >}}). For details on what is currently supported, see [supported distributions]({{< relref "/operate/kubernetes/7.8.4/reference/supported_k8s_distributions.md" >}}). ## Prerequisites To deploy Redis Enterprise for Kubernetes, you'll need: -- Kubernetes cluster in a [supported distribution]({{< relref "/operate/kubernetes/reference/supported_k8s_distributions.md" >}}) +- Kubernetes cluster in a [supported distribution]({{< relref "/operate/kubernetes/7.8.4/reference/supported_k8s_distributions.md" >}}) - minimum of three worker nodes - Kubernetes client (kubectl) - access to DockerHub, RedHat Container Catalog, or a private repository that can hold the required images. @@ -57,7 +57,7 @@ Redis Enterprise for Kubernetes bundle is published as a container image. A list The operator [definition and reference materials](https://github.com/RedisLabs/redis-enterprise-k8s-docs) are available on GitHub. The operator definitions are [packaged as a single generic YAML file](https://github.com/RedisLabs/redis-enterprise-k8s-docs/blob/master/bundle.yaml). {{}} -If you do not pull images from DockerHub or another public registry, you need to use a [private container registry]({{< relref "/operate/kubernetes/deployment/container-images#manage-image-sources" >}}). +If you do not pull images from DockerHub or another public registry, you need to use a [private container registry]({{< relref "/operate/kubernetes/7.8.4/deployment/container-images#manage-image-sources" >}}). {{}} ### Download the operator bundle @@ -113,7 +113,7 @@ redis-enterprise-operator 1/1 1 1 0m36s A Redis Enterprise cluster (REC) is created from a `RedisEnterpriseCluster` custom resource that contains cluster specifications. -The following example creates a minimal Redis Enterprise cluster. See the [RedisEnterpriseCluster API reference]({{}}) for more information on the various options available. +The following example creates a minimal Redis Enterprise cluster. See the [RedisEnterpriseCluster API reference]({{}}) for more information on the various options available. 1. Create a file that defines a Redis Enterprise cluster with three nodes. @@ -258,4 +258,4 @@ The operator bundle includes a webhook file. The webhook will intercept requests You can create multiple databases within the same namespace as your REC or in other namespaces. -See [manage Redis Enterprise databases for Kubernetes]({{< relref "/operate/kubernetes/re-databases/db-controller.md" >}}) to create a new REDB. +See [manage Redis Enterprise databases for Kubernetes]({{< relref "/operate/kubernetes/7.8.4/re-databases/db-controller.md" >}}) to create a new REDB. diff --git a/content/operate/kubernetes/7.8.4/faqs/_index.md b/content/operate/kubernetes/7.8.4/faqs/_index.md index 98857247a4..be2cc9bd6d 100644 --- a/content/operate/kubernetes/7.8.4/faqs/_index.md +++ b/content/operate/kubernetes/7.8.4/faqs/_index.md @@ -16,7 +16,7 @@ Here are some frequently asked questions about Redis Enterprise on integration p ## What is an Operator? -An operator is a [Kubernetes custom controller](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources#custom-controllers) which extends the native K8s API. Refer to the article [Redis Enterprise K8s Operator-based deployments – Overview]({{< relref "/operate/kubernetes/architecture/" >}}). +An operator is a [Kubernetes custom controller](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources#custom-controllers) which extends the native K8s API. Refer to the article [Redis Enterprise K8s Operator-based deployments – Overview]({{< relref "/operate/kubernetes/7.8.4/architecture/" >}}). ## Does Redis Enterprise operator support multiple RECs per namespace? @@ -40,7 +40,7 @@ kubectl describe rec The cluster admin user password is created by the operator during the deployment of the Redis Enterprise cluster (REC) and is stored in a Kubernetes [secret](https://kubernetes.io/docs/concepts/configuration/secret/). -See [Manage REC credentials]({{< relref "/operate/kubernetes/security/manage-rec-credentials" >}}) for instructions on changing the admin password. +See [Manage REC credentials]({{< relref "/operate/kubernetes/7.8.4/security/manage-rec-credentials" >}}) for instructions on changing the admin password. ## How is using Redis Enterprise operator superior to using Helm charts? @@ -66,7 +66,7 @@ Connect to the UI by pointing your browser to `https://localhost:8443` For nodes hosting the Redis Enterprise cluster [statefulSet](https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/) [pods](https://kubernetes.io/docs/concepts/workloads/pods/), follow the guidelines provided for Redis Enterprise in the [hardware requirements]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/hardware-requirements.md" >}}). -For additional information please also refer to [Kubernetes operator deployment – persistent volumes]({{< relref "/operate/kubernetes/recommendations/persistent-volumes.md" >}}). +For additional information please also refer to [Kubernetes operator deployment – persistent volumes]({{< relref "/operate/kubernetes/7.8.4/recommendations/persistent-volumes.md" >}}). ## How to retrieve the username/password for a Redis Enterprise Cluster? diff --git a/content/operate/kubernetes/7.8.4/networking/_index.md b/content/operate/kubernetes/7.8.4/networking/_index.md index 152aacf817..8b9b5de4e8 100644 --- a/content/operate/kubernetes/7.8.4/networking/_index.md +++ b/content/operate/kubernetes/7.8.4/networking/_index.md @@ -16,7 +16,7 @@ Redis Enterprise for Kubernetes supports several ways to route external traffic - Ingress controllers [HAProxy](https://haproxy-ingress.github.io/) and [NGINX](https://kubernetes.github.io/ingress-nginx/) require an `ingress` API resource. - [Istio](https://istio.io/latest/docs/setup/getting-started/) requires `Gateway` and `VirtualService` API resources. -- OpenShift uses [routes]({{< relref "/operate/kubernetes/networking/routes.md" >}}) to route external traffic. +- OpenShift uses [routes]({{< relref "/operate/kubernetes/7.8.4/networking/routes.md" >}}) to route external traffic. - The RedisEnterpriseActiveActiveDatabase (REAADB) requires any of the above routing methods to be configured in the RedisEnterpriseCluster (REC) with the `ingressOrRouteSpec` field. ## External routing using Redis Enterprise for Kubernetes @@ -27,13 +27,13 @@ Redis Enterprise supports three [types of services](https://kubernetes.io/docs/c By default, the operator creates a `ClusterIP` type service, which exposes a cluster-internal IP and that can only be accessed from within the K8s cluster. For requests to be routed from outside the K8s cluster, you need an [Ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/) (or [route](https://docs.openshift.com/container-platform/4.12/networking/routes/route-configuration.html) if you are using OpenShift). See [kubernetes.io](https://kubernetes.io/docs/) for more details on [Ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/) and [Ingress controllers](https://kubernetes.io/docs/concepts/services-networking/ingress-controllers/). -* To use NGINX or HAProxy Ingress controllers, see [Ingress routing]({{< relref "/operate/kubernetes/networking/ingress.md" >}}). -* To use OpenShift routes, see [OpenShift routes]({{< relref "/operate/kubernetes/networking/routes.md" >}}). -* To use Istio as an Ingress controller, see [Istio Ingress routing]({{< relref "/operate/kubernetes/networking/istio-ingress.md" >}}) +* To use NGINX or HAProxy Ingress controllers, see [Ingress routing]({{< relref "/operate/kubernetes/7.8.4/networking/ingress.md" >}}). +* To use OpenShift routes, see [OpenShift routes]({{< relref "/operate/kubernetes/7.8.4/networking/routes.md" >}}). +* To use Istio as an Ingress controller, see [Istio Ingress routing]({{< relref "/operate/kubernetes/7.8.4/networking/istio-ingress.md" >}}) ## `ingressOrRouteSpec` for Active-Active databases -Versions 6.4.2 or later of Redis Enterprise for Kubernetes include a feature for ingress configuration. The `ingressOrRouteSpec` field is available in the RedisEnterpriseCluster spec to automatically create an Ingress (or route) for the API service and databases (REAADB) on that REC. See [REC external routing]({{< relref "/operate/kubernetes/networking/ingressorroutespec.md" >}}) for more details. +Versions 6.4.2 or later of Redis Enterprise for Kubernetes include a feature for ingress configuration. The `ingressOrRouteSpec` field is available in the RedisEnterpriseCluster spec to automatically create an Ingress (or route) for the API service and databases (REAADB) on that REC. See [REC external routing]({{< relref "/operate/kubernetes/7.8.4/networking/ingressorroutespec.md" >}}) for more details. This feature only supports automatic Ingress creation for Active-Active databases created and managed with the RedisEnterpriseActiveActiveDatabase (REAADB) custom resource. Use with the standard Redis Enterprise database (REDB) is not currently supported. diff --git a/content/operate/kubernetes/7.8.4/networking/ingress.md b/content/operate/kubernetes/7.8.4/networking/ingress.md index cea059b8e4..db6514c1cc 100644 --- a/content/operate/kubernetes/7.8.4/networking/ingress.md +++ b/content/operate/kubernetes/7.8.4/networking/ingress.md @@ -21,7 +21,7 @@ Before creating an Ingress, you'll need: - [Ingress-NGINX Controller](https://kubernetes.github.io/ingress-nginx/deploy/) - Be sure to use the `kubernetes/ingress-nginx` controller and NOT the `nginxinc/kubernetes-ingress` controller. - [HAProxy Ingress](https://haproxy-ingress.github.io/docs/getting-started/) - - To use Istio for your Ingress resources, see [Configure Istio for external routing]({{< relref "/operate/kubernetes/networking/istio-ingress.md" >}}) + - To use Istio for your Ingress resources, see [Configure Istio for external routing]({{< relref "/operate/kubernetes/7.8.4/networking/istio-ingress.md" >}}) {{}}Make sure your Ingress controller has `ssl-passthrough`enabled. This is enabled by default for HAProxy, but disabled by default for NGINX. See the [NGINX User Guide](https://kubernetes.github.io/ingress-nginx/user-guide/tls/#ssl-passthrough) for details. {{}} diff --git a/content/operate/kubernetes/7.8.4/networking/ingressorroutespec.md b/content/operate/kubernetes/7.8.4/networking/ingressorroutespec.md index cce66ff3a6..22b0cd394d 100644 --- a/content/operate/kubernetes/7.8.4/networking/ingressorroutespec.md +++ b/content/operate/kubernetes/7.8.4/networking/ingressorroutespec.md @@ -19,7 +19,7 @@ Redis Enterprise for Kubernetes supports the Ingress controllers below: * [NGINX](https://kubernetes.github.io/ingress-nginx/) * [Istio](https://istio.io/latest/docs/setup/getting-started/) -OpenShift users can use [routes]({{< relref "/operate/kubernetes/networking/routes.md" >}}) instead of an Ingress. +OpenShift users can use [routes]({{< relref "/operate/kubernetes/7.8.4/networking/routes.md" >}}) instead of an Ingress. Install your chosen Ingress controller, making sure `ssl-passthrough` is enabled. `ssl-passthrough` is turned off by default for NGINX but enabled by default for HAProxy. diff --git a/content/operate/kubernetes/7.8.4/networking/istio-ingress.md b/content/operate/kubernetes/7.8.4/networking/istio-ingress.md index fb6f2484a4..2b8869a237 100644 --- a/content/operate/kubernetes/7.8.4/networking/istio-ingress.md +++ b/content/operate/kubernetes/7.8.4/networking/istio-ingress.md @@ -149,10 +149,10 @@ To configure Istio to work with the Redis Kubernetes operator, we will use two c redis-vs ["redis-gateway"] ["*.istio.k8s.my.example.com"] 3h33m ``` -1. [Deploy the operator]({{< relref "/operate/kubernetes/deployment/quick-start.md" >}}), Redis Enterprise Cluster (REC), and Redis Enterprise Database (REDB) on the same namespace as the gateway and virtual service. +1. [Deploy the operator]({{< relref "/operate/kubernetes/7.8.4/deployment/quick-start.md" >}}), Redis Enterprise Cluster (REC), and Redis Enterprise Database (REDB) on the same namespace as the gateway and virtual service. ## Test your external access to the database -To [test your external access]({{< relref "/operate/kubernetes/networking/ingress.md" >}}) to the database, you need a client that supports [TLS](https://en.wikipedia.org/wiki/Transport_Layer_Security) and [SNI](https://en.wikipedia.org/wiki/Server_Name_Indication). +To [test your external access]({{< relref "/operate/kubernetes/7.8.4/networking/ingress.md" >}}) to the database, you need a client that supports [TLS](https://en.wikipedia.org/wiki/Transport_Layer_Security) and [SNI](https://en.wikipedia.org/wiki/Server_Name_Indication). -See [Test your access with Openssl]({{< relref "/operate/kubernetes/networking/ingress#test-your-access-with-openssl" >}}) or [Test your access with Python]({{< relref "/operate/kubernetes/networking/ingress#test-your-access-with-python" >}}) for more info. +See [Test your access with Openssl]({{< relref "/operate/kubernetes/7.8.4/networking/ingress#test-your-access-with-openssl" >}}) or [Test your access with Python]({{< relref "/operate/kubernetes/7.8.4/networking/ingress#test-your-access-with-python" >}}) for more info. diff --git a/content/operate/kubernetes/7.8.4/re-clusters/auto-tiering.md b/content/operate/kubernetes/7.8.4/re-clusters/auto-tiering.md index f94ab50956..dc7971c48a 100644 --- a/content/operate/kubernetes/7.8.4/re-clusters/auto-tiering.md +++ b/content/operate/kubernetes/7.8.4/re-clusters/auto-tiering.md @@ -32,7 +32,7 @@ For more information on node storage, see [Node persistent and ephemeral storage ## Create a Redis Enterprise cluster -To deploy a Redis Enterprise cluster (REC) with Auto Tiering, you'll need to specify the following in the `redisOnFlashSpec` section of your [REC custom resource]({{< relref "/operate/kubernetes/reference/redis_enterprise_cluster_api" >}}): +To deploy a Redis Enterprise cluster (REC) with Auto Tiering, you'll need to specify the following in the `redisOnFlashSpec` section of your [REC custom resource]({{< relref "/operate/kubernetes/7.8.4/reference/redis_enterprise_cluster_api" >}}): - enable Auto Tiering (`enabled: true`) - flash storage driver (`bigStoreDriver`) diff --git a/content/operate/kubernetes/7.8.4/re-clusters/cluster-recovery.md b/content/operate/kubernetes/7.8.4/re-clusters/cluster-recovery.md index 292683a470..1804c134a9 100644 --- a/content/operate/kubernetes/7.8.4/re-clusters/cluster-recovery.md +++ b/content/operate/kubernetes/7.8.4/re-clusters/cluster-recovery.md @@ -27,7 +27,7 @@ The Redis Enterprise for Kubernetes automates these recovery steps: ## Prerequisites -- For cluster recovery, the cluster must be [deployed with persistence]({{< relref "/operate/kubernetes/recommendations/persistent-volumes.md" >}}). +- For cluster recovery, the cluster must be [deployed with persistence]({{< relref "/operate/kubernetes/7.8.4/recommendations/persistent-volumes.md" >}}). ## Recover a cluster diff --git a/content/operate/kubernetes/7.8.4/re-clusters/connect-prometheus-operator.md b/content/operate/kubernetes/7.8.4/re-clusters/connect-prometheus-operator.md index fa5a3a1948..2f9f6fa026 100644 --- a/content/operate/kubernetes/7.8.4/re-clusters/connect-prometheus-operator.md +++ b/content/operate/kubernetes/7.8.4/re-clusters/connect-prometheus-operator.md @@ -18,9 +18,9 @@ To collect metrics data from your databases and Redis Enterprise cluster (REC), Before connecting Redis Enterprise to Prometheus on your Kubernetes cluster, make sure you've done the following: -- [Deploy Redis Enterprise for Kubernetes]({{< relref "/operate/kubernetes/deployment/quick-start.md" >}}) (version 6.2.10-4 or newer) +- [Deploy Redis Enterprise for Kubernetes]({{< relref "/operate/kubernetes/7.8.4/deployment/quick-start.md" >}}) (version 6.2.10-4 or newer) - [Deploy the Prometheus operator](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/user-guides/getting-started.md) (version 0.19.0 or newer) -- [Create a Redis Enterprise cluster]({{< relref "/operate/kubernetes/deployment/quick-start#create-a-redis-enterprise-cluster-rec" >}}) +- [Create a Redis Enterprise cluster]({{< relref "/operate/kubernetes/7.8.4/deployment/quick-start#create-a-redis-enterprise-cluster-rec" >}}) ## Create a `ServiceMonitor` custom resource diff --git a/content/operate/kubernetes/7.8.4/re-clusters/delete-custom-resources.md b/content/operate/kubernetes/7.8.4/re-clusters/delete-custom-resources.md index c95f238051..974ad80f47 100644 --- a/content/operate/kubernetes/7.8.4/re-clusters/delete-custom-resources.md +++ b/content/operate/kubernetes/7.8.4/re-clusters/delete-custom-resources.md @@ -70,7 +70,7 @@ kubectl delete -f admission-service.yaml kubectl delete -f operator.yaml ``` -You will also need to remove [the `namespaceSelector` section from the validating webhook]({{< relref "/operate/kubernetes/deployment/quick-start#webhook" >}}). +You will also need to remove [the `namespaceSelector` section from the validating webhook]({{< relref "/operate/kubernetes/7.8.4/deployment/quick-start#webhook" >}}). ## Delete an Active-Active database (REAADB) diff --git a/content/operate/kubernetes/7.8.4/re-clusters/multi-namespace.md b/content/operate/kubernetes/7.8.4/re-clusters/multi-namespace.md index fb1f429d43..69b32c7a03 100644 --- a/content/operate/kubernetes/7.8.4/re-clusters/multi-namespace.md +++ b/content/operate/kubernetes/7.8.4/re-clusters/multi-namespace.md @@ -15,19 +15,19 @@ url: '/operate/kubernetes/7.8.4/re-clusters/multi-namespace/' Multiple Redis Enterprise database resources (REDBs) can be associated with a single Redis Enterprise cluster resource (REC) even if they reside in different namespaces. -To learn more about designing a multi-namespace Redis Enterprise cluster, see [flexible deployment options]({{< relref "/operate/kubernetes/architecture/deployment-options.md" >}}). +To learn more about designing a multi-namespace Redis Enterprise cluster, see [flexible deployment options]({{< relref "/operate/kubernetes/7.8.4/architecture/deployment-options.md" >}}). {{}} Multi-namespace installations don't support Active-Active databases (REAADB). Only databases created with the REDB resource are supported in multi-namespace deployments at this time.{{}} ## Prerequisites -Before configuring a multi-namespace deployment, you must have a running [Redis Enterprise cluster (REC)]({{< relref "/operate/kubernetes/deployment/quick-start.md" >}}). See more information in the [deployment]({{< relref "/operate/kubernetes/deployment/" >}}) section. +Before configuring a multi-namespace deployment, you must have a running [Redis Enterprise cluster (REC)]({{< relref "/operate/kubernetes/7.8.4/deployment/quick-start.md" >}}). See more information in the [deployment]({{< relref "/operate/kubernetes/7.8.4/deployment/" >}}) section. ## Create role and role binding for managed namespaces Both the operator and the RedisEnterpriseCluster (REC) resource need access to each namespace the REC will manage. For each **managed** namespace, create a `role.yaml` and `role_binding.yaml` file within the managed namespace, as shown in the examples below. -{{}}These will need to be reapplied each time you [upgrade]({{< relref "/operate/kubernetes/upgrade/upgrade-redis-cluster.md" >}}). {{}} +{{}}These will need to be reapplied each time you [upgrade]({{< relref "/operate/kubernetes/7.8.4/upgrade/upgrade-redis-cluster.md" >}}). {{}} Replace `` with the namespace the REC resides in. Replace `` with your own value (defaults to the REC name). diff --git a/content/operate/kubernetes/7.8.4/re-databases/db-controller.md b/content/operate/kubernetes/7.8.4/re-databases/db-controller.md index 058d4aa318..a9c52c6450 100644 --- a/content/operate/kubernetes/7.8.4/re-databases/db-controller.md +++ b/content/operate/kubernetes/7.8.4/re-databases/db-controller.md @@ -27,13 +27,13 @@ the custom resource with default values to create a full specification. It then database on the specified Redis Enterprise cluster (REC). Once the database is created, it is exposed with the same service mechanisms by the service rigger for the Redis Enterprise cluster. -If the database [custom resource is deleted]({{< relref "/operate/kubernetes/re-clusters/delete-custom-resources" >}}), the database and its services are deleted from the cluster. +If the database [custom resource is deleted]({{< relref "/operate/kubernetes/7.8.4/re-clusters/delete-custom-resources" >}}), the database and its services are deleted from the cluster. ### Flexible deployment options -Databases in multiple namespaces can be managed by the same operator. To learn more, see [Manage databases in multiple namespaces]({{}}). +Databases in multiple namespaces can be managed by the same operator. To learn more, see [Manage databases in multiple namespaces]({{}}). -To learn more about designing a multi-namespace Redis Enterprise cluster, see [flexible deployment options]({{< relref "/operate/kubernetes/architecture/deployment-options.md" >}}). +To learn more about designing a multi-namespace Redis Enterprise cluster, see [flexible deployment options]({{< relref "/operate/kubernetes/7.8.4/architecture/deployment-options.md" >}}). ## Create a database @@ -85,7 +85,7 @@ To modify the database: ``` 1. Change the specification (only properties in `spec` section) and save the changes. - For more details, see [RedisEnterpriseDatabaseSpec](https://github.com/RedisLabs/redis-enterprise-k8s-docs/blob/master/redis_enterprise_database_api.md#redisenterprisedatabasespec) or [Options for Redis Enterprise databases]({{< relref "/operate/kubernetes/reference/redis_enterprise_database_api" >}}). + For more details, see [RedisEnterpriseDatabaseSpec](https://github.com/RedisLabs/redis-enterprise-k8s-docs/blob/master/redis_enterprise_database_api.md#redisenterprisedatabasespec) or [Options for Redis Enterprise databases]({{< relref "/operate/kubernetes/7.8.4/reference/redis_enterprise_database_api" >}}). 1. Monitor the status to see when the changes take effect: @@ -119,7 +119,7 @@ Connection information for the database is stored in a Kubernetes [secret](https The name of that secret is stored in the database custom resource. {{}} -Use these steps to connect to your database from within your K8s cluster. To access your database from outside the K8s cluster, set up the [Ingress]({{< relref "/operate/kubernetes/networking/ingress.md" >}}) controller or use OpenShift routes. +Use these steps to connect to your database from within your K8s cluster. To access your database from outside the K8s cluster, set up the [Ingress]({{< relref "/operate/kubernetes/7.8.4/networking/ingress.md" >}}) controller or use OpenShift routes. {{}} 1. Retrieve the secret name. diff --git a/content/operate/kubernetes/7.8.4/recommendations/node-selection.md b/content/operate/kubernetes/7.8.4/recommendations/node-selection.md index a27ceadeea..c76c615142 100644 --- a/content/operate/kubernetes/7.8.4/recommendations/node-selection.md +++ b/content/operate/kubernetes/7.8.4/recommendations/node-selection.md @@ -29,7 +29,7 @@ Here are the ways that you can control the pod scheduling: ## Using node selectors -The [`nodeSelector`]({{}}) +The [`nodeSelector`]({{}}) property of the cluster specification uses the same values and structures as the [Kubernetes `nodeSelector`](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#nodeselector). In general, node labels are a simple way to make sure that specific nodes are used for Redis Enterprise pods. diff --git a/content/operate/kubernetes/7.8.4/recommendations/persistent-volumes.md b/content/operate/kubernetes/7.8.4/recommendations/persistent-volumes.md index 124536f5da..f2b84974b4 100644 --- a/content/operate/kubernetes/7.8.4/recommendations/persistent-volumes.md +++ b/content/operate/kubernetes/7.8.4/recommendations/persistent-volumes.md @@ -50,7 +50,7 @@ requirements]({{< relref "/operate/rs/installing-upgrading/install/plan-deployme To explicitly specify the persistent storage size, use the *volumeSize* property as described in the example above. -Persistent volume claims can be expanded, but not reduced after creation. See [Expand PersistentVolumeClaim (PVC)]({{}}) for details. +Persistent volume claims can be expanded, but not reduced after creation. See [Expand PersistentVolumeClaim (PVC)]({{}}) for details. {{< note >}} We recommend that you omit the volumeSize definition from the REC declaration diff --git a/content/operate/kubernetes/7.8.4/recommendations/sizing-on-kubernetes.md b/content/operate/kubernetes/7.8.4/recommendations/sizing-on-kubernetes.md index a59623eaed..9728d943fe 100644 --- a/content/operate/kubernetes/7.8.4/recommendations/sizing-on-kubernetes.md +++ b/content/operate/kubernetes/7.8.4/recommendations/sizing-on-kubernetes.md @@ -117,5 +117,5 @@ Then, apply the file by running: When adjusting compute resources, make sure the ratio of persistent volume size and the new memory size are in accordance to the [Hardware requirements]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/hardware-requirements.md" >}}). -Persistent volume claims can be expanded, but not reduced after creation. See [Expand PersistentVolumeClaim (PVC)]({{}}) for details. +Persistent volume claims can be expanded, but not reduced after creation. See [Expand PersistentVolumeClaim (PVC)]({{}}) for details. {{< /warning >}} diff --git a/content/operate/kubernetes/7.8.4/security/manage-rec-credentials.md b/content/operate/kubernetes/7.8.4/security/manage-rec-credentials.md index de83bc3a22..07e9534238 100644 --- a/content/operate/kubernetes/7.8.4/security/manage-rec-credentials.md +++ b/content/operate/kubernetes/7.8.4/security/manage-rec-credentials.md @@ -9,7 +9,7 @@ linkTitle: Manage REC credentials weight: 93 url: '/operate/kubernetes/7.8.4/security/manage-rec-credentials/' --- -Redis Enterprise for Kubernetes uses a custom resource called [`RedisEnterpriseCluster`]({{< relref "/operate/kubernetes/reference/redis_enterprise_cluster_api" >}}) to create a Redis Enterprise cluster (REC). During creation it generates random credentials for the operator to use. The credentials are saved in a Kubernetes (K8s) [secret](https://kubernetes.io/docs/concepts/configuration/secret/). The secret name defaults to the name of the cluster. +Redis Enterprise for Kubernetes uses a custom resource called [`RedisEnterpriseCluster`]({{< relref "/operate/kubernetes/7.8.4/reference/redis_enterprise_cluster_api" >}}) to create a Redis Enterprise cluster (REC). During creation it generates random credentials for the operator to use. The credentials are saved in a Kubernetes (K8s) [secret](https://kubernetes.io/docs/concepts/configuration/secret/). The secret name defaults to the name of the cluster. {{}} This procedure is only supported for operator versions 6.0.20-12 and above. @@ -112,7 +112,7 @@ curl -k --request DELETE \ ### Change both the REC username and password -1. [Connect to the admin console]({{< relref "/operate/kubernetes/re-clusters/connect-to-admin-console.md" >}}) +1. [Connect to the admin console]({{< relref "/operate/kubernetes/7.8.4/re-clusters/connect-to-admin-console.md" >}}) 2. [Add another admin user]({{< relref "/operate/rs/security/access-control/create-users" >}}) and choose a new password. diff --git a/content/operate/kubernetes/7.8.4/upgrade/_index.md b/content/operate/kubernetes/7.8.4/upgrade/_index.md index 51ac2c2f70..5b6fcfbfc3 100644 --- a/content/operate/kubernetes/7.8.4/upgrade/_index.md +++ b/content/operate/kubernetes/7.8.4/upgrade/_index.md @@ -20,15 +20,15 @@ The upgrade process includes updating three components: 2. Upgrade the Redis Enterprise cluster (REC) 3. Upgrade Redis Enterprise databases (REDB) -If you are using OpenShift, see [Upgrade Redis Enterprise with OpenShift CLI]({{}}) or [Upgrade Redis Enterprise with OpenShift OperatorHub]({{}}). +If you are using OpenShift, see [Upgrade Redis Enterprise with OpenShift CLI]({{}}) or [Upgrade Redis Enterprise with OpenShift OperatorHub]({{}}). -For all other Kubernetes distributions, see [Upgrade Redis Enterprise for Kubernetes]({{}}). +For all other Kubernetes distributions, see [Upgrade Redis Enterprise for Kubernetes]({{}}). ## Upgrade compatibility When upgrading, both your Kubernetes version and Redis operator version need to be supported at all times. -{{}}If your current Kubernetes distribution is not [supported]({{}}), upgrade to a supported distribution before upgrading. {{}} +{{}}If your current Kubernetes distribution is not [supported]({{}}), upgrade to a supported distribution before upgrading. {{}} ## RHEL9-based image @@ -40,6 +40,6 @@ Redis Enterprise images are now based on Red Hat Enterprise Linux 9 (RHEL9). Thi For detailed steps, see the relevant upgrade page: -- [OpenShift CLI]({{}}) -- [OpenShift OperatorHub]({{}}) -- [Kubernetes]({{}}) +- [OpenShift CLI]({{}}) +- [OpenShift OperatorHub]({{}}) +- [Kubernetes]({{}}) diff --git a/content/operate/kubernetes/7.8.4/upgrade/openshift-cli.md b/content/operate/kubernetes/7.8.4/upgrade/openshift-cli.md index ee82c98a4b..b6f9db2960 100644 --- a/content/operate/kubernetes/7.8.4/upgrade/openshift-cli.md +++ b/content/operate/kubernetes/7.8.4/upgrade/openshift-cli.md @@ -26,7 +26,7 @@ See the [troubleshooting](#troubleshooting) section for details on recovering a #### Kubernetes version -Check [Supported Kubernetes distributions]({{}}) to make sure your Kubernetes distribution is supported. If not, upgrade your Kubernetes distribution before upgrading the Redis operator. +Check [Supported Kubernetes distributions]({{}}) to make sure your Kubernetes distribution is supported. If not, upgrade your Kubernetes distribution before upgrading the Redis operator. #### Redis operator version @@ -34,7 +34,7 @@ Your Redis Enterprise clusters must be running version 7.4.2-2 or later before u #### Redis database version -Your Redis databases must be running version 7.2 or later before upgrading your cluster version. See [upgrade databases](#upgrade-databases) for detailed steps. You can find your database version in the [REDB `spec.redisVersion` field]({{}}). +Your Redis databases must be running version 7.2 or later before upgrading your cluster version. See [upgrade databases](#upgrade-databases) for detailed steps. You can find your database version in the [REDB `spec.redisVersion` field]({{}}). #### RHEL9-compatible modules @@ -131,7 +131,7 @@ redis-enterprise-operator 1/1 1 1 0m36s ### Reapply the SCC -If you are using OpenShift, you will also need to manually reapply the [security context constraints](https://docs.openshift.com/container-platform/4.8/authentication/managing-security-context-constraints.html) file ([`scc.yaml`]({{< relref "/operate/kubernetes/deployment/openshift/openshift-cli#deploy-the-operator" >}})) and bind it to your service account. +If you are using OpenShift, you will also need to manually reapply the [security context constraints](https://docs.openshift.com/container-platform/4.8/authentication/managing-security-context-constraints.html) file ([`scc.yaml`]({{< relref "/operate/kubernetes/7.8.4/deployment/openshift/openshift-cli#deploy-the-operator" >}})) and bind it to your service account. ```sh oc apply -f openshift/scc.yaml @@ -180,7 +180,7 @@ After the operator upgrade is complete, you can upgrade Redis Enterprise cluster ### Reapply roles and role bindings -If your operator is monitoring multiple namespaces, you'll need to [reapply your role and role bindings]({{< relref "/operate/kubernetes/re-clusters/multi-namespace#create-role-and-role-binding-for-managed-namespaces" >}}) for each managed namespace. See [Manage databases in multiple namespaces]({{< relref "/operate/kubernetes/re-clusters/multi-namespace" >}}) for more details. +If your operator is monitoring multiple namespaces, you'll need to [reapply your role and role bindings]({{< relref "/operate/kubernetes/7.8.4/re-clusters/multi-namespace#create-role-and-role-binding-for-managed-namespaces" >}}) for each managed namespace. See [Manage databases in multiple namespaces]({{< relref "/operate/kubernetes/7.8.4/re-clusters/multi-namespace" >}}) for more details. ### Monitor the upgrade @@ -206,7 +206,7 @@ oc rollout status sts After the cluster is upgraded, you can upgrade your databases. Specify your new database version in the `spec.redisVersion` field for your REDB and REAADB custom resources. Supported database versions include `"7.2"` and `"7.4"` (note this value is a string). -Note that if your cluster [`redisUpgradePolicy`]({{}}) or your database [`redisVersion`]({{< relref "/operate/kubernetes/reference/redis_enterprise_database_api#redisversion" >}}) are set to `major`, you won't be able to upgrade those databases to minor versions. See [Redis upgrade policy]({{< relref "/operate/rs/installing-upgrading/upgrading#redis-upgrade-policy" >}}) for more details. +Note that if your cluster [`redisUpgradePolicy`]({{}}) or your database [`redisVersion`]({{< relref "/operate/kubernetes/7.8.4/reference/redis_enterprise_database_api#redisversion" >}}) are set to `major`, you won't be able to upgrade those databases to minor versions. See [Redis upgrade policy]({{< relref "/operate/rs/installing-upgrading/upgrading#redis-upgrade-policy" >}}) for more details. ## Troubleshooting diff --git a/content/operate/kubernetes/7.8.4/upgrade/upgrade-olm.md b/content/operate/kubernetes/7.8.4/upgrade/upgrade-olm.md index 50fedd8364..79ee1ac790 100644 --- a/content/operate/kubernetes/7.8.4/upgrade/upgrade-olm.md +++ b/content/operate/kubernetes/7.8.4/upgrade/upgrade-olm.md @@ -26,7 +26,7 @@ See the [troubleshooting](#troubleshooting) section for details on recovering a #### Kubernetes version -Check [Supported Kubernetes distributions]({{}}) to make sure your Kubernetes distribution is supported. If not, upgrade your Kubernetes distribution before upgrading the Redis operator. +Check [Supported Kubernetes distributions]({{}}) to make sure your Kubernetes distribution is supported. If not, upgrade your Kubernetes distribution before upgrading the Redis operator. #### Redis operator version @@ -34,7 +34,7 @@ Your Redis Enterprise clusters must be running version 7.4.2-2 or later before u #### Redis database version -Your Redis databases must be running version 7.2 or later before upgrading your cluster version to 7.8.2-6. See [upgrade databases](#upgrade-databases) for detailed steps. You can find your database version in the [REDB `spec.redisVersion` field]({{}}). +Your Redis databases must be running version 7.2 or later before upgrading your cluster version to 7.8.2-6. See [upgrade databases](#upgrade-databases) for detailed steps. You can find your database version in the [REDB `spec.redisVersion` field]({{}}). #### RHEL9-compatible modules @@ -77,7 +77,7 @@ You can monitor the upgrade from the **Installed Operators** page. A new Redis E ## Reapply the SCC -If you are using OpenShift, you must manually reappply the [security context constraints (SCC)](https://docs.openshift.com/container-platform/4.8/authentication/managing-security-context-constraints.html) file ([`scc.yaml`]({{< relref "/operate/kubernetes/deployment/openshift/openshift-cli#deploy-the-operator" >}})) and bind it to your service account. +If you are using OpenShift, you must manually reappply the [security context constraints (SCC)](https://docs.openshift.com/container-platform/4.8/authentication/managing-security-context-constraints.html) file ([`scc.yaml`]({{< relref "/operate/kubernetes/7.8.4/deployment/openshift/openshift-cli#deploy-the-operator" >}})) and bind it to your service account. ```sh oc apply -f openshift/scc.yaml @@ -123,7 +123,7 @@ After the operator upgrade is complete, you can upgrade Redis Enterprise cluster ### Reapply roles and role bindings -If your operator is monitoring multiple namespaces, you'll need to [reapply your role and role bindings]({{< relref "/operate/kubernetes/re-clusters/multi-namespace#create-role-and-role-binding-for-managed-namespaces" >}}) for each managed namespace. See [Manage databases in multiple namespaces]({{< relref "/operate/kubernetes/re-clusters/multi-namespace" >}}) for more details. +If your operator is monitoring multiple namespaces, you'll need to [reapply your role and role bindings]({{< relref "/operate/kubernetes/7.8.4/re-clusters/multi-namespace#create-role-and-role-binding-for-managed-namespaces" >}}) for each managed namespace. See [Manage databases in multiple namespaces]({{< relref "/operate/kubernetes/7.8.4/re-clusters/multi-namespace" >}}) for more details. ### Monitor the upgrade @@ -149,7 +149,7 @@ oc rollout status sts After the cluster is upgraded, you can upgrade your databases. Specify your new database version in the `spec.redisVersion` field for your REDB and REAADB custom resources. Supported database versions for this operator version include `"7.2"` and `"7.4"` (note this value is a string). -Note that if your cluster [`redisUpgradePolicy`]({{}}) or your database [`redisVersion`]({{< relref "/operate/kubernetes/reference/redis_enterprise_database_api#redisversion" >}}) are set to `major`, you won't be able to upgrade those databases to minor versions. See [Redis upgrade policy]({{< relref "/operate/rs/installing-upgrading/upgrading#redis-upgrade-policy" >}}) for more details. +Note that if your cluster [`redisUpgradePolicy`]({{}}) or your database [`redisVersion`]({{< relref "/operate/kubernetes/7.8.4/reference/redis_enterprise_database_api#redisversion" >}}) are set to `major`, you won't be able to upgrade those databases to minor versions. See [Redis upgrade policy]({{< relref "/operate/rs/installing-upgrading/upgrading#redis-upgrade-policy" >}}) for more details. The Redis Enterprise cluster (REC) can be updated automatically or manually. To trigger automatic upgrade of the REC after the operator upgrade completes, specify `autoUpgradeRedisEnterprise: true` in your REC spec. If you don't have automatic upgrade enabled, follow the below steps for the manual upgrade. ## Troubleshooting diff --git a/content/operate/kubernetes/7.8.4/upgrade/upgrade-redis-cluster.md b/content/operate/kubernetes/7.8.4/upgrade/upgrade-redis-cluster.md index 3882da2050..31e0568899 100644 --- a/content/operate/kubernetes/7.8.4/upgrade/upgrade-redis-cluster.md +++ b/content/operate/kubernetes/7.8.4/upgrade/upgrade-redis-cluster.md @@ -29,7 +29,7 @@ See the [troubleshooting](#troubleshooting) section for details on recovering a ### Kubernetes version -Check [Supported Kubernetes distributions]({{}}) to make sure your Kubernetes distribution is supported by 7.8.2-6. If not, upgrade your Kubernetes distribution before upgrading the Redis operator. +Check [Supported Kubernetes distributions]({{}}) to make sure your Kubernetes distribution is supported by 7.8.2-6. If not, upgrade your Kubernetes distribution before upgrading the Redis operator. ### Redis operator version @@ -37,7 +37,7 @@ Your Redis Enterprise clusters must be running version 7.4.2-2 or later before u ### Redis database version -Your Redis databases must be running version 7.2 or later before upgrading your cluster version to 7.8.2-6. See [upgrade databases](#upgrade-databases) for detailed steps. You can find your database version in the [REDB `spec.redisVersion` field]({{}}). +Your Redis databases must be running version 7.2 or later before upgrading your cluster version to 7.8.2-6. See [upgrade databases](#upgrade-databases) for detailed steps. You can find your database version in the [REDB `spec.redisVersion` field]({{}}). ### RHEL9-compatible modules @@ -169,7 +169,7 @@ If you are upgrading from a preview version of the Active-Active controller, you ### Reapply roles and role bindings -If your operator is monitoring multiple namespaces, you'll need to [reapply your role and role bindings]({{< relref "/operate/kubernetes/re-clusters/multi-namespace#create-role-and-role-binding-for-managed-namespaces" >}}) for each managed namespace. See [Manage databases in multiple namespaces]({{< relref "/operate/kubernetes/re-clusters/multi-namespace" >}}) for more details. +If your operator is monitoring multiple namespaces, you'll need to [reapply your role and role bindings]({{< relref "/operate/kubernetes/7.8.4/re-clusters/multi-namespace#create-role-and-role-binding-for-managed-namespaces" >}}) for each managed namespace. See [Manage databases in multiple namespaces]({{< relref "/operate/kubernetes/7.8.4/re-clusters/multi-namespace" >}}) for more details. ### Monitor the upgrade @@ -195,7 +195,7 @@ kubectl rollout status sts After the cluster is upgraded, you can upgrade your databases. Specify your new database version in the `spec.redisVersion` field for your REDB and REAADB custom resources. Supported database versions for operator version 7.8.2-6 include `"7.2"` and `"7.4"` (note this value is a string). -Note that if your cluster [`redisUpgradePolicy`]({{}}) or your database [`redisVersion`]({{< relref "/operate/kubernetes/reference/redis_enterprise_database_api#redisversion" >}}) are set to `major`, you won't be able to upgrade those databases to minor versions. See [Redis upgrade policy]({{< relref "/operate/rs/installing-upgrading/upgrading#redis-upgrade-policy" >}}) for more details. +Note that if your cluster [`redisUpgradePolicy`]({{}}) or your database [`redisVersion`]({{< relref "/operate/kubernetes/7.8.4/reference/redis_enterprise_database_api#redisversion" >}}) are set to `major`, you won't be able to upgrade those databases to minor versions. See [Redis upgrade policy]({{< relref "/operate/rs/installing-upgrading/upgrading#redis-upgrade-policy" >}}) for more details. ## Troubleshooting diff --git a/content/operate/rs/7.4/_index.md b/content/operate/rs/7.4/_index.md index c99c376608..99062e98bb 100644 --- a/content/operate/rs/7.4/_index.md +++ b/content/operate/rs/7.4/_index.md @@ -28,34 +28,34 @@ If you prefer a fully managed Redis database-as-a-service, available on major pu ## Get started Build a small-scale cluster with the Redis Enterprise 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]({{< relref "/operate/rs/7.4/installing-upgrading/quickstarts/redis-enterprise-software-quickstart" >}}) +- [Docker quickstart]({{< relref "/operate/rs/7.4/installing-upgrading/quickstarts/docker-quickstart" >}}) +- [Get started with Active-Active]({{< relref "/operate/rs/7.4/databases/active-active/get-started" >}}) ## Install & setup -[Install & set up]({{< relref "/operate/rs/installing-upgrading" >}}) a Redis Enterprise 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" >}}) +[Install & set up]({{< relref "/operate/rs/7.4/installing-upgrading" >}}) a Redis Enterprise Software cluster. +- [Networking]({{< relref "/operate/rs/7.4/networking" >}}) +- [Set up]({{< relref "/operate/rs/7.4/clusters/new-cluster-setup" >}}) & [configure]({{< relref "/operate/rs/7.4/clusters/configure" >}}) a [cluster]({{< relref "/operate/rs/7.4/clusters" >}}) - [Release notes]({{< relref "/operate/rs/release-notes" >}}) ## Databases -Create and manage a [Redis database]({{< relref "/operate/rs/databases" >}}) on a cluster. -- [Create a Redis Enterprise 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]({{< relref "/operate/rs/7.4/databases" >}}) on a cluster. +- [Create a Redis Enterprise Software database]({{< relref "/operate/rs/7.4/databases/create" >}}) +- [Configure database]({{< relref "/operate/rs/7.4/databases/configure" >}}) +- [Create Active-Active database]({{< relref "/operate/rs/7.4/databases/active-active/create" >}}) +- [Edit Active-Active database]({{< relref "/operate/rs/7.4/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]({{< relref "/operate/rs/7.4/security" >}}) to the cluster and databases. +- [Access control]({{< relref "/operate/rs/7.4/security/access-control" >}}) +- [Users]({{< relref "/operate/rs/7.4/security/access-control/manage-users" >}}) & [roles]({{< relref "/operate/rs/7.4/security/access-control" >}}) +- [Certificates]({{< relref "/operate/rs/7.4/security/certificates" >}}) +- [TLS]({{< relref "/operate/rs/7.4/security/encryption/tls" >}}) & [Encryption]({{< relref "/operate/rs/7.4/security/encryption" >}}) ## 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" >}}) -- [REST API reference]({{< relref "/operate/rs/references/rest-api" >}}) & [examples]({{< relref "/operate/rs/references/rest-api/quick-start" >}}) +- [rladmin]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin" >}}), [crdb-cli]({{< relref "/operate/rs/7.4/references/cli-utilities/crdb-cli" >}}), & [other utilities]({{< relref "/operate/rs/7.4/references/cli-utilities" >}}) +- [REST API reference]({{< relref "/operate/rs/7.4/references/rest-api" >}}) & [examples]({{< relref "/operate/rs/7.4/references/rest-api/quick-start" >}}) - [Redis commands]({{< relref "/commands" >}}) ## Archive diff --git a/content/operate/rs/7.4/clusters/_index.md b/content/operate/rs/7.4/clusters/_index.md index 46b9a81171..1b186a6d42 100644 --- a/content/operate/rs/7.4/clusters/_index.md +++ b/content/operate/rs/7.4/clusters/_index.md @@ -16,5 +16,5 @@ url: '/operate/rs/7.4/clusters/' You can manage your Redis Enterprise 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]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin" >}}), [redis-cli]({{< relref "/develop/tools/cli" >}}), [crdb-cli]({{< relref "/operate/rs/7.4/references/cli-utilities/crdb-cli" >}})) +- [REST API]({{< relref "/operate/rs/7.4/references/rest-api/_index.md" >}}) diff --git a/content/operate/rs/7.4/clusters/add-node.md b/content/operate/rs/7.4/clusters/add-node.md index 9a2d4823d8..1587f8827b 100644 --- a/content/operate/rs/7.4/clusters/add-node.md +++ b/content/operate/rs/7.4/clusters/add-node.md @@ -16,12 +16,12 @@ After you install the first node, you can add more nodes to the cluster. {{< note >}} 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]({{< relref "/operate/rs/7.4/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]({{< relref "/operate/rs/7.4/networking/cluster-dns" >}}) each time a node is added or replaced. - We recommend that you add nodes one after the other rather than in parallel @@ -30,8 +30,8 @@ Before you add a node to the cluster: To add a node to an existing cluster: -1. [Install the Redis Enterprise 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 Enterprise Software installation package]({{< relref "/operate/rs/7.4/installing-upgrading" >}}) on a clean installation + of a [supported operating system]({{< relref "/operate/rs/7.4/installing-upgrading/install/plan-deployment/supported-platforms.md" >}}). 1. To connect to the Cluster Manager UI of the new Redis Enterprise Software installation, go to: @@ -39,7 +39,7 @@ To add a node to an existing cluster: {{< 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" >}}) +You can also [replace the TLS certificate]({{< relref "/operate/rs/7.4/security/certificates/updating-certificates" >}}) with a custom certificate. {{< /tip >}} @@ -57,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*]({{< relref "/operate/rs/7.4/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage" >}}), 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*]({{< relref "/operate/rs/7.4/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage" >}}), or leave the default path. - 1. To enable [*Auto Tiering*]({{< relref "/operate/rs/databases/auto-tiering/" >}}), + 1. To enable [*Auto Tiering*]({{< relref "/operate/rs/7.4/databases/auto-tiering/" >}}), 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]({{< relref "/operate/rs/7.4/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**. @@ -77,6 +77,6 @@ You can see it in the list of nodes in the cluster. If you see an error when you add the node, try adding the node again. {{< tip >}} -We recommend that you run the [rlcheck utility]({{< relref "/operate/rs/references/cli-utilities/rlcheck" >}}) to verify that the node is functioning properly. +We recommend that you run the [rlcheck utility]({{< relref "/operate/rs/7.4/references/cli-utilities/rlcheck" >}}) to verify that the node is functioning properly. {{< /tip >}} diff --git a/content/operate/rs/7.4/clusters/cluster-recovery.md b/content/operate/rs/7.4/clusters/cluster-recovery.md index b36c225ce9..c99f9f5782 100644 --- a/content/operate/rs/7.4/clusters/cluster-recovery.md +++ b/content/operate/rs/7.4/clusters/cluster-recovery.md @@ -26,7 +26,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]({{< relref "/operate/rs/7.4/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage" >}}). The cluster recovery process includes: @@ -34,7 +34,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]({{< relref "/operate/rs/7.4/databases/recover.md" >}}). ## Prerequisites @@ -51,7 +51,7 @@ The cluster recovery process includes: 1. (Optional) If you want to recover the cluster to the original cluster nodes, uninstall Redis Enterprise Software from the nodes. -1. [Install Redis Enterprise Software]({{< relref "/operate/rs/installing-upgrading/install/install-on-linux" >}}) on the new cluster nodes. +1. [Install Redis Enterprise Software]({{< relref "/operate/rs/7.4/installing-upgrading/install/install-on-linux" >}}) on the new cluster nodes. The new servers must have the same basic hardware and software configuration as the original servers, including: @@ -74,7 +74,7 @@ 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`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/cluster/recover" >}}) on the first node in the new cluster: ```sh rladmin cluster recover filename [ | ] node_uid rack_id @@ -89,7 +89,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`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/cluster/join" >}}) from each new node: ```sh rladmin cluster join nodes username password replace_node @@ -101,15 +101,15 @@ 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`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/status" >}}) 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" >}}) +Make sure that you update your [DNS records]({{< relref "/operate/rs/7.4/networking/cluster-dns" >}}) with the IP addresses of the new nodes. {{< /note >}} -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]({{< relref "/operate/rs/7.4/databases/recover.md" >}}). diff --git a/content/operate/rs/7.4/clusters/configure/_index.md b/content/operate/rs/7.4/clusters/configure/_index.md index 4a74ac4140..a7bb89a6ec 100644 --- a/content/operate/rs/7.4/clusters/configure/_index.md +++ b/content/operate/rs/7.4/clusters/configure/_index.md @@ -14,8 +14,8 @@ url: '/operate/rs/7.4/clusters/configure/' You can manage your Redis Enterprise 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]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin" >}}), [redis-cli]({{< relref "/develop/tools/cli" >}}), [crdb-cli]({{< relref "/operate/rs/7.4/references/cli-utilities/crdb-cli" >}})) +- [REST API]({{< relref "/operate/rs/7.4/references/rest-api/_index.md" >}}) diff --git a/content/operate/rs/7.4/clusters/configure/cluster-settings.md b/content/operate/rs/7.4/clusters/configure/cluster-settings.md index 00bee60f60..ce3e55eb3d 100644 --- a/content/operate/rs/7.4/clusters/configure/cluster-settings.md +++ b/content/operate/rs/7.4/clusters/configure/cluster-settings.md @@ -23,7 +23,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]({{< relref "/operate/rs/7.4/clusters/configure/license-keys.md" >}}). ### View max number of allowed shards @@ -44,7 +44,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/clusters/monitoring#send-alerts-by-email" >}}) to relevant users. +You can also configure email server settings and [send alerts by email]({{< relref "/operate/rs/7.4/clusters/monitoring#send-alerts-by-email" >}}) to relevant users. ### Configure email server settings diff --git a/content/operate/rs/7.4/clusters/configure/license-keys.md b/content/operate/rs/7.4/clusters/configure/license-keys.md index f12048aaa5..e0775e1b13 100644 --- a/content/operate/rs/7.4/clusters/configure/license-keys.md +++ b/content/operate/rs/7.4/clusters/configure/license-keys.md @@ -20,7 +20,7 @@ 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 Enterprise 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]({{< relref "/operate/rs/7.4/references/rest-api/requests/bootstrap#post-bootstrap" >}}), a trial cluster license is generated by default. ## View cluster license key @@ -32,9 +32,9 @@ To view the cluster license key, use: 1. Select **Change** to view the cluster license key. -- REST API - [`GET /v1/license`]({{< relref "/operate/rs/references/rest-api/requests/license#get-license" >}}) +- REST API - [`GET /v1/license`]({{< relref "/operate/rs/7.4/references/rest-api/requests/license#get-license" >}}) - For a list of returned fields, see the [response section]({{< relref "/operate/rs/references/rest-api/requests/license#get-response" >}}). + For a list of returned fields, see the [response section]({{< relref "/operate/rs/7.4/references/rest-api/requests/license#get-response" >}}). {{}} As of version 7.2, Redis Enterprise 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. diff --git a/content/operate/rs/7.4/clusters/configure/rack-zone-awareness.md b/content/operate/rs/7.4/clusters/configure/rack-zone-awareness.md index 19c5a7be2f..122b72aeaf 100644 --- a/content/operate/rs/7.4/clusters/configure/rack-zone-awareness.md +++ b/content/operate/rs/7.4/clusters/configure/rack-zone-awareness.md @@ -55,7 +55,7 @@ cluster, nodes, and [databases](#enable-database-rack-zone-awareness). ### 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]({{< relref "/operate/rs/7.4/clusters/new-cluster-setup" >}}): 1. In the **Cluster** screen's **Configuration** section, enable **Rack zone awareness**. @@ -63,22 +63,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]({{< relref "/operate/rs/7.4/clusters/new-cluster-setup" >}}). -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]({{< relref "/operate/rs/7.4/clusters/add-node" >}}), 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]({{< relref "/operate/rs/7.4/references/rest-api" >}}): -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]({{< relref "/operate/rs/7.4/references/rest-api/requests/nodes#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]({{< relref "/operate/rs/7.4/references/rest-api/requests/cluster/policy#put-cluster-policy" >}}) to enable rack-zone awareness: ```sh PUT /v1/cluster/policy @@ -92,11 +92,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]({{< relref "/operate/rs/7.4/references/rest-api/requests/bdbs#put-bdbs" >}}): ```sh PUT /v1/bdbs/ @@ -120,9 +120,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]({{< relref "/operate/rs/7.4/references/rest-api" >}}) 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]({{< relref "/operate/rs/7.4/references/rest-api/requests/bdbs/actions/optimize_shards_placement#get-bdbs-actions-optimize-shards-placement" >}}): 1. Send the following `GET` request: @@ -134,7 +134,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]({{< relref "/operate/rs/7.4/references/rest-api/requests/bdbs/actions/optimize_shards_placement#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/7.4/clusters/configure/sync-clocks.md b/content/operate/rs/7.4/clusters/configure/sync-clocks.md index b240fa2682..5209dc3939 100644 --- a/content/operate/rs/7.4/clusters/configure/sync-clocks.md +++ b/content/operate/rs/7.4/clusters/configure/sync-clocks.md @@ -130,5 +130,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)]({{< relref "/operate/rs/7.4/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/7.4/clusters/logging/_index.md b/content/operate/rs/7.4/clusters/logging/_index.md index 79b0be04d1..0c926111d5 100644 --- a/content/operate/rs/7.4/clusters/logging/_index.md +++ b/content/operate/rs/7.4/clusters/logging/_index.md @@ -32,8 +32,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]({{< relref "/operate/rs/7.4/clusters/logging/redis-slow-log.md" >}}) +- [rsyslog logging]({{< relref "/operate/rs/7.4/clusters/logging/rsyslog-logging/" >}}) ## View logs in the UI diff --git a/content/operate/rs/7.4/clusters/logging/log-security.md b/content/operate/rs/7.4/clusters/logging/log-security.md index 82bbe5d571..d9fa692b31 100644 --- a/content/operate/rs/7.4/clusters/logging/log-security.md +++ b/content/operate/rs/7.4/clusters/logging/log-security.md @@ -10,13 +10,13 @@ linktitle: Manage logs weight: 50 url: '/operate/rs/7.4/clusters/logging/log-security/' --- -Redis Enterprise 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 Enterprise comes with [a set of logs]({{< relref "/operate/rs/7.4/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. ## Send logs to a remote logging server Redis Enterprise 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]({{< relref "/operate/rs/7.4/clusters/logging/rsyslog-logging/" >}}) for additional details. ## Log rotation diff --git a/content/operate/rs/7.4/clusters/logging/rsyslog-logging/_index.md b/content/operate/rs/7.4/clusters/logging/rsyslog-logging/_index.md index 2179a55229..09a4e9d862 100644 --- a/content/operate/rs/7.4/clusters/logging/rsyslog-logging/_index.md +++ b/content/operate/rs/7.4/clusters/logging/rsyslog-logging/_index.md @@ -21,13 +21,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]({{< relref "/operate/rs/7.4/clusters/logging/log-security" >}}) 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]({{< relref "/operate/rs/7.4/clusters/logging/alerts-events" >}}) for more details. ### Severity @@ -64,7 +64,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]({{< relref "/operate/rs/7.4/clusters/logging/alerts-events" >}}) 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:** @@ -106,7 +106,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]({{< relref "/operate/rs/7.4/clusters/logging/alerts-events" >}}) for more details. #### "Alert off" log entry sample @@ -136,7 +136,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]({{< relref "/operate/rs/7.4/clusters/logging/alerts-events" >}}) for more details. ### Odd number of nodes with a minimum of three nodes alert @@ -166,7 +166,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]({{< relref "/operate/rs/7.4/clusters/logging/alerts-events" >}}) for more details. #### "Alert off" log entry sample @@ -194,7 +194,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]({{< relref "/operate/rs/7.4/clusters/logging/alerts-events" >}}) for more details. ### Node has insufficient disk space for AOF rewrite @@ -233,7 +233,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]({{< relref "/operate/rs/7.4/clusters/logging/alerts-events" >}}) for more details. #### "Alert off" log entry sample @@ -266,4 +266,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]({{< relref "/operate/rs/7.4/clusters/logging/alerts-events" >}}) for more details. diff --git a/content/operate/rs/7.4/clusters/maintenance-mode.md b/content/operate/rs/7.4/clusters/maintenance-mode.md index ffd3536a08..1b5cba0433 100644 --- a/content/operate/rs/7.4/clusters/maintenance-mode.md +++ b/content/operate/rs/7.4/clusters/maintenance-mode.md @@ -25,7 +25,7 @@ When you activate maintenance mode, Redis Enterprise does the following: 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`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/status" >}}) displays the node's shards field in yellow, which indicates that shards cannot migrate to the node. {{< image filename="/images/rs/maintenance_mode.png" >}} @@ -103,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 Enterprise 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`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/node/snapshot#node-snapshot-create" >}}). If you do not specify a snapshot, Redis Enterprise uses the latest maintenance mode snapshot by default. To get a list of available snapshots, run: @@ -145,7 +145,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`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/status" >}}) changes when you turn on maintenance mode for a node. The cluster status before turning on maintenance mode: @@ -182,7 +182,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]({{< relref "/operate/rs/7.4/references/rest-api" >}}) to [POST `/nodes/{node_uid}/actions/{action}`]({{< relref "/operate/rs/7.4/references/rest-api/requests/nodes/actions#post-node-action" >}}). ### Activate maintenance mode (REST API) @@ -230,7 +230,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}`]({{< relref "/operate/rs/7.4/references/rest-api/requests/nodes/actions#get-node-action" >}}) to track the [status]({{< relref "/operate/rs/7.4/references/rest-api/objects/action" >}}) of the `maintenance_on` and `maintenance_off` actions. This request returns the status of the `maintenance_on` action: diff --git a/content/operate/rs/7.4/clusters/monitoring/_index.md b/content/operate/rs/7.4/clusters/monitoring/_index.md index d2fb1bf776..c30df51fbb 100644 --- a/content/operate/rs/7.4/clusters/monitoring/_index.md +++ b/content/operate/rs/7.4/clusters/monitoring/_index.md @@ -18,7 +18,7 @@ In the Redis Enterprise Cluster Manager UI, you can see real-time metrics and co To integrate Redis Enterprise metrics into your monitoring environment, see the integration guides for [Prometheus and Grafana]({{< relref "/integrate/prometheus-with-redis-enterprise/" >}}) or [Uptrace]({{< relref "/integrate/uptrace-with-redis-enterprise/" >}}). -Make sure you read the [definition of each metric]({{< relref "/operate/rs/references/metrics/" >}}) +Make sure you read the [definition of each metric]({{< relref "/operate/rs/7.4/references/metrics/" >}}) so that you understand exactly what it represents. ## Real-time metrics @@ -79,8 +79,8 @@ To enable alerts for a database: To send cluster and database alerts by email: 1. In **Cluster > Alert Settings**, click **Edit**. -1. Select **Set an email** to configure the [email server settings]({{< relref "/operate/rs/clusters/configure/cluster-settings#configuring-email-server-settings" >}}). +1. Select **Set an email** to configure the [email server settings]({{< relref "/operate/rs/7.4/clusters/configure/cluster-settings#configuring-email-server-settings" >}}). 1. In **Configuration** for the database, click **Edit**. 1. Select the **Alerts** section to open it. 1. Select **Receive email alerts** and click **Save**. -1. In **Access Control**, select the [database and cluster alerts]({{< relref "/operate/rs/security/access-control/manage-users" >}}) that you want each user to receive. +1. In **Access Control**, select the [database and cluster alerts]({{< relref "/operate/rs/7.4/security/access-control/manage-users" >}}) that you want each user to receive. diff --git a/content/operate/rs/7.4/clusters/new-cluster-setup.md b/content/operate/rs/7.4/clusters/new-cluster-setup.md index 556e3345c7..d48c86d1f1 100644 --- a/content/operate/rs/7.4/clusters/new-cluster-setup.md +++ b/content/operate/rs/7.4/clusters/new-cluster-setup.md @@ -18,9 +18,9 @@ In a cluster that consists of only one node, some features and capabilities are such as database replication that provides high availability. {{< /note >}} -To set up a new cluster, you must first [install the Redis Enterprise Software package]({{< relref "/operate/rs/installing-upgrading" >}}) +To set up a new cluster, you must first [install the Redis Enterprise Software package]({{< relref "/operate/rs/7.4/installing-upgrading" >}}) 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]({{< relref "/operate/rs/7.4/clusters/add-node.md" >}}). To create a cluster: @@ -28,7 +28,7 @@ To create a cluster: For example, if you installed Redis Enterprise 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" >}}). +- The management UI uses a [self-signed certificate for TLS encryption]({{< relref "/operate/rs/7.4/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 >}} @@ -42,26 +42,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]({{< relref "/operate/rs/7.4/networking/cluster-dns" >}}) 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**]({{< relref "/operate/rs/7.4/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**]({{< relref "/operate/rs/7.4/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*]({{< relref "/operate/rs/7.4/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage" >}}), 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*]({{< relref "/operate/rs/7.4/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage" >}}), or leave the default path. - 1. To enable [*Auto Tiering*]({{< relref "/operate/rs/databases/auto-tiering/" >}}), + 1. To enable [*Auto Tiering*]({{< relref "/operate/rs/7.4/databases/auto-tiering/" >}}), 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]({{< relref "/operate/rs/7.4/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**. @@ -74,5 +74,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]({{< relref "/operate/rs/7.4/databases/create.md" >}}) +- [Joining a new node to a cluster]({{< relref "/operate/rs/7.4/clusters/add-node.md" >}}) diff --git a/content/operate/rs/7.4/clusters/optimize/disk-sizing-heavy-write-scenarios.md b/content/operate/rs/7.4/clusters/optimize/disk-sizing-heavy-write-scenarios.md index 93ce4df237..0930d99885 100644 --- a/content/operate/rs/7.4/clusters/optimize/disk-sizing-heavy-write-scenarios.md +++ b/content/operate/rs/7.4/clusters/optimize/disk-sizing-heavy-write-scenarios.md @@ -37,5 +37,5 @@ disk space they would require in this scenario: For disk size requirements in standard usage scenarios, refer to the [Hardware -requirements]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/hardware-requirements.md" >}}) +requirements]({{< relref "/operate/rs/7.4/installing-upgrading/install/plan-deployment/hardware-requirements.md" >}}) section. diff --git a/content/operate/rs/7.4/clusters/optimize/memtier-benchmark.md b/content/operate/rs/7.4/clusters/optimize/memtier-benchmark.md index 3fb0ef2e78..31ddad45ba 100644 --- a/content/operate/rs/7.4/clusters/optimize/memtier-benchmark.md +++ b/content/operate/rs/7.4/clusters/optimize/memtier-benchmark.md @@ -20,7 +20,7 @@ Prerequisites: - A cluster configured - A database created -For help with the prerequisites, see the [Redis Enterprise Software quickstart]({{< relref "/operate/rs/installing-upgrading/quickstarts/redis-enterprise-software-quickstart" >}}). +For help with the prerequisites, see the [Redis Enterprise Software quickstart]({{< relref "/operate/rs/7.4/installing-upgrading/quickstarts/redis-enterprise-software-quickstart" >}}). 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/7.4/clusters/optimize/optimization.md b/content/operate/rs/7.4/clusters/optimize/optimization.md index ec01f2fc22..0917569c58 100644 --- a/content/operate/rs/7.4/clusters/optimize/optimization.md +++ b/content/operate/rs/7.4/clusters/optimize/optimization.md @@ -36,7 +36,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`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/tune#tune-cluster" >}}) commands. - For Redis Enterprise Software version 6.4.2-69 and later, run: diff --git a/content/operate/rs/7.4/clusters/optimize/oss-cluster-api.md b/content/operate/rs/7.4/clusters/optimize/oss-cluster-api.md index d8f8d790d3..226a5d7489 100644 --- a/content/operate/rs/7.4/clusters/optimize/oss-cluster-api.md +++ b/content/operate/rs/7.4/clusters/optimize/oss-cluster-api.md @@ -17,6 +17,6 @@ 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 Enterprise 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 Enterprise Software, see [Enable OSS Cluster API]({{< relref "/operate/rs/7.4/databases/configure/oss-cluster-api" >}}). To learn how to enable OSS Cluster API in Redis Cloud, see [Clustering Redis databases]({{< relref "/operate/rc/databases/configuration/clustering#cluster-api" >}}). diff --git a/content/operate/rs/7.4/clusters/optimize/turn-off-services.md b/content/operate/rs/7.4/clusters/optimize/turn-off-services.md index c71a8f07c3..f0b4869382 100644 --- a/content/operate/rs/7.4/clusters/optimize/turn-off-services.md +++ b/content/operate/rs/7.4/clusters/optimize/turn-off-services.md @@ -22,9 +22,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]({{< relref "/operate/rs/7.4/security/access-control/ldap" >}}) - `saslauthd` +- [Discovery service]({{< relref "/operate/rs/7.4/networking/cluster-dns.md" >}})- `mdns_server`, `pdns_server` +- [Active-Active databases]({{< relref "/operate/rs/7.4/databases/active-active" >}}) - `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`. @@ -33,7 +33,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`]({{< relref "/operate/rs/7.4/references/rest-api/requests/cluster/services_configuration#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/7.4/clusters/remove-node.md b/content/operate/rs/7.4/clusters/remove-node.md index eec0942e2d..65667c5f7f 100644 --- a/content/operate/rs/7.4/clusters/remove-node.md +++ b/content/operate/rs/7.4/clusters/remove-node.md @@ -16,7 +16,7 @@ You might want to remove a node from a Redis Enterprise cluster for one of the f - 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/clusters/monitoring#cluster-alerts" >}}) to notify you of cluster changes, including when a node is removed. +You can configure [email alerts from the cluster]({{< relref "/operate/rs/7.4/clusters/monitoring#cluster-alerts" >}}) to notify you of cluster changes, including when a node is removed. {{}} Read through these explanations thoroughly before taking @@ -51,7 +51,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]({{< relref "/operate/rs/7.4/clusters/replace-node.md" >}}). ## Replace a healthy node @@ -60,14 +60,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]({{< relref "/operate/rs/7.4/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)]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin" >}}). {{< note >}} -The [DNS records]({{< relref "/operate/rs/networking/cluster-dns" >}}) must be updated each time a node is added or replaced. +The [DNS records]({{< relref "/operate/rs/7.4/networking/cluster-dns" >}}) must be updated each time a node is added or replaced. {{< /note >}} ## Remove a node @@ -94,11 +94,11 @@ To remove a node using the Cluster Manager UI: 1. Once the process finishes, the node is no longer shown in the UI. -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`]({{< relref "/operate/rs/7.4/references/rest-api/requests/nodes/actions#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]({{}}) `persistent_node_removal` to `true` to change the cluster's default behavior. For example: @@ -111,6 +111,6 @@ 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. +you must [uninstall]({{< relref "/operate/rs/7.4/installing-upgrading/uninstalling.md" >}}) +and [reinstall]({{< relref "/operate/rs/7.4/installing-upgrading" >}}) the software on that node. {{< /note >}} diff --git a/content/operate/rs/7.4/clusters/replace-node.md b/content/operate/rs/7.4/clusters/replace-node.md index e20b92fa98..87c905a724 100644 --- a/content/operate/rs/7.4/clusters/replace-node.md +++ b/content/operate/rs/7.4/clusters/replace-node.md @@ -17,13 +17,13 @@ To replace a failed node: 1. Prepare a new node identical to the old one. 1. Install and - configure Redis Enterprise Software on the node. See [Install and setup]({{< relref "/operate/rs/installing-upgrading" >}}) for more information. + configure Redis Enterprise Software on the node. See [Install and setup]({{< relref "/operate/rs/7.4/installing-upgrading" >}}) for more information. {{< note >}} -If you are using [Auto Tiering]({{< relref "/operate/rs/databases/auto-tiering/" >}}), make sure the required flash storage is set up on this new node. +If you are using [Auto Tiering]({{< relref "/operate/rs/7.4/databases/auto-tiering/" >}}), make sure the required flash storage is set up on this new node. {{< /note >}} -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]({{< relref "/operate/rs/7.4/clusters/add-node" >}}) 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. @@ -33,6 +33,6 @@ If you are using [Auto Tiering]({{< relref "/operate/rs/databases/auto-tiering/" {{< note >}} - If there is a faulty node in the cluster to which you are adding a node, Redis Enterprise Software will use the new node to replace the faulty one. -- Any existing [DNS records]({{< relref "/operate/rs/networking/cluster-dns" >}}) must be updated +- Any existing [DNS records]({{< relref "/operate/rs/7.4/networking/cluster-dns" >}}) must be updated each time a node is added or replaced. {{< /note >}} diff --git a/content/operate/rs/7.4/databases/_index.md b/content/operate/rs/7.4/databases/_index.md index 41c86d5e49..72df2e3371 100644 --- a/content/operate/rs/7.4/databases/_index.md +++ b/content/operate/rs/7.4/databases/_index.md @@ -16,7 +16,7 @@ url: '/operate/rs/7.4/databases/' You can manage your Redis Enterprise Software databases 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`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin" >}}), [`redis-cli`]({{< relref "/develop/tools/cli" >}}), [`crdb-cli`]({{< relref "/operate/rs/7.4/references/cli-utilities/crdb-cli" >}})) +- [REST API]({{< relref "/operate/rs/7.4/references/rest-api/_index.md" >}}) diff --git a/content/operate/rs/7.4/databases/active-active/_index.md b/content/operate/rs/7.4/databases/active-active/_index.md index 810276ef54..a6bef6d5b8 100644 --- a/content/operate/rs/7.4/databases/active-active/_index.md +++ b/content/operate/rs/7.4/databases/active-active/_index.md @@ -22,9 +22,9 @@ Active-Active databases also provide disaster recovery and accelerated data read ## High availability -The [high availability]({{< relref "/operate/rs/databases/durability-ha/" >}}) that Active-Active replication provides is built upon a number of Redis Enterprise Software features (such as [clustering]({{< relref "/operate/rs/databases/durability-ha/clustering.md" >}}), [replication]({{< relref "/operate/rs/databases/durability-ha/replication.md" >}}), and [replica HA]({{< relref "/operate/rs/databases/configure/replica-ha.md" >}})) as well as some features unique to Active-Active ([multi-primary replication]({{}}), [automatic conflict resolution]({{}}), and [strong eventual consistency]({{}})). +The [high availability]({{< relref "/operate/rs/7.4/databases/durability-ha/" >}}) that Active-Active replication provides is built upon a number of Redis Enterprise Software features (such as [clustering]({{< relref "/operate/rs/7.4/databases/durability-ha/clustering.md" >}}), [replication]({{< relref "/operate/rs/7.4/databases/durability-ha/replication.md" >}}), and [replica HA]({{< relref "/operate/rs/7.4/databases/configure/replica-ha.md" >}})) as well as some features unique to Active-Active ([multi-primary replication]({{}}), [automatic conflict resolution]({{}}), and [strong eventual consistency]({{}})). -Clustering and replication are used together in Active-Active databases to distribute multiple copies of the dataset across multiple nodes and multiple clusters. As a result, a node or cluster is less likely to become a single point of failure. If a primary node or primary shard fails, a replica is automatically promoted to primary. To avoid having one node hold all copies of certain data, the [replica HA]({{< relref "/operate/rs/databases/configure/replica-ha.md" >}}) feature (enabled by default) automatically migrates replica shards to available nodes. +Clustering and replication are used together in Active-Active databases to distribute multiple copies of the dataset across multiple nodes and multiple clusters. As a result, a node or cluster is less likely to become a single point of failure. If a primary node or primary shard fails, a replica is automatically promoted to primary. To avoid having one node hold all copies of certain data, the [replica HA]({{< relref "/operate/rs/7.4/databases/configure/replica-ha.md" >}}) feature (enabled by default) automatically migrates replica shards to available nodes. ## Multi-primary replication @@ -39,25 +39,25 @@ Database configurations, LUA scripts, and other support info are not replicated. ## Syncer -Keeping multiple copies of the dataset consistent across multiple clusters is no small task. To achieve consistency between participating clusters, Redis Active-Active replication uses a process called the [syncer]({{< relref "/operate/rs/databases/active-active/syncer" >}}). +Keeping multiple copies of the dataset consistent across multiple clusters is no small task. To achieve consistency between participating clusters, Redis Active-Active replication uses a process called the [syncer]({{< relref "/operate/rs/7.4/databases/active-active/syncer" >}}). -The syncer keeps a [replication backlog]({{< relref "/operate/rs/databases/active-active/manage#replication-backlog/" >}}), which stores changes to the dataset that the syncer sends to other participating clusters. The syncer uses partial syncs to keep replicas up to date with changes, or a full sync in the event a replica or primary is lost. +The syncer keeps a [replication backlog]({{< relref "/operate/rs/7.4/databases/active-active/manage#replication-backlog/" >}}), which stores changes to the dataset that the syncer sends to other participating clusters. The syncer uses partial syncs to keep replicas up to date with changes, or a full sync in the event a replica or primary is lost. ## Conflict resolution Because you can connect to any participating cluster to perform a write operation, concurrent and conflicting writes are always possible. Conflict resolution is an important part of the Active-Active technology. Active-Active databases only use [conflict-free replicated data types (CRDTs)](https://en.wikipedia.org/wiki/Conflict-free_replicated_data_type). These data types provide a predictable conflict resolution and don't require any additional work from the application or client side. -When developing with CRDTs for Active-Active databases, you need to consider some important differences. See [Develop applications with Active-Active databases]({{< relref "/operate/rs/databases/active-active/develop/_index.md" >}}) for related information. +When developing with CRDTs for Active-Active databases, you need to consider some important differences. See [Develop applications with Active-Active databases]({{< relref "/operate/rs/7.4/databases/active-active/develop/_index.md" >}}) for related information. ## Strong eventual consistency Maintaining strong consistency for replicated databases comes with tradeoffs in scalability and availability. Redis Active-Active databases use a strong eventual consistency model, which means that local values may differ across replicas for short periods of time, but they all eventually converge to one consistent state. Redis uses vector clocks and the CRDT conflict resolution to strengthen consistency between replicas. You can also enable the causal consistency feature to preserve the order of operations as they are synchronized among replicas. -Other Redis Enterprise Software features can also be used to enhance the performance, scalability, or durability of your Active-Active database. These include [data persistence]({{< relref "/operate/rs/databases/configure/database-persistence.md" >}}), [multiple active proxies]({{< relref "/operate/rs/databases/configure/proxy-policy.md" >}}), [distributed synchronization]({{< relref "/operate/rs/databases/active-active/synchronization-mode.md" >}}), [OSS Cluster API]({{< relref "/operate/rs/databases/configure/oss-cluster-api.md" >}}), and [rack-zone awareness]({{< relref "/operate/rs/clusters/configure/rack-zone-awareness.md" >}}). +Other Redis Enterprise Software features can also be used to enhance the performance, scalability, or durability of your Active-Active database. These include [data persistence]({{< relref "/operate/rs/7.4/databases/configure/database-persistence.md" >}}), [multiple active proxies]({{< relref "/operate/rs/7.4/databases/configure/proxy-policy.md" >}}), [distributed synchronization]({{< relref "/operate/rs/7.4/databases/active-active/synchronization-mode.md" >}}), [OSS Cluster API]({{< relref "/operate/rs/7.4/databases/configure/oss-cluster-api.md" >}}), and [rack-zone awareness]({{< relref "/operate/rs/7.4/clusters/configure/rack-zone-awareness.md" >}}). ## Next steps -- [Plan your Active-Active deployment]({{< relref "/operate/rs/databases/active-active/planning.md" >}}) -- [Get started with Active-Active]({{< relref "/operate/rs/databases/active-active/get-started.md" >}}) -- [Create an Active-Active database]({{< relref "/operate/rs/databases/active-active/create.md" >}}) +- [Plan your Active-Active deployment]({{< relref "/operate/rs/7.4/databases/active-active/planning.md" >}}) +- [Get started with Active-Active]({{< relref "/operate/rs/7.4/databases/active-active/get-started.md" >}}) +- [Create an Active-Active database]({{< relref "/operate/rs/7.4/databases/active-active/create.md" >}}) diff --git a/content/operate/rs/7.4/databases/active-active/create.md b/content/operate/rs/7.4/databases/active-active/create.md index fc3dd74363..76bfe2235d 100644 --- a/content/operate/rs/7.4/databases/active-active/create.md +++ b/content/operate/rs/7.4/databases/active-active/create.md @@ -11,11 +11,11 @@ linkTitle: Create weight: 25 url: '/operate/rs/7.4/databases/active-active/create/' --- -[Active-Active geo-replicated databases]({{< relref "/operate/rs/databases/active-active" >}}) (formerly known as CRDBs) give applications write access +[Active-Active geo-replicated databases]({{< relref "/operate/rs/7.4/databases/active-active" >}}) (formerly known as CRDBs) give applications write access to replicas of the dataset in different geographical locations. The participating Redis Enterprise Software clusters that host the instances can be distributed in different geographic locations. -Every instance of an Active-Active database can receive write operations, and all operations are [synchronized]({{< relref "/operate/rs/databases/active-active/develop#example-of-synchronization" >}}) to all instances without conflict. +Every instance of an Active-Active database can receive write operations, and all operations are [synchronized]({{< relref "/operate/rs/7.4/databases/active-active/develop#example-of-synchronization" >}}) to all instances without conflict. ## Steps to create an Active-Active database @@ -30,7 +30,7 @@ Every instance of an Active-Active database can receive write operations, and al - Two or more machines with the same version of Redis Enterprise Software installed - Network connectivity and cluster FQDN name resolution between all participating clusters -- [Network time service]({{< relref "/operate/rs/databases/active-active#network-time-service-ntp-or-chrony" >}}) listener (ntpd) configured and running on each node in all clusters +- [Network time service]({{< relref "/operate/rs/7.4/databases/active-active#network-time-service-ntp-or-chrony" >}}) listener (ntpd) configured and running on each node in all clusters ## Create an Active-Active database @@ -88,14 +88,14 @@ Every instance of an Active-Active database can receive write operations, and al {{Add cluster panel.}} {{}} -If an Active-Active database [runs on flash memory]({{}}), you cannot add participating clusters that run on RAM only. +If an Active-Active database [runs on flash memory]({{}}), you cannot add participating clusters that run on RAM only. {{}} 1. Click **Join cluster** to add the cluster to the list of participating clusters. 1. Enter a **Database name**. -1. If your cluster supports [Auto Tiering]({{< relref "/operate/rs/databases/auto-tiering/" >}}), in **Runs on** you can select **Flash** so that your database uses Flash memory. We recommend that you use AOF every 1 sec for the best performance during the initial Active-Active database sync of a new replica. +1. If your cluster supports [Auto Tiering]({{< relref "/operate/rs/7.4/databases/auto-tiering/" >}}), in **Runs on** you can select **Flash** so that your database uses Flash memory. We recommend that you use AOF every 1 sec for the best performance during the initial Active-Active database sync of a new replica. 1. To configure additional database settings, expand each relevant section to make changes. @@ -120,11 +120,11 @@ If an Active-Active database [runs on flash memory]({{}} -You cannot change the [port number]({{< relref "/operate/rs/networking/port-configurations.md" >}}) +You cannot change the [port number]({{< relref "/operate/rs/7.4/networking/port-configurations.md" >}}) after the database is created. {{< /note >}} -- **Memory limit** - [Database memory limits]({{< relref "/operate/rs/databases/memory-performance/memory-limit.md" >}}) include all database replicas and shards, including replica shards in database replication and database shards in database clustering. +- **Memory limit** - [Database memory limits]({{< relref "/operate/rs/7.4/databases/memory-performance/memory-limit.md" >}}) include all database replicas and shards, including replica shards in database replication and database shards in database clustering. If the total size of the database in the cluster reaches the memory limit, the data eviction policy for the database is enforced. @@ -157,17 +157,17 @@ After you create the Active-Active database, you can set the TLS mode to **Requi ### High availability & durability -- [**Replication**]({{< relref "/operate/rs/databases/durability-ha/replication" >}}) - We recommend that all Active-Active database use replication for best intercluster synchronization performance. +- [**Replication**]({{< relref "/operate/rs/7.4/databases/durability-ha/replication" >}}) - We recommend that all Active-Active database use replication for best intercluster synchronization performance. When replication is enabled, every Active-Active database master shard is replicated to a corresponding replica shard. The replica shards are then used to synchronize data between the instances, and the master shards are dedicated to handling client requests. - We also recommend that you enable [replica HA]({{< relref "/operate/rs/databases/configure/replica-ha" >}}) to ensure that the replica shards are highly-available for this synchronization. + We also recommend that you enable [replica HA]({{< relref "/operate/rs/7.4/databases/configure/replica-ha" >}}) to ensure that the replica shards are highly-available for this synchronization. -- [**Data persistence**]({{< relref "/operate/rs/databases/configure/database-persistence.md" >}}) - To protect against loss of data stored in RAM, you can enable data persistence to store a copy of the data on disk. +- [**Data persistence**]({{< relref "/operate/rs/7.4/databases/configure/database-persistence.md" >}}) - To protect against loss of data stored in RAM, you can enable data persistence to store a copy of the data on disk. Active-Active databases support append-only file (AOF) persistence only. Snapshot persistence is not supported for Active-Active databases. -- **Eviction policy** - The default eviction policy for Active-Active databases is `noeviction`. Redis Enterprise version 6.0.20 and later support all eviction policies for Active-Active databases, unless [Auto Tiering]({{< relref "/operate/rs/databases/auto-tiering" >}}) is enabled. +- **Eviction policy** - The default eviction policy for Active-Active databases is `noeviction`. Redis Enterprise version 6.0.20 and later support all eviction policies for Active-Active databases, unless [Auto Tiering]({{< relref "/operate/rs/7.4/databases/auto-tiering" >}}) is enabled. ### Clustering @@ -175,18 +175,18 @@ After you create the Active-Active database, you can set the TLS mode to **Requi - Make sure the Database clustering is enabled and select the number of shards that you want to have in the database. When database clustering is enabled, - databases are subject to limitations on [Multi-key commands]({{< relref "/operate/rs/databases/durability-ha/clustering.md" >}}). + databases are subject to limitations on [Multi-key commands]({{< relref "/operate/rs/7.4/databases/durability-ha/clustering.md" >}}). You can increase the number of shards in the database at any time. - Clear the **Database clustering** option to use only one shard so that you - can use [Multi-key commands]({{< relref "/operate/rs/databases/durability-ha/clustering.md" >}}) + can use [Multi-key commands]({{< relref "/operate/rs/7.4/databases/durability-ha/clustering.md" >}}) without the limitations. {{}} You cannot enable or turn off database clustering after the Active-Active database is created. {{}} -- [**OSS Cluster API**]({{< relref "/operate/rs/databases/configure/oss-cluster-api.md" >}}) - {{< embed-md "oss-cluster-api-intro.md" >}} +- [**OSS Cluster API**]({{< relref "/operate/rs/7.4/databases/configure/oss-cluster-api.md" >}}) - {{< embed-md "oss-cluster-api-intro.md" >}} ### Access control @@ -198,7 +198,7 @@ You cannot enable or turn off database clustering after the Active-Active databa Creating a database without ACLs enables a *default* user with full access to the database. You can secure default user access by requiring a password. -- **Access Control List** - You can specify the [user roles]({{< relref "/operate/rs/security/access-control/create-db-roles" >}}) that have access to the database and the [Redis ACLs]({{< relref "/operate/rs/security/access-control/redis-acl-overview" >}}) that apply to those connections. +- **Access Control List** - You can specify the [user roles]({{< relref "/operate/rs/7.4/security/access-control/create-db-roles" >}}) that have access to the database and the [Redis ACLs]({{< relref "/operate/rs/7.4/security/access-control/redis-acl-overview" >}}) that apply to those connections. You can only configure access control after the Active-Active database is created. In each participating cluster, add ACLs after database creation. @@ -206,19 +206,19 @@ You cannot enable or turn off database clustering after the Active-Active databa 1. In **Security > Access Control > Access Control List**, select **+ Add ACL**. - 1. Select a [role]({{< relref "/operate/rs/security/access-control/create-db-roles" >}}) to grant database access. + 1. Select a [role]({{< relref "/operate/rs/7.4/security/access-control/create-db-roles" >}}) to grant database access. - 1. Associate a [Redis ACL]({{< relref "/operate/rs/security/access-control/create-db-roles" >}}) with the role and database. + 1. Associate a [Redis ACL]({{< relref "/operate/rs/7.4/security/access-control/create-db-roles" >}}) with the role and database. 1. Select the check mark to add the ACL. ### Causal consistency -[**Causal consistency**]({{< relref "/operate/rs/databases/active-active/causal-consistency" >}}) in an Active-Active database guarantees that the order of operations on a specific key is maintained across all instances of an Active-Active database. +[**Causal consistency**]({{< relref "/operate/rs/7.4/databases/active-active/causal-consistency" >}}) in an Active-Active database guarantees that the order of operations on a specific key is maintained across all instances of an Active-Active database. To enable causal consistency for an existing Active-Active database, use the REST API. ## Test Active-Active database connections -With the Redis database created, you are ready to connect to your database. See [Connect to Active-Active databases]({{< relref "/operate/rs/databases/active-active/connect.md" >}}) for tutorials and examples of multiple connection methods. +With the Redis database created, you are ready to connect to your database. See [Connect to Active-Active databases]({{< relref "/operate/rs/7.4/databases/active-active/connect.md" >}}) for tutorials and examples of multiple connection methods. diff --git a/content/operate/rs/7.4/databases/active-active/delete.md b/content/operate/rs/7.4/databases/active-active/delete.md index cab2dc2a72..e44eca0370 100644 --- a/content/operate/rs/7.4/databases/active-active/delete.md +++ b/content/operate/rs/7.4/databases/active-active/delete.md @@ -25,5 +25,5 @@ and then restore the data to the database from backup. We recommended that you: - Back up your data and test the restore on another database before you delete an Active-Active database. -- Consider [flushing the data]({{< relref "/operate/rs/databases/import-export/flush.md" >}}) from the database +- Consider [flushing the data]({{< relref "/operate/rs/7.4/databases/import-export/flush.md" >}}) from the database so that you can keep the Active-Active database configuration and restore the data to it if necessary. diff --git a/content/operate/rs/7.4/databases/active-active/develop/_index.md b/content/operate/rs/7.4/databases/active-active/develop/_index.md index 733c4f3617..a7069cfe21 100644 --- a/content/operate/rs/7.4/databases/active-active/develop/_index.md +++ b/content/operate/rs/7.4/databases/active-active/develop/_index.md @@ -64,5 +64,5 @@ in between. | t6 | | SET key1 “d” | [Learn more about -synchronization]({{< relref "/operate/rs/databases/active-active" >}}) for -each supported data type and [how to develop]({{< relref "/operate/rs/databases/active-active/develop/develop-for-aa.md" >}}) with them on Redis Enterprise Software. +synchronization]({{< relref "/operate/rs/7.4/databases/active-active" >}}) for +each supported data type and [how to develop]({{< relref "/operate/rs/7.4/databases/active-active/develop/develop-for-aa.md" >}}) with them on Redis Enterprise Software. diff --git a/content/operate/rs/7.4/databases/active-active/develop/develop-for-aa.md b/content/operate/rs/7.4/databases/active-active/develop/develop-for-aa.md index 0e730d69e4..45fc243974 100644 --- a/content/operate/rs/7.4/databases/active-active/develop/develop-for-aa.md +++ b/content/operate/rs/7.4/databases/active-active/develop/develop-for-aa.md @@ -98,8 +98,8 @@ execute them in script-replication mode. ## Eviction -The default policy for Active-Active databases is _noeviction_ mode. Redis Enterprise version 6.0.20 and later support all eviction policies for Active-Active databases, unless [Auto Tiering]({{< relref "/operate/rs/databases/auto-tiering" >}})(previously known as Redis on Flash) is enabled. -For details, see [eviction for Active-Active databases]({{< relref "/operate/rs/databases/memory-performance/eviction-policy#active-active-database-eviction" >}}). +The default policy for Active-Active databases is _noeviction_ mode. Redis Enterprise version 6.0.20 and later support all eviction policies for Active-Active databases, unless [Auto Tiering]({{< relref "/operate/rs/7.4/databases/auto-tiering" >}})(previously known as Redis on Flash) is enabled. +For details, see [eviction for Active-Active databases]({{< relref "/operate/rs/7.4/databases/memory-performance/eviction-policy#active-active-database-eviction" >}}). ## Expiration diff --git a/content/operate/rs/7.4/databases/active-active/get-started.md b/content/operate/rs/7.4/databases/active-active/get-started.md index e1fbcd90ad..2c67f726be 100644 --- a/content/operate/rs/7.4/databases/active-active/get-started.md +++ b/content/operate/rs/7.4/databases/active-active/get-started.md @@ -22,12 +22,12 @@ clusters for test and development environments. Here are the steps: 1. Test connectivity to the Active-Active database. -To run an Active-Active database on installations from the [Redis Enterprise Software download package]({{< relref "/operate/rs/installing-upgrading/quickstarts/redis-enterprise-software-quickstart" >}}), +To run an Active-Active database on installations from the [Redis Enterprise Software download package]({{< relref "/operate/rs/7.4/installing-upgrading/quickstarts/redis-enterprise-software-quickstart" >}}), set up two Redis Enterprise Software installations and continue from Step 2. {{}} This getting started guide is for development or demonstration environments. -For production environments, see [Create an Active-Active geo-replicated database]({{< relref "/operate/rs/databases/active-active/create" >}}) for instructions. +For production environments, see [Create an Active-Active geo-replicated database]({{< relref "/operate/rs/7.4/databases/active-active/create" >}}) for instructions. {{}} ## Run two containers @@ -137,10 +137,10 @@ Each Active-Active instance must have a unique fully-qualified domain name (FQDN 1. In the **Clustering** section, either: - Make sure that **Sharding** is enabled and select the number of shards you want to have in the database. When database clustering is enabled, - databases are subject to limitations on [Multi-key commands]({{< relref "/operate/rs/databases/durability-ha/clustering" >}}). + databases are subject to limitations on [Multi-key commands]({{< relref "/operate/rs/7.4/databases/durability-ha/clustering" >}}). You can increase the number of shards in the database at any time. - - Turn off **Sharding** to use only one shard and avoid [Multi-key command]({{< relref "/operate/rs/databases/durability-ha/clustering" >}}) limitations. + - Turn off **Sharding** to use only one shard and avoid [Multi-key command]({{< relref "/operate/rs/7.4/databases/durability-ha/clustering" >}}) limitations. {{< note >}} You cannot enable or turn off database clustering after the Active-Active database is created. @@ -165,4 +165,4 @@ You cannot enable or turn off database clustering after the Active-Active databa ## Test connection With the Redis database created, you are ready to connect to your -database. See [Connect to Active-Active databases]({{< relref "/operate/rs/databases/active-active/connect" >}}) for tutorials and examples of multiple connection methods. +database. See [Connect to Active-Active databases]({{< relref "/operate/rs/7.4/databases/active-active/connect" >}}) for tutorials and examples of multiple connection methods. diff --git a/content/operate/rs/7.4/databases/active-active/manage.md b/content/operate/rs/7.4/databases/active-active/manage.md index c281b9236c..68abb214d2 100644 --- a/content/operate/rs/7.4/databases/active-active/manage.md +++ b/content/operate/rs/7.4/databases/active-active/manage.md @@ -13,9 +13,9 @@ url: '/operate/rs/7.4/databases/active-active/manage/' You can configure and manage your Active-Active database from either the Cluster Manager UI or the command line. -To change the global configuration of the Active-Active database, use [`crdb-cli`]({{< relref "/operate/rs/references/cli-utilities/crdb-cli" >}}). +To change the global configuration of the Active-Active database, use [`crdb-cli`]({{< relref "/operate/rs/7.4/references/cli-utilities/crdb-cli" >}}). -If you need to apply changes locally to one database instance, you use the Cluster Manager UI or [`rladmin`]({{< relref "/operate/rs/references/cli-utilities/rladmin" >}}). +If you need to apply changes locally to one database instance, you use the Cluster Manager UI or [`rladmin`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin" >}}). ## Database settings @@ -24,7 +24,7 @@ Many Active-Active database settings can be changed after database creation. One ## Participating clusters You can add and remove participating clusters of an Active-Active database to change the topology. -To manage the changes to Active-Active topology, use [`crdb-cli`]({{< relref "/operate/rs/references/cli-utilities/crdb-cli/" >}}) or the participating clusters list in the Cluster Manager UI. +To manage the changes to Active-Active topology, use [`crdb-cli`]({{< relref "/operate/rs/7.4/references/cli-utilities/crdb-cli/" >}}) or the participating clusters list in the Cluster Manager UI. ### Add participating clusters @@ -36,7 +36,7 @@ the new database instance can accept connections and read operations. The new instance does not accept write operations until it is in the syncing state. {{}} -If an Active-Active database [runs on flash memory]({{}}), you cannot add participating clusters that run on RAM only. +If an Active-Active database [runs on flash memory]({{}}), you cannot add participating clusters that run on RAM only. {{}} To add a new participating cluster to an existing Active-Active configuration using the Cluster Manager UI: @@ -81,13 +81,13 @@ To remove a participating cluster using the Cluster Manager UI: ## Replication backlog -Redis databases that use [replication for high availability]({{< relref "/operate/rs/databases/durability-ha/replication.md" >}}) maintain a replication backlog (per shard) to synchronize the primary and replica shards of a database. In addition to the database replication backlog, Active-Active databases maintain a backlog (per shard) to synchronize the database instances between clusters. +Redis databases that use [replication for high availability]({{< relref "/operate/rs/7.4/databases/durability-ha/replication.md" >}}) maintain a replication backlog (per shard) to synchronize the primary and replica shards of a database. In addition to the database replication backlog, Active-Active databases maintain a backlog (per shard) to synchronize the database instances between clusters. By default, both the database and Active-Active replication backlogs are set to one percent (1%) of the database size divided by the number of shards. This can range between 1MB to 250MB per shard for each backlog. ### Change the replication backlog size -Use the [`crdb-cli`]({{< relref "/operate/rs/references/cli-utilities/crdb-cli" >}}) utility to control the size of the replication backlogs. You can set it to `auto` or set a specific size. +Use the [`crdb-cli`]({{< relref "/operate/rs/7.4/references/cli-utilities/crdb-cli" >}}) utility to control the size of the replication backlogs. You can set it to `auto` or set a specific size. Update the database replication backlog configuration with the `crdb-cli` command shown below. diff --git a/content/operate/rs/7.4/databases/active-active/planning.md b/content/operate/rs/7.4/databases/active-active/planning.md index 517d429a91..fb6bfa3112 100644 --- a/content/operate/rs/7.4/databases/active-active/planning.md +++ b/content/operate/rs/7.4/databases/active-active/planning.md @@ -16,21 +16,21 @@ In Redis Enterprise, Active-Active geo-distribution is based on [conflict-free r Because of the complexities of Active-Active databases, there are special considerations to keep in mind while planning your Active-Active database. -See [Active-Active Redis]({{< relref "/operate/rs/databases/active-active/" >}}) for more information about geo-distributed replication. For more info on other high availability features, see [Durability and high availability]({{< relref "/operate/rs/databases/durability-ha/" >}}). +See [Active-Active Redis]({{< relref "/operate/rs/7.4/databases/active-active/" >}}) for more information about geo-distributed replication. For more info on other high availability features, see [Durability and high availability]({{< relref "/operate/rs/7.4/databases/durability-ha/" >}}). ## Participating clusters -You need at least [two participating clusters]({{< relref "/operate/rs/clusters/new-cluster-setup" >}}) for an Active-Active database. If your database requires more than ten participating clusters, contact Redis support. You can [add or remove participating clusters]({{< relref "/operate/rs/databases/active-active/manage#participating-clusters/" >}}) after database creation. +You need at least [two participating clusters]({{< relref "/operate/rs/7.4/clusters/new-cluster-setup" >}}) for an Active-Active database. If your database requires more than ten participating clusters, contact Redis support. You can [add or remove participating clusters]({{< relref "/operate/rs/7.4/databases/active-active/manage#participating-clusters/" >}}) after database creation. {{}} -If an Active-Active database [runs on flash memory]({{}}), you cannot add participating clusters that run on RAM only. +If an Active-Active database [runs on flash memory]({{}}), you cannot add participating clusters that run on RAM only. {{}} Changes made from the Cluster Manager UI to an Active-Active database configuration only apply to the cluster you are editing. For global configuration changes across all clusters, use the `crdb-cli` command-line utility. ## Memory limits -Database memory limits define the maximum size of your database across all database replicas and [shards]({{< relref "/operate/rs/references/terminology.md#redis-instance-shard" >}}) on the cluster. Your memory limit also determines the number of shards. +Database memory limits define the maximum size of your database across all database replicas and [shards]({{< relref "/operate/rs/7.4/references/terminology.md#redis-instance-shard" >}}) on the cluster. Your memory limit also determines the number of shards. Besides your dataset, the memory limit must also account for replication, Active-Active metadata, and module overhead. These features can increase your database size, sometimes increasing it by two times or more. @@ -39,15 +39,15 @@ Factors to consider when sizing your database: - **dataset size**: you want your limit to be above 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 can consume more memory. -- [**database clustering**]({{< relref "/operate/rs/databases/durability-ha/clustering.md" >}}): enables you to spread your data into shards across multiple nodes (scale out). -- [**database replication**]({{< relref "/operate/rs/databases/durability-ha/replication.md" >}}): enabling replication doubles memory consumption -- [**Active-Active replication**]({{< relref "/operate/rs/databases/active-active/_index.md" >}}): enabling Active-Active replication 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/active-active/manage#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.md" >}}) for synchronization between clusters. By default, this is set to 1% of the database size. +- [**database clustering**]({{< relref "/operate/rs/7.4/databases/durability-ha/clustering.md" >}}): enables you to spread your data into shards across multiple nodes (scale out). +- [**database replication**]({{< relref "/operate/rs/7.4/databases/durability-ha/replication.md" >}}): enabling replication doubles memory consumption +- [**Active-Active replication**]({{< relref "/operate/rs/7.4/databases/active-active/_index.md" >}}): enabling Active-Active replication 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/7.4/databases/active-active/manage#replication-backlog/" >}}) for synchronization between shards. By default, this is set to 1% of the database size. +- [**Active-Active replication backlog**]({{< relref "/operate/rs/7.4/databases/active-active/manage.md" >}}) for synchronization between clusters. By default, this is set to 1% of the database size. It's also important to know 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. -For more information on memory limits, see [Memory and performance]({{< relref "/operate/rs/databases/memory-performance/" >}}) or [Database memory limits]({{< relref "/operate/rs/databases/memory-performance/memory-limit.md" >}}). +For more information on memory limits, see [Memory and performance]({{< relref "/operate/rs/7.4/databases/memory-performance/" >}}) or [Database memory limits]({{< relref "/operate/rs/7.4/databases/memory-performance/memory-limit.md" >}}). ## Networking @@ -61,14 +61,14 @@ Networking between the clusters must be configured before creating an Active-Act ### Network ports -Every node must have access to the REST API ports of every other node as well as other ports for proxies, VPNs, and the Cluster Manager UI. See [Network port configurations]({{< relref "/operate/rs/networking/port-configurations.md" >}}) for more details. These ports should be allowed through firewalls that may be positioned between the clusters. +Every node must have access to the REST API ports of every other node as well as other ports for proxies, VPNs, and the Cluster Manager UI. See [Network port configurations]({{< relref "/operate/rs/7.4/networking/port-configurations.md" >}}) for more details. These ports should be allowed through firewalls that may be positioned between the clusters. ### Network Time Service {#network-time-service} Active-Active databases require a time service like NTP or Chrony to make sure the clocks on all cluster nodes are synchronized. This is critical to avoid problems with internal cluster communications that can impact your data integrity. -See [Synchronizing cluster node clocks]({{< relref "/operate/rs/clusters/configure/sync-clocks.md" >}}) for more information. +See [Synchronizing cluster node clocks]({{< relref "/operate/rs/7.4/clusters/configure/sync-clocks.md" >}}) for more information. ## Redis modules {#redis-modules} @@ -81,10 +81,10 @@ Starting with v6.2.18, you can index, query, and perform full-text searches of n Active-Active databases have the following limitations: -- An existing database can't be changed into an Active-Active database. To move data from an existing database to an Active-Active database, you must [create a new Active-Active database]({{< relref "/operate/rs/databases/active-active/create.md" >}}) and [migrate the data]({{< relref "/operate/rs/databases/import-export/migrate-to-active-active.md" >}}). -- [Discovery service]({{< relref "/operate/rs/databases/durability-ha/discovery-service.md" >}}) is not supported with Active-Active databases. Active-Active databases require FQDNs or [mDNS]({{< relref "/operate/rs/networking/mdns.md" >}}). +- An existing database can't be changed into an Active-Active database. To move data from an existing database to an Active-Active database, you must [create a new Active-Active database]({{< relref "/operate/rs/7.4/databases/active-active/create.md" >}}) and [migrate the data]({{< relref "/operate/rs/7.4/databases/import-export/migrate-to-active-active.md" >}}). +- [Discovery service]({{< relref "/operate/rs/7.4/databases/durability-ha/discovery-service.md" >}}) is not supported with Active-Active databases. Active-Active databases require FQDNs or [mDNS]({{< relref "/operate/rs/7.4/networking/mdns.md" >}}). - The `FLUSH` command is not supported from the CLI. To flush your database, use the API or Cluster Manager UI. - The `UNLINK` command is a blocking command for all types of keys. - Cross slot multi commands (such as `MSET`) are not supported with Active-Active databases. - The hashing policy can't be changed after database creation. -- If an Active-Active database [runs on flash memory]({{}}), you cannot add participating clusters that run on RAM only. +- If an Active-Active database [runs on flash memory]({{}}), you cannot add participating clusters that run on RAM only. diff --git a/content/operate/rs/7.4/databases/active-active/syncer.md b/content/operate/rs/7.4/databases/active-active/syncer.md index c4e14a14ac..e6e8679ebb 100644 --- a/content/operate/rs/7.4/databases/active-active/syncer.md +++ b/content/operate/rs/7.4/databases/active-active/syncer.md @@ -31,14 +31,14 @@ When a new primary is appointed, the replication ID changes, but a partial sync In a partial sync, the backlog of operations since the offset are transferred as raw operations. In a full sync, the data from the primary is transferred to the replica as an RDB file which is followed by a partial sync. -Partial synchronization requires a backlog large enough to store the data operations until connection is restored. See [replication backlog]({{< relref "/operate/rs/databases/active-active/manage#replication-backlog" >}}) for more info on changing the replication backlog size. +Partial synchronization requires a backlog large enough to store the data operations until connection is restored. See [replication backlog]({{< relref "/operate/rs/7.4/databases/active-active/manage#replication-backlog" >}}) for more info on changing the replication backlog size. ### Syncer in Active-Active replication In the case of an Active-Active database: - Multiple past replication IDs and offsets are stored to allow for multiple syncs -- The [Active-Active replication backlog]({{< relref "/operate/rs/databases/active-active/manage#replication-backlog" >}}) is also sent to the replica during a full sync. +- The [Active-Active replication backlog]({{< relref "/operate/rs/7.4/databases/active-active/manage#replication-backlog" >}}) is also sent to the replica during a full sync. {{< warning >}} Full sync triggers heavy data transfers between geo-replicated instances of an Active-Active database. diff --git a/content/operate/rs/7.4/databases/active-active/synchronization-mode.md b/content/operate/rs/7.4/databases/active-active/synchronization-mode.md index 98c312972d..70dda2b3d4 100644 --- a/content/operate/rs/7.4/databases/active-active/synchronization-mode.md +++ b/content/operate/rs/7.4/databases/active-active/synchronization-mode.md @@ -11,7 +11,7 @@ linktitle: Distributed synchronization weight: 80 url: '/operate/rs/7.4/databases/active-active/synchronization-mode/' --- -Replicated databases, such as [Replica Of]({{< relref "/operate/rs/databases/import-export/replica-of/" >}}) and [Active-Active]({{< relref "/operate/rs/databases/active-active" >}}) databases, +Replicated databases, such as [Replica Of]({{< relref "/operate/rs/7.4/databases/import-export/replica-of/" >}}) and [Active-Active]({{< relref "/operate/rs/7.4/databases/active-active" >}}) databases, use proxy endpoints to synchronize database changes with the databases on other participating clusters. To improve the throughput and lower the latency for synchronization traffic, @@ -21,7 +21,7 @@ Every database by default has one proxy endpoint that manages client and synchro and that proxy endpoint is used for database synchronization. This is called centralized synchronization. -To prepare a database to use distributed synchronization you must first make sure that the database [proxy policy]({{< relref "/operate/rs/databases/configure/proxy-policy.md" >}}) +To prepare a database to use distributed synchronization you must first make sure that the database [proxy policy]({{< relref "/operate/rs/7.4/databases/configure/proxy-policy.md" >}}) is defined so that either each node has a proxy endpoint or each primary (master) shard has a proxy endpoint. After you have multiple proxies for the database, you can configure the database synchronization to use distributed synchronization. diff --git a/content/operate/rs/7.4/databases/auto-tiering/_index.md b/content/operate/rs/7.4/databases/auto-tiering/_index.md index 31e96e440e..a678d6b7d2 100644 --- a/content/operate/rs/7.4/databases/auto-tiering/_index.md +++ b/content/operate/rs/7.4/databases/auto-tiering/_index.md @@ -111,8 +111,8 @@ On-premises environments support more deployment options than other environments ## Next steps -- [Auto Tiering metrics]({{< relref "/operate/rs/references/metrics/auto-tiering" >}}) -- [Auto Tiering quick start]({{< relref "/operate/rs/databases/auto-tiering/quickstart.md" >}}) +- [Auto Tiering metrics]({{< relref "/operate/rs/7.4/references/metrics/auto-tiering" >}}) +- [Auto Tiering quick start]({{< relref "/operate/rs/7.4/databases/auto-tiering/quickstart.md" >}}) -- [Ephemeral and persistent storage]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage" >}}) -- [Hardware requirements]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/hardware-requirements.md" >}}) +- [Ephemeral and persistent storage]({{< relref "/operate/rs/7.4/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage" >}}) +- [Hardware requirements]({{< relref "/operate/rs/7.4/installing-upgrading/install/plan-deployment/hardware-requirements.md" >}}) diff --git a/content/operate/rs/7.4/databases/auto-tiering/quickstart.md b/content/operate/rs/7.4/databases/auto-tiering/quickstart.md index f625d05492..4b24acd33d 100644 --- a/content/operate/rs/7.4/databases/auto-tiering/quickstart.md +++ b/content/operate/rs/7.4/databases/auto-tiering/quickstart.md @@ -11,9 +11,9 @@ linkTitle: Quick start weight: 80 url: '/operate/rs/7.4/databases/auto-tiering/quickstart/' --- -This page guides you through a quick setup of [Auto Tiering]({{< relref "/operate/rs/databases/auto-tiering/" >}}) with a single node for testing and demo purposes. +This page guides you through a quick setup of [Auto Tiering]({{< relref "/operate/rs/7.4/databases/auto-tiering/" >}}) with a single node for testing and demo purposes. -For production environments, you can find more detailed installation instructions in the [install and setup]({{< relref "/operate/rs/installing-upgrading" >}}) section. +For production environments, you can find more detailed installation instructions in the [install and setup]({{< relref "/operate/rs/7.4/installing-upgrading" >}}) section. The steps to set up a Redis Enterprise Software cluster using Auto Tiering with a single node are: @@ -116,11 +116,11 @@ You now have a database with Auto Tiering enabled! ## Connect to your database -You are ready to connect to your database to store data. See the [test connectivity]({{< relref "/operate/rs/databases/connect/test-client-connectivity.md" >}}) page to learn how to connect to your database. +You are ready to connect to your database to store data. See the [test connectivity]({{< relref "/operate/rs/7.4/databases/connect/test-client-connectivity.md" >}}) page to learn how to connect to your database. ## Next steps If you want to generate load against the -database or add a bunch of data for cluster testing, see the [memtier_benchmark quick start]({{< relref "/operate/rs/clusters/optimize/memtier-benchmark.md" >}}) for help. +database or add a bunch of data for cluster testing, see the [memtier_benchmark quick start]({{< relref "/operate/rs/7.4/clusters/optimize/memtier-benchmark.md" >}}) for help. -To see the true performance and scale of Auto Tiering, you must tune your I/O path and set the flash path to the mounted path of SSD or NVMe flash memory as that is what it is designed to run on. For more information, see [Auto Tiering]({{< relref "/operate/rs/databases/auto-tiering/" >}}). +To see the true performance and scale of Auto Tiering, you must tune your I/O path and set the flash path to the mounted path of SSD or NVMe flash memory as that is what it is designed to run on. For more information, see [Auto Tiering]({{< relref "/operate/rs/7.4/databases/auto-tiering/" >}}). diff --git a/content/operate/rs/7.4/databases/configure/_index.md b/content/operate/rs/7.4/databases/configure/_index.md index 4da3b53579..20a1a0bc4f 100644 --- a/content/operate/rs/7.4/databases/configure/_index.md +++ b/content/operate/rs/7.4/databases/configure/_index.md @@ -19,13 +19,13 @@ You can manage your Redis Enterprise Software databases with several tools: - Command-line tools: - - [`rladmin`]({{< relref "/operate/rs/references/cli-utilities/rladmin" >}}) for standalone database configuration + - [`rladmin`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin" >}}) for standalone database configuration - - [`crdb-cli`]({{< relref "/operate/rs/references/cli-utilities/crdb-cli" >}}) for Active-Active database configuration + - [`crdb-cli`]({{< relref "/operate/rs/7.4/references/cli-utilities/crdb-cli" >}}) for Active-Active database configuration - [`redis-cli`]({{< relref "/develop/tools/cli" >}}) for Redis Community Edition configuration -- [REST API]({{< relref "/operate/rs/references/rest-api/_index.md" >}}) +- [REST API]({{< relref "/operate/rs/7.4/references/rest-api/_index.md" >}}) ## Edit database settings @@ -40,7 +40,7 @@ To edit the configuration of a database using the Cluster Manager UI: 1. Change any [configurable database settings](#config-settings). {{< note >}} -For [Active-Active database instances]({{< relref "/operate/rs/databases/active-active" >}}), most database settings only apply to the instance that you are editing. +For [Active-Active database instances]({{< relref "/operate/rs/7.4/databases/active-active" >}}), most database settings only apply to the instance that you are editing. {{< /note >}} 1. Select **Save**. @@ -62,11 +62,11 @@ For [Active-Active database instances]({{< relref "/operate/rs/databases/active- - **Endpoint port number** - You can define the port number that clients use to connect to the database. Otherwise, a port is randomly selected. {{< note >}} -You cannot change the [port number]({{< relref "/operate/rs/networking/port-configurations.md" >}}) +You cannot change the [port number]({{< relref "/operate/rs/7.4/networking/port-configurations.md" >}}) after the database is created. {{< /note >}} -- **Memory limit** - [Database memory limits]({{< relref "/operate/rs/databases/memory-performance/memory-limit.md" >}}) include all database replicas and shards, including replica shards in database replication and database shards in database clustering. +- **Memory limit** - [Database memory limits]({{< relref "/operate/rs/7.4/databases/memory-performance/memory-limit.md" >}}) include all database replicas and shards, including replica shards in database replication and database shards in database clustering. If the total size of the database in the cluster reaches the memory limit, the data eviction policy for the database is enforced. @@ -93,30 +93,30 @@ You cannot enable them after database creation. ### High availability & durability -- [**Replication**]({{< relref "/operate/rs/databases/durability-ha/replication.md" >}}) - We recommend you use intra-cluster replication to create replica shards for each database for high availability. +- [**Replication**]({{< relref "/operate/rs/7.4/databases/durability-ha/replication.md" >}}) - We recommend you use intra-cluster replication to create replica shards for each database for high availability. - If the cluster is configured to support [rack-zone awareness]({{< relref "/operate/rs/clusters/configure/rack-zone-awareness.md" >}}), you can also enable rack-zone awareness for the database. + If the cluster is configured to support [rack-zone awareness]({{< relref "/operate/rs/7.4/clusters/configure/rack-zone-awareness.md" >}}), you can also enable rack-zone awareness for the database. -- [**Replica high availability**]({{< relref "/operate/rs/databases/configure/replica-ha" >}}) - Automatically migrates replica shards to an available node if a replica node fails or is promoted to primary. +- [**Replica high availability**]({{< relref "/operate/rs/7.4/databases/configure/replica-ha" >}}) - Automatically migrates replica shards to an available node if a replica node fails or is promoted to primary. -- [**Persistence**]({{< relref "/operate/rs/databases/configure/database-persistence.md" >}}) - To protect against loss of data stored in RAM, you can enable data persistence and store a copy of the data on disk with snapshots or an Append Only File. +- [**Persistence**]({{< relref "/operate/rs/7.4/databases/configure/database-persistence.md" >}}) - To protect against loss of data stored in RAM, you can enable data persistence and store a copy of the data on disk with snapshots or an Append Only File. -- [**Data eviction policy**]({{< relref "/operate/rs/databases/memory-performance/eviction-policy.md" >}}) - By default, when the total size of the database reaches its memory limit the database evicts keys according to the least recently used keys out of all keys with an "expire" field set in order to make room for new keys. You can select a different data eviction policy. +- [**Data eviction policy**]({{< relref "/operate/rs/7.4/databases/memory-performance/eviction-policy.md" >}}) - By default, when the total size of the database reaches its memory limit the database evicts keys according to the least recently used keys out of all keys with an "expire" field set in order to make room for new keys. You can select a different data eviction policy. ### Clustering - **Sharding** - You can either: - - Turn on **Sharding** to enable [database clustering]({{< relref "/operate/rs/databases/durability-ha/clustering.md" >}}) and select the number of database shards. + - Turn on **Sharding** to enable [database clustering]({{< relref "/operate/rs/7.4/databases/durability-ha/clustering.md" >}}) and select the number of database shards. - When database clustering is enabled, databases are subject to limitations on [Multi-key commands]({{< relref "/operate/rs/databases/durability-ha/clustering.md" >}}). + When database clustering is enabled, databases are subject to limitations on [Multi-key commands]({{< relref "/operate/rs/7.4/databases/durability-ha/clustering.md" >}}). You can increase the number of shards in the database at any time. - You can accept the [standard hashing policy]({{< relref "/operate/rs/databases/durability-ha/clustering#standard-hashing-policy" >}}), which is compatible with Redis Community Edition, or define a [custom hashing policy]({{< relref "/operate/rs/databases/durability-ha/clustering#custom-hashing-policy" >}}) to define where keys are located in the clustered database. + You can accept the [standard hashing policy]({{< relref "/operate/rs/7.4/databases/durability-ha/clustering#standard-hashing-policy" >}}), which is compatible with Redis Community Edition, or define a [custom hashing policy]({{< relref "/operate/rs/7.4/databases/durability-ha/clustering#custom-hashing-policy" >}}) to define where keys are located in the clustered database. - - Turn off **Sharding** to use only one shard so that you can use [Multi-key commands]({{< relref "/operate/rs/databases/durability-ha/clustering.md" >}}) without the limitations. + - Turn off **Sharding** to use only one shard so that you can use [Multi-key commands]({{< relref "/operate/rs/7.4/databases/durability-ha/clustering.md" >}}) without the limitations. -- [**OSS Cluster API**]({{< relref "/operate/rs/databases/configure/oss-cluster-api.md" >}}) - The OSS Cluster API configuration allows access to multiple endpoints for increased throughput. +- [**OSS Cluster API**]({{< relref "/operate/rs/7.4/databases/configure/oss-cluster-api.md" >}}) - The OSS Cluster API configuration allows access to multiple endpoints for increased throughput. This configuration requires clients to connect to the primary node to retrieve the cluster topology before they can connect directly to proxies on each node. @@ -126,31 +126,31 @@ You cannot enable them after database creation. You must use a client that supports the cluster API to connect to a database that has the cluster API enabled. {{}} -- [**Shards placement**]({{< relref "/operate/rs/databases/memory-performance/shard-placement-policy" >}}) - Determines how to distribute database shards across nodes in the cluster. +- [**Shards placement**]({{< relref "/operate/rs/7.4/databases/memory-performance/shard-placement-policy" >}}) - Determines how to distribute database shards across nodes in the cluster. - _Dense_ places shards on the smallest number of nodes. - _Sparse_ spreads shards across many nodes. -- [**Database proxy**]({{< relref "/operate/rs/databases/configure/proxy-policy" >}}) - Determines the number and location of active proxies, which manage incoming database operation requests. +- [**Database proxy**]({{< relref "/operate/rs/7.4/databases/configure/proxy-policy" >}}) - Determines the number and location of active proxies, which manage incoming database operation requests. ### Replica Of -With [**Replica Of**]({{< relref "/operate/rs/databases/import-export/replica-of/create.md" >}}), you can make the database a repository for keys from other databases. +With [**Replica Of**]({{< relref "/operate/rs/7.4/databases/import-export/replica-of/create.md" >}}), you can make the database a repository for keys from other databases. ### Scheduled backup -You can configure [periodic backups]({{< relref "/operate/rs/databases/import-export/schedule-backups" >}}) of the database, including the interval and backup location parameters. +You can configure [periodic backups]({{< relref "/operate/rs/7.4/databases/import-export/schedule-backups" >}}) of the database, including the interval and backup location parameters. ### Alerts -Select [alerts]({{< relref "/operate/rs/clusters/monitoring#database-alerts" >}}) to show in the database status and configure their thresholds. +Select [alerts]({{< relref "/operate/rs/7.4/clusters/monitoring#database-alerts" >}}) to show in the database status and configure their thresholds. -You can also choose to [send alerts by email]({{< relref "/operate/rs/clusters/monitoring#send-alerts-by-email" >}}) to relevant users. +You can also choose to [send alerts by email]({{< relref "/operate/rs/7.4/clusters/monitoring#send-alerts-by-email" >}}) to relevant users. ### TLS -You can require [**TLS**]({{< relref "/operate/rs/security/encryption/tls/" >}}) encryption and authentication for all communications, TLS encryption and authentication for Replica Of communication only, and TLS authentication for clients. +You can require [**TLS**]({{< relref "/operate/rs/7.4/security/encryption/tls/" >}}) encryption and authentication for all communications, TLS encryption and authentication for Replica Of communication only, and TLS authentication for clients. ### Access control @@ -162,19 +162,19 @@ You can require [**TLS**]({{< relref "/operate/rs/security/encryption/tls/" >}}) Creating a database without ACLs enables a *default* user with full access to the database. You can secure default user access by requiring a password. -- **Access Control List** - You can specify the [user roles]({{< relref "/operate/rs/security/access-control/create-db-roles" >}}) that have access to the database and the [Redis ACLs]({{< relref "/operate/rs/security/access-control/redis-acl-overview" >}}) that apply to those connections. +- **Access Control List** - You can specify the [user roles]({{< relref "/operate/rs/7.4/security/access-control/create-db-roles" >}}) that have access to the database and the [Redis ACLs]({{< relref "/operate/rs/7.4/security/access-control/redis-acl-overview" >}}) that apply to those connections. To define an access control list for a database: 1. In **Security > Access Control > Access Control List**, select **+ Add ACL**. - 1. Select a [role]({{< relref "/operate/rs/security/access-control/create-db-roles" >}}) to grant database access. + 1. Select a [role]({{< relref "/operate/rs/7.4/security/access-control/create-db-roles" >}}) to grant database access. - 1. Associate a [Redis ACL]({{< relref "/operate/rs/security/access-control/create-db-roles" >}}) with the role and database. + 1. Associate a [Redis ACL]({{< relref "/operate/rs/7.4/security/access-control/create-db-roles" >}}) with the role and database. 1. Select the check mark to add the ACL. ### Internode encryption -Enable **Internode encryption** to encrypt data in transit between nodes for this database. See [Internode encryption]({{< relref "/operate/rs/security/encryption/internode-encryption" >}}) for more information. +Enable **Internode encryption** to encrypt data in transit between nodes for this database. See [Internode encryption]({{< relref "/operate/rs/7.4/security/encryption/internode-encryption" >}}) for more information. diff --git a/content/operate/rs/7.4/databases/configure/database-persistence.md b/content/operate/rs/7.4/databases/configure/database-persistence.md index 817714e8bc..fa5f7f0eaf 100644 --- a/content/operate/rs/7.4/databases/configure/database-persistence.md +++ b/content/operate/rs/7.4/databases/configure/database-persistence.md @@ -11,7 +11,7 @@ linktitle: Persistence weight: 30 url: '/operate/rs/7.4/databases/configure/database-persistence/' --- -All data is stored and managed exclusively in either RAM or RAM + flash Memory ([Auto Tiering]({{< relref "/operate/rs/databases/auto-tiering/" >}})) and therefore, is at risk of being lost upon a process or server +All data is stored and managed exclusively in either RAM or RAM + flash Memory ([Auto Tiering]({{< relref "/operate/rs/7.4/databases/auto-tiering/" >}})) and therefore, is at risk of being lost upon a process or server failure. As Redis Enterprise Software is not just a caching solution, but also a full-fledged database, [persistence](https://redis.com/redis-enterprise/technology/durable-redis/) to disk is critical. Therefore, Redis Enterprise Software supports persisting data to disk on a per-database basis and in multiple ways. @@ -20,7 +20,7 @@ database's configuration. While the persistence model can be changed dynamically ## Configure database persistence -You can configure persistence when you [create a database]({{< relref "/operate/rs/databases/create" >}}), or you can edit an existing database's configuration: +You can configure persistence when you [create a database]({{< relref "/operate/rs/7.4/databases/create" >}}), or you can edit an existing database's configuration: 1. From the **Databases** list, select the database, then select **Configuration**. diff --git a/content/operate/rs/7.4/databases/configure/db-defaults.md b/content/operate/rs/7.4/databases/configure/db-defaults.md index 8ec7ecce58..641fea8823 100644 --- a/content/operate/rs/7.4/databases/configure/db-defaults.md +++ b/content/operate/rs/7.4/databases/configure/db-defaults.md @@ -44,9 +44,9 @@ You can choose a predefined endpoint configuration to use the recommended databa ### Database proxy -Redis Enterprise Software uses [proxies]({{< relref "/operate/rs/references/terminology#proxy" >}}) to manage and optimize access to database shards. Each node in the cluster runs a single proxy process, which can be active (receives incoming traffic) or passive (waits for failovers). +Redis Enterprise Software uses [proxies]({{< relref "/operate/rs/7.4/references/terminology#proxy" >}}) to manage and optimize access to database shards. Each node in the cluster runs a single proxy process, which can be active (receives incoming traffic) or passive (waits for failovers). -You can configure default [proxy policies]({{< relref "/operate/rs/databases/configure/proxy-policy" >}}) to determine which nodes' proxies are active and bound to new databases by default. +You can configure default [proxy policies]({{< relref "/operate/rs/7.4/databases/configure/proxy-policy" >}}) to determine which nodes' proxies are active and bound to new databases by default. To configure the default database proxy policy using the Cluster Manager UI: @@ -60,13 +60,13 @@ To configure the default database proxy policy using the Cluster Manager UI: To configure the default proxy policy for non-sharded databases, use one of the following methods: -- [rladmin tune cluster]({{< relref "/operate/rs/references/cli-utilities/rladmin/tune#tune-cluster" >}}): +- [rladmin tune cluster]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/tune#tune-cluster" >}}): ```sh rladmin tune cluster default_non_sharded_proxy_policy { single | all-master-shards | all-nodes } ``` -- [Update cluster policy]({{< relref "/operate/rs/references/rest-api/requests/cluster/policy#put-cluster-policy" >}}) REST API request: +- [Update cluster policy]({{< relref "/operate/rs/7.4/references/rest-api/requests/cluster/policy#put-cluster-policy" >}}) REST API request: ```sh PUT /v1/cluster/policy @@ -77,13 +77,13 @@ To configure the default proxy policy for non-sharded databases, use one of the To configure the default proxy policy for sharded databases, use one of the following methods: -- [rladmin tune cluster]({{< relref "/operate/rs/references/cli-utilities/rladmin/tune#tune-cluster" >}}): +- [rladmin tune cluster]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/tune#tune-cluster" >}}): ```sh rladmin tune cluster default_sharded_proxy_policy { single | all-master-shards | all-nodes } ``` -- [Update cluster policy]({{< relref "/operate/rs/references/rest-api/requests/cluster/policy#put-cluster-policy" >}}) REST API request: +- [Update cluster policy]({{< relref "/operate/rs/7.4/references/rest-api/requests/cluster/policy#put-cluster-policy" >}}) REST API request: ```sh PUT /v1/cluster/policy @@ -92,7 +92,7 @@ To configure the default proxy policy for sharded databases, use one of the foll ### Shards placement -The default [shard placement policy]({{< relref "/operate/rs/databases/memory-performance/shard-placement-policy" >}}) determines the distribution of database shards across nodes in the cluster. +The default [shard placement policy]({{< relref "/operate/rs/7.4/databases/memory-performance/shard-placement-policy" >}}) determines the distribution of database shards across nodes in the cluster. Shard placement policies include: @@ -110,13 +110,13 @@ To configure default shard placement, use one of the following methods: {{The Database defaults panel lets you select Database proxy and Shards placement if Endpoint Configuration is set to Custom.}} -- [rladmin tune cluster]({{< relref "/operate/rs/references/cli-utilities/rladmin/tune#tune-cluster" >}}): +- [rladmin tune cluster]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/tune#tune-cluster" >}}): ```sh rladmin tune cluster default_shards_placement { dense | sparse } ``` -- [Update cluster policy]({{< relref "/operate/rs/references/rest-api/requests/cluster/policy#put-cluster-policy" >}}) REST API request: +- [Update cluster policy]({{< relref "/operate/rs/7.4/references/rest-api/requests/cluster/policy#put-cluster-policy" >}}) REST API request: ```sh PUT /v1/cluster/policy @@ -125,20 +125,20 @@ To configure default shard placement, use one of the following methods: ### Database version -New databases use the default Redis database version unless you select a different **Database version** when you [create a database]({{}}) in the Cluster Manager UI or specify the `redis_version` in a [create database REST API request]({{< relref "/operate/rs/references/rest-api/requests/bdbs" >}}). +New databases use the default Redis database version unless you select a different **Database version** when you [create a database]({{}}) in the Cluster Manager UI or specify the `redis_version` in a [create database REST API request]({{< relref "/operate/rs/7.4/references/rest-api/requests/bdbs" >}}). To configure the Redis database version, use one of the following methods: - Cluster Manager UI: Edit **Database version** in [**Database defaults**](#edit-database-defaults) -- [rladmin tune cluster]({{< relref "/operate/rs/references/cli-utilities/rladmin/tune#tune-cluster" >}}): +- [rladmin tune cluster]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/tune#tune-cluster" >}}): ```sh rladmin tune cluster default_redis_version ``` -- [Update cluster policy]({{< relref "/operate/rs/references/rest-api/requests/cluster/policy#put-cluster-policy" >}}) REST API request: +- [Update cluster policy]({{< relref "/operate/rs/7.4/references/rest-api/requests/cluster/policy#put-cluster-policy" >}}) REST API request: ```sh PUT /v1/cluster/policy @@ -147,19 +147,19 @@ To configure the Redis database version, use one of the following methods: ### Internode encryption -Enable [internode encryption]({{< relref "/operate/rs/security/encryption/internode-encryption" >}}) to encrypt data in transit between nodes for new databases by default. +Enable [internode encryption]({{< relref "/operate/rs/7.4/security/encryption/internode-encryption" >}}) to encrypt data in transit between nodes for new databases by default. To enable or turn off internode encryption by default, use one of the following methods: - Cluster Manager UI: Edit **Internode Encryption** in [**Database defaults**](#edit-database-defaults) -- [rladmin tune cluster]({{< relref "/operate/rs/references/cli-utilities/rladmin/tune#tune-cluster" >}}): +- [rladmin tune cluster]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/tune#tune-cluster" >}}): ```sh rladmin tune cluster data_internode_encryption { enabled | disabled } ``` -- [Update cluster policy]({{< relref "/operate/rs/references/rest-api/requests/cluster/policy#put-cluster-policy" >}}) REST API request: +- [Update cluster policy]({{< relref "/operate/rs/7.4/references/rest-api/requests/cluster/policy#put-cluster-policy" >}}) REST API request: ```sh PUT /v1/cluster/policy diff --git a/content/operate/rs/7.4/databases/configure/db-upgrade.md b/content/operate/rs/7.4/databases/configure/db-upgrade.md index c5e4deb22b..61d9597457 100644 --- a/content/operate/rs/7.4/databases/configure/db-upgrade.md +++ b/content/operate/rs/7.4/databases/configure/db-upgrade.md @@ -34,13 +34,13 @@ To change the number of shards upgraded in parallel during database upgrades, us - Cluster Manager UI – Edit **Database shard parallel upgrade** in [**Upgrade configuration**](#edit-upgrade-configuration) -- [rladmin tune cluster]({{< relref "/operate/rs/references/cli-utilities/rladmin/tune#tune-cluster" >}}): +- [rladmin tune cluster]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/tune#tune-cluster" >}}): ```sh rladmin tune cluster parallel_shards_upgrade { all | } ``` -- [Update cluster policy]({{< relref "/operate/rs/references/rest-api/requests/cluster/policy#put-cluster-policy" >}}) REST API request: +- [Update cluster policy]({{< relref "/operate/rs/7.4/references/rest-api/requests/cluster/policy#put-cluster-policy" >}}) REST API request: ```sh PUT /v1/cluster/policy @@ -55,13 +55,13 @@ To change `resp3_default` to `disabled`, use one of the following methods: - Cluster Manager UI – Edit **RESP3 support** in [**Upgrade configuration**](#edit-upgrade-configuration) -- [rladmin tune cluster]({{< relref "/operate/rs/references/cli-utilities/rladmin/tune#tune-cluster" >}}): +- [rladmin tune cluster]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/tune#tune-cluster" >}}): ```sh rladmin tune cluster resp3_default { enabled | disabled } ``` -- [Update cluster policy]({{< relref "/operate/rs/references/rest-api/requests/cluster/policy#put-cluster-policy" >}}) REST API request: +- [Update cluster policy]({{< relref "/operate/rs/7.4/references/rest-api/requests/cluster/policy#put-cluster-policy" >}}) REST API request: ```sh PUT /v1/cluster/policy diff --git a/content/operate/rs/7.4/databases/configure/oss-cluster-api.md b/content/operate/rs/7.4/databases/configure/oss-cluster-api.md index e437ff93c8..7c8213f32a 100644 --- a/content/operate/rs/7.4/databases/configure/oss-cluster-api.md +++ b/content/operate/rs/7.4/databases/configure/oss-cluster-api.md @@ -13,7 +13,7 @@ aliases: url: '/operate/rs/7.4/databases/configure/oss-cluster-api/' --- -Review [Redis OSS Cluster API]({{< relref "/operate/rs/clusters/optimize/oss-cluster-api" >}}) to determine if you should enable this feature for your database. +Review [Redis OSS Cluster API]({{< relref "/operate/rs/7.4/clusters/optimize/oss-cluster-api" >}}) to determine if you should enable this feature for your database. ## Prerequisites @@ -21,8 +21,8 @@ The Redis OSS Cluster API is supported only when a database meets specific crite The database must: -- Use the standard [hashing policy]({{< relref "/operate/rs/databases/durability-ha/clustering#supported-hashing-policies" >}}). -- Have the [proxy policy]({{< relref "/operate/rs/databases/configure/proxy-policy" >}}) set to either `all-master-shards` or `all-nodes`. +- Use the standard [hashing policy]({{< relref "/operate/rs/7.4/databases/durability-ha/clustering#supported-hashing-policies" >}}). +- Have the [proxy policy]({{< relref "/operate/rs/7.4/databases/configure/proxy-policy" >}}) set to either `all-master-shards` or `all-nodes`. In addition, the database must _not_: @@ -37,7 +37,7 @@ You can use the Cluster Manager UI or the `rladmin` utility to enable OSS Cluste ### Cluster Manager UI -When you use the Cluster Manager UI to enable the OSS Cluster API, it automatically configures the [prerequisites]({{< relref "/operate/rs/databases/configure/oss-cluster-api#prerequisites" >}}). +When you use the Cluster Manager UI to enable the OSS Cluster API, it automatically configures the [prerequisites]({{< relref "/operate/rs/7.4/databases/configure/oss-cluster-api#prerequisites" >}}). To enable the OSS Cluster API for an existing database in the Cluster Manager UI: @@ -55,11 +55,11 @@ You can also use the Cluster Manager UI to enable the setting when creating a ne ### Command line (`rladmin`) -You can use the [`rladmin` utility]({{< relref "/operate/rs/references/cli-utilities/rladmin/" >}}) to enable the OSS Cluster API for Redis Enterprise Software databases, including Replica Of databases. +You can use the [`rladmin` utility]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/" >}}) to enable the OSS Cluster API for Redis Enterprise Software databases, including Replica Of databases. For Active-Active (CRDB) databases, [use the crdb-cli utility](#active-active-databases). -Ensure the [prerequisites]({{< relref "/operate/rs/databases/configure/oss-cluster-api#prerequisites" >}}) have been configured. Then, enable the OSS Cluster API for a Redis database from the command line: +Ensure the [prerequisites]({{< relref "/operate/rs/7.4/databases/configure/oss-cluster-api#prerequisites" >}}) have been configured. Then, enable the OSS Cluster API for a Redis database from the command line: ```sh $ rladmin tune db oss_cluster enabled @@ -76,7 +76,7 @@ The OSS Cluster API setting applies to the specified database only; it does not ### Active-Active databases -Ensure the [prerequisites]({{< relref "/operate/rs/databases/configure/oss-cluster-api#prerequisites" >}}) have been configured. Then, use the `crdb-cli` utility to enable the OSS Cluster API for Active-Active databases: +Ensure the [prerequisites]({{< relref "/operate/rs/7.4/databases/configure/oss-cluster-api#prerequisites" >}}) have been configured. Then, use the `crdb-cli` utility to enable the OSS Cluster API for Active-Active databases: ```sh $ crdb-cli crdb update --crdb-guid --oss-cluster true @@ -141,4 +141,4 @@ To deactivate OSS Cluster API support for a database, either: When you enable the OSS Cluster API for a database, [multi-key commands]({{< relref "/operate/rc/databases/configuration/clustering#multikey-operations" >}}) are only allowed when all keys are mapped to the same slot. -To verify that your database meets this requirement, make sure that the `CLUSTER KEYSLOT` reply is the same for all keys affected by the multi-key command. To learn more, see [multi-key operations]({{< relref "/operate/rs/databases/durability-ha/clustering#multikey-operations" >}}). +To verify that your database meets this requirement, make sure that the `CLUSTER KEYSLOT` reply is the same for all keys affected by the multi-key command. To learn more, see [multi-key operations]({{< relref "/operate/rs/7.4/databases/durability-ha/clustering#multikey-operations" >}}). diff --git a/content/operate/rs/7.4/databases/configure/proxy-policy.md b/content/operate/rs/7.4/databases/configure/proxy-policy.md index 3a20279e6e..33b04aaf93 100644 --- a/content/operate/rs/7.4/databases/configure/proxy-policy.md +++ b/content/operate/rs/7.4/databases/configure/proxy-policy.md @@ -24,7 +24,7 @@ A database can have one of these proxy policies: |------------|-----------------| | Single | There is only a single proxy that is bound to the database. This is the default database configuration and preferable in most use cases. | | All Master Shards | There are multiple proxies that are bound to the database, one on each node that hosts a database master shard. This mode fits most use cases that require multiple proxies. | -| All Nodes | There are multiple proxies that are bound to the database, one on each node in the cluster, regardless of whether or not there is a shard from this database on the node. This mode should be used only in special cases, such as [using a load balancer]({{< relref "/operate/rs/networking/cluster-lba-setup.md" >}}). | +| All Nodes | There are multiple proxies that are bound to the database, one on each node in the cluster, regardless of whether or not there is a shard from this database on the node. This mode should be used only in special cases, such as [using a load balancer]({{< relref "/operate/rs/7.4/networking/cluster-lba-setup.md" >}}). | {{< note >}} Manual intervention is also available via the rladmin bind add and @@ -138,7 +138,7 @@ When the network on a single active proxy becomes the bottleneck, you might also look into enabling the multiple NIC support in RS. With nodes that have multiple physical NICs (Network Interface Cards), you can configure RS to separate internal and external traffic onto -independent physical NICs. For more details, refer to [Manage IP addresses]({{< relref "/operate/rs/networking/multi-ip-ipv6" >}}). +independent physical NICs. For more details, refer to [Manage IP addresses]({{< relref "/operate/rs/7.4/networking/multi-ip-ipv6" >}}). {{< /note >}} Having multiple proxies for a database can improve RS's ability for fast diff --git a/content/operate/rs/7.4/databases/configure/replica-ha.md b/content/operate/rs/7.4/databases/configure/replica-ha.md index 56c2168e67..fc686e9d85 100644 --- a/content/operate/rs/7.4/databases/configure/replica-ha.md +++ b/content/operate/rs/7.4/databases/configure/replica-ha.md @@ -12,7 +12,7 @@ weight: 50 url: '/operate/rs/7.4/databases/configure/replica-ha/' --- -When you enable [database replication]({{< relref "/operate/rs/databases/durability-ha/replication.md" >}}), +When you enable [database replication]({{< relref "/operate/rs/7.4/databases/durability-ha/replication.md" >}}), Redis Enterprise Software creates a replica of each primary (master) shard. The replica shard will always be located on a different node than the primary shard to make your data highly available. If the primary shard fails or if the node hosting the primary shard fails, then the replica is promoted to primary. @@ -26,7 +26,7 @@ the former replica shard which has been promoted to primary and a new replica sh An available node: -1. Meets replica migration requirements, such as [rack-awareness]({{< relref "/operate/rs/clusters/configure/rack-zone-awareness.md" >}}). +1. Meets replica migration requirements, such as [rack-awareness]({{< relref "/operate/rs/7.4/clusters/configure/rack-zone-awareness.md" >}}). 1. Has enough available RAM to store the replica shard. 1. Does not also contain the master shard. @@ -44,7 +44,7 @@ For example: 1. The data from the master shard is replicated to the new replica shard. {{< note >}} -- Replica HA follows all prerequisites of replica migration, such as [rack-awareness]({{< relref "/operate/rs/clusters/configure/rack-zone-awareness.md" >}}). +- Replica HA follows all prerequisites of replica migration, such as [rack-awareness]({{< relref "/operate/rs/7.4/clusters/configure/rack-zone-awareness.md" >}}). - Replica HA migrates as many shards as possible based on available DRAM in the target node. When no DRAM is available, replica HA stops migrating replica shards to that node. {{< /note >}} @@ -77,13 +77,13 @@ The replica HA cluster policy is deprecated as of Redis Enterprise Software vers To enable or turn off replica high availability by default for the entire cluster, use one of the following methods: -- [rladmin tune cluster]({{< relref "/operate/rs/references/cli-utilities/rladmin/tune#tune-cluster" >}}): +- [rladmin tune cluster]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/tune#tune-cluster" >}}): ```sh rladmin tune cluster slave_ha { enabled | disabled } ``` -- [Update cluster policy]({{< relref "/operate/rs/references/rest-api/requests/cluster/policy#put-cluster-policy" >}}) REST API request: +- [Update cluster policy]({{< relref "/operate/rs/7.4/references/rest-api/requests/cluster/policy#put-cluster-policy" >}}) REST API request: ```sh PUT /v1/cluster/policy @@ -151,7 +151,7 @@ database in the cluster until the cooldown period ends. The default is one hour. After a database is migrated with replica HA, it cannot go through another migration due to another node failure until the cooldown period for the database (`slave_ha_bdb_cooldown_period`) ends. The default is two hours. -To configure cooldown periods, use [`rladmin tune cluster`]({{< relref "/operate/rs/references/cli-utilities/rladmin/tune#tune-cluster" >}}): +To configure cooldown periods, use [`rladmin tune cluster`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/tune#tune-cluster" >}}): - For the cluster: diff --git a/content/operate/rs/7.4/databases/configure/shard-placement.md b/content/operate/rs/7.4/databases/configure/shard-placement.md index 6d130267b1..d26a8e5cf8 100644 --- a/content/operate/rs/7.4/databases/configure/shard-placement.md +++ b/content/operate/rs/7.4/databases/configure/shard-placement.md @@ -12,7 +12,7 @@ url: '/operate/rs/7.4/databases/configure/shard-placement/' --- In Redis Enterprise Software , the location of master and replica shards on the cluster nodes can impact the database and node performance. Master shards and their corresponding replica shards are always placed on separate nodes for data resiliency. -The [shard placement policy]({{< relref "/operate/rs/databases/memory-performance/shard-placement-policy.md" >}}) helps to maintain optimal performance and resiliency. +The [shard placement policy]({{< relref "/operate/rs/7.4/databases/memory-performance/shard-placement-policy.md" >}}) helps to maintain optimal performance and resiliency. {{< embed-md "shard-placement-intro.md" >}} diff --git a/content/operate/rs/7.4/databases/connect/_index.md b/content/operate/rs/7.4/databases/connect/_index.md index d471f61efc..1602b955e6 100644 --- a/content/operate/rs/7.4/databases/connect/_index.md +++ b/content/operate/rs/7.4/databases/connect/_index.md @@ -12,24 +12,24 @@ weight: 20 url: '/operate/rs/7.4/databases/connect/' --- -After you [set up a cluster]({{< relref "/operate/rs/clusters/new-cluster-setup" >}}) and [create a Redis database]({{< relref "/operate/rs/databases/create" >}}), you can connect to your database. +After you [set up a cluster]({{< relref "/operate/rs/7.4/clusters/new-cluster-setup" >}}) and [create a Redis database]({{< relref "/operate/rs/7.4/databases/create" >}}), you can connect to your database. To connect to your database, you need the database endpoint, which includes the cluster name (FQDN) and the database port. To view and copy public and private endpoints for a database in the cluster, see the database’s **Configuration > General** section in the Cluster Manager UI. {{View public and private endpoints from the General section of the database's Configuration screen.}} -If you try to connect with the FQDN, and the database does not respond, try connecting with the IP address. If this succeeds, DNS is not properly configured. To set up DNS, see [Configure cluster DNS]({{< relref "/operate/rs/networking/cluster-dns" >}}). +If you try to connect with the FQDN, and the database does not respond, try connecting with the IP address. If this succeeds, DNS is not properly configured. To set up DNS, see [Configure cluster DNS]({{< relref "/operate/rs/7.4/networking/cluster-dns" >}}). -If you want to secure your connection, set up [TLS]({{< relref "/operate/rs/security/encryption/tls/" >}}). +If you want to secure your connection, set up [TLS]({{< relref "/operate/rs/7.4/security/encryption/tls/" >}}). ## Connect to a database Use one of the following connection methods to connect to your database: -- [`redis-cli`]({{< relref "/operate/rs/references/cli-utilities/redis-cli/" >}}) utility +- [`redis-cli`]({{< relref "/operate/rs/7.4/references/cli-utilities/redis-cli/" >}}) utility - [Redis Insight](https://redis.com/redis-enterprise/redis-insight/) - [Redis client]({{< relref "/develop/clients/" >}}) for your preferred programming language -For examples, see [Test client connection]({{< relref "/operate/rs/databases/connect/test-client-connectivity" >}}). +For examples, see [Test client connection]({{< relref "/operate/rs/7.4/databases/connect/test-client-connectivity" >}}). diff --git a/content/operate/rs/7.4/databases/connect/supported-clients-browsers.md b/content/operate/rs/7.4/databases/connect/supported-clients-browsers.md index 2a9a1d3775..52ec92b39d 100644 --- a/content/operate/rs/7.4/databases/connect/supported-clients-browsers.md +++ b/content/operate/rs/7.4/databases/connect/supported-clients-browsers.md @@ -17,17 +17,17 @@ To connect an application to a Redis database hosted by Redis Enterprise Softwar You can also use the `redis-cli` utility to connect to a database from the command line. -For examples of each approach, see the [Redis Enterprise Software quickstart]({{< relref "/operate/rs/installing-upgrading/quickstarts/redis-enterprise-software-quickstart" >}}). +For examples of each approach, see the [Redis Enterprise Software quickstart]({{< relref "/operate/rs/7.4/installing-upgrading/quickstarts/redis-enterprise-software-quickstart" >}}). Note: You cannot use client libraries to configure Redis Enterprise Software. Instead, use: -- The Redis Enterprise Software [Cluster Manager UI]({{< relref "/operate/rs/installing-upgrading/quickstarts/redis-enterprise-software-quickstart" >}}) -- The [REST API]({{< relref "/operate/rs/references/rest-api" >}}) -- Command-line utilities, such as [`rladmin`]({{< relref "/operate/rs/references/cli-utilities/rladmin" >}}) +- The Redis Enterprise Software [Cluster Manager UI]({{< relref "/operate/rs/7.4/installing-upgrading/quickstarts/redis-enterprise-software-quickstart" >}}) +- The [REST API]({{< relref "/operate/rs/7.4/references/rest-api" >}}) +- Command-line utilities, such as [`rladmin`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin" >}}) ### Discovery service -We recommend the following clients when using a [discovery service]({{< relref "/operate/rs/databases/durability-ha/discovery-service.md" >}}) based on the Redis Sentinel API: +We recommend the following clients when using a [discovery service]({{< relref "/operate/rs/7.4/databases/durability-ha/discovery-service.md" >}}) based on the Redis Sentinel API: - [redis-py]({{< relref "/develop/clients/redis-py" >}}) (Python client) - [NRedisStack]({{< relref "/develop/clients/dotnet" >}}) (.NET client) diff --git a/content/operate/rs/7.4/databases/connect/test-client-connectivity.md b/content/operate/rs/7.4/databases/connect/test-client-connectivity.md index 2d29573d08..30d4a25c94 100644 --- a/content/operate/rs/7.4/databases/connect/test-client-connectivity.md +++ b/content/operate/rs/7.4/databases/connect/test-client-connectivity.md @@ -16,7 +16,7 @@ database. To test client connectivity: -1. After you [create a Redis database]({{< relref "/operate/rs/databases/create" >}}), copy the database endpoint, which contains the cluster name (FQDN). +1. After you [create a Redis database]({{< relref "/operate/rs/7.4/databases/create" >}}), copy the database endpoint, which contains the cluster name (FQDN). To view and copy endpoints for a database in the cluster, see the database’s **Configuration > General** section in the Cluster Manager UI: @@ -29,7 +29,7 @@ To test client connectivity: endpoint using the IP address rather than the FQDN. If you succeed, then DNS is not properly configured. For additional details, see - [Configure cluster DNS]({{< relref "/operate/rs/networking/cluster-dns" >}}). + [Configure cluster DNS]({{< relref "/operate/rs/7.4/networking/cluster-dns" >}}). If any issues occur when testing database connections, [contact support](https://redis.com/company/support/). @@ -39,7 +39,7 @@ support](https://redis.com/company/support/). After you create a Redis database, you can connect to your database and store data using one of the following methods: -- [`redis-cli`]({{< relref "/operate/rs/references/cli-utilities/redis-cli" >}}), the built-in command-line tool +- [`redis-cli`]({{< relref "/operate/rs/7.4/references/cli-utilities/redis-cli" >}}), the built-in command-line tool - [Redis Insight](https://redis.com/redis-enterprise/redis-insight/), a free Redis GUI that is available for macOS, Windows, and Linux @@ -57,7 +57,7 @@ OK "123" ``` -For more `redis-cli` connection examples, see the [`redis-cli` reference]({{< relref "/operate/rs/references/cli-utilities/redis-cli" >}}). +For more `redis-cli` connection examples, see the [`redis-cli` reference]({{< relref "/operate/rs/7.4/references/cli-utilities/redis-cli" >}}). ### Connect with Redis Insight @@ -69,7 +69,7 @@ Redis Insight is a free Redis GUI that is available for macOS, Windows, and Linu 1. Enter the host and port in the **Host** and **Port** fields. -1. Select **Use TLS** if [TLS]({{< relref "/operate/rs/security/encryption/tls" >}}) is set up. +1. Select **Use TLS** if [TLS]({{< relref "/operate/rs/7.4/security/encryption/tls" >}}) is set up. 1. Select **Add Redis Database** to connect to the database. diff --git a/content/operate/rs/7.4/databases/connect/troubleshooting-guide.md b/content/operate/rs/7.4/databases/connect/troubleshooting-guide.md index 82a6e41d96..5e67cd1796 100644 --- a/content/operate/rs/7.4/databases/connect/troubleshooting-guide.md +++ b/content/operate/rs/7.4/databases/connect/troubleshooting-guide.md @@ -93,7 +93,7 @@ Verify that time is synchronized with the time server using one of the following #### Review system logs -Review system logs including the syslog or journal for any error messages, warnings, or critical events. See [Logging]({{< relref "/operate/rs/clusters/logging" >}}) for more information. +Review system logs including the syslog or journal for any error messages, warnings, or critical events. See [Logging]({{< relref "/operate/rs/7.4/clusters/logging" >}}) for more information. ## Identify issues caused by security hardening @@ -137,7 +137,7 @@ Review system logs including the syslog or journal for any error messages, warni rlcheck ``` -- Run [`rladmin status issues_only`]({{< relref "/operate/rs/references/cli-utilities/rladmin/status" >}}) and verify that no issues appear: +- Run [`rladmin status issues_only`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/status" >}}) and verify that no issues appear: ```sh $ rladmin status issues_only @@ -155,7 +155,7 @@ Review system logs including the syslog or journal for any error messages, warni ``` -- Run [`rladmin status shards`]({{< relref "/operate/rs/references/cli-utilities/rladmin/status#status-shards" >}}). For each shard, `USED_MEMORY` should be less than 25 GB. +- Run [`rladmin status shards`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/status#status-shards" >}}). For each shard, `USED_MEMORY` should be less than 25 GB. ```sh $ rladmin status shards @@ -164,7 +164,7 @@ Review system logs including the syslog or journal for any error messages, warni db:1 db1 redis:1 node:1 master 0-16383 2.13MB OK ``` -- Run [`rladmin cluster running_actions`]({{< relref "/operate/rs/references/cli-utilities/rladmin/cluster/running_actions" >}}) and confirm that no tasks are currently running (active): +- Run [`rladmin cluster running_actions`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/cluster/running_actions" >}}) and confirm that no tasks are currently running (active): ```sh $ rladmin cluster running_actions @@ -193,7 +193,7 @@ Review system logs including the syslog or journal for any error messages, warni #### Client application issues -1. To identify possible client application issues, test connectivity from the client machine to the database using [`redis-cli`]({{< relref "/operate/rs/references/cli-utilities/redis-cli" >}}): +1. To identify possible client application issues, test connectivity from the client machine to the database using [`redis-cli`]({{< relref "/operate/rs/7.4/references/cli-utilities/redis-cli" >}}): [`INFO`]({{< relref "/commands/info" >}}): @@ -249,7 +249,7 @@ Review system logs including the syslog or journal for any error messages, warni #### Server-side latency -- Make sure the database's used memory does not reach the configured database max memory limit. For more details, see [Database memory limits]({{< relref "/operate/rs/databases/memory-performance/memory-limit" >}}). +- Make sure the database's used memory does not reach the configured database max memory limit. For more details, see [Database memory limits]({{< relref "/operate/rs/7.4/databases/memory-performance/memory-limit" >}}). - Try to correlate the time of the latency with any surge in the following metrics: @@ -261,7 +261,7 @@ Review system logs including the syslog or journal for any error messages, warni - Expired keys -- Run [`SLOWLOG GET`]({{< relref "/commands/slowlog-get" >}}) using [`redis-cli`]({{< relref "/operate/rs/references/cli-utilities/redis-cli" >}}) to identify slow commands such as [`KEYS`]({{< relref "/commands/keys" >}}) or [`HGETALL`]({{< relref "/commands/hgetall" >}}: +- Run [`SLOWLOG GET`]({{< relref "/commands/slowlog-get" >}}) using [`redis-cli`]({{< relref "/operate/rs/7.4/references/cli-utilities/redis-cli" >}}) to identify slow commands such as [`KEYS`]({{< relref "/commands/keys" >}}) or [`HGETALL`]({{< relref "/commands/hgetall" >}}: ```sh redis-cli -h -p -a SLOWLOG GET @@ -283,7 +283,7 @@ Review system logs including the syslog or journal for any error messages, warni - [Diagnosing latency issues]({{< relref "/operate/oss_and_stack/management/optimization/latency" >}}) - - [View Redis slow log]({{< relref "/operate/rs/clusters/logging/redis-slow-log" >}}) + - [View Redis slow log]({{< relref "/operate/rs/7.4/clusters/logging/redis-slow-log" >}}) #### Client-side latency diff --git a/content/operate/rs/7.4/databases/create.md b/content/operate/rs/7.4/databases/create.md index b8d55b1e24..4623dd4711 100644 --- a/content/operate/rs/7.4/databases/create.md +++ b/content/operate/rs/7.4/databases/create.md @@ -26,12 +26,12 @@ To create a new database: 1. If you did not specify a port number for the database, you can find the port number in the **Endpoint** field in the **Databases > Configuration > General** section. -1. [Test client connectivity]({{< relref "/operate/rs/databases/connect/test-client-connectivity" >}}). +1. [Test client connectivity]({{< relref "/operate/rs/7.4/databases/connect/test-client-connectivity" >}}). {{< note >}} For databases with Active-Active replication for geo-distributed locations, -see [Create an Active-Active database]({{< relref "/operate/rs/databases/active-active/create.md" >}}). To create and manage Active-Active databases, use the legacy UI. +see [Create an Active-Active database]({{< relref "/operate/rs/7.4/databases/active-active/create.md" >}}). To create and manage Active-Active databases, use the legacy UI. {{< /note >}} ## Quick database @@ -54,7 +54,7 @@ To quickly create a database and skip additional configuration options during in - Capabilities (previously modules) to enable -1. Optionally select **Full options** to configure [additional settings]({{< relref "/operate/rs/databases/configure#config-settings" >}}). +1. Optionally select **Full options** to configure [additional settings]({{< relref "/operate/rs/7.4/databases/configure#config-settings" >}}). 1. Select **Create**. @@ -76,10 +76,10 @@ To create a new database and configure additional settings: - **Single Region** - - **Active-Active database** - Multiple participating Redis Enterprise clusters can host instances of the same [Active-Active database]({{< relref "/operate/rs/databases/active-active" >}}) in different geographic locations. Every instance can receive write operations, which are synchronized across all instances without conflict. + - **Active-Active database** - Multiple participating Redis Enterprise clusters can host instances of the same [Active-Active database]({{< relref "/operate/rs/7.4/databases/active-active" >}}) in different geographic locations. Every instance can receive write operations, which are synchronized across all instances without conflict. {{}} -For Active-Active databases, see [Create an Active-Active geo-replicated database]({{< relref "/operate/rs/databases/active-active/create" >}}). +For Active-Active databases, see [Create an Active-Active geo-replicated database]({{< relref "/operate/rs/7.4/databases/active-active/create" >}}). {{}} 1. Select a Redis version from the **Database version** list. @@ -96,6 +96,6 @@ For Active-Active databases, see [Create an Active-Active geo-replicated databas 1. To configure additional database settings, expand each relevant section to make changes. - See [Configuration settings]({{< relref "/operate/rs/databases/configure#config-settings" >}}) for more information about each setting. + See [Configuration settings]({{< relref "/operate/rs/7.4/databases/configure#config-settings" >}}) for more information about each setting. 1. Select **Create**. diff --git a/content/operate/rs/7.4/databases/durability-ha/_index.md b/content/operate/rs/7.4/databases/durability-ha/_index.md index 0f074045f7..cb08155be7 100644 --- a/content/operate/rs/7.4/databases/durability-ha/_index.md +++ b/content/operate/rs/7.4/databases/durability-ha/_index.md @@ -16,24 +16,24 @@ Redis Enterprise Software comes with several features that make your data more d ## Replication -When you [replicate your database]({{}}), each database instance (shard) is copied one or more times. Your database will have one primary shard and one or more replica shards. When a primary shard fails, Redis Enterprise automatically promotes a replica shard to primary. +When you [replicate your database]({{}}), each database instance (shard) is copied one or more times. Your database will have one primary shard and one or more replica shards. When a primary shard fails, Redis Enterprise automatically promotes a replica shard to primary. ## Clustering -[Clustering]({{}}) (or sharding) breaks your database into individual instances (shards) and spreads them across several nodes. Clustering lets you add resources to your cluster to scale your database and prevents node failures from causing availability loss. +[Clustering]({{}}) (or sharding) breaks your database into individual instances (shards) and spreads them across several nodes. Clustering lets you add resources to your cluster to scale your database and prevents node failures from causing availability loss. ## Database persistence -[Database persistence]({{}}) gives your database durability against process or server failures by saving data to disk at set intervals. +[Database persistence]({{}}) gives your database durability against process or server failures by saving data to disk at set intervals. ## Active-Active geo-distributed replication -[Active-Active Redis Enterprise databases]({{}}) distribute your replicated data across multiple nodes and availability zones. This increases the durability of your database by reducing the likelihood of data or availability loss. It also reduces data access latency. +[Active-Active Redis Enterprise databases]({{}}) distribute your replicated data across multiple nodes and availability zones. This increases the durability of your database by reducing the likelihood of data or availability loss. It also reduces data access latency. ## Rack-zone awareness -[Rack-zone awareness]({{}}) maps each node in your Redis Enterprise cluster to a physical rack or logical zone. The cluster uses this information to distribute primary shards and their replica shards in different racks or zones. This ensures data availability if a rack or zone fails. +[Rack-zone awareness]({{}}) maps each node in your Redis Enterprise cluster to a physical rack or logical zone. The cluster uses this information to distribute primary shards and their replica shards in different racks or zones. This ensures data availability if a rack or zone fails. ## Discovery service -The [discovery service]({{}}) provides an IP-based connection management service used when connecting to Redis Enterprise Software databases. It lets your application discover which node hosts the database endpoint. The discovery service API complies with the [Redis Sentinel API]({{< relref "/operate/oss_and_stack/management/sentinel" >}}#sentinel-api). +The [discovery service]({{}}) provides an IP-based connection management service used when connecting to Redis Enterprise Software databases. It lets your application discover which node hosts the database endpoint. The discovery service API complies with the [Redis Sentinel API]({{< relref "/operate/oss_and_stack/management/sentinel" >}}#sentinel-api). diff --git a/content/operate/rs/7.4/databases/durability-ha/discovery-service.md b/content/operate/rs/7.4/databases/durability-ha/discovery-service.md index 63b065064e..a894bdb9ab 100644 --- a/content/operate/rs/7.4/databases/durability-ha/discovery-service.md +++ b/content/operate/rs/7.4/databases/durability-ha/discovery-service.md @@ -31,7 +31,7 @@ connecting to databases. The Discovery Service is available for querying on each node of the cluster, listening on port 8001. To employ it, your application utilizes a [Redis Sentinel enabled client -library]({{< relref "/operate/rs/databases/connect/supported-clients-browsers.md" >}}) +library]({{< relref "/operate/rs/7.4/databases/connect/supported-clients-browsers.md" >}}) to connect to the Discovery Service and request the endpoint for the given database. The Discovery Service replies with the database's endpoint for that database. In case of a node failure, the Discovery @@ -95,7 +95,7 @@ To use Redis Sentinel, every database name must be unique across the cluster. ## Redis client support -We recommend these clients that are tested for use with the [Discovery Service]({{< relref "/operate/rs/databases/durability-ha/discovery-service.md" >}}) that uses the Redis Sentinel API: +We recommend these clients that are tested for use with the [Discovery Service]({{< relref "/operate/rs/7.4/databases/durability-ha/discovery-service.md" >}}) that uses the Redis Sentinel API: {{< embed-md "discovery-clients.md" >}} diff --git a/content/operate/rs/7.4/databases/durability-ha/replication.md b/content/operate/rs/7.4/databases/durability-ha/replication.md index 79e867ecab..493a3ef1a2 100644 --- a/content/operate/rs/7.4/databases/durability-ha/replication.md +++ b/content/operate/rs/7.4/databases/durability-ha/replication.md @@ -22,13 +22,13 @@ guarantees that data is served with minimal interruption. You can tune your high availability configuration with: - [Rack/Zone -Awareness]({{< relref "/operate/rs/clusters/configure/rack-zone-awareness.md" >}}) - When rack-zone awareness is used additional logic ensures that master and replica shards never share the same rack, thus ensuring availability even under loss of an entire rack. -- [High Availability for Replica Shards]({{< relref "/operate/rs/databases/configure/replica-ha.md" >}}) - When high availability +Awareness]({{< relref "/operate/rs/7.4/clusters/configure/rack-zone-awareness.md" >}}) - When rack-zone awareness is used additional logic ensures that master and replica shards never share the same rack, thus ensuring availability even under loss of an entire rack. +- [High Availability for Replica Shards]({{< relref "/operate/rs/7.4/databases/configure/replica-ha.md" >}}) - When high availability for replica shards is used, the replica shard is automatically migrated on node failover to maintain high availability. {{< warning >}} Enabling replication has implications for the total database size, -as explained in [Database memory limits]({{< relref "/operate/rs/databases/memory-performance/memory-limit.md" >}}). +as explained in [Database memory limits]({{< relref "/operate/rs/7.4/databases/memory-performance/memory-limit.md" >}}). {{< /warning >}} ## Auto Tiering replication considerations @@ -61,9 +61,9 @@ only one primary and one replica can be part of a full sync replication process. ## Database replication backlog -Redis databases that use [replication for high availability]({{< relref "/operate/rs/databases/durability-ha/replication.md" >}}) maintain a replication backlog (per shard) to synchronize the primary and replica shards of a database. +Redis databases that use [replication for high availability]({{< relref "/operate/rs/7.4/databases/durability-ha/replication.md" >}}) maintain a replication backlog (per shard) to synchronize the primary and replica shards of a database. By default, the replication backlog is set to one percent (1%) of the database size divided by the database number of shards and ranges between 1MB to 250MB per shard. -Use the [`rladmin`]({{< relref "/operate/rs/references/cli-utilities/rladmin" >}}) and the [`crdb-cli`]({{< relref "/operate/rs/references/cli-utilities/crdb-cli" >}}) utilities to control the size of the replication backlog. You can set it to `auto` or set a specific size. +Use the [`rladmin`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin" >}}) and the [`crdb-cli`]({{< relref "/operate/rs/7.4/references/cli-utilities/crdb-cli" >}}) utilities to control the size of the replication backlog. You can set it to `auto` or set a specific size. The syntax varies between regular and Active-Active databases. @@ -81,7 +81,7 @@ crdb-cli crdb update --crdb-guid --default-db-config "{\"repl_backlo In addition to the database replication backlog, Active-Active databases maintain a backlog (per shard) to synchronize the database instances between clusters. By default, the Active-Active replication backlog is set to one percent (1%) of the database size divided by the database number of shards, and ranges between 1MB to 250MB per shard. -Use the [`crdb-cli`]({{< relref "/operate/rs/references/cli-utilities/crdb-cli" >}}) utility to control the size of the CRDT replication backlog. You can set it to `auto` or set a specific size: +Use the [`crdb-cli`]({{< relref "/operate/rs/7.4/references/cli-utilities/crdb-cli" >}}) utility to control the size of the CRDT replication backlog. You can set it to `auto` or set a specific size: ```text crdb-cli crdb update --crdb-guid --default-db-config "{\"crdt_repl_backlog_size\": }" @@ -89,7 +89,7 @@ crdb-cli crdb update --crdb-guid --default-db-config "{\"crdt_repl_b **For Redis Software versions earlier than 6.0.20:** The replication backlog and the CRDT replication backlog defaults are set to 1MB and cannot be set dynamically with 'auto' mode. -To control the size of the replication log, use [`rladmin`]({{< relref "/operate/rs/references/cli-utilities/rladmin" >}}) to tune the local database instance in each cluster. +To control the size of the replication log, use [`rladmin`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin" >}}) to tune the local database instance in each cluster. ```text rladmin tune db repl_backlog ``` diff --git a/content/operate/rs/7.4/databases/import-export/export-data.md b/content/operate/rs/7.4/databases/import-export/export-data.md index dfad691e2f..8c469b3451 100644 --- a/content/operate/rs/7.4/databases/import-export/export-data.md +++ b/content/operate/rs/7.4/databases/import-export/export-data.md @@ -51,7 +51,7 @@ To export data from a database using the Cluster Manager UI: Data can be exported to a local mount point, transferred to [a URI](https://en.wikipedia.org/wiki/Uniform_Resource_Identifier) using FTP/SFTP, or stored on cloud provider storage. -When saved to a local mount point or a cloud provider, export locations need to be available to [the group and user]({{< relref "/operate/rs/installing-upgrading/install/customize-user-and-group.md" >}}) running Redis Enterprise Software, `redislabs:redislabs` by default. +When saved to a local mount point or a cloud provider, export locations need to be available to [the group and user]({{< relref "/operate/rs/7.4/installing-upgrading/install/customize-user-and-group.md" >}}) running Redis Enterprise Software, `redislabs:redislabs` by default. Redis Enterprise Software needs the ability to view permissions and update objects in the storage location. Implementation details vary according to the provider and your configuration. To learn more, consult the provider's documentation. @@ -161,7 +161,7 @@ To export data to an [Amazon Web Services](https://aws.amazon.com/) (AWS) Simple - In the **Secret access key** field, enter the secret access key. -You can also connect to a storage service that uses the S3 protocol but is not hosted by Amazon AWS. The storage service must have a valid SSL certificate. To connect to an S3-compatible storage location, run [`rladmin cluster config`]({{}}): +You can also connect to a storage service that uses the S3 protocol but is not hosted by Amazon AWS. The storage service must have a valid SSL certificate. To connect to an S3-compatible storage location, run [`rladmin cluster config`]({{}}): ```sh rladmin cluster config s3_url diff --git a/content/operate/rs/7.4/databases/import-export/flush.md b/content/operate/rs/7.4/databases/import-export/flush.md index a19f2d4559..cd0c77528d 100644 --- a/content/operate/rs/7.4/databases/import-export/flush.md +++ b/content/operate/rs/7.4/databases/import-export/flush.md @@ -19,7 +19,7 @@ You can use the Cluster Manager UI to flush data from Active-Active databases. {{< warning title="Data Loss Warning" >}} The flush command deletes ALL in-memory and persistence data in the database. -We recommend that you [back up your database]({{< relref "/operate/rs/databases/import-export/schedule-backups.md" >}}) before you flush the data. +We recommend that you [back up your database]({{< relref "/operate/rs/7.4/databases/import-export/schedule-backups.md" >}}) before you flush the data. {{< /warning >}} ## Flush data from a database @@ -39,7 +39,7 @@ redis-cli -h redis-12345.cluster.local -p 9443 -a xyz flushall ``` {{< note >}} -Port 9443 is the default [port configuration]({{< relref "/operate/rs/networking/port-configurations#https://docs.redis.com/latest/rs/networking/port-configurations#ports-and-port-ranges-used-by-redis-enterprise-software" >}}). +Port 9443 is the default [port configuration]({{< relref "/operate/rs/7.4/networking/port-configurations#https://docs.redis.com/latest/rs/networking/port-configurations#ports-and-port-ranges-used-by-redis-enterprise-software" >}}). {{< /note >}} @@ -108,13 +108,13 @@ To flush data from an Active-Active database: - REST API - 1. To find the ID of the Active-Active database, use [`GET /v1/crdbs`]({{< relref "/operate/rs/references/rest-api/requests/crdbs#get-all-crdbs" >}}): + 1. To find the ID of the Active-Active database, use [`GET /v1/crdbs`]({{< relref "/operate/rs/7.4/references/rest-api/requests/crdbs#get-all-crdbs" >}}): ```sh GET https://[host][:port]/v1/crdbs ``` - 1. To flush the Active-Active database, use [`PUT /v1/crdbs/{guid}/flush`]({{< relref "/operate/rs/references/rest-api/requests/crdbs/flush#put-crdbs-flush" >}}): + 1. To flush the Active-Active database, use [`PUT /v1/crdbs/{guid}/flush`]({{< relref "/operate/rs/7.4/references/rest-api/requests/crdbs/flush#put-crdbs-flush" >}}): ```sh PUT https://[host][:port]/v1/crdbs//flush @@ -122,7 +122,7 @@ To flush data from an Active-Active database: The command output contains the task ID of the flush task. - 1. To check the status of the flush task, use [`GET /v1/crdb_tasks`]({{< relref "/operate/rs/references/rest-api/requests/crdb_tasks#get-crdb_task" >}}): + 1. To check the status of the flush task, use [`GET /v1/crdb_tasks`]({{< relref "/operate/rs/7.4/references/rest-api/requests/crdb_tasks#get-crdb_task" >}}): ```sh GET https://[host][:port]/v1/crdb_tasks/ diff --git a/content/operate/rs/7.4/databases/import-export/import-data.md b/content/operate/rs/7.4/databases/import-export/import-data.md index f7b9fc12b0..a3a5759128 100644 --- a/content/operate/rs/7.4/databases/import-export/import-data.md +++ b/content/operate/rs/7.4/databases/import-export/import-data.md @@ -12,8 +12,8 @@ linktitle: Import data weight: 10 url: '/operate/rs/7.4/databases/import-export/import-data/' --- -You can import, [export]({{< relref "/operate/rs/databases/import-export/export-data" >}}), -or [backup]({{< relref "/operate/rs/databases/import-export/schedule-backups" >}}) +You can import, [export]({{< relref "/operate/rs/7.4/databases/import-export/export-data" >}}), +or [backup]({{< relref "/operate/rs/7.4/databases/import-export/schedule-backups" >}}) files of a specific Redis Enterprise Software database to restore data. You can either import from a single file or from multiple files, such as when you want to import from a backup of a clustered database. @@ -38,7 +38,7 @@ To import data into a database using the Cluster Manager UI: Data can be imported from a local mount point, transferred to [a URI](https://en.wikipedia.org/wiki/Uniform_Resource_Identifier) using FTP/SFTP, or stored on cloud provider storage. -When importing from a local mount point or a cloud provider, import locations need to be available to [the group and user]({{< relref "/operate/rs/installing-upgrading/install/customize-user-and-group.md" >}}) running Redis Enterprise Software, `redislabs:redislabs` by default. +When importing from a local mount point or a cloud provider, import locations need to be available to [the group and user]({{< relref "/operate/rs/7.4/installing-upgrading/install/customize-user-and-group.md" >}}) running Redis Enterprise Software, `redislabs:redislabs` by default. Redis Enterprise Software needs the ability to view objects in the storage location. Implementation details vary according to the provider and your configuration. To learn more, consult the provider's documentation. @@ -156,7 +156,7 @@ In the Redis Enterprise Software Cluster Manager UI, when you enter the export l - In the **Secret access key** field, enter the secret access key. -You can also connect to a storage service that uses the S3 protocol but is not hosted by Amazon AWS. The storage service must have a valid SSL certificate. To connect to an S3-compatible storage location, run [`rladmin cluster config`]({{}}): +You can also connect to a storage service that uses the S3 protocol but is not hosted by Amazon AWS. The storage service must have a valid SSL certificate. To connect to an S3-compatible storage location, run [`rladmin cluster config`]({{}}): ```sh rladmin cluster config s3_url @@ -213,7 +213,7 @@ In the Redis Enterprise Software Cluster Manager UI, when you enter the import l When importing data into an Active-Active database, there are two options: -- [Flush all data]({{< relref "/operate/rs/databases/import-export/flush#flush-data-from-an-active-active-database" >}}) from the Active-Active database, then import the data into the database. +- [Flush all data]({{< relref "/operate/rs/7.4/databases/import-export/flush#flush-data-from-an-active-active-database" >}}) from the Active-Active database, then import the data into the database. - Import data but merge it into the existing database. Because Active-Active databases have a numeric counter data type, diff --git a/content/operate/rs/7.4/databases/import-export/migrate-to-active-active.md b/content/operate/rs/7.4/databases/import-export/migrate-to-active-active.md index 0b40aa1c7f..65e4e53910 100644 --- a/content/operate/rs/7.4/databases/import-export/migrate-to-active-active.md +++ b/content/operate/rs/7.4/databases/import-export/migrate-to-active-active.md @@ -11,8 +11,8 @@ weight: $weight url: '/operate/rs/7.4/databases/import-export/migrate-to-active-active/' --- -If you have data in a single-region Redis Enterprise Software database that you want to migrate to an [Active-Active database]({{< relref "/operate/rs/databases/active-active" >}}), -you'll need to create a new Active-Active database and migrate the data into the new database as a [Replica Of]({{< relref "/operate/rs/databases/import-export/replica-of/" >}}) the existing database. +If you have data in a single-region Redis Enterprise Software database that you want to migrate to an [Active-Active database]({{< relref "/operate/rs/7.4/databases/active-active" >}}), +you'll need to create a new Active-Active database and migrate the data into the new database as a [Replica Of]({{< relref "/operate/rs/7.4/databases/import-export/replica-of/" >}}) the existing database. This process will gradually populate the data in the Active-Active database. Before data migration starts, all data is flushed from the Active-Active database. @@ -27,7 +27,7 @@ When data migration is finished, turn off migration and connect your application - During the migration, any applications that connect to the Active-Active database must be **read-only** to ensure the dataset is identical to the source database during the migration process. However, you can continue to write to the source database during the migration process. - If you used the mDNS protocol for the cluster name (FQDN), -the [client mDNS prerequisites]({{< relref "/operate/rs/networking/mdns" >}}) must be met in order to communicate with other clusters. +the [client mDNS prerequisites]({{< relref "/operate/rs/7.4/networking/mdns" >}}) must be met in order to communicate with other clusters. ## Migrate from a Redis Enterprise cluster @@ -37,7 +37,7 @@ You can migrate a Redis Enterprise database from the [same cluster](#migrate-fro To migrate a database to Active-Active in the same Redis Enterprise cluster: -1. Create a new Active-Active database. For prerequisites and detailed instructions, see [Create an Active-Active geo-replicated database]({{< relref "/operate/rs/databases/active-active/create" >}}). +1. Create a new Active-Active database. For prerequisites and detailed instructions, see [Create an Active-Active geo-replicated database]({{< relref "/operate/rs/7.4/databases/active-active/create" >}}). 1. After the Active-Active database is active, click **Edit** on the **Configuration** screen. @@ -61,7 +61,7 @@ To migrate a database to Active-Active in the same Redis Enterprise cluster: {{< note >}} For a source database on a different Redis Enterprise Software cluster, -you can [compress the replication data]({{< relref "/operate/rs/databases/import-export/replica-of#data-compression-for-replica-of" >}}) to save bandwidth. +you can [compress the replication data]({{< relref "/operate/rs/7.4/databases/import-export/replica-of#data-compression-for-replica-of" >}}) to save bandwidth. {{< /note >}} To migrate a database to Active-Active in different Redis Enterprise clusters: @@ -82,7 +82,7 @@ To migrate a database to Active-Active in different Redis Enterprise clusters: 1. Sign in to the Cluster Manager UI of the destination database’s cluster. -1. Create a new Active-Active database. For prerequisites and detailed instructions, see [Create an Active-Active geo-replicated database]({{< relref "/operate/rs/databases/active-active/create" >}}). +1. Create a new Active-Active database. For prerequisites and detailed instructions, see [Create an Active-Active geo-replicated database]({{< relref "/operate/rs/7.4/databases/active-active/create" >}}). 1. After the Active-Active database is active, click **Edit** on the **Configuration** screen. @@ -106,7 +106,7 @@ To migrate a database to Active-Active in different Redis Enterprise clusters: To migrate a Redis Community Edition database to Active-Active: -1. Create a new Active-Active database. For prerequisites and detailed instructions, see [Create an Active-Active geo-replicated database]({{< relref "/operate/rs/databases/active-active/create" >}}). +1. Create a new Active-Active database. For prerequisites and detailed instructions, see [Create an Active-Active geo-replicated database]({{< relref "/operate/rs/7.4/databases/active-active/create" >}}). 1. After the Active-Active database is active, click **Edit** on the **Configuration** screen. diff --git a/content/operate/rs/7.4/databases/import-export/replica-of/_index.md b/content/operate/rs/7.4/databases/import-export/replica-of/_index.md index bfc2b26f35..51a8d571aa 100644 --- a/content/operate/rs/7.4/databases/import-export/replica-of/_index.md +++ b/content/operate/rs/7.4/databases/import-export/replica-of/_index.md @@ -21,9 +21,9 @@ all write commands are synchronized from the sources to the destination. Replica Of lets you distribute the read load of your application across multiple databases or synchronize the database, either within Redis Enterprise or external to Redis Enterprise, to another database. -You can [create Active-Passive]({{< relref "/operate/rs/databases/import-export/replica-of/create.md" >}}) databases on Redis Enterprise Software or Redis Cloud. +You can [create Active-Passive]({{< relref "/operate/rs/7.4/databases/import-export/replica-of/create.md" >}}) databases on Redis Enterprise Software or Redis Cloud. -[Active-Active Geo-Distribution (CRDB)]({{< relref "/operate/rs/databases/active-active" >}}) +[Active-Active Geo-Distribution (CRDB)]({{< relref "/operate/rs/7.4/databases/active-active" >}}) provides these benefits and also provides write access to all of the database replicas. {{< warning >}} @@ -48,7 +48,7 @@ destination database. {{< note >}} The Replica Of feature should not be confused with the in-memory [Database -replication]({{< relref "/operate/rs/databases/durability-ha/replication.md" >}}) +replication]({{< relref "/operate/rs/7.4/databases/durability-ha/replication.md" >}}) feature, which is used for creating a master / replica configuration that enables ensuring database high-availability. {{< /note >}} @@ -103,7 +103,7 @@ of the statuses of all the sources. {{< note >}} If you encounter issues with the Replica Of process, refer to the troubleshooting section [Replica Of repeatedly -fails]({{< relref "/operate/rs/databases/import-export/replica-of/replicaof-repeatedly-fails.md" >}}). +fails]({{< relref "/operate/rs/7.4/databases/import-export/replica-of/replicaof-repeatedly-fails.md" >}}). {{< /note >}} ### Synchronization errors @@ -208,9 +208,9 @@ This avoids a full sync that can overwrite your data. ## Active-Passive replication backlog -In addition to the [database replication backlog]({{< relref "/operate/rs/databases/durability-ha/replication#database-replication-backlog" >}}), active-passive databases maintain a replication backlog (per shard) to synchronize the database instances between clusters. +In addition to the [database replication backlog]({{< relref "/operate/rs/7.4/databases/durability-ha/replication#database-replication-backlog" >}}), active-passive databases maintain a replication backlog (per shard) to synchronize the database instances between clusters. By default, the replication backlog is set to one percent (1%) of the database size divided by the database number of shards and ranges between 1MB to 250MB per shard. -Use the [`rladmin`]({{< relref "/operate/rs/references/cli-utilities/rladmin" >}}) utility to control the size of the replication backlog. You can set it to `auto` or set a specific size. +Use the [`rladmin`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin" >}}) utility to control the size of the replication backlog. You can set it to `auto` or set a specific size. For an Active-Passive database: ```text diff --git a/content/operate/rs/7.4/databases/import-export/replica-of/create.md b/content/operate/rs/7.4/databases/import-export/replica-of/create.md index 870b7e015b..a6ee40443e 100644 --- a/content/operate/rs/7.4/databases/import-export/replica-of/create.md +++ b/content/operate/rs/7.4/databases/import-export/replica-of/create.md @@ -42,17 +42,17 @@ You can configure a database as a Replica Of, where the source database is in on The order of the multiple Replica Of sources has no material impact on replication. -For best results when using the [Multicast DNS](https://en.wikipedia.org/wiki/Multicast_DNS) (mDNS) protocol to resolve the fully-qualified domain name (FQDN) of the cluster, verify that your client connections meet the [client mDNS prerequisites]({{< relref "/operate/rs/networking/mdns.md" >}}). +For best results when using the [Multicast DNS](https://en.wikipedia.org/wiki/Multicast_DNS) (mDNS) protocol to resolve the fully-qualified domain name (FQDN) of the cluster, verify that your client connections meet the [client mDNS prerequisites]({{< relref "/operate/rs/7.4/networking/mdns.md" >}}). {{< note >}} -As long as Replica Of is enabled, data in the target database will not expire and will not be evicted regardless of the set [data eviction policy]({{< relref "/operate/rs/databases/memory-performance/eviction-policy.md" >}}). +As long as Replica Of is enabled, data in the target database will not expire and will not be evicted regardless of the set [data eviction policy]({{< relref "/operate/rs/7.4/databases/memory-performance/eviction-policy.md" >}}). {{< /note >}} ### Same Redis Enterprise cluster {#same-cluster} To configure a Replica Of database in the same Redis Enterprise cluster as the source database: -1. [Create a new database]({{< relref "/operate/rs/databases/create" >}}) or select an existing database from the **Databases** screen. +1. [Create a new database]({{< relref "/operate/rs/7.4/databases/create" >}}) or select an existing database from the **Databases** screen. 1. For an existing database, select **Edit** from the **Configuration** tab. @@ -88,7 +88,7 @@ To configure a Replica Of database in a different Redis Enterprise cluster from 1. Sign in to the Cluster Manager UI of the destination database's cluster. -1. [Create a new database]({{< relref "/operate/rs/databases/create" >}}) or select an existing database from the **Databases** screen. +1. [Create a new database]({{< relref "/operate/rs/7.4/databases/create" >}}) or select an existing database from the **Databases** screen. 1. For an existing database, select **Edit** from the **Configuration** tab. @@ -104,13 +104,13 @@ To configure a Replica Of database in a different Redis Enterprise cluster from 1. Select **Save**. -For source databases on different clusters, you can [compress replication data]({{< relref "/operate/rs/databases/import-export/replica-of/#data-compression-for-replica-of" >}}) to save bandwidth. +For source databases on different clusters, you can [compress replication data]({{< relref "/operate/rs/7.4/databases/import-export/replica-of/#data-compression-for-replica-of" >}}) to save bandwidth. ### Redis Community Edition cluster {#source-available-cluster} To use a database from a Redis Community Edition cluster as a Replica Of source: -1. [Create a new database]({{< relref "/operate/rs/databases/create" >}}) or select an existing database from the **Databases** screen. +1. [Create a new database]({{< relref "/operate/rs/7.4/databases/create" >}}) or select an existing database from the **Databases** screen. 1. For an existing database, select **Edit** from the **Configuration** tab. diff --git a/content/operate/rs/7.4/databases/import-export/schedule-backups.md b/content/operate/rs/7.4/databases/import-export/schedule-backups.md index dd3b3bb455..f5de35e3e6 100644 --- a/content/operate/rs/7.4/databases/import-export/schedule-backups.md +++ b/content/operate/rs/7.4/databases/import-export/schedule-backups.md @@ -15,7 +15,7 @@ Periodic backups provide a way to restore data with minimal data loss. With Red As of v6.2.8, you can specify the start time in UTC for 24-hour or 12-hour backups. -To make an on-demand backup, [export your data]({{< relref "/operate/rs/databases/import-export/export-data.md" >}}). +To make an on-demand backup, [export your data]({{< relref "/operate/rs/7.4/databases/import-export/export-data.md" >}}). You can schedule backups to a variety of locations, including: @@ -26,7 +26,7 @@ You can schedule backups to a variety of locations, including: - Azure Blob Storage - Google Cloud Storage -The backup process creates compressed (.gz) RDB files that you can [import into a database]({{< relref "/operate/rs/databases/import-export/import-data.md" >}}). +The backup process creates compressed (.gz) RDB files that you can [import into a database]({{< relref "/operate/rs/7.4/databases/import-export/import-data.md" >}}). When you back up a database configured for database clustering, Redis Enterprise Software creates a backup file for each shard in the configuration. All backup files are copied to the storage location. @@ -36,7 +36,7 @@ Redis Enterprise Software creates a backup file for each shard in the configurat - Make sure that you have enough space available in your storage location. If there is not enough space in the backup location, the backup fails. - The backup configuration only applies to the database it is configured on. -- To limit the parallel backup for shards, set both [`tune cluster max_simultaneous_backups`]({{< relref "/operate/rs/references/cli-utilities/rladmin/tune#tune-cluster" >}}) and [`tune node max_redis_forks`]({{< relref "/operate/rs/references/cli-utilities/rladmin/tune#tune-node" >}}). `max_simultaneous_backups` is set to 4 by default. +- To limit the parallel backup for shards, set both [`tune cluster max_simultaneous_backups`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/tune#tune-cluster" >}}) and [`tune node max_redis_forks`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/tune#tune-node" >}}). `max_simultaneous_backups` is set to 4 by default. {{< /note >}} @@ -104,7 +104,7 @@ For help with specific backup issues, [contact support](https://redis.com/compan Database backups can be saved to a local mount point, transferred to [a URI](https://en.wikipedia.org/wiki/Uniform_Resource_Identifier) using FTP/SFTP, or stored on cloud provider storage. -When saved to a local mount point or a cloud provider, backup locations need to be available to [the group and user]({{< relref "/operate/rs/installing-upgrading/install/customize-user-and-group.md" >}}) running Redis Enterprise Software, `redislabs:redislabs` by default. +When saved to a local mount point or a cloud provider, backup locations need to be available to [the group and user]({{< relref "/operate/rs/7.4/installing-upgrading/install/customize-user-and-group.md" >}}) running Redis Enterprise Software, `redislabs:redislabs` by default. Redis Enterprise Software needs the ability to view permissions and update objects in the storage location. Implementation details vary according to the provider and your configuration. To learn more, consult the provider's documentation. @@ -210,7 +210,7 @@ To store backups in an Amazon Web Services (AWS) Simple Storage Service (S3) [bu - In the **Secret Access Key** field, enter the secret access key. -You can also connect to a storage service that uses the S3 protocol but is not hosted by Amazon AWS. The storage service must have a valid SSL certificate. To connect to an S3-compatible storage location, run [`rladmin cluster config`]({{}}): +You can also connect to a storage service that uses the S3 protocol but is not hosted by Amazon AWS. The storage service must have a valid SSL certificate. To connect to an S3-compatible storage location, run [`rladmin cluster config`]({{}}): ```sh rladmin cluster config s3_url diff --git a/content/operate/rs/7.4/databases/memory-performance/_index.md b/content/operate/rs/7.4/databases/memory-performance/_index.md index 99cac1da90..2472c06175 100644 --- a/content/operate/rs/7.4/databases/memory-performance/_index.md +++ b/content/operate/rs/7.4/databases/memory-performance/_index.md @@ -21,7 +21,7 @@ Database memory limits define the maximum size your database can reach across al Besides your dataset, the memory limit must also account for replication, Active-Active overhead, and module overhead, and a number of other factors. These can significantly increase your database size, sometimes increasing it by four times or more. -For more information on memory limits, see [Database memory limits]({{< relref "/operate/rs/databases/memory-performance/memory-limit.md" >}}). +For more information on memory limits, see [Database memory limits]({{< relref "/operate/rs/7.4/databases/memory-performance/memory-limit.md" >}}). ## Eviction policies @@ -29,7 +29,7 @@ When a database exceeds its memory limit, eviction policies determine which data The default eviction policy for databases is `volatile-lru` which evicts the least recently used keys out of all keys with the `expire` field set. The default for Active-Active databases is `noeviction`. -For more information, see [eviction policies]({{< relref "/operate/rs/databases/memory-performance/eviction-policy.md" >}}). +For more information, see [eviction policies]({{< relref "/operate/rs/7.4/databases/memory-performance/eviction-policy.md" >}}). ## Database persistence @@ -41,13 +41,13 @@ Append-only files (AoF) keep a record of data changes and writes each change to Snapshots capture all the data as it exists in one moment in time and writes it to disk, allowing you to recover the entire dataset as it existed at that moment in time. -For more info on data persistence see [Database persistence with Redis Enterprise Software]({{< relref "/operate/rs/databases/configure/database-persistence.md" >}}) or [Durable Redis](https://redis.com/redis-enterprise/technology/durable-redis/). +For more info on data persistence see [Database persistence with Redis Enterprise Software]({{< relref "/operate/rs/7.4/databases/configure/database-persistence.md" >}}) or [Durable Redis](https://redis.com/redis-enterprise/technology/durable-redis/). ## Auto Tiering -By default, Redis Enterprise Software stores your data entirely in [RAM](https://en.wikipedia.org/wiki/Random-access_memory) for improved performance. The [Auto Tiering]({{< relref "/operate/rs/databases/auto-tiering/" >}}) feature enables your data to span both RAM and [SSD](https://en.wikipedia.org/wiki/Solid-state_drive) storage ([flash memory](https://en.wikipedia.org/wiki/Flash_memory)). Keys are always stored in RAM, but Auto Tiering manages the location of their values. Frequently used (hot) values are stored on RAM, but infrequently used (warm) values are moved to flash memory. This saves on expensive RAM space, which give you comparable performance at a lower cost for large datasets. +By default, Redis Enterprise Software stores your data entirely in [RAM](https://en.wikipedia.org/wiki/Random-access_memory) for improved performance. The [Auto Tiering]({{< relref "/operate/rs/7.4/databases/auto-tiering/" >}}) feature enables your data to span both RAM and [SSD](https://en.wikipedia.org/wiki/Solid-state_drive) storage ([flash memory](https://en.wikipedia.org/wiki/Flash_memory)). Keys are always stored in RAM, but Auto Tiering manages the location of their values. Frequently used (hot) values are stored on RAM, but infrequently used (warm) values are moved to flash memory. This saves on expensive RAM space, which give you comparable performance at a lower cost for large datasets. -For more info, see [Auto Tiering]({{< relref "/operate/rs/databases/auto-tiering/" >}}). +For more info, see [Auto Tiering]({{< relref "/operate/rs/7.4/databases/auto-tiering/" >}}). ## Shard placement @@ -60,7 +60,7 @@ Redis Enterprise Software has two shard placement policies available: - **dense**: puts as many shards as possible on the smallest number of nodes - **sparse**: spread the shards across as many nodes as possible -For more info about the shard placement policy, see [Shard placement policy]({{< relref "/operate/rs/databases/memory-performance/shard-placement-policy.md" >}}) +For more info about the shard placement policy, see [Shard placement policy]({{< relref "/operate/rs/7.4/databases/memory-performance/shard-placement-policy.md" >}}) ## Metrics @@ -68,7 +68,7 @@ From the Redis Enterprise Software Cluster Manager UI, you can monitor the perfo With the Redis Enterprise Software API, you can also integrate Redis Enterprise metrics into other monitoring environments, such as Prometheus. -For more info about monitoring with Redis Enterprise Software, see [Monitoring with metrics and alerts]({{< relref "/operate/rs/clusters/monitoring/_index.md" >}}), and [Memory statistics]({{< relref "/operate/rs/databases/memory-performance/memory-limit#memory-metrics" >}}). +For more info about monitoring with Redis Enterprise Software, see [Monitoring with metrics and alerts]({{< relref "/operate/rs/7.4/clusters/monitoring/_index.md" >}}), and [Memory statistics]({{< relref "/operate/rs/7.4/databases/memory-performance/memory-limit#memory-metrics" >}}). ## Scaling databases diff --git a/content/operate/rs/7.4/databases/memory-performance/eviction-policy.md b/content/operate/rs/7.4/databases/memory-performance/eviction-policy.md index 7219a08b80..d2d1b431e2 100644 --- a/content/operate/rs/7.4/databases/memory-performance/eviction-policy.md +++ b/content/operate/rs/7.4/databases/memory-performance/eviction-policy.md @@ -34,7 +34,7 @@ To prevent this from happening, make sure your database is large enough to hold `volatile-lru` is the default eviction policy for most databases. -The default policy for [Active-Active databases]({{< relref "/operate/rs/databases/active-active" >}}) is _noeviction_ policy. +The default policy for [Active-Active databases]({{< relref "/operate/rs/7.4/databases/active-active" >}}) is _noeviction_ policy. ## Active-Active database eviction @@ -53,7 +53,7 @@ Data eviction policies are not supported for Active-Active databases with Auto T To avoid data eviction, make sure your database is large enough to hold required values. -For larger databases, consider using [Auto Tiering ]({{< relref "/operate/rs/databases/auto-tiering/" >}}). +For larger databases, consider using [Auto Tiering ]({{< relref "/operate/rs/7.4/databases/auto-tiering/" >}}). Auto Tiering stores actively-used data (also known as _hot data_) in RAM and the remaining data in flash memory (SSD). This lets you retain more data while ensuring the fastest access to the most critical data. diff --git a/content/operate/rs/7.4/databases/memory-performance/memory-limit.md b/content/operate/rs/7.4/databases/memory-performance/memory-limit.md index 72b7da4e17..8667191c2b 100644 --- a/content/operate/rs/7.4/databases/memory-performance/memory-limit.md +++ b/content/operate/rs/7.4/databases/memory-performance/memory-limit.md @@ -27,14 +27,14 @@ Factors to consider when sizing your database: - **dataset size**: you want your limit to be above 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.md" >}}): enables you to spread your data into shards across multiple nodes. -- [**database replication**]({{< relref "/operate/rs/databases/durability-ha/replication.md" >}}): enabling replication doubles memory consumption. +- [**database clustering**]({{< relref "/operate/rs/7.4/databases/durability-ha/clustering.md" >}}): enables you to spread your data into shards across multiple nodes. +- [**database replication**]({{< relref "/operate/rs/7.4/databases/durability-ha/replication.md" >}}): enabling replication doubles memory consumption. Additional factors for Active-Active databases: -- [**Active-Active replication**]({{< relref "/operate/rs/databases/active-active/_index.md" >}}): enabling Active-Active replication 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/active-active/manage#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.md" >}}) for synchronization between clusters. By default, this is set to 1% of the database size. +- [**Active-Active replication**]({{< relref "/operate/rs/7.4/databases/active-active/_index.md" >}}): enabling Active-Active replication 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/7.4/databases/active-active/manage#replication-backlog/" >}}) for synchronization between shards. By default, this is set to 1% of the database size. +- [**Active-Active replication backlog**]({{< relref "/operate/rs/7.4/databases/active-active/manage.md" >}}) for synchronization between clusters. By default, this is set to 1% of the database size. It's also important to know 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. @@ -42,7 +42,7 @@ Additional factors for databases with Auto Tiering enabled: - The available flash space must be greater than or equal to the total database size (RAM+Flash). The extra space accounts for write buffers and [write amplification](https://en.wikipedia.org/wiki/Write_amplification). -- [**database persistence**]({{< relref "/operate/rs/databases/configure/database-persistence.md" >}}): 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**]({{< relref "/operate/rs/7.4/databases/configure/database-persistence.md" >}}): 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. ## What happens when Redis Enterprise Software is low on RAM? @@ -50,9 +50,9 @@ Redis Enterprise Software manages node memory so that data is entirely in RAM ( Redis Enterprise Software protects the existing data and prevents the database from being able to store data into the shards. -You can configure the cluster to move the data to another node, or even discard it according to the [eviction policy]({{< relref "/operate/rs/databases/memory-performance/eviction-policy.md" >}}) set on each database by the administrator. +You can configure the cluster to move the data to another node, or even discard it according to the [eviction policy]({{< relref "/operate/rs/7.4/databases/memory-performance/eviction-policy.md" >}}) set on each database by the administrator. -[Auto Tiering]({{< relref "/operate/rs/databases/auto-tiering/" >}}) +[Auto Tiering]({{< relref "/operate/rs/7.4/databases/auto-tiering/" >}}) manages memory so that you can also use flash memory (SSD) to store data. ### Order of events for low RAM @@ -65,7 +65,7 @@ out of memory (OOM) messages. 4. If shards can't free memory, Redis Enterprise relies on the OS processes to stop replicas, but tries to avoid stopping primary shards. -We recommend that you have a [monitoring platform]({{< relref "/operate/rs/clusters/monitoring/" >}}) that alerts you before a system gets low on RAM. +We recommend that you have a [monitoring platform]({{< relref "/operate/rs/7.4/clusters/monitoring/" >}}) that alerts you before a system gets low on RAM. You must maintain sufficient free memory to make sure that you have a healthy Redis Enterprise installation. ## Memory metrics @@ -78,13 +78,13 @@ The Cluster Manager UI provides metrics that can help you evaluate your memory u - Memory usage - Memory limit -See [console metrics]({{< relref "/operate/rs/references/metrics" >}}) for more detailed information. +See [console metrics]({{< relref "/operate/rs/7.4/references/metrics" >}}) for more detailed information. ## Related info -- [Memory and performance]({{< relref "/operate/rs/databases/memory-performance" >}}) -- [Disk sizing for heavy write scenarios]({{< relref "/operate/rs/clusters/optimize/disk-sizing-heavy-write-scenarios.md" >}}) -- [Turn off services to free system memory]({{< relref "/operate/rs/clusters/optimize/turn-off-services.md" >}}) -- [Eviction policy]({{< relref "/operate/rs/databases/memory-performance/eviction-policy.md" >}}) -- [Shard placement policy]({{< relref "/operate/rs/databases/memory-performance/shard-placement-policy.md" >}}) -- [Database persistence]({{< relref "/operate/rs/databases/configure/database-persistence.md" >}}) +- [Memory and performance]({{< relref "/operate/rs/7.4/databases/memory-performance" >}}) +- [Disk sizing for heavy write scenarios]({{< relref "/operate/rs/7.4/clusters/optimize/disk-sizing-heavy-write-scenarios.md" >}}) +- [Turn off services to free system memory]({{< relref "/operate/rs/7.4/clusters/optimize/turn-off-services.md" >}}) +- [Eviction policy]({{< relref "/operate/rs/7.4/databases/memory-performance/eviction-policy.md" >}}) +- [Shard placement policy]({{< relref "/operate/rs/7.4/databases/memory-performance/shard-placement-policy.md" >}}) +- [Database persistence]({{< relref "/operate/rs/7.4/databases/configure/database-persistence.md" >}}) diff --git a/content/operate/rs/7.4/databases/memory-performance/shard-placement-policy.md b/content/operate/rs/7.4/databases/memory-performance/shard-placement-policy.md index 1b5266c03e..6fd4b4a743 100644 --- a/content/operate/rs/7.4/databases/memory-performance/shard-placement-policy.md +++ b/content/operate/rs/7.4/databases/memory-performance/shard-placement-policy.md @@ -52,4 +52,4 @@ For Redis on RAM databases with OSS cluster API enabled and for databases with A ## Related articles -You can [configure the shard placement policy]({{< relref "/operate/rs/databases/configure/shard-placement.md" >}}) for each database. +You can [configure the shard placement policy]({{< relref "/operate/rs/7.4/databases/configure/shard-placement.md" >}}) for each database. diff --git a/content/operate/rs/7.4/databases/migrate-shards.md b/content/operate/rs/7.4/databases/migrate-shards.md index 720da06332..60bb8aa111 100644 --- a/content/operate/rs/7.4/databases/migrate-shards.md +++ b/content/operate/rs/7.4/databases/migrate-shards.md @@ -13,7 +13,7 @@ weight: 32 url: '/operate/rs/7.4/databases/migrate-shards/' --- -To migrate database shards to other nodes in the cluster, you can use the [`rladmin migrate`]({{}}) command or [REST API requests]({{}}). +To migrate database shards to other nodes in the cluster, you can use the [`rladmin migrate`]({{}}) command or [REST API requests]({{}}). ## Use cases for shard migration @@ -43,15 +43,15 @@ If too many primary shards are placed on the same node, it can impact database p To migrate a specific database shard, use one of the following methods: -- [`rladmin migrate shard`]({{}}): +- [`rladmin migrate shard`]({{}}): ```sh rladmin migrate shard target_node ``` -- [Migrate shard]({{}}) REST API request: +- [Migrate shard]({{}}) REST API request: - Specify the ID of the shard to migrate in the request path and the destination node's ID as the `target_node_uid` in the request body. See the [request reference]({{}}) for more options. + Specify the ID of the shard to migrate in the request path and the destination node's ID as the `target_node_uid` in the request body. See the [request reference]({{}}) for more options. ```sh POST /v1/shards//actions/migrate @@ -69,21 +69,21 @@ To migrate a specific database shard, use one of the following methods: } ``` - You can track the action's progress with a [`GET /v1/actions/`]({{}}) request. + You can track the action's progress with a [`GET /v1/actions/`]({{}}) request. ## Migrate multiple shards To migrate multiple database shards, use one of the following methods: -- [`rladmin migrate shard`]({{}}): +- [`rladmin migrate shard`]({{}}): ```sh rladmin migrate shard target_node ``` -- [Migrate multiple shards]({{}}) REST API request: +- [Migrate multiple shards]({{}}) REST API request: - Specify the IDs of the shards to migrate in the `shard_uids` list and the destination node's ID as the `target_node_uid` in the request body. See the [request reference]({{}}) for more options. + Specify the IDs of the shards to migrate in the `shard_uids` list and the destination node's ID as the `target_node_uid` in the request body. See the [request reference]({{}}) for more options. ```sh POST /v1/shards/actions/migrate @@ -102,11 +102,11 @@ To migrate multiple database shards, use one of the following methods: } ``` - You can track the action's progress with a [`GET /v1/actions/`]({{}}) request. + You can track the action's progress with a [`GET /v1/actions/`]({{}}) request. ## Migrate all shards from a node -To migrate all shards from a specific node to another node, run [`rladmin migrate all_shards`]({{}}): +To migrate all shards from a specific node to another node, run [`rladmin migrate all_shards`]({{}}): ```sh rladmin migrate node all_shards target_node @@ -114,7 +114,7 @@ rladmin migrate node all_shards target_node ## Migrate primary shards -You can use the [`rladmin migrate all_master_shards`]({{}}) command to migrate all primary shards for a specific database or node to another node in the cluster. +You can use the [`rladmin migrate all_master_shards`]({{}}) command to migrate all primary shards for a specific database or node to another node in the cluster. To migrate a specific database's primary shards: @@ -130,7 +130,7 @@ rladmin migrate node all_master_shards target_node ## Migrate replica shards -You can use the [`rladmin migrate all_slave_shards`]({{}}) command to migrate all replica shards for a specific database or node to another node in the cluster. +You can use the [`rladmin migrate all_slave_shards`]({{}}) command to migrate all replica shards for a specific database or node to another node in the cluster. To migrate a specific database's replica shards: diff --git a/content/operate/rs/7.4/databases/recover.md b/content/operate/rs/7.4/databases/recover.md index e91487494b..241f9e6cf4 100644 --- a/content/operate/rs/7.4/databases/recover.md +++ b/content/operate/rs/7.4/databases/recover.md @@ -13,16 +13,16 @@ url: '/operate/rs/7.4/databases/recover/' --- When a cluster fails or a database is corrupted, you must: -1. [Restore the cluster configuration]({{< relref "/operate/rs/clusters/cluster-recovery.md" >}}) from the CCS files +1. [Restore the cluster configuration]({{< relref "/operate/rs/7.4/clusters/cluster-recovery.md" >}}) from the CCS files 1. Recover the databases with their previous configuration and data To restore data to databases in the new cluster, you must restore the database persistence files (backup, AOF, or snapshot files) to the databases. -These files are stored in the [persistence storage location]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage" >}}). +These files are stored in the [persistence storage location]({{< relref "/operate/rs/7.4/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage" >}}). The database recovery process includes: -1. If the cluster failed, [recover the cluster]({{< relref "/operate/rs/clusters/cluster-recovery.md" >}}). +1. If the cluster failed, [recover the cluster]({{< relref "/operate/rs/7.4/clusters/cluster-recovery.md" >}}). 1. Identify recoverable databases. 1. Restore the database data. 1. Verify that the databases are active. @@ -31,7 +31,7 @@ The database recovery process includes: - Before you start database recovery, make sure that the cluster that hosts the database is healthy. In the case of a cluster failure, - you must [recover the cluster]({{< relref "/operate/rs/clusters/cluster-recovery.md" >}}) before you recover the databases. + you must [recover the cluster]({{< relref "/operate/rs/7.4/clusters/cluster-recovery.md" >}}) before you recover the databases. - We recommend that you allocate new persistent storage drives for the new cluster nodes. If you use the original storage drives, @@ -40,7 +40,7 @@ The database recovery process includes: ## Recover databases After you prepare the cluster that hosts the database, -you can run the recovery process from the [`rladmin`]({{< relref "/operate/rs/references/cli-utilities/rladmin" >}}) +you can run the recovery process from the [`rladmin`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin" >}}) command-line interface (CLI). To recover the database: @@ -71,7 +71,7 @@ of the configuration and persistence files on each of the nodes. If you cannot resolve the issues, contact [Redis support](https://redis.com/company/support/). -1. Recover the database using one of the following [`rladmin recover`]({{< relref "/operate/rs/references/cli-utilities/rladmin/recover" >}}) commands: +1. Recover the database using one of the following [`rladmin recover`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/recover" >}}) commands: - Recover all databases from the persistence files located in the persistent storage drives: @@ -122,7 +122,7 @@ After the databases are recovered, make sure your Redis clients can successfully If you enable the automatic recovery cluster policy, Redis Enterprise tries to quickly recover as much data as possible from before the disaster. -To enable automatic recovery, [update the cluster policy]({{< relref "/operate/rs/references/rest-api/requests/cluster/policy#put-cluster-policy" >}}) using the REST API: +To enable automatic recovery, [update the cluster policy]({{< relref "/operate/rs/7.4/references/rest-api/requests/cluster/policy#put-cluster-policy" >}}) using the REST API: ```sh PUT /v1/cluster/policy @@ -144,4 +144,4 @@ PUT /v1/bdbs/ } ``` -You can also set `recovery_wait_time` when you [create a database]({{< relref "/operate/rs/references/rest-api/requests/bdbs#post-bdbs-v1" >}}) using the REST API. +You can also set `recovery_wait_time` when you [create a database]({{< relref "/operate/rs/7.4/references/rest-api/requests/bdbs#post-bdbs-v1" >}}) using the REST API. diff --git a/content/operate/rs/7.4/installing-upgrading/_index.md b/content/operate/rs/7.4/installing-upgrading/_index.md index b956bb1acc..39cd4d02b8 100644 --- a/content/operate/rs/7.4/installing-upgrading/_index.md +++ b/content/operate/rs/7.4/installing-upgrading/_index.md @@ -21,19 +21,19 @@ If you prefer a fully managed Redis database-as-a-service, available on major pu If you want to try out Redis Enterprise Software, see the following quickstarts: -- [Redis Enterprise Software quickstart]({{< relref "/operate/rs/installing-upgrading/quickstarts/redis-enterprise-software-quickstart" >}}) +- [Redis Enterprise Software quickstart]({{< relref "/operate/rs/7.4/installing-upgrading/quickstarts/redis-enterprise-software-quickstart" >}}) -- [Docker quickstart for Redis Enterprise Software]({{< relref "/operate/rs/installing-upgrading/quickstarts/docker-quickstart" >}}) +- [Docker quickstart for Redis Enterprise Software]({{< relref "/operate/rs/7.4/installing-upgrading/quickstarts/docker-quickstart" >}}) ## Install Redis Enterprise Software -To install Redis Enterprise Software on a [supported platform]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/supported-platforms" >}}), you need to: +To install Redis Enterprise Software on a [supported platform]({{< relref "/operate/rs/7.4/installing-upgrading/install/plan-deployment/supported-platforms" >}}), you need to: -1. [Plan your deployment]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment" >}}). +1. [Plan your deployment]({{< relref "/operate/rs/7.4/installing-upgrading/install/plan-deployment" >}}). -1. [Prepare to install]({{< relref "/operate/rs/installing-upgrading/install/prepare-install" >}}). +1. [Prepare to install]({{< relref "/operate/rs/7.4/installing-upgrading/install/prepare-install" >}}). -1. [Perform the install]({{< relref "/operate/rs/installing-upgrading/install" >}}). +1. [Perform the install]({{< relref "/operate/rs/7.4/installing-upgrading/install" >}}). Depending on your needs, you may also want to [customize the installation](#more-info-and-options). @@ -41,34 +41,34 @@ Depending on your needs, you may also want to [customize the installation](#more If you already installed Redis Enterprise Software, you can: -- [Upgrade a cluster]({{< relref "/operate/rs/installing-upgrading/upgrading/upgrade-cluster" >}}) +- [Upgrade a cluster]({{< relref "/operate/rs/7.4/installing-upgrading/upgrading/upgrade-cluster" >}}) -- [Upgrade a database]({{< relref "/operate/rs/installing-upgrading/upgrading/upgrade-database" >}}) +- [Upgrade a database]({{< relref "/operate/rs/7.4/installing-upgrading/upgrading/upgrade-database" >}}) -- [Upgrade an Active-Active database]({{< relref "/operate/rs/installing-upgrading/upgrading/upgrade-active-active" >}}) +- [Upgrade an Active-Active database]({{< relref "/operate/rs/7.4/installing-upgrading/upgrading/upgrade-active-active" >}}) ## Uninstall Redis Enterprise Software -- [Uninstall existing deployment]({{< relref "/operate/rs/installing-upgrading/uninstalling" >}}) +- [Uninstall existing deployment]({{< relref "/operate/rs/7.4/installing-upgrading/uninstalling" >}}) ## 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]({{< relref "/operate/rs/7.4/installing-upgrading/configuring/centos-rhel-firewall.md" >}}) +- [Change socket file location]({{< relref "/operate/rs/7.4/installing-upgrading/configuring/change-location-socket-files.md" >}}) +- [Cluster DNS configuration]({{< relref "/operate/rs/7.4/networking/cluster-dns.md" >}}) +- [Cluster load balancer setup]({{< relref "/operate/rs/7.4/networking/cluster-lba-setup.md" >}}) +- [File locations]({{< relref "/operate/rs/7.4/installing-upgrading/install/plan-deployment/file-locations.md" >}}) +- [Linux swap space configuration]({{< relref "/operate/rs/7.4/installing-upgrading/configuring/linux-swap.md" >}}) +- [mDNS client prerequisites]({{< relref "/operate/rs/7.4/networking/mdns.md" >}}) +- [User and group ownership]({{< relref "/operate/rs/7.4/installing-upgrading/install/customize-user-and-group.md" >}}) ## Next steps After you install Redis Enterprise 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]({{< relref "/operate/rs/7.4/security/access-control/create-users" >}}) to the cluster with specific permissions. To begin, start with [Access control]({{< relref "/operate/rs/7.4/security/access-control" >}}). -- [Create databases]({{< relref "/operate/rs/databases/create" >}}) to use with your applications. +- [Create databases]({{< relref "/operate/rs/7.4/databases/create" >}}) to use with your applications. diff --git a/content/operate/rs/7.4/installing-upgrading/configuring/centos-rhel-firewall.md b/content/operate/rs/7.4/installing-upgrading/configuring/centos-rhel-firewall.md index 2b76dec88f..d71091147f 100644 --- a/content/operate/rs/7.4/installing-upgrading/configuring/centos-rhel-firewall.md +++ b/content/operate/rs/7.4/installing-upgrading/configuring/centos-rhel-firewall.md @@ -20,7 +20,7 @@ When you install Redis Enterprise Software on CentOS or RHEL, it automatically c - 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 Enterprise 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 Enterprise Software installation, the [installer prompts]({{< relref "/operate/rs/7.4/installing-upgrading/install/manage-installation-questions" >}}) 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. @@ -28,6 +28,6 @@ You can use firewalld configuration tools such as **firewall-cmd** (command line to create more specific firewall policies that allow these two services through the firewall, as necessary. {{}} -If databases are created with non-standard [Redis Enterprise Software ports]({{< relref "/operate/rs/networking/port-configurations" >}}), +If databases are created with non-standard [Redis Enterprise Software ports]({{< relref "/operate/rs/7.4/networking/port-configurations" >}}), you need to explicitly configure firewalld to make sure those ports are not blocked. {{}} diff --git a/content/operate/rs/7.4/installing-upgrading/configuring/change-location-socket-files.md b/content/operate/rs/7.4/installing-upgrading/configuring/change-location-socket-files.md index 2325670086..b4ffa47f6f 100644 --- a/content/operate/rs/7.4/installing-upgrading/configuring/change-location-socket-files.md +++ b/content/operate/rs/7.4/installing-upgrading/configuring/change-location-socket-files.md @@ -24,7 +24,7 @@ The default location was changed in case you run any maintenance procedures that When you upgrade Redis Enterprise Software from an earlier version to 5.2.2 or later, the socket files are not moved to the new location by default. You need to either specify a custom location -for the socket files during [installation]({{< relref "/operate/rs/installing-upgrading" >}}) or use the [following procedure](#change-socket-file-locations) after installation. +for the socket files during [installation]({{< relref "/operate/rs/7.4/installing-upgrading" >}}) or use the [following procedure](#change-socket-file-locations) after installation. ## Change socket file locations diff --git a/content/operate/rs/7.4/installing-upgrading/configuring/linux-swap.md b/content/operate/rs/7.4/installing-upgrading/configuring/linux-swap.md index 511f68feb1..24771d5655 100644 --- a/content/operate/rs/7.4/installing-upgrading/configuring/linux-swap.md +++ b/content/operate/rs/7.4/installing-upgrading/configuring/linux-swap.md @@ -12,7 +12,7 @@ url: '/operate/rs/7.4/installing-upgrading/configuring/linux-swap/' --- 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 Enterprise 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]({{< relref "/operate/rs/7.4/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 Enterprise Software cluster, avoid configuring swap partitions if possible. diff --git a/content/operate/rs/7.4/installing-upgrading/creating-support-package.md b/content/operate/rs/7.4/installing-upgrading/creating-support-package.md index 452da105b7..24ca6e2c8b 100644 --- a/content/operate/rs/7.4/installing-upgrading/creating-support-package.md +++ b/content/operate/rs/7.4/installing-upgrading/creating-support-package.md @@ -39,7 +39,7 @@ The following table describes the included files: | 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_.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_.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. | @@ -56,7 +56,7 @@ 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`]({{}}) 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. | @@ -120,7 +120,7 @@ To create a support package from the Cluster Manager UI: ### Command-line method -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`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/cluster/debug_info" >}}) command: ```sh /opt/redislabs/bin/rladmin cluster debug_info @@ -152,7 +152,7 @@ Upload the tar file to [Redis support](https://redis.com/company/support/). The ### REST API method -You can also use `debuginfo` [REST API]({{< relref "/operate/rs/references/rest-api" >}}) requests to create and download support packages. +You can also use `debuginfo` [REST API]({{< relref "/operate/rs/7.4/references/rest-api" >}}) requests to create and download support packages. To download debug info from all nodes and databases: diff --git a/content/operate/rs/7.4/installing-upgrading/install/_index.md b/content/operate/rs/7.4/installing-upgrading/install/_index.md index 5feefaa3e9..002f4e2720 100644 --- a/content/operate/rs/7.4/installing-upgrading/install/_index.md +++ b/content/operate/rs/7.4/installing-upgrading/install/_index.md @@ -12,13 +12,13 @@ weight: 35 url: '/operate/rs/7.4/installing-upgrading/install/' --- -After you [plan your deployment]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment" >}}), [download a Redis Enterprise 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]({{< relref "/operate/rs/7.4/installing-upgrading/install/plan-deployment" >}}), [download a Redis Enterprise Software installation package]({{< relref "/operate/rs/7.4/installing-upgrading/install/prepare-install/download-install-package" >}}), and finish [installation preparation]({{< relref "/operate/rs/7.4/installing-upgrading/install/prepare-install" >}}): -1. [Install the Redis Enterprise Software package]({{< relref "/operate/rs/installing-upgrading/install/install-on-linux" >}}) on one of the nodes in the cluster. +1. [Install the Redis Enterprise Software package]({{< relref "/operate/rs/7.4/installing-upgrading/install/install-on-linux" >}}) 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]({{< relref "/operate/rs/7.4/installing-upgrading/install/offline-installation" >}}). ## Permissions and access @@ -36,26 +36,26 @@ Do not reduce permissions to `700`. This configuration has not been tested and i If you've already installed Redis Enterprise Software, you can also: -- [Upgrade an existing deployment]({{< relref "/operate/rs/installing-upgrading/upgrading" >}}). +- [Upgrade an existing deployment]({{< relref "/operate/rs/7.4/installing-upgrading/upgrading" >}}). -- [Uninstall an existing deployment]({{< relref "/operate/rs/installing-upgrading/uninstalling.md" >}}). +- [Uninstall an existing deployment]({{< relref "/operate/rs/7.4/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]({{< relref "/operate/rs/7.4/installing-upgrading/configuring/centos-rhel-firewall.md" >}}) +- [Change socket file location]({{< relref "/operate/rs/7.4/installing-upgrading/configuring/change-location-socket-files.md" >}}) +- [Cluster DNS configuration]({{< relref "/operate/rs/7.4/networking/cluster-dns.md" >}}) +- [Cluster load balancer setup]({{< relref "/operate/rs/7.4/networking/cluster-lba-setup.md" >}}) +- [File locations]({{< relref "/operate/rs/7.4/installing-upgrading/install/plan-deployment/file-locations.md" >}}) +- [Supported platforms]({{< relref "/operate/rs/7.4/installing-upgrading/install/plan-deployment/supported-platforms.md" >}}) +- [Manage installation questions]({{< relref "/operate/rs/7.4/installing-upgrading/install/manage-installation-questions.md" >}}) +- [mDNS client prerequisites]({{< relref "/operate/rs/7.4/networking/mdns.md" >}}) +- [User and group ownership]({{< relref "/operate/rs/7.4/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]({{< relref "/operate/rs/7.4/security/access-control/create-users" >}}) to the cluster with specific permissions. To begin, start with [Access control]({{< relref "/operate/rs/7.4/security/access-control" >}}). +- [Create databases]({{< relref "/operate/rs/7.4/databases/create" >}}) to use with your applications. diff --git a/content/operate/rs/7.4/installing-upgrading/install/customize-install-directories.md b/content/operate/rs/7.4/installing-upgrading/install/customize-install-directories.md index eee022abcb..051f33b470 100644 --- a/content/operate/rs/7.4/installing-upgrading/install/customize-install-directories.md +++ b/content/operate/rs/7.4/installing-upgrading/install/customize-install-directories.md @@ -48,7 +48,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]({{< relref "/operate/rs/7.4/installing-upgrading/install/install-on-linux" >}}), include installer flags as [command-line options]({{< relref "/operate/rs/7.4/installing-upgrading/install/install-script" >}}) when you run the `install.sh` script. For example: ```sh sudo ./install.sh --install-dir --config-dir --var-dir diff --git a/content/operate/rs/7.4/installing-upgrading/install/customize-user-and-group.md b/content/operate/rs/7.4/installing-upgrading/install/customize-user-and-group.md index 05f9198e3c..6a4189720d 100644 --- a/content/operate/rs/7.4/installing-upgrading/install/customize-user-and-group.md +++ b/content/operate/rs/7.4/installing-upgrading/install/customize-user-and-group.md @@ -11,7 +11,7 @@ weight: 40 url: '/operate/rs/7.4/installing-upgrading/install/customize-user-and-group/' --- -By default, Redis Enterprise Software is installed with the user:group `redislabs:redislabs`. See [Access control]({{< relref "/operate/rs/security/access-control" >}}) for user and group security information. +By default, Redis Enterprise Software is installed with the user:group `redislabs:redislabs`. See [Access control]({{< relref "/operate/rs/7.4/security/access-control" >}}) for user and group security information. During installation, you can specify the user and group that own all Redis Enterprise Software processes. @@ -24,7 +24,7 @@ If you specify the user only, then installation is run with the primary group th - You can specify an LDAP user as the installation user. {{< /note >}} -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. For example: +To customize the user or group during [installation]({{< relref "/operate/rs/7.4/installing-upgrading/install/install-on-linux" >}}), include the `--os-user` or `--os-group` [command-line options]({{< relref "/operate/rs/7.4/installing-upgrading/install/install-script" >}}) when you run the `install.sh` script. For example: ```sh sudo ./install.sh --os-user --os-group diff --git a/content/operate/rs/7.4/installing-upgrading/install/install-on-linux.md b/content/operate/rs/7.4/installing-upgrading/install/install-on-linux.md index 0f5889ec46..6f75da0c80 100644 --- a/content/operate/rs/7.4/installing-upgrading/install/install-on-linux.md +++ b/content/operate/rs/7.4/installing-upgrading/install/install-on-linux.md @@ -11,9 +11,9 @@ weight: 10 url: '/operate/rs/7.4/installing-upgrading/install/install-on-linux/' --- -After you [download a Redis Enterprise 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 Enterprise Software installation package]({{< relref "/operate/rs/7.4/installing-upgrading/install/prepare-install/download-install-package" >}}), 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]({{< relref "/operate/rs/7.4/installing-upgrading/install/offline-installation" >}}). ## Install on Linux @@ -49,25 +49,25 @@ To install Redis Enterprise 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 list of command-line options you can add to the following command: +1. To start the installation process, run the installation script. See [installation script options]({{< relref "/operate/rs/7.4/installing-upgrading/install/install-script" >}}) for a list of command-line options you can add to the following command: ```sh sudo ./install.sh ``` {{< note >}} -- The Redis Enterprise Software files are installed in the default [file locations]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/file-locations.md" >}}). -- By default, Redis Enterprise 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. +- The Redis Enterprise Software files are installed in the default [file locations]({{< relref "/operate/rs/7.4/installing-upgrading/install/plan-deployment/file-locations.md" >}}). +- By default, Redis Enterprise 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/7.4/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 >}} -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]({{< relref "/operate/rs/7.4/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. +- Create an [answer file]({{< relref "/operate/rs/7.4/installing-upgrading/install/manage-installation-questions#configure-file-to-answer" >}}) to answer installation questions automatically. {{< /note >}} 1. When installation completes successfully, the output displays the Cluster Manager UI's IP address: @@ -88,7 +88,7 @@ To skip the installation questions, use one of the following methods: ## Auto Tiering installation -If you want to use Auto Tiering for your databases, review the prerequisites, storage requirements, and [other considerations]({{< relref "/operate/rs/databases/auto-tiering/" >}}) for Auto Tiering databases and prepare and format the flash memory. +If you want to use Auto Tiering for your databases, review the prerequisites, storage requirements, and [other considerations]({{< relref "/operate/rs/7.4/databases/auto-tiering/" >}}) for Auto Tiering databases and prepare and format the flash memory. After you [install on Linux](#install-on-linux), use the `prepare_flash` script to prepare and format flash memory: @@ -108,17 +108,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]({{< relref "/operate/rs/7.4/installing-upgrading/configuring/centos-rhel-firewall.md" >}}) +- [Change socket file location]({{< relref "/operate/rs/7.4/installing-upgrading/configuring/change-location-socket-files.md" >}}) +- [Cluster DNS configuration]({{< relref "/operate/rs/7.4/networking/cluster-dns.md" >}}) +- [Cluster load balancer setup]({{< relref "/operate/rs/7.4/networking/cluster-lba-setup.md" >}}) +- [mDNS client prerequisites]({{< relref "/operate/rs/7.4/networking/mdns.md" >}}) +- [File locations]({{< relref "/operate/rs/7.4/installing-upgrading/install/plan-deployment/file-locations.md" >}}) +- [Supported platforms]({{< relref "/operate/rs/7.4/installing-upgrading/install/plan-deployment/supported-platforms.md" >}}) ## Limitations -Several Redis Enterprise 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 Enterprise Software installation reference files are installed to the directory `/etc/opt/redislabs/` even if you use [custom installation directories]({{< relref "/operate/rs/7.4/installing-upgrading/install/customize-install-directories" >}}). As a workaround to install Redis Enterprise Software without using any root directories, do the following before installing Redis Enterprise Software: @@ -128,11 +128,11 @@ As a workaround to install Redis Enterprise Software without using any root dire ## Next steps -1. [Create]({{< relref "/operate/rs/clusters/new-cluster-setup.md" >}}) - or [join]({{< relref "/operate/rs/clusters/add-node.md" >}}) an existing Redis Enterprise Software cluster. +1. [Create]({{< relref "/operate/rs/7.4/clusters/new-cluster-setup.md" >}}) + or [join]({{< relref "/operate/rs/7.4/clusters/add-node.md" >}}) an existing Redis Enterprise Software cluster. -1. [Create a database]({{< relref "/operate/rs/databases/create" >}}). +1. [Create a database]({{< relref "/operate/rs/7.4/databases/create" >}}). - 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]({{< relref "/operate/rs/7.4/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]({{< relref "/operate/rs/7.4/security/access-control/create-users" >}}) to the cluster with specific permissions. To begin, start with [Access control]({{< relref "/operate/rs/7.4/security/access-control" >}}). diff --git a/content/operate/rs/7.4/installing-upgrading/install/install-script.md b/content/operate/rs/7.4/installing-upgrading/install/install-script.md index 89c5399538..717d6700c6 100644 --- a/content/operate/rs/7.4/installing-upgrading/install/install-script.md +++ b/content/operate/rs/7.4/installing-upgrading/install/install-script.md @@ -17,11 +17,11 @@ 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]({{< relref "/operate/rs/7.4/installing-upgrading/install/manage-installation-questions" >}})| +| `-c ` | Specify answer file used to respond to install prompts
See [Manage install questions]({{< relref "/operate/rs/7.4/installing-upgrading/install/manage-installation-questions" >}})| | `-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]({{< relref "/operate/rs/7.4/installing-upgrading/install/customize-install-directories" >}})| +| `--config-dir ` | Configuration file directory *(new installs only)*
See [Customize install locations]({{< relref "/operate/rs/7.4/installing-upgrading/install/customize-install-directories" >}})| +| `--var-dir ` | Var directory used for installation *(new installs only)*
See [Customize install locations]({{< relref "/operate/rs/7.4/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/7.4/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/7.4/installing-upgrading/install/customize-user-and-group" >}}) *(new installs only)* | diff --git a/content/operate/rs/7.4/installing-upgrading/install/manage-installation-questions.md b/content/operate/rs/7.4/installing-upgrading/install/manage-installation-questions.md index e837494107..4e3f198f22 100644 --- a/content/operate/rs/7.4/installing-upgrading/install/manage-installation-questions.md +++ b/content/operate/rs/7.4/installing-upgrading/install/manage-installation-questions.md @@ -22,7 +22,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]({{< relref "/operate/rs/7.4/installing-upgrading/configuring/linux-swap.md" >}}) in the operating system configuration to give Redis Enterprise Software control of the memory allocation. - **Automatic OS tuning** - `Do you want to automatically tune the system for best performance [Y/N]?` @@ -36,15 +36,15 @@ Several questions appear during installation: Redis Enterprise 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]({{< relref "/operate/rs/7.4/clusters/configure/sync-clocks.md" >}}). - **Firewall ports** - `Would you like to open RedisLabs cluster ports on the default firewall zone [Y/N]?` - Redis Enterprise Software requires that all nodes have [specific network ports]({{< relref "/operate/rs/networking/port-configurations.md" >}}) open. + Redis Enterprise Software requires that all nodes have [specific network ports]({{< relref "/operate/rs/7.4/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]({{< relref "/operate/rs/7.4/installing-upgrading/configuring/centos-rhel-firewall" >}}). - 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]?` @@ -62,11 +62,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]({{< relref "/operate/rs/7.4/installing-upgrading/install/install-on-linux" >}}). ### 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]({{< relref "/operate/rs/7.4/installing-upgrading/install/install-script" >}}) with the `-y` parameter: ```bash ./install.sh -y @@ -93,7 +93,7 @@ Use an answer file to manage your response: If you use `systune=yes`, the installation answers `yes` to all of the system tuning questions. -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]({{< relref "/operate/rs/7.4/installing-upgrading/install/install-script" >}}) with the `-c` command-line option and add the path to the answer file. For example: diff --git a/content/operate/rs/7.4/installing-upgrading/install/offline-installation.md b/content/operate/rs/7.4/installing-upgrading/install/offline-installation.md index 0c23b72a4f..bc0619511a 100644 --- a/content/operate/rs/7.4/installing-upgrading/install/offline-installation.md +++ b/content/operate/rs/7.4/installing-upgrading/install/offline-installation.md @@ -13,7 +13,7 @@ url: '/operate/rs/7.4/installing-upgrading/install/offline-installation/' --- 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]({{< relref "/operate/rs/7.4/clusters/configure/sync-clocks.md" >}}) against an NTP server. If you install Redis Enterprise Software on a machine without an internet connection, you need to perform two tasks manually. @@ -24,4 +24,4 @@ When you install Redis Enterprise Software on a machine that is not connected to ## 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]({{< relref "/operate/rs/7.4/clusters/configure/sync-clocks.md" >}}). diff --git a/content/operate/rs/7.4/installing-upgrading/install/plan-deployment/_index.md b/content/operate/rs/7.4/installing-upgrading/install/plan-deployment/_index.md index 8f657e6643..f7b84e7c2f 100644 --- a/content/operate/rs/7.4/installing-upgrading/install/plan-deployment/_index.md +++ b/content/operate/rs/7.4/installing-upgrading/install/plan-deployment/_index.md @@ -14,31 +14,31 @@ url: '/operate/rs/7.4/installing-upgrading/install/plan-deployment/' Before installing Redis Enterprise 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]({{< relref "/operate/rs/7.4/installing-upgrading/install/plan-deployment/hardware-requirements.md" >}}) and [Persistent and ephemeral node storage +]({{< relref "/operate/rs/7.4/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage" >}}) for more information. -- Choose your [deployment platform]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/supported-platforms.md" >}}). +- Choose your [deployment platform]({{< relref "/operate/rs/7.4/installing-upgrading/install/plan-deployment/supported-platforms.md" >}}). Redis Enterprise 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) + - [Amazon AWS AMI]({{< relref "/operate/rs/7.4/installing-upgrading/install/plan-deployment/configuring-aws-instances" >}}) + - [Docker container]({{< relref "/operate/rs/7.4/installing-upgrading/quickstarts/docker-quickstart" >}}) (for development and testing only) - [Kubernetes]({{< relref "/operate/kubernetes" >}}) - For more details, see [Supported platforms]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/supported-platforms.md" >}}). + For more details, see [Supported platforms]({{< relref "/operate/rs/7.4/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]({{< relref "/operate/rs/7.4/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]({{< relref "/operate/rs/7.4/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/7.4/installing-upgrading/install/offline-installation" >}}). ## 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]({{< relref "/operate/rs/7.4/installing-upgrading/install/prepare-install/download-install-package" >}}). -- [Prepare to install]({{< relref "/operate/rs/installing-upgrading/install/prepare-install" >}}) Redis Enterprise Software. +- [Prepare to install]({{< relref "/operate/rs/7.4/installing-upgrading/install/prepare-install" >}}) Redis Enterprise Software. -- [View installation questions]({{< relref "/operate/rs/installing-upgrading/install/manage-installation-questions" >}}) and prepare answers before installation. +- [View installation questions]({{< relref "/operate/rs/7.4/installing-upgrading/install/manage-installation-questions" >}}) and prepare answers before installation. diff --git a/content/operate/rs/7.4/installing-upgrading/install/plan-deployment/configuring-aws-instances.md b/content/operate/rs/7.4/installing-upgrading/install/plan-deployment/configuring-aws-instances.md index e56cf3878a..3bee8ef7b9 100644 --- a/content/operate/rs/7.4/installing-upgrading/install/plan-deployment/configuring-aws-instances.md +++ b/content/operate/rs/7.4/installing-upgrading/install/plan-deployment/configuring-aws-instances.md @@ -27,11 +27,11 @@ 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 Enterprise 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]({{< relref "/operate/rs/7.4/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage" >}}) is configured to use this volume. {{< note >}} -After [installing the Redis Enterprise 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" >}}), +After [installing the Redis Enterprise Software package]({{< relref "/operate/rs/7.4/installing-upgrading" >}}) on the instance +and **before** running through [the setup process]({{< relref "/operate/rs/7.4/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 @@ -44,7 +44,7 @@ Provisioned IOPS for EBS-backed volumes. Provisioned IOPS guarantee a certain level of disk performance. There are two features in Redis Enterprise Software where this feature could be critical to use: -1. When using [Auto Tiering]({{< relref "/operate/rs/databases/auto-tiering/" >}}) +1. When using [Auto Tiering]({{< relref "/operate/rs/7.4/databases/auto-tiering/" >}}) 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. @@ -53,7 +53,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 Enterprise Software [hardware -requirements]({{< relref "/operate/rs/installing-upgrading/install/plan-deployment/hardware-requirements.md" >}}). +requirements]({{< relref "/operate/rs/7.4/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 @@ -69,14 +69,14 @@ When configuring the security group: access the Cluster Manager UI. - If you are using the DNS resolving option with Redis Enterprise 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]({{< relref "/operate/rs/7.4/networking/cluster-dns" >}}). - 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 Enterprise Software]({{< relref "/operate/rs/networking/port-configurations.md" >}}). + To limit the number of open ports, you can open only the [ports used by Redis Enterprise Software]({{< relref "/operate/rs/7.4/networking/port-configurations.md" >}}). After successfully launching the instances: -1. Install Redis Enterprise 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 Enterprise Software from the [Linux package or AWS AMI]({{< relref "/operate/rs/7.4/installing-upgrading" >}}). +2. [Set up the cluster]({{< relref "/operate/rs/7.4/clusters/new-cluster-setup.md" >}}). diff --git a/content/operate/rs/7.4/installing-upgrading/install/plan-deployment/file-locations.md b/content/operate/rs/7.4/installing-upgrading/install/plan-deployment/file-locations.md index 8ed1f9dfb6..7056e3b6e5 100644 --- a/content/operate/rs/7.4/installing-upgrading/install/plan-deployment/file-locations.md +++ b/content/operate/rs/7.4/installing-upgrading/install/plan-deployment/file-locations.md @@ -21,7 +21,7 @@ The directories that Redis Enterprise Software installs into are: | **Path** | **Description** | |------------|-----------------| | /opt/redislabs | Main installation directory for all Redis Enterprise 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`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin" >}}) or [`redis-cli`]({{< relref "/operate/rs/7.4/references/cli-utilities/redis-cli" >}}) | | /opt/redislabs/config | System configuration files | | /opt/redislabs/lib | System library files | | /opt/redislabs/sbin | System binaries for tweaking provisioning | @@ -40,5 +40,5 @@ The default directories that Redis Enterprise Software uses for data and metadat 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]({{< relref "/operate/rs/7.4/clusters/new-cluster-setup.md" >}}) during cluster setup +- [Socket files]({{< relref "/operate/rs/7.4/installing-upgrading/configuring/change-location-socket-files.md" >}}) after cluster setup diff --git a/content/operate/rs/7.4/installing-upgrading/install/plan-deployment/hardware-requirements.md b/content/operate/rs/7.4/installing-upgrading/install/plan-deployment/hardware-requirements.md index f87e412dcb..53f748968f 100644 --- a/content/operate/rs/7.4/installing-upgrading/install/plan-deployment/hardware-requirements.md +++ b/content/operate/rs/7.4/installing-upgrading/install/plan-deployment/hardware-requirements.md @@ -23,16 +23,16 @@ 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. +- [**Database clustering**]({{< relref "/operate/rs/7.4/databases/durability-ha/clustering" >}}) – Allows you to spread your data into shards across multiple nodes. +- [**Database replication**]({{< relref "/operate/rs/7.4/databases/durability-ha/replication" >}}) – 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**]({{< relref "/operate/rs/7.4/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/7.4/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/7.4/databases/active-active/manage#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. @@ -42,5 +42,5 @@ Active-Active databases have a lower threshold for activating the eviction polic 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**]({{< relref "/operate/rs/7.4/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. diff --git a/content/operate/rs/7.4/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage.md b/content/operate/rs/7.4/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage.md index 5ad51bee5a..b5dd1932d3 100644 --- a/content/operate/rs/7.4/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage.md +++ b/content/operate/rs/7.4/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage.md @@ -13,7 +13,7 @@ weight: 50 url: '/operate/rs/7.4/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage/' --- 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]({{< relref "/operate/rs/7.4/installing-upgrading/install/customize-user-and-group" >}}) page for instructions. {{< note >}} The persistent storage and ephemeral storage discussed in this document are not related @@ -26,7 +26,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]({{< relref "/operate/rs/7.4/databases/configure/database-persistence" >}}) options for a database. The persistent volume must be a storage area network (SAN) @@ -47,10 +47,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]({{< relref "/operate/rs/7.4/installing-upgrading/install/plan-deployment/hardware-requirements" >}}) 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]({{< relref "/operate/rs/7.4/clusters/optimize/disk-sizing-heavy-write-scenarios" >}}) for special considerations when dealing with a high rate of write commands. diff --git a/content/operate/rs/7.4/installing-upgrading/install/prepare-install/_index.md b/content/operate/rs/7.4/installing-upgrading/install/prepare-install/_index.md index 4c77f60114..2431bcaeb6 100644 --- a/content/operate/rs/7.4/installing-upgrading/install/prepare-install/_index.md +++ b/content/operate/rs/7.4/installing-upgrading/install/prepare-install/_index.md @@ -14,24 +14,24 @@ url: '/operate/rs/7.4/installing-upgrading/install/prepare-install/' Before you install Redis Enterprise Software: -- [Download an installation package]({{< relref "/operate/rs/installing-upgrading/install/prepare-install/download-install-package" >}}). +- [Download an installation package]({{< relref "/operate/rs/7.4/installing-upgrading/install/prepare-install/download-install-package" >}}). -- [View installation questions]({{< relref "/operate/rs/installing-upgrading/install/manage-installation-questions" >}}) and optionally prepare answers before installation. +- [View installation questions]({{< relref "/operate/rs/7.4/installing-upgrading/install/manage-installation-questions" >}}) and optionally prepare answers before installation. -- Review the [security considerations]({{< relref "/operate/rs/security/" >}}) for your deployment. +- Review the [security considerations]({{< relref "/operate/rs/7.4/security/" >}}) 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]({{< relref "/operate/rs/7.4/installing-upgrading/install/prepare-install/port-availability" >}}). -- [Turn off Linux swap]({{< relref "/operate/rs/installing-upgrading/configuring/linux-swap.md" >}}) on all cluster nodes. +- [Turn off Linux swap]({{< relref "/operate/rs/7.4/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]({{< relref "/operate/rs/7.4/installing-upgrading/install/install-on-linux#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]({{< relref "/operate/rs/7.4/installing-upgrading/install/install-script" >}}) before starting the installation. -- [Install Redis Enterprise Software]({{< relref "/operate/rs/installing-upgrading/install" >}}). +- [Install Redis Enterprise Software]({{< relref "/operate/rs/7.4/installing-upgrading/install" >}}). diff --git a/content/operate/rs/7.4/installing-upgrading/install/prepare-install/download-install-package.md b/content/operate/rs/7.4/installing-upgrading/install/prepare-install/download-install-package.md index ef3a7b395d..645af41f12 100644 --- a/content/operate/rs/7.4/installing-upgrading/install/prepare-install/download-install-package.md +++ b/content/operate/rs/7.4/installing-upgrading/install/prepare-install/download-install-package.md @@ -19,5 +19,5 @@ To download the installation package for any of the supported platforms: {{< 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" >}}). +review the [configuration requirements for AWS EC2 instances]({{< relref "/operate/rs/7.4/installing-upgrading/install/plan-deployment/configuring-aws-instances" >}}). {{< /note >}} diff --git a/content/operate/rs/7.4/installing-upgrading/install/prepare-install/port-availability.md b/content/operate/rs/7.4/installing-upgrading/install/prepare-install/port-availability.md index 38979ca73b..e7ed6a8dce 100644 --- a/content/operate/rs/7.4/installing-upgrading/install/prepare-install/port-availability.md +++ b/content/operate/rs/7.4/installing-upgrading/install/prepare-install/port-availability.md @@ -11,7 +11,7 @@ weight: 40 url: '/operate/rs/7.4/installing-upgrading/install/prepare-install/port-availability/' --- -Before [installing Redis Enterprise Software]({{< relref "/operate/rs/installing-upgrading/install" >}}), make sure all required ports are available. +Before [installing Redis Enterprise Software]({{< relref "/operate/rs/7.4/installing-upgrading/install" >}}), make sure all required ports are available. {{}} diff --git a/content/operate/rs/7.4/installing-upgrading/product-lifecycle.md b/content/operate/rs/7.4/installing-upgrading/product-lifecycle.md index c161fe149c..e5ecaf1445 100644 --- a/content/operate/rs/7.4/installing-upgrading/product-lifecycle.md +++ b/content/operate/rs/7.4/installing-upgrading/product-lifecycle.md @@ -52,4 +52,4 @@ This update to the EOL policy allows a lead time of at least 24 months to upgrad {{}} -For detailed upgrade instructions, see [Upgrade a Redis Enterprise Software cluster]({{}}). +For detailed upgrade instructions, see [Upgrade a Redis Enterprise Software cluster]({{}}). diff --git a/content/operate/rs/7.4/installing-upgrading/quickstarts/_index.md b/content/operate/rs/7.4/installing-upgrading/quickstarts/_index.md index 76a89d89f2..c5780b8d8e 100644 --- a/content/operate/rs/7.4/installing-upgrading/quickstarts/_index.md +++ b/content/operate/rs/7.4/installing-upgrading/quickstarts/_index.md @@ -14,14 +14,14 @@ url: '/operate/rs/7.4/installing-upgrading/quickstarts/' Try out Redis Enterprise Software using one of the following quickstarts: -- [Redis Enterprise Software quickstart]({{< relref "/operate/rs/installing-upgrading/quickstarts/redis-enterprise-software-quickstart" >}}) +- [Redis Enterprise Software quickstart]({{< relref "/operate/rs/7.4/installing-upgrading/quickstarts/redis-enterprise-software-quickstart" >}}) -- [Docker quickstart for Redis Enterprise Software]({{< relref "/operate/rs/installing-upgrading/quickstarts/docker-quickstart" >}}) +- [Docker quickstart for Redis Enterprise Software]({{< relref "/operate/rs/7.4/installing-upgrading/quickstarts/docker-quickstart" >}}) Additional quickstart guides are available to help you: -- Set up a [Auto Tiering cluster]({{< relref "/operate/rs/databases/auto-tiering/quickstart.md" >}}) to optimize memory resources. +- Set up a [Auto Tiering cluster]({{< relref "/operate/rs/7.4/databases/auto-tiering/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]({{< relref "/operate/rs/7.4/databases/active-active/get-started.md" >}}) to enable high availability. -- [Benchmark]({{< relref "/operate/rs/clusters/optimize/memtier-benchmark.md" >}}) Redis Enterprise Software performance. +- [Benchmark]({{< relref "/operate/rs/7.4/clusters/optimize/memtier-benchmark.md" >}}) Redis Enterprise Software performance. diff --git a/content/operate/rs/7.4/installing-upgrading/quickstarts/docker-quickstart.md b/content/operate/rs/7.4/installing-upgrading/quickstarts/docker-quickstart.md index 18b9eaec19..367ab5b052 100644 --- a/content/operate/rs/7.4/installing-upgrading/quickstarts/docker-quickstart.md +++ b/content/operate/rs/7.4/installing-upgrading/quickstarts/docker-quickstart.md @@ -57,11 +57,11 @@ The example command runs the Docker container with Redis Enterprise Software on - Port 8443 for HTTPS connections -- Port 9443 for [REST API]({{< relref "/operate/rs/references/rest-api" >}}) connections +- Port 9443 for [REST API]({{< relref "/operate/rs/7.4/references/rest-api" >}}) 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]({{< relref "/operate/rs/7.4/networking/port-configurations.md" >}}) with `-p :` or use the `--network host` option to open all ports to the host network. ## Set up a cluster @@ -82,7 +82,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 Enterprise 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 Enterprise Software includes the command-line tool [`redis-cli`]({{< relref "/operate/rs/7.4/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. Use [`docker exec`](https://docs.docker.com/engine/reference/commandline/exec/) to start an interactive `redis-cli` session in the running Redis Enterprise Software container: @@ -96,7 +96,7 @@ OK ### 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]({{< relref "/operate/rs/7.4/databases/connect/" >}}). Use `localhost` as the `host` and `12000` as the port. ## Test different topologies diff --git a/content/operate/rs/7.4/installing-upgrading/quickstarts/redis-enterprise-software-quickstart.md b/content/operate/rs/7.4/installing-upgrading/quickstarts/redis-enterprise-software-quickstart.md index b0bdfbe2cd..8c43eee593 100644 --- a/content/operate/rs/7.4/installing-upgrading/quickstarts/redis-enterprise-software-quickstart.md +++ b/content/operate/rs/7.4/installing-upgrading/quickstarts/redis-enterprise-software-quickstart.md @@ -26,7 +26,7 @@ When finished, you'll have a simple cluster with a single node: {{< 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. +For production environments, see the [install and setup]({{< relref "/operate/rs/7.4/installing-upgrading#install-redis-enterprise-software" >}}) guide for deployment options and instructions. {{< /note >}} ## Ensure port availability @@ -94,7 +94,7 @@ To set up your machine as a Redis Enterprise 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]({{< relref "/operate/rs/7.4/databases/connect/test-client-connectivity" >}}) for connection options and examples. ## Supported web browsers diff --git a/content/operate/rs/7.4/installing-upgrading/uninstalling.md b/content/operate/rs/7.4/installing-upgrading/uninstalling.md index 877001a6cf..4258654c78 100644 --- a/content/operate/rs/7.4/installing-upgrading/uninstalling.md +++ b/content/operate/rs/7.4/installing-upgrading/uninstalling.md @@ -13,7 +13,7 @@ url: '/operate/rs/7.4/installing-upgrading/uninstalling/' Use the script `rl_uninstall.sh` to uninstall Redis Enterprise 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]({{}}). ## Uninstall Redis Enterprise Software diff --git a/content/operate/rs/7.4/installing-upgrading/upgrading/_index.md b/content/operate/rs/7.4/installing-upgrading/upgrading/_index.md index 165c84e325..154038f4dc 100644 --- a/content/operate/rs/7.4/installing-upgrading/upgrading/_index.md +++ b/content/operate/rs/7.4/installing-upgrading/upgrading/_index.md @@ -13,8 +13,8 @@ url: '/operate/rs/7.4/installing-upgrading/upgrading/' --- To upgrade Redis Enterprise Software: -1. Verify appropriate [network ports]({{< relref "/operate/rs/networking/port-configurations.md" >}}) are either open or used by Redis Enterprise Software. +1. Verify appropriate [network ports]({{< relref "/operate/rs/7.4/networking/port-configurations.md" >}}) are either open or used by Redis Enterprise Software. -1. [Upgrade the software on all nodes of the cluster.]({{< relref "/operate/rs/installing-upgrading/upgrading/upgrade-cluster" >}}) +1. [Upgrade the software on all nodes of the cluster.]({{< relref "/operate/rs/7.4/installing-upgrading/upgrading/upgrade-cluster" >}}) -2. _(Optional)_ [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. +2. _(Optional)_ [Upgrade each database]({{< relref "/operate/rs/7.4/installing-upgrading/upgrading/upgrade-database" >}}) in the cluster or [upgrade an Active-Active database]({{< relref "/operate/rs/7.4/installing-upgrading/upgrading/upgrade-active-active" >}}) to enable new features and important fixes. diff --git a/content/operate/rs/7.4/installing-upgrading/upgrading/upgrade-active-active.md b/content/operate/rs/7.4/installing-upgrading/upgrading/upgrade-active-active.md index d1a2ab2b8a..6d02a38a48 100644 --- a/content/operate/rs/7.4/installing-upgrading/upgrading/upgrade-active-active.md +++ b/content/operate/rs/7.4/installing-upgrading/upgrading/upgrade-active-active.md @@ -11,7 +11,7 @@ weight: 70 url: '/operate/rs/7.4/installing-upgrading/upgrading/upgrade-active-active/' --- -When you upgrade an [Active-Active (CRDB) database]({{< relref "/operate/rs/databases/active-active" >}}), you can also upgrade the CRDB protocol version and feature version. +When you upgrade an [Active-Active (CRDB) database]({{< relref "/operate/rs/7.4/databases/active-active" >}}), you can also upgrade the CRDB protocol version and feature version. ## CRDB protocol version guidelines @@ -53,7 +53,7 @@ Follow these upgrade guidelines: To upgrade an Active-Active database (CRDB) instance: -1. [Upgrade Redis Enterprise 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 Enterprise Software]({{< relref "/operate/rs/7.4/installing-upgrading/upgrading/upgrade-cluster" >}}) on each node in the clusters where the Active-Active instances are located. 1. To see the status of your Active-Active instances, run: @@ -88,7 +88,7 @@ To upgrade an Active-Active database (CRDB) instance: Use the `keep_crdt_protocol_version` option to upgrade the database feature version without upgrading the CRDB protocol version. - If you use this option, 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. + If you use this option, make sure that you upgrade the CRDB protocol soon after with the [`rladmin upgrade db`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/upgrade#upgrade-db" >}}) command. You must upgrade the CRDB protocol before you update the CRDB feature set version. diff --git a/content/operate/rs/7.4/installing-upgrading/upgrading/upgrade-cluster.md b/content/operate/rs/7.4/installing-upgrading/upgrading/upgrade-cluster.md index 7cb7efbef9..f4e8f0d581 100644 --- a/content/operate/rs/7.4/installing-upgrading/upgrading/upgrade-cluster.md +++ b/content/operate/rs/7.4/installing-upgrading/upgrading/upgrade-cluster.md @@ -15,13 +15,13 @@ url: '/operate/rs/7.4/installing-upgrading/upgrading/upgrade-cluster/' {{}} -See the [Redis Enterprise Software product lifecycle]({{}}) for more information about release numbers and the end-of-life schedule. +See the [Redis Enterprise Software product lifecycle]({{}}) for more information about release numbers and the end-of-life schedule. ## 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]({{< relref "/operate/rs/7.4/references/cli-utilities/rlcheck/" >}}) and [rladmin]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/#use-the-rladmin-shell" >}}) commands - Verify that you meet the upgrade path requirements for your desired cluster version and review the relevant [release notes]({{< relref "/operate/rs/release-notes" >}}) for any preparation instructions. @@ -31,9 +31,9 @@ Before upgrading a cluster: - **Nodes** screen in the new Cluster Manager UI (only available for Redis Enterprise versions 7.2 and later) - - [`rladmin status nodes`]({{< relref "/operate/rs/references/cli-utilities/rladmin/status#status-nodes" >}}) command + - [`rladmin status nodes`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/status#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`]({{< relref "/operate/rs/7.4/references/rest-api/requests/nodes/status#get-all-nodes-status" >}}) REST API request ## Upgrade cluster @@ -58,7 +58,7 @@ Starting with the primary (master) node, follow these steps for every node in th 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: +1. Run the install command. See [installation script options]({{< relref "/operate/rs/7.4/installing-upgrading/install/install-script" >}}) for a list of command-line options you can add to the following command: ``` shell sudo ./install.sh diff --git a/content/operate/rs/7.4/installing-upgrading/upgrading/upgrade-database.md b/content/operate/rs/7.4/installing-upgrading/upgrading/upgrade-database.md index afb78a2a5b..29fb483072 100644 --- a/content/operate/rs/7.4/installing-upgrading/upgrading/upgrade-database.md +++ b/content/operate/rs/7.4/installing-upgrading/upgrading/upgrade-database.md @@ -13,7 +13,7 @@ url: '/operate/rs/7.4/installing-upgrading/upgrading/upgrade-database/' ## 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]({{< relref "/operate/rs/7.4/references/rest-api/requests/bdbs" >}}) or [`rladmin upgrade db`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/upgrade#upgrade-db" >}}). Redis Enterprise Software v6.x includes two Redis database versions: 6.0 and 6.2. As of version 7.2, Redis Enterprise Software includes three Redis database versions. @@ -22,7 +22,7 @@ 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]({{< relref "/operate/rs/7.4/references/rest-api/requests/nodes" >}}) and see `supported_database_versions` in the response. The default Redis database version differs between Redis Enterprise releases as follows: @@ -48,7 +48,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`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/status" >}}) command to display configuration details: ```sh rladmin status extra all @@ -62,11 +62,11 @@ Before upgrading a 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]({{< relref "/operate/rs/7.4/references/compatibility/resp#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]({{< relref "/operate/rs/7.4/databases/import-export/schedule-backups" >}}). - 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]({{< relref "/operate/rs/7.4/databases/import-export/export-data" >}}) to an external location, [enable replication]({{< relref "/operate/rs/7.4/databases/durability-ha/replication" >}}), or [enable persistence]({{< relref "/operate/rs/7.4/databases/configure/database-persistence" >}}). When choosing how to back up data, keep the following in mind: @@ -80,7 +80,7 @@ To upgrade a database: 1. _(Optional)_ Back up the database to minimize the risk of data loss. -1. Use [`rladmin`]({{< relref "/operate/rs/references/cli-utilities/rladmin/upgrade" >}}) to upgrade the database. During the upgrade process, the database will restart without losing any data. +1. Use [`rladmin`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/upgrade" >}}) to upgrade the database. During the upgrade process, the database will restart without losing any data. - To upgrade a database without modules: @@ -114,7 +114,7 @@ To upgrade 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**. - - 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: + - Use [`rladmin status databases extra all`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/status#status-databases" >}}) to display a list of the databases in your cluster and their current Redis database compatibility version: ```sh rladmin status databases extra all diff --git a/content/operate/rs/7.4/installing-upgrading/upgrading/upgrade-os.md b/content/operate/rs/7.4/installing-upgrading/upgrading/upgrade-os.md index 246ffa64f3..0a34afb3c1 100644 --- a/content/operate/rs/7.4/installing-upgrading/upgrading/upgrade-os.md +++ b/content/operate/rs/7.4/installing-upgrading/upgrading/upgrade-os.md @@ -19,15 +19,15 @@ To upgrade the operating system (OS) on a Redis Enterprise Software cluster to a 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 Enterprise Software version that supports the OS's current version and upgrade version. +1. [Upgrade all nodes in the cluster]({{< relref "/operate/rs/7.4/installing-upgrading/upgrading/upgrade-cluster" >}}) to a Redis Enterprise Software version that supports the OS's current version and upgrade version. - To learn which versions of Redis Enterprise Software support specific OS versions, see [Supported platforms]({{< relref "/operate/rs/references/supported-platforms#supported-platforms" >}}). + To learn which versions of Redis Enterprise Software support specific OS versions, see [Supported platforms]({{< relref "/operate/rs/7.4/references/supported-platforms#supported-platforms" >}}). 1. If the cluster contains databases that use modules: 1. Update all nodes in the cluster to [Redis Enterprise Software version 7.2.4-52]({{< relref "/operate/rs/release-notes/rs-7-2-4-releases" >}}) or later before you upgrade the OS. - 1. Check the status of modules using [`rladmin`]({{< relref "/operate/rs/references/cli-utilities/rladmin" >}}): + 1. Check the status of modules using [`rladmin`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin" >}}): ```sh rladmin status modules @@ -61,7 +61,7 @@ The uploaded module packages have the following requirements: - The module version matches the version currently used by databases. {{}} -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]({{< relref "/operate/rs/7.4/installing-upgrading/install/customize-install-directories" >}}) for details. ## Perform OS rolling upgrade @@ -75,17 +75,17 @@ 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 Enterprise 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 Enterprise Software version]({{< relref "/operate/rs/7.4/installing-upgrading/install/install-on-linux" >}}) 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]({{< relref "/operate/rs/7.4/clusters/add-node" >}}) to the cluster. -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]({{< relref "/operate/rs/7.4/clusters/remove-node#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. ### Replace node upgrade method {#replace-node-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]({{< relref "/operate/rs/7.4/clusters/remove-node#remove-a-node" >}}) with the earlier OS version from the cluster. 1. Uninstall Redis Enterprise Software from the removed node: @@ -95,11 +95,11 @@ 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 Enterprise 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 Enterprise Software version]({{< relref "/operate/rs/7.4/installing-upgrading/install/install-on-linux" >}}) 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]({{< relref "/operate/rs/7.4/clusters/add-node" >}}) 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`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/cluster/join" >}}) with the `replace_node` flag: ```sh rladmin cluster join nodes username password replace_node @@ -129,7 +129,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`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/status" >}}) on the new node: ```sh rladmin status extra all diff --git a/content/operate/rs/7.4/networking/cluster-dns.md b/content/operate/rs/7.4/networking/cluster-dns.md index 0265f7233e..5b997096fa 100644 --- a/content/operate/rs/7.4/networking/cluster-dns.md +++ b/content/operate/rs/7.4/networking/cluster-dns.md @@ -11,7 +11,7 @@ weight: $weight url: '/operate/rs/7.4/networking/cluster-dns/' --- -By default, Redis Enterprise Software deployments use DNS to communicate between nodes. You can also use the [Discovery Service]({{< relref "/operate/rs/databases/durability-ha/discovery-service.md" >}}), which uses IP addresses to connect and complies with the [Redis Sentinel API]({{< relref "/operate/oss_and_stack/management/sentinel" >}}) supported by Redis Community Edition. +By default, Redis Enterprise Software deployments use DNS to communicate between nodes. You can also use the [Discovery Service]({{< relref "/operate/rs/7.4/databases/durability-ha/discovery-service.md" >}}), which uses IP addresses to connect and complies with the [Redis Sentinel API]({{< relref "/operate/oss_and_stack/management/sentinel" >}}) supported by Redis Community Edition. Each node in a Redis Enterprise cluster includes a small DNS server to manage internal functions, such as high availability, automatic failover, automatic migration, and so on. Nodes should only run the DNS server included with the software. Running additional DNS servers can lead to unexpected behavior. @@ -106,9 +106,9 @@ However, as the topology of the cluster changes and node with the given IP addre you need to remember the IP address of another node participating in this cluster to connect to the Cluster Manager UI and manage the cluster. Applications connecting to Redis Software databases have the same constraints. -When using the IP-based connection method, you can use the [Discovery Service]({{< relref "/operate/rs/databases/durability-ha/discovery-service.md" >}}) +When using the IP-based connection method, you can use the [Discovery Service]({{< relref "/operate/rs/7.4/databases/durability-ha/discovery-service.md" >}}) to discover the database endpoint for a given database name as long as you have an IP address for at least one of the nodes in the cluster. The API used for discovery service is compliant with the Redis Sentinel API. -To test your connection, try pinging the service. For help, see [Connect to your database]({{< relref "/operate/rs/databases/connect/test-client-connectivity" >}}). +To test your connection, try pinging the service. For help, see [Connect to your database]({{< relref "/operate/rs/7.4/databases/connect/test-client-connectivity" >}}). diff --git a/content/operate/rs/7.4/networking/cluster-lba-setup.md b/content/operate/rs/7.4/networking/cluster-lba-setup.md index 9c94d9de10..903c2560d4 100644 --- a/content/operate/rs/7.4/networking/cluster-lba-setup.md +++ b/content/operate/rs/7.4/networking/cluster-lba-setup.md @@ -41,7 +41,7 @@ The architecture is shown in the following diagram with a 3-node Redis Enterpris ### Prerequisites -- [Install]({{< relref "/operate/rs/installing-upgrading" >}}) the latest version of Redis Enterprise Software on your clusters +- [Install]({{< relref "/operate/rs/7.4/installing-upgrading" >}}) the latest version of Redis Enterprise Software on your clusters - Configure the cluster with the cluster name (FQDN) even though DNS is not in use. Remember that the same cluster name is used to issue the license keys. We recommend that you use a “.local” suffix in the FQDN. @@ -54,7 +54,7 @@ The architecture is shown in the following diagram with a 3-node Redis Enterpris - Rest API on port 9443 for secure HTTPS connections and port 8080 for HTTP - Database ports 10000-19999 -Other ports are shown in the list of [Redis Enterprise network ports]({{< relref "/operate/rs/networking/port-configurations" >}}). +Other ports are shown in the list of [Redis Enterprise network ports]({{< relref "/operate/rs/7.4/networking/port-configurations" >}}). {{< note >}} Sticky, secured connections are needed only for the Redis Enterprise Cluster Manager UI on port 8443. @@ -66,7 +66,7 @@ Sticky, secured connections are needed only for the Redis Enterprise Cluster Man ### Configure cluster -For clusters behind load balancers, we recommend using the `all-nodes` [proxy policy]({{}}) and enabling `handle_redirects`. +For clusters behind load balancers, we recommend using the `all-nodes` [proxy policy]({{}}) and enabling `handle_redirects`. To allow inbound connections to be terminated on the relevant node inside the cluster, run the following `rladmin` commands on the cluster: @@ -87,9 +87,9 @@ rladmin tune cluster default_shards_placement sparse ### Configure database -After you update the cluster settings and configure the load balancers, you can go to the Redis Enterprise Cluster Manager UI at `https://load-balancer-virtual-ip:8443/` and [create a new database]({{< relref "/operate/rs/databases/create.md" >}}). +After you update the cluster settings and configure the load balancers, you can go to the Redis Enterprise Cluster Manager UI at `https://load-balancer-virtual-ip:8443/` and [create a new database]({{< relref "/operate/rs/7.4/databases/create.md" >}}). -To create an Active-Active database, use the `crdb-cli` utility. See the [`crdb-cli` reference]({{< relref "/operate/rs/references/cli-utilities/crdb-cli" >}}) for more information about creating Active-Active databases from the command line. +To create an Active-Active database, use the `crdb-cli` utility. See the [`crdb-cli` reference]({{< relref "/operate/rs/7.4/references/cli-utilities/crdb-cli" >}}) for more information about creating Active-Active databases from the command line. ### Update load balancer configuration when cluster configuration changes @@ -106,7 +106,7 @@ especially if they are directly connected on IP addresses that have changed. ## Intercluster communication considerations -Redis Enterprise supports several topologies that allow intercluster replication, such as [Replica Of]({{< relref "/operate/rs/databases/import-export/replica-of/" >}}) and [Active-Active]({{< relref "/operate/rs/databases/active-active/" >}}) deployment options. +Redis Enterprise supports several topologies that allow intercluster replication, such as [Replica Of]({{< relref "/operate/rs/7.4/databases/import-export/replica-of/" >}}) and [Active-Active]({{< relref "/operate/rs/7.4/databases/active-active/" >}}) deployment options. When your Redis Enterprise software clusters are behind load balancers, you must allow some network services to be open and defined in the load balancers to allow the replication to work. ### Replica Of @@ -115,4 +115,4 @@ For Replica Of communication to work, you must expose database ports locally in ### Active-Active -For Active-Active communication to work, you must expose several ports, including every database port and several control plane ports as defined in [Network port configurations]({{< relref "/operate/rs/networking/port-configurations" >}}). Pay attention to services that include "Active-Active" in the connection source column, and allow these ports through any firewalls between the clusters. +For Active-Active communication to work, you must expose several ports, including every database port and several control plane ports as defined in [Network port configurations]({{< relref "/operate/rs/7.4/networking/port-configurations" >}}). Pay attention to services that include "Active-Active" in the connection source column, and allow these ports through any firewalls between the clusters. diff --git a/content/operate/rs/7.4/networking/mdns.md b/content/operate/rs/7.4/networking/mdns.md index 738a1aefe8..00df624fa0 100644 --- a/content/operate/rs/7.4/networking/mdns.md +++ b/content/operate/rs/7.4/networking/mdns.md @@ -14,9 +14,9 @@ url: '/operate/rs/7.4/networking/mdns/' mDNS is only supported for development and testing environments. {{< /note >}} -If you choose to use the mDNS protocol when [you set the cluster name]({{< relref "/operate/rs/networking/cluster-dns" >}}), +If you choose to use the mDNS protocol when [you set the cluster name]({{< relref "/operate/rs/7.4/networking/cluster-dns" >}}), make sure that the configurations and prerequisites for resolving database endpoints are met on the client machines. -If you have [Replica Of]({{< relref "/operate/rs/databases/import-export/replica-of/" >}}) databases on the cluster, +If you have [Replica Of]({{< relref "/operate/rs/7.4/databases/import-export/replica-of/" >}}) databases on the cluster, the configurations and prerequisites are also required for the Redis Enterprise Software nodes. To prepare a client or node for mDNS: @@ -47,7 +47,7 @@ To prepare a client or node for mDNS: $ service avahi-daemon start ``` -1. If you are using [mDNS with IPv6 addresses]({{< relref "/operate/rs/networking/multi-ip-ipv6" >}}), +1. If you are using [mDNS with IPv6 addresses]({{< relref "/operate/rs/7.4/networking/multi-ip-ipv6" >}}), update the hosts line in `/etc/nsswitch.conf` to: ```yaml diff --git a/content/operate/rs/7.4/networking/multi-ip-ipv6.md b/content/operate/rs/7.4/networking/multi-ip-ipv6.md index df1b5d8df6..e414457c2d 100644 --- a/content/operate/rs/7.4/networking/multi-ip-ipv6.md +++ b/content/operate/rs/7.4/networking/multi-ip-ipv6.md @@ -38,7 +38,7 @@ IPv6 for internal communication is supported only for new clusters with Redis En If the server has only IPv6 interfaces, IPv6 is automatically used for internal and external traffic. Otherwise, internal traffic uses IPv4 by default. -To use IPv6 for internal traffic on a machine with both IPv4 and IPv6 interfaces, set `use_internal_ipv6` to `true` when you create a cluster using the [bootstrap REST API request]({{< relref "/operate/rs/references/rest-api/requests/bootstrap#post-bootstrap" >}}): +To use IPv6 for internal traffic on a machine with both IPv4 and IPv6 interfaces, set `use_internal_ipv6` to `true` when you create a cluster using the [bootstrap REST API request]({{< relref "/operate/rs/7.4/references/rest-api/requests/bootstrap#post-bootstrap" >}}): ```sh POST /v1/bootstrap/create_cluster @@ -88,7 +88,7 @@ If you need to update the internal IP address in the OS, one option is to remove Alternatively, you can use the following steps to update a node's internal IP address without removing it from the cluster: -1. Turn the node into a replica using [`rladmin`]({{< relref "/operate/rs/references/cli-utilities/rladmin/node/enslave" >}}): +1. Turn the node into a replica using [`rladmin`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/node/enslave" >}}): ```sh rladmin node enslave demote_node @@ -104,7 +104,7 @@ Alternatively, you can use the following steps to update a node's internal IP ad 1. Follow the operating system vendor's instructions to change the node's IP address. -1. From a different cluster node, use [`rladmin node addr set`]({{< relref "/operate/rs/references/cli-utilities/rladmin/node/addr" >}}) to update the first node's IP address: +1. From a different cluster node, use [`rladmin node addr set`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/node/addr" >}}) to update the first node's IP address: ```sh rladmin node addr set @@ -135,7 +135,7 @@ Repeat this procedure for other cluster nodes to change their internal IP addres You can configure external addresses that are not bound to an active interface, but are otherwise mapped or configured to route traffic to the node (such as AWS Elastic IPs or a load balancer VIP). -You can use [rladmin node external_addr]({{< relref "/operate/rs/references/cli-utilities/rladmin/node/external-addr" >}}) to change a node's external IP addresses. +You can use [rladmin node external_addr]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/node/external-addr" >}}) to change a node's external IP addresses. Add an external IP address: @@ -158,7 +158,7 @@ rladmin node external_addr remove {{< note >}} While [joining a new node to a -cluster]({{< relref "/operate/rs/clusters/add-node.md" >}}) +cluster]({{< relref "/operate/rs/7.4/clusters/add-node.md" >}}) during the node bootstrap process, when prompted to provide an IP of an existing node in the cluster, if you use the node's IP, provide the node's internal IP address. diff --git a/content/operate/rs/7.4/networking/port-configurations.md b/content/operate/rs/7.4/networking/port-configurations.md index 16afb5513e..41789f230e 100644 --- a/content/operate/rs/7.4/networking/port-configurations.md +++ b/content/operate/rs/7.4/networking/port-configurations.md @@ -27,7 +27,7 @@ Redis Enterprise Software's port usage falls into three general categories: | Protocol | Port | Configurable | Connection source | Description | |----------|------|--------------|-------------------|-------------| -| TCP | 8001 | ❌ No | Internal, External | Traffic from application to Redis Enterprise Software [Discovery Service]({{< relref "/operate/rs/databases/durability-ha/discovery-service.md" >}}) | +| TCP | 8001 | ❌ No | Internal, External | Traffic from application to Redis Enterprise Software [Discovery Service]({{< relref "/operate/rs/7.4/databases/durability-ha/discovery-service.md" >}}) | | TCP | 8000, 8070, 8071, 9090, 9125 | ❌ No | Internal, External | Metrics exported and managed by the web proxy | | TCP | 8443 | ✅ Yes | Internal, External | Secure (HTTPS) access to the management web UI | | TCP | 9081 | ✅ Yes | Internal | CRDB coordinator for Active-Active management (internal) | @@ -48,7 +48,7 @@ Redis Enterprise Software's port usage falls into three general categories: Redis Enterprise Software reserves some ports by default (`system_reserved_ports`). To reserve other ports or port ranges and prevent the cluster from assigning them to database endpoints, configure `reserved_ports` using one of the following methods: -- [rladmin cluster config]({{< relref "/operate/rs/references/cli-utilities/rladmin/cluster/config" >}}) +- [rladmin cluster config]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/cluster/config" >}}) ```sh rladmin cluster config reserved_ports @@ -60,7 +60,7 @@ Redis Enterprise Software reserves some ports by default (`system_reserved_ports rladmin cluster config reserved_ports 11000 13000-13010 ``` -- [Update cluster settings]({{< relref "/operate/rs/references/rest-api/requests/cluster#put-cluster" >}}) REST API request +- [Update cluster settings]({{< relref "/operate/rs/7.4/references/rest-api/requests/cluster#put-cluster" >}}) REST API request ```sh PUT /v1/cluster @@ -97,7 +97,7 @@ For system health monitoring, Redis uses the following ports by default: - Port 8006 for gossip envoy admin -You can change each envoy port to a custom port using the [`rladmin cluster config`]({{< relref "/operate/rs/references/cli-utilities/rladmin/cluster/config" >}}) command as long as the new port is not in use by another process. When you change `envoy_admin_port`, expect a restart of envoy. +You can change each envoy port to a custom port using the [`rladmin cluster config`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/cluster/config" >}}) command as long as the new port is not in use by another process. When you change `envoy_admin_port`, expect a restart of envoy. To change the envoy admin port, run: @@ -168,4 +168,4 @@ To poll metrics from the `metrics_exporter` or to access the Cluster Manager UI, ## Nodes on different VLANs Nodes in the same cluster must reside on the same VLAN. If you can't -host the nodes on the same VLAN, then you must open [all ports]({{< relref "/operate/rs/networking/port-configurations.md" >}}) between them. +host the nodes on the same VLAN, then you must open [all ports]({{< relref "/operate/rs/7.4/networking/port-configurations.md" >}}) between them. diff --git a/content/operate/rs/7.4/networking/private-public-endpoints.md b/content/operate/rs/7.4/networking/private-public-endpoints.md index db73f6d1bf..8b3fd6c9a2 100644 --- a/content/operate/rs/7.4/networking/private-public-endpoints.md +++ b/content/operate/rs/7.4/networking/private-public-endpoints.md @@ -11,7 +11,7 @@ title: "Enable private and\_public database endpoints" weight: $weight url: '/operate/rs/7.4/networking/private-public-endpoints/' --- -Each node in Redis Enterprise can be configured with [private and external IP addresses]({{< relref "/operate/rs/networking/multi-ip-ipv6" >}}). By default, Redis Enterprise Software databases expose a single endpoint, e.g. cluster.com (FQDN), using the external IP addresses, making it available to the public network (e.g. the internet). Additionally, the cluster can be configured to expose a private FQDN, which utilizes the private IP addresses for access from the private network only (e.g. VPC or an internal network). +Each node in Redis Enterprise can be configured with [private and external IP addresses]({{< relref "/operate/rs/7.4/networking/multi-ip-ipv6" >}}). By default, Redis Enterprise Software databases expose a single endpoint, e.g. cluster.com (FQDN), using the external IP addresses, making it available to the public network (e.g. the internet). Additionally, the cluster can be configured to expose a private FQDN, which utilizes the private IP addresses for access from the private network only (e.g. VPC or an internal network). When you create a cluster via the UI, you can configure it to expose private and public endpoints. This is common for environments such as cloud platforms and enterprises. diff --git a/content/operate/rs/7.4/new-features-redis-enterprise.md b/content/operate/rs/7.4/new-features-redis-enterprise.md index f0d6ab2268..3d65bdd5e9 100644 --- a/content/operate/rs/7.4/new-features-redis-enterprise.md +++ b/content/operate/rs/7.4/new-features-redis-enterprise.md @@ -27,7 +27,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]({{< relref "/operate/rs/7.4/developing/crdbs" >}}). ## Redis modules @@ -70,7 +70,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.]({{< relref "/operate/rs/7.4/installing-upgrading/get-started-docker.md" >}}) ## LDAP integration @@ -81,4 +81,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]({{< relref "/operate/rs/7.4/security/passwords-users-roles.md#setting-up-ldap" >}}). diff --git a/content/operate/rs/7.4/references/cli-utilities/crdb-cli/_index.md b/content/operate/rs/7.4/references/cli-utilities/crdb-cli/_index.md index 017ae1b864..3f5296ab2a 100644 --- a/content/operate/rs/7.4/references/cli-utilities/crdb-cli/_index.md +++ b/content/operate/rs/7.4/references/cli-utilities/crdb-cli/_index.md @@ -12,7 +12,7 @@ weight: $weight url: '/operate/rs/7.4/references/cli-utilities/crdb-cli/' --- -An [Active-Active database]({{< relref "/operate/rs/databases/active-active/_index.md" >}}) (also known as CRDB or conflict-free replicated database) +An [Active-Active database]({{< relref "/operate/rs/7.4/databases/active-active/_index.md" >}}) (also known as CRDB or conflict-free replicated database) replicates your data across Redis Enterprise Software clusters located in geographically distributed regions. Active-Active databases allow read-write access in all locations, making them ideal for distributed applications that require fast response times and disaster recovery. @@ -21,7 +21,7 @@ Each cluster that hosts an instance is called a **participating cluster**. An Active-Active database requires two or more participating clusters. Each instance is responsible for updating the instances that reside on other participating clusters with the transactions it receives. -Write conflicts are resolved using [conflict-free replicated data types]({{< relref "/operate/rs/databases/active-active" >}}) (CRDTs). +Write conflicts are resolved using [conflict-free replicated data types]({{< relref "/operate/rs/7.4/databases/active-active" >}}) (CRDTs). To programmatically maintain an Active-Active database and its instances, you can use the `crdb-cli` command-line tool. @@ -45,6 +45,6 @@ By default, the command runs immediately and displays the result in the output. If you use the `--no-wait` flag, the command runs in the background so that your application is not delayed by the response. -Use the [`crdb-cli task` commands]({{< relref "/operate/rs/references/cli-utilities/crdb-cli/task/" >}}) to manage Active-Active database tasks. +Use the [`crdb-cli task` commands]({{< relref "/operate/rs/7.4/references/cli-utilities/crdb-cli/task/" >}}) to manage Active-Active database tasks. For each `crdb-cli` command, you can use `--help` for additional information about the command. diff --git a/content/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/create.md b/content/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/create.md index 6f1371fecd..c55b4fcaf8 100644 --- a/content/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/create.md +++ b/content/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/create.md @@ -41,7 +41,7 @@ crdb-cli crdb create --name Before you create an Active-Active database, you must have: - At least two participating clusters -- [Network connectivity]({{< relref "/operate/rs/networking/port-configurations" >}}) between the participating clusters +- [Network connectivity]({{< relref "/operate/rs/7.4/networking/port-configurations" >}}) between the participating clusters ### Parameters @@ -56,18 +56,18 @@ Before you create an Active-Active database, you must have: | default-db-config-file \ | filepath | Default database configuration options from a file | | no-wait | | Prevents `crdb-cli` from running another command before this command finishes | | compression | 0-6 | The level of data compression:

0 = No compression

6 = High compression and resource load (Default: 3) | -| causal-consistency | true
false (*default*) | [Causal consistency]({{< relref "/operate/rs/databases/active-active/causal-consistency.md" >}}) applies updates to all instances in the order they were received | +| causal-consistency | true
false (*default*) | [Causal consistency]({{< relref "/operate/rs/7.4/databases/active-active/causal-consistency.md" >}}) applies updates to all instances in the order they were received | | password \ | string | Password for access to the database | -| replication | true
false (*default*) | Activates or deactivates [database replication]({{< relref "/operate/rs/databases/durability-ha/replication.md" >}}) where every master shard replicates to a replica shard | +| replication | true
false (*default*) | Activates or deactivates [database replication]({{< relref "/operate/rs/7.4/databases/durability-ha/replication.md" >}}) where every master shard replicates to a replica shard | | encryption | true
false (*default*) | Activates or deactivates encryption | -| sharding | true
false (*default*) | Activates or deactivates sharding (also known as [database clustering]({{< relref "/operate/rs/databases/durability-ha/replication.md" >}})). Cannot be updated after the database is created | +| sharding | true
false (*default*) | Activates or deactivates sharding (also known as [database clustering]({{< relref "/operate/rs/7.4/databases/durability-ha/replication.md" >}})). Cannot be updated after the database is created | | shards-count \ | integer | If sharding is enabled, this specifies the number of Redis shards for each database instance | -| oss-cluster | true
false (*default*) | Activates [OSS cluster API]({{< relref "/operate/rs/clusters/optimize/oss-cluster-api" >}}) | -| shard-key-regex \ | string | If clustering is enabled, this defines a regex rule (also known as a [hashing policy]({{< relref "/operate/rs/databases/durability-ha/clustering#custom-hashing-policy" >}})) that determines which keys are located in each shard (defaults to `{u'regex': u'.*\\{(?.*)\\}.*'}, {u'regex': u'(?.*)'} `) | +| oss-cluster | true
false (*default*) | Activates [OSS cluster API]({{< relref "/operate/rs/7.4/clusters/optimize/oss-cluster-api" >}}) | +| shard-key-regex \ | string | If clustering is enabled, this defines a regex rule (also known as a [hashing policy]({{< relref "/operate/rs/7.4/databases/durability-ha/clustering#custom-hashing-policy" >}})) that determines which keys are located in each shard (defaults to `{u'regex': u'.*\\{(?.*)\\}.*'}, {u'regex': u'(?.*)'} `) | | bigstore | true

false (*default*) | If true, the database uses Auto Tiering to add flash memory to the database | | bigstore-ram-size \ | size in bytes, kilobytes (KB), or gigabytes (GB) | Maximum RAM limit for databases with Auto Tiering enabled | | with-module
  name=\,
  version=\,
  args=\ | strings | Creates a database with a specific module | -| eviction-policy | noeviction (*default*)
allkeys-lru
allkeys-lfu
allkeys-random
volatile-lru
volatile-lfu
volatile-random
volatile-ttl | Sets [eviction policy]({{< relref "/operate/rs/databases/memory-performance/eviction-policy" >}}) | +| eviction-policy | noeviction (*default*)
allkeys-lru
allkeys-lfu
allkeys-random
volatile-lru
volatile-lfu
volatile-random
volatile-ttl | Sets [eviction policy]({{< relref "/operate/rs/7.4/databases/memory-performance/eviction-policy" >}}) | | proxy-policy | all-nodes
all-master-shards
single | Sets proxy policy | diff --git a/content/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/purge-instance.md b/content/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/purge-instance.md index 5b0243d369..a6ee794df3 100644 --- a/content/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/purge-instance.md +++ b/content/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/purge-instance.md @@ -20,7 +20,7 @@ crdb-cli crdb purge-instance --crdb-guid [ --no-wait ] ``` -Once this command finishes, the other replicas must remove this instance with [`crdb-cli crdb remove-instance --force`]({{< relref "/operate/rs/references/cli-utilities/crdb-cli/crdb/remove-instance" >}}). +Once this command finishes, the other replicas must remove this instance with [`crdb-cli crdb remove-instance --force`]({{< relref "/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/remove-instance" >}}). ### Parameters diff --git a/content/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/remove-instance.md b/content/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/remove-instance.md index 74980bcafc..59c69ea22f 100644 --- a/content/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/remove-instance.md +++ b/content/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/remove-instance.md @@ -24,7 +24,7 @@ If the cluster cannot communicate with the instance that you want to remove, you 1. Use the `--force` option to remove the instance from the Active-Active database without purging the data from the instance. -1. Run [`crdb-cli crdb purge-instance`]({{< relref "/operate/rs/references/cli-utilities/crdb-cli/crdb/purge-instance" >}}) from the removed instance to delete the Active-Active database and its data. +1. Run [`crdb-cli crdb purge-instance`]({{< relref "/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/purge-instance" >}}) from the removed instance to delete the Active-Active database and its data. ### Parameters @@ -32,7 +32,7 @@ If the cluster cannot communicate with the instance that you want to remove, you |------------------------------|--------|------------| | crdb-guid | string | The GUID of the database (required) | | instance-id | string | The ID of the local instance to remove (required) | -| force | | Removes the instance without purging data from the instance.
If --force is specified, you must run [`crdb-cli crdb purge-instance`]({{< relref "/operate/rs/references/cli-utilities/crdb-cli/crdb/purge-instance" >}}) from the removed instance. | +| force | | Removes the instance without purging data from the instance.
If --force is specified, you must run [`crdb-cli crdb purge-instance`]({{< relref "/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/purge-instance" >}}) from the removed instance. | | no-wait | | Does not wait for the task to complete | ### Returns diff --git a/content/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/update.md b/content/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/update.md index 762521f1f8..ee3cd1bedc 100644 --- a/content/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/update.md +++ b/content/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/update.md @@ -30,7 +30,7 @@ crdb-cli crdb update --crdb-guid [--update-module name=,featureset_version=] ``` -If you want to change the configuration of the local instance only, use [`rladmin`]({{< relref "/operate/rs/references/cli-utilities/rladmin" >}}) instead. +If you want to change the configuration of the local instance only, use [`rladmin`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin" >}}) instead. ### Parameters @@ -39,7 +39,7 @@ If you want to change the configuration of the local instance only, use [`rladmi | crdb-guid \ | string | GUID of the Active-Active database (required) | | bigstore-ram-size \ | size in bytes, kilobytes (KB), or gigabytes (GB) | Maximum RAM limit for the databases with Auto Tiering enabled, if activated | | memory-size \ | size in bytes, kilobytes (KB), or gigabytes (GB) | Maximum database memory (required) | -| causal-consistency | true
false | [Causal consistency]({{< relref "/operate/rs/databases/active-active/causal-consistency.md" >}}) applies updates to all instances in the order they were received | +| causal-consistency | true
false | [Causal consistency]({{< relref "/operate/rs/7.4/databases/active-active/causal-consistency.md" >}}) applies updates to all instances in the order they were received | | compression | 0-6 | The level of data compression:

0 = No compression

6 = High compression and resource load (Default: 3) | | credentials id=\,username=\,password=\ | strings | Updates the credentials for access to the instance | | default-db-config \ | | Default database configuration from stdin | @@ -48,7 +48,7 @@ If you want to change the configuration of the local instance only, use [`rladmi | force | | Force an update even if there are no changes | | no-wait | | Do not wait for the command to finish | | oss-cluster | true
false | Activates or deactivates OSS Cluster mode | -| eviction-policy | noeviction
allkeys-lru
allkeys-lfu
allkeys-random
volatile-lru
volatile-lfu
volatile-random
volatile-ttl | Updates [eviction policy]({{< relref "/operate/rs/databases/memory-performance/eviction-policy" >}}) | +| eviction-policy | noeviction
allkeys-lru
allkeys-lfu
allkeys-random
volatile-lru
volatile-lfu
volatile-random
volatile-ttl | Updates [eviction policy]({{< relref "/operate/rs/7.4/databases/memory-performance/eviction-policy" >}}) | | featureset-version | true
false | Updates to latest FeatureSet version | | update-module name=\,featureset_version=\ | strings | Update a module to the specified version | diff --git a/content/operate/rs/7.4/references/cli-utilities/crdb-cli/task/status.md b/content/operate/rs/7.4/references/cli-utilities/crdb-cli/task/status.md index bd94933368..108926c011 100644 --- a/content/operate/rs/7.4/references/cli-utilities/crdb-cli/task/status.md +++ b/content/operate/rs/7.4/references/cli-utilities/crdb-cli/task/status.md @@ -27,7 +27,7 @@ crdb-cli task status --task-id The `--verbose` and `--no-verbose` options are mutually incompatible; specify one or the other. -The `404 Not Found` error indicates an invalid task ID. Use the [`task list`]({{< relref "/operate/rs/references/cli-utilities/crdb-cli/task/list" >}}) command to determine available task IDs. +The `404 Not Found` error indicates an invalid task ID. Use the [`task list`]({{< relref "/operate/rs/7.4/references/cli-utilities/crdb-cli/task/list" >}}) command to determine available task IDs. ### Returns diff --git a/content/operate/rs/7.4/references/cli-utilities/redis-cli/_index.md b/content/operate/rs/7.4/references/cli-utilities/redis-cli/_index.md index 67ef3d97a4..e962860cb2 100644 --- a/content/operate/rs/7.4/references/cli-utilities/redis-cli/_index.md +++ b/content/operate/rs/7.4/references/cli-utilities/redis-cli/_index.md @@ -26,9 +26,9 @@ To learn how to install Redis and `redis-cli`, see the following installation gu - [Redis Community Edition]({{< relref "/operate/oss_and_stack/install/install-redis/" >}}) -- [Redis Enterprise Software]({{< relref "/operate/rs/installing-upgrading/quickstarts/redis-enterprise-software-quickstart" >}}) +- [Redis Enterprise Software]({{< relref "/operate/rs/7.4/installing-upgrading/quickstarts/redis-enterprise-software-quickstart" >}}) -- [Redis Enterprise Software with Docker]({{< relref "/operate/rs/installing-upgrading/quickstarts/docker-quickstart" >}}) +- [Redis Enterprise Software with Docker]({{< relref "/operate/rs/7.4/installing-upgrading/quickstarts/docker-quickstart" >}}) ## Connect to a database diff --git a/content/operate/rs/7.4/references/cli-utilities/rladmin/_index.md b/content/operate/rs/7.4/references/cli-utilities/rladmin/_index.md index 792c945119..58c3833ebb 100644 --- a/content/operate/rs/7.4/references/cli-utilities/rladmin/_index.md +++ b/content/operate/rs/7.4/references/cli-utilities/rladmin/_index.md @@ -39,6 +39,6 @@ In the `rladmin` shell, you can: - Run any `rladmin` command without prefacing it with `rladmin`. - Enter `?` to view the full list of available commands. -- Enter [`help`]({{< relref "/operate/rs/references/cli-utilities/rladmin/help" >}}) followed by the name of a command for a detailed explanation of the command and its usage. +- Enter [`help`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/help" >}}) followed by the name of a command for a detailed explanation of the command and its usage. - Press the `Tab` key for command completion. - Enter `exit` or press `Control+D` to exit the `rladmin` shell and return to the terminal prompt. diff --git a/content/operate/rs/7.4/references/cli-utilities/rladmin/bind.md b/content/operate/rs/7.4/references/cli-utilities/rladmin/bind.md index 39d06be6c1..31c0944b34 100644 --- a/content/operate/rs/7.4/references/cli-utilities/rladmin/bind.md +++ b/content/operate/rs/7.4/references/cli-utilities/rladmin/bind.md @@ -40,7 +40,7 @@ rladmin bind Returns `Finished successfully` if the list of excluded proxies was successfully changed. Otherwise, it returns an error. -Use [`rladmin status endpoints`]({{< relref "/operate/rs/references/cli-utilities/rladmin/status#status-endpoints" >}}) to verify that the policy changed. +Use [`rladmin status endpoints`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/status#status-endpoints" >}}) to verify that the policy changed. ### Example @@ -86,7 +86,7 @@ rladmin bind Returns `Finished successfully` if the list of included proxies was successfully changed. Otherwise, it returns an error. -Use [`rladmin status endpoints`]({{< relref "/operate/rs/references/cli-utilities/rladmin/status#status-endpoints" >}}) to verify that the policy changed. +Use [`rladmin status endpoints`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/status#status-endpoints" >}}) to verify that the policy changed. ### Example @@ -134,7 +134,7 @@ rladmin bind Returns `Finished successfully` if the proxy policy was successfully changed. Otherwise, it returns an error. -Use [`rladmin status endpoints`]({{< relref "/operate/rs/references/cli-utilities/rladmin/status#status-endpoints" >}}) to verify that the policy changed. +Use [`rladmin status endpoints`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/status#status-endpoints" >}}) to verify that the policy changed. ### Example diff --git a/content/operate/rs/7.4/references/cli-utilities/rladmin/cluster/certificate.md b/content/operate/rs/7.4/references/cli-utilities/rladmin/cluster/certificate.md index 23ecf2dab9..c6ee1581bd 100644 --- a/content/operate/rs/7.4/references/cli-utilities/rladmin/cluster/certificate.md +++ b/content/operate/rs/7.4/references/cli-utilities/rladmin/cluster/certificate.md @@ -24,7 +24,7 @@ rladmin cluster certificate [ key_file ] ``` -To set a certificate for a specific service, use the corresponding certificate name. See the [certificates table]({{< relref "/operate/rs/security/certificates" >}}) for the list of cluster certificates and their descriptions. +To set a certificate for a specific service, use the corresponding certificate name. See the [certificates table]({{< relref "/operate/rs/7.4/security/certificates" >}}) for the list of cluster certificates and their descriptions. ### Parameters diff --git a/content/operate/rs/7.4/references/cli-utilities/rladmin/cluster/config.md b/content/operate/rs/7.4/references/cli-utilities/rladmin/cluster/config.md index d1c4675065..87a22d8a3e 100644 --- a/content/operate/rs/7.4/references/cli-utilities/rladmin/cluster/config.md +++ b/content/operate/rs/7.4/references/cli-utilities/rladmin/cluster/config.md @@ -58,9 +58,9 @@ Updates the cluster configuration. | Parameter | Type/Value | Description | |-----------|------------|-------------| -| audit_address | string | TCP/IP address where a listener can capture [audit event notifications]({{< relref "/operate/rs/security/audit-events" >}}) | -| audit_port | string | Port where a listener can capture [audit event notifications]({{< relref "/operate/rs/security/audit-events" >}}) | -| audit_protocol | `tcp`
`local` | Protocol used for [audit event notifications]({{< relref "/operate/rs/security/audit-events" >}})
For production systems, only `tcp` is supported. | +| audit_address | string | TCP/IP address where a listener can capture [audit event notifications]({{< relref "/operate/rs/7.4/security/audit-events" >}}) | +| audit_port | string | Port where a listener can capture [audit event notifications]({{< relref "/operate/rs/7.4/security/audit-events" >}}) | +| audit_protocol | `tcp`
`local` | Protocol used for [audit event notifications]({{< relref "/operate/rs/7.4/security/audit-events" >}})
For production systems, only `tcp` is supported. | | control_cipher_suites | list of ciphers | Cipher suites used for TLS connections to the Cluster Manager UI (specified in the format understood by the BoringSSL library)
(previously named `cipher_suites`) | | cm_port | integer | UI server listening port | | cm_session_timeout_minutes | integer | Timeout in minutes for the CM session diff --git a/content/operate/rs/7.4/references/cli-utilities/rladmin/failover.md b/content/operate/rs/7.4/references/cli-utilities/rladmin/failover.md index 723fd7bcaf..a699ade44f 100644 --- a/content/operate/rs/7.4/references/cli-utilities/rladmin/failover.md +++ b/content/operate/rs/7.4/references/cli-utilities/rladmin/failover.md @@ -34,7 +34,7 @@ rladmin failover Returns `Finished successfully` if the failover completed. Otherwise, it returns an error. -Use [`rladmin status shards`]({{< relref "/operate/rs/references/cli-utilities/rladmin/status#status-shards" >}}) to verify that the failover completed. +Use [`rladmin status shards`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/status#status-shards" >}}) to verify that the failover completed. ### Example diff --git a/content/operate/rs/7.4/references/cli-utilities/rladmin/migrate.md b/content/operate/rs/7.4/references/cli-utilities/rladmin/migrate.md index e6145f2888..9d477be9ad 100644 --- a/content/operate/rs/7.4/references/cli-utilities/rladmin/migrate.md +++ b/content/operate/rs/7.4/references/cli-utilities/rladmin/migrate.md @@ -16,7 +16,7 @@ url: '/operate/rs/7.4/references/cli-utilities/rladmin/migrate/' Moves Redis Enterprise shards or endpoints to a new node in the same cluster. -For more information about shard migration use cases and considerations, see [Migrate database shards]({{}}). +For more information about shard migration use cases and considerations, see [Migrate database shards]({{}}). ## `migrate all_master_shards` @@ -42,7 +42,7 @@ rladmin migrate { db { db: | } | node } Returns `Done` if the migration completed successfully. Otherwise, returns an error. -Use [`rladmin status shards`]({{< relref "/operate/rs/references/cli-utilities/rladmin/status#status-shards" >}}) to verify the migration completed. +Use [`rladmin status shards`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/status#status-shards" >}}) to verify the migration completed. ### Example @@ -93,7 +93,7 @@ rladmin migrate node Returns `Done` if the migration completed successfully. Otherwise, returns an error. -Use [`rladmin status shards`]({{< relref "/operate/rs/references/cli-utilities/rladmin/status#status-shards" >}}) to verify the migration completed. +Use [`rladmin status shards`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/status#status-shards" >}}) to verify the migration completed. ### Example @@ -148,7 +148,7 @@ rladmin migrate { db { db: | } | node } Returns `Done` if the migration completed successfully. Otherwise, returns an error. -Use [`rladmin status shards`]({{< relref "/operate/rs/references/cli-utilities/rladmin/status#status-shards" >}}) to verify the migration completed. +Use [`rladmin status shards`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/status#status-shards" >}}) to verify the migration completed. ### Example @@ -202,7 +202,7 @@ rladmin migrate [ db { db: | } ] Returns a list of steps to perform the migration. If the `commit` flag is set, the steps will run and return `Finished successfully` if they were completed. Otherwise, returns an error. -Use [`rladmin status endpoints`]({{< relref "/operate/rs/references/cli-utilities/rladmin/status#status-endpoints" >}}) to verify that the endpoints were moved. +Use [`rladmin status endpoints`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/status#status-endpoints" >}}) to verify that the endpoints were moved. ### Example @@ -248,7 +248,7 @@ rladmin migrate shard Returns `Done` if the migration completed successfully. Otherwise, returns an error. -Use [`rladmin status shards`]({{< relref "/operate/rs/references/cli-utilities/rladmin/status#status-shards" >}}) to verify the migration completed. +Use [`rladmin status shards`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/status#status-shards" >}}) to verify the migration completed. ### Example diff --git a/content/operate/rs/7.4/references/cli-utilities/rladmin/node/addr.md b/content/operate/rs/7.4/references/cli-utilities/rladmin/node/addr.md index b5eaaeda5a..d376e77d99 100644 --- a/content/operate/rs/7.4/references/cli-utilities/rladmin/node/addr.md +++ b/content/operate/rs/7.4/references/cli-utilities/rladmin/node/addr.md @@ -13,7 +13,7 @@ weight: $weight url: '/operate/rs/7.4/references/cli-utilities/rladmin/node/addr/' --- -Sets the internal IP address of a node. You can only set the internal IP address when the node is down. See [Change internal IP address]({{< relref "/operate/rs/networking/multi-ip-ipv6#change-internal-ip-address" >}}) for detailed instructions. +Sets the internal IP address of a node. You can only set the internal IP address when the node is down. See [Change internal IP address]({{< relref "/operate/rs/7.4/networking/multi-ip-ipv6#change-internal-ip-address" >}}) for detailed instructions. ```sh rladmin node addr set @@ -30,7 +30,7 @@ rladmin node addr set Returns `Updated successfully` if the IP address was set. Otherwise, it returns an error. -Use [`rladmin status nodes`]({{< relref "/operate/rs/references/cli-utilities/rladmin/status#status-nodes" >}}) to verify the internal IP address was changed. +Use [`rladmin status nodes`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/status#status-nodes" >}}) to verify the internal IP address was changed. ### Example diff --git a/content/operate/rs/7.4/references/cli-utilities/rladmin/node/enslave.md b/content/operate/rs/7.4/references/cli-utilities/rladmin/node/enslave.md index e31a22c2e3..733c03479d 100644 --- a/content/operate/rs/7.4/references/cli-utilities/rladmin/node/enslave.md +++ b/content/operate/rs/7.4/references/cli-utilities/rladmin/node/enslave.md @@ -37,7 +37,7 @@ rladmin node enslave Returns `OK` if the roles were successfully changed. Otherwise, it returns an error. -Use [`rladmin status shards`]({{< relref "/operate/rs/references/cli-utilities/rladmin/status#status-shards" >}}) to verify that the roles were changed. +Use [`rladmin status shards`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/status#status-shards" >}}) to verify that the roles were changed. ### Example @@ -93,7 +93,7 @@ rladmin node enslave endpoints_only Returns `OK` if the roles were successfully changed. Otherwise, it returns an error. -Use [`rladmin status endpoints`]({{< relref "/operate/rs/references/cli-utilities/rladmin/status#status-endpoints" >}}) to verify that the roles were changed. +Use [`rladmin status endpoints`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/status#status-endpoints" >}}) to verify that the roles were changed. ### Example @@ -133,7 +133,7 @@ rladmin node enslave shards_only Returns `OK` if the roles were successfully changed. Otherwise, it returns an error. -Use [`rladmin status shards`]({{< relref "/operate/rs/references/cli-utilities/rladmin/status#status-shards" >}}) to verify that the roles were changed. +Use [`rladmin status shards`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/status#status-shards" >}}) to verify that the roles were changed. ### Example diff --git a/content/operate/rs/7.4/references/cli-utilities/rladmin/node/external-addr.md b/content/operate/rs/7.4/references/cli-utilities/rladmin/node/external-addr.md index 8acea85acc..875bcb9379 100644 --- a/content/operate/rs/7.4/references/cli-utilities/rladmin/node/external-addr.md +++ b/content/operate/rs/7.4/references/cli-utilities/rladmin/node/external-addr.md @@ -35,7 +35,7 @@ rladmin node external_addr Returns `Updated successfully` if the IP address was added. Otherwise, it returns an error. -Use [`rladmin status nodes`]({{< relref "/operate/rs/references/cli-utilities/rladmin/status#status-nodes" >}}) to verify the external IP address was added. +Use [`rladmin status nodes`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/status#status-nodes" >}}) to verify the external IP address was added. ### Example @@ -70,7 +70,7 @@ rladmin node external_addr Returns `Updated successfully` if the IP addresses were set. Otherwise, it returns an error. -Use [`rladmin status nodes`]({{< relref "/operate/rs/references/cli-utilities/rladmin/status#status-nodes" >}}) to verify the external IP address was set. +Use [`rladmin status nodes`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/status#status-nodes" >}}) to verify the external IP address was set. ### Example @@ -104,7 +104,7 @@ rladmin node external_addr Returns `Updated successfully` if the IP address was removed. Otherwise, it returns an error. -Use [`rladmin status nodes`]({{< relref "/operate/rs/references/cli-utilities/rladmin/status#status-nodes" >}}) to verify the external IP address was removed. +Use [`rladmin status nodes`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/status#status-nodes" >}}) to verify the external IP address was removed. ### Example diff --git a/content/operate/rs/7.4/references/cli-utilities/rladmin/node/maintenance-mode.md b/content/operate/rs/7.4/references/cli-utilities/rladmin/node/maintenance-mode.md index adc4094ced..5b2c80394d 100644 --- a/content/operate/rs/7.4/references/cli-utilities/rladmin/node/maintenance-mode.md +++ b/content/operate/rs/7.4/references/cli-utilities/rladmin/node/maintenance-mode.md @@ -13,7 +13,7 @@ weight: $weight url: '/operate/rs/7.4/references/cli-utilities/rladmin/node/maintenance-mode/' --- -Configures [quorum-only mode]({{< relref "/operate/rs/clusters/maintenance-mode#activate-maintenance-mode" >}}) on a node. +Configures [quorum-only mode]({{< relref "/operate/rs/7.4/clusters/maintenance-mode#activate-maintenance-mode" >}}) on a node. ## `node maintenance_mode on` @@ -47,7 +47,7 @@ rladmin node maintenance_mode on Returns `OK` if the node was converted successfully. If the cluster does not have enough resources to migrate the shards, the process returns a warning. -Use [`rladmin status nodes`]({{< relref "/operate/rs/references/cli-utilities/rladmin/status#status-nodes" >}}) to verify the node became a quorum node. +Use [`rladmin status nodes`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/status#status-nodes" >}}) to verify the node became a quorum node. ### Example @@ -91,7 +91,7 @@ rladmin node maintenance_mode off Returns `OK` if the node was restored successfully. -Use [`rladmin status nodes`]({{< relref "/operate/rs/references/cli-utilities/rladmin/status#status-nodes" >}}) to verify the node was restored. +Use [`rladmin status nodes`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/status#status-nodes" >}}) to verify the node was restored. ### Example diff --git a/content/operate/rs/7.4/references/cli-utilities/rladmin/node/recovery-path.md b/content/operate/rs/7.4/references/cli-utilities/rladmin/node/recovery-path.md index 67e4cc7c73..393f38a52e 100644 --- a/content/operate/rs/7.4/references/cli-utilities/rladmin/node/recovery-path.md +++ b/content/operate/rs/7.4/references/cli-utilities/rladmin/node/recovery-path.md @@ -13,7 +13,7 @@ weight: $weight url: '/operate/rs/7.4/references/cli-utilities/rladmin/node/recovery-path/' --- -Sets the node's local recovery path, which specifies the directory where [persistence files]({{< relref "/operate/rs/databases/configure/database-persistence" >}}) are stored. You can use these persistence files to [recover a failed database]({{< relref "/operate/rs/databases/recover" >}}). +Sets the node's local recovery path, which specifies the directory where [persistence files]({{< relref "/operate/rs/7.4/databases/configure/database-persistence" >}}) are stored. You can use these persistence files to [recover a failed database]({{< relref "/operate/rs/7.4/databases/recover" >}}). ```sh rladmin node recovery_path set diff --git a/content/operate/rs/7.4/references/cli-utilities/rladmin/node/remove.md b/content/operate/rs/7.4/references/cli-utilities/rladmin/node/remove.md index 415918f64b..1442ec4928 100644 --- a/content/operate/rs/7.4/references/cli-utilities/rladmin/node/remove.md +++ b/content/operate/rs/7.4/references/cli-utilities/rladmin/node/remove.md @@ -30,7 +30,7 @@ rladmin node remove [ wait_for_persistence { enabled | disabled } ] Returns `OK` if the node was removed successfully. Otherwise, it returns an error. -Use [`rladmin status nodes`]({{< relref "/operate/rs/references/cli-utilities/rladmin/status#status-nodes" >}}) to verify that the node was removed. +Use [`rladmin status nodes`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/status#status-nodes" >}}) to verify that the node was removed. ### Example diff --git a/content/operate/rs/7.4/references/cli-utilities/rladmin/placement.md b/content/operate/rs/7.4/references/cli-utilities/rladmin/placement.md index 6db0a78099..972ca6136f 100644 --- a/content/operate/rs/7.4/references/cli-utilities/rladmin/placement.md +++ b/content/operate/rs/7.4/references/cli-utilities/rladmin/placement.md @@ -33,7 +33,7 @@ rladmin placement Returns the new shard placement policy if the policy was changed successfully. Otherwise, it returns an error. -Use [`rladmin status databases`]({{< relref "/operate/rs/references/cli-utilities/rladmin/status#status-databases" >}}) to verify that the failover completed. +Use [`rladmin status databases`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/status#status-databases" >}}) to verify that the failover completed. ### Example diff --git a/content/operate/rs/7.4/references/cli-utilities/rladmin/recover.md b/content/operate/rs/7.4/references/cli-utilities/rladmin/recover.md index 72c4c79828..57a2f4bc97 100644 --- a/content/operate/rs/7.4/references/cli-utilities/rladmin/recover.md +++ b/content/operate/rs/7.4/references/cli-utilities/rladmin/recover.md @@ -13,9 +13,9 @@ weight: $weight url: '/operate/rs/7.4/references/cli-utilities/rladmin/recover/' --- -Recovers databases in recovery mode after events such as cluster failure, and restores the databases' configurations and data from stored persistence files. See [Recover a failed database]({{< relref "/operate/rs/databases/recover" >}}) for detailed instructions. +Recovers databases in recovery mode after events such as cluster failure, and restores the databases' configurations and data from stored persistence files. See [Recover a failed database]({{< relref "/operate/rs/7.4/databases/recover" >}}) for detailed instructions. -Database persistence files are stored in `/var/opt/redislabs/persist/redis/` by default, but you can specify a different directory to use for database recovery with [`rladmin node recovery_path set `]({{< relref "/operate/rs/references/cli-utilities/rladmin/node/recovery-path" >}}). +Database persistence files are stored in `/var/opt/redislabs/persist/redis/` by default, but you can specify a different directory to use for database recovery with [`rladmin node recovery_path set `]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/node/recovery-path" >}}). ## `recover all` diff --git a/content/operate/rs/7.4/references/cli-utilities/rladmin/tune.md b/content/operate/rs/7.4/references/cli-utilities/rladmin/tune.md index 56b6fcea19..5ea8e46a1e 100644 --- a/content/operate/rs/7.4/references/cli-utilities/rladmin/tune.md +++ b/content/operate/rs/7.4/references/cli-utilities/rladmin/tune.md @@ -56,13 +56,13 @@ rladmin tune cluster |----------------------------------------|-----------------------------------|------------------------------------------------------------------------------------------------------------------------------| | acl_pubsub_default | `resetchannels`
`allchannels` | Default pub/sub ACL rule for all databases in the cluster:
•`resetchannels` blocks access to all channels (restrictive)
•`allchannels` allows access to all channels (permissive) | | automatic_node_offload | `enabled`
`disabled` | Define whether automatic node offload migration will take place | -| data_internode_encryption | `enabled`
`disabled` | Activates or deactivates [internode encryption]({{< relref "/operate/rs/security/encryption/internode-encryption" >}}) for new databases | -| db_conns_auditing | `enabled`
`disabled` | Activates or deactivates [connection auditing]({{< relref "/operate/rs/security/audit-events" >}}) by default for new databases of a cluster | +| data_internode_encryption | `enabled`
`disabled` | Activates or deactivates [internode encryption]({{< relref "/operate/rs/7.4/security/encryption/internode-encryption" >}}) for new databases | +| db_conns_auditing | `enabled`
`disabled` | Activates or deactivates [connection auditing]({{< relref "/operate/rs/7.4/security/audit-events" >}}) by default for new databases of a cluster | | default_concurrent_restore_actions | integer
`all` | Default number of concurrent actions when restoring a node from a snapshot (positive integer or "all") | -| default_non_sharded_proxy_policy | `single`

`all-master-shards`

`all-nodes` | Default [proxy policy]({{< relref "/operate/rs/databases/configure/proxy-policy" >}}) for newly created non-sharded databases' endpoints | +| default_non_sharded_proxy_policy | `single`

`all-master-shards`

`all-nodes` | Default [proxy policy]({{< relref "/operate/rs/7.4/databases/configure/proxy-policy" >}}) for newly created non-sharded databases' endpoints | | default_redis_version | version number | The default Redis database compatibility version used to create new databases.

The value parameter should be a version number in the form of "x.y" where _x_ represents the major version number and _y_ represents the minor version number. The final value corresponds to the desired version of Redis.

You cannot set _default_redis_version_ to a value higher than that supported by the current _redis_upgrade_policy_ value. | -| default_sharded_proxy_policy | `single`

`all-master-shards`

`all-nodes` | Default [proxy policy]({{< relref "/operate/rs/databases/configure/proxy-policy" >}}) for newly created sharded databases' endpoints | -| default_shards_placement | `dense`
`sparse` | New databases place shards according to the default [shard placement policy]({{< relref "/operate/rs/databases/memory-performance/shard-placement-policy" >}}) | +| default_sharded_proxy_policy | `single`

`all-master-shards`

`all-nodes` | Default [proxy policy]({{< relref "/operate/rs/7.4/databases/configure/proxy-policy" >}}) for newly created sharded databases' endpoints | +| default_shards_placement | `dense`
`sparse` | New databases place shards according to the default [shard placement policy]({{< relref "/operate/rs/7.4/databases/memory-performance/shard-placement-policy" >}}) | | expose_hostnames_for_all_suffixes | `enabled`
`disabled` | Exposes hostnames for all DNS suffixes | | failure_detection_sensitivity | `high`
`low` | Predefined thresholds and timeouts for failure detection (previously known as `watchdog_profile`)
• `high` (previously `local-network`) – high failure detection sensitivity, lower thresholds, faster failure detection and failover
• `low` (previously `cloud`) – low failure detection sensitivity, higher tolerance for latency variance (also called network jitter) | | login_lockout_counter_reset_after | time in seconds | Time after failed login attempt before the counter resets to 0 | @@ -79,17 +79,17 @@ rladmin tune cluster | repl_diskless | `enabled`
`disabled` | Activates or deactivates diskless replication (can be overridden per database) | | resp3_default | `enabled`
`disabled` | Determines the default value of the `resp3` option upon upgrading a database to version 7.2 (defaults to `enabled`) | | show_internals | `enabled`
`disabled` | Controls the visibility of internal databases that are only used for the cluster's management | -| slave_ha | `enabled`
`disabled` | Activates or deactivates [replica high availability]({{< relref "/operate/rs/databases/configure/replica-ha" >}}) in the cluster
(enabled by default; use [`rladmin tune db`](#tune-db) to change `slave_ha` for a specific database)

Deprecated as of Redis Enterprise Software v7.2.4. | -| slave_ha_bdb_cooldown_period | time in seconds (default: 7200) | Time (in seconds) a database must wait after its shards are relocated by [replica high availability]({{< relref "/operate/rs/databases/configure/replica-ha" >}}) before it can go through another shard migration if another node fails (default is 2 hours) | -| slave_ha_cooldown_period | time in seconds (default: 3600) | Time (in seconds) [replica high availability]({{< relref "/operate/rs/databases/configure/replica-ha" >}}) must wait after relocating shards due to node failure before performing another shard migration for any database in the cluster (default is 1 hour) | -| slave_ha_grace_period | time in seconds (default: 600) | Time (in seconds) between when a node fails and when [replica high availability]({{< relref "/operate/rs/databases/configure/replica-ha" >}}) starts relocating shards to another node | +| slave_ha | `enabled`
`disabled` | Activates or deactivates [replica high availability]({{< relref "/operate/rs/7.4/databases/configure/replica-ha" >}}) in the cluster
(enabled by default; use [`rladmin tune db`](#tune-db) to change `slave_ha` for a specific database)

Deprecated as of Redis Enterprise Software v7.2.4. | +| slave_ha_bdb_cooldown_period | time in seconds (default: 7200) | Time (in seconds) a database must wait after its shards are relocated by [replica high availability]({{< relref "/operate/rs/7.4/databases/configure/replica-ha" >}}) before it can go through another shard migration if another node fails (default is 2 hours) | +| slave_ha_cooldown_period | time in seconds (default: 3600) | Time (in seconds) [replica high availability]({{< relref "/operate/rs/7.4/databases/configure/replica-ha" >}}) must wait after relocating shards due to node failure before performing another shard migration for any database in the cluster (default is 1 hour) | +| slave_ha_grace_period | time in seconds (default: 600) | Time (in seconds) between when a node fails and when [replica high availability]({{< relref "/operate/rs/7.4/databases/configure/replica-ha" >}}) starts relocating shards to another node | | watchdog_profile | `cloud`
`local-network` | Watchdog profiles with preconfigured thresholds and timeouts (deprecated as of Redis Enterprise Software v6.4.2-69; use `failure_detection_sensitivity` instead)
• `cloud` is suitable for common cloud environments and has a higher tolerance for latency variance (also called network jitter).
• `local-network` is suitable for dedicated LANs and has better failure detection and failover times. | ### Returns Returns `Finished successfully` if the cluster configuration was changed. Otherwise, it returns an error. -Use [`rladmin info cluster`]({{< relref "/operate/rs/references/cli-utilities/rladmin/info#info-cluster" >}}) to verify the cluster configuration was changed. +Use [`rladmin info cluster`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/info#info-cluster" >}}) to verify the cluster configuration was changed. ### Example @@ -156,8 +156,8 @@ rladmin tune db { db: | } | continue_on_error | | Flag that skips tuning shards that can't be reached | | crdt_repl_backlog | value in MB
`auto` | Size of the Active-Active replication buffer | | crdt_xadd_id_uniqueness_mode | `liberal`
`semi-strict`
`strict` | XADD's behavior in an Active-Active database, defined as liberal, semi-strict, or strict (see descriptions below) | -| data_internode_encryption | `enabled`
`disabled` | Activates or deactivates [internode encryption]({{< relref "/operate/rs/security/encryption/internode-encryption" >}}) for the database | -| db_conns_auditing | `enabled`
`disabled` | Activates or deactivates database [connection auditing]({{< relref "/operate/rs/security/audit-events" >}}) for a database | +| data_internode_encryption | `enabled`
`disabled` | Activates or deactivates [internode encryption]({{< relref "/operate/rs/7.4/security/encryption/internode-encryption" >}}) for the database | +| db_conns_auditing | `enabled`
`disabled` | Activates or deactivates database [connection auditing]({{< relref "/operate/rs/7.4/security/audit-events" >}}) for a database | | gradual_src_mode | `enabled`
`disabled` | Activates or deactivates gradual sync of sources | | gradual_sync_max_shards_per_source | integer | Number of shards per sync source that can be replicated in parallel (positive integer) | | gradual_sync_mode | `enabled`
`disabled`
`auto` | Activates, deactivates, or automatically determines gradual sync of source shards | @@ -198,7 +198,7 @@ rladmin tune db { db: | } Returns `Finished successfully` if the database configuration was changed. Otherwise, it returns an error. -Use [`rladmin info db`]({{< relref "/operate/rs/references/cli-utilities/rladmin/info#info-db" >}}) to verify the database configuration was changed. +Use [`rladmin info db`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/info#info-db" >}}) to verify the database configuration was changed. ### Example @@ -239,7 +239,7 @@ tune node { | all } Returns `Finished successfully` if the node configuration was changed. Otherwise, it returns an error. -Use [`rladmin info node`]({{< relref "/operate/rs/references/cli-utilities/rladmin/info#info-node" >}}) to verify the node configuration was changed. +Use [`rladmin info node`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/info#info-node" >}}) to verify the node configuration was changed. ### Example @@ -279,7 +279,7 @@ rladmin tune proxy { | all } Returns `OK` if the proxy configuration was changed. Otherwise, it returns an error. -Use [`rladmin info proxy`]({{< relref "/operate/rs/references/cli-utilities/rladmin/info#info-proxy" >}}) to verify the proxy configuration was changed. +Use [`rladmin info proxy`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/info#info-proxy" >}}) to verify the proxy configuration was changed. ### Example diff --git a/content/operate/rs/7.4/references/cli-utilities/rladmin/upgrade.md b/content/operate/rs/7.4/references/cli-utilities/rladmin/upgrade.md index 7e69981e06..0dd3559062 100644 --- a/content/operate/rs/7.4/references/cli-utilities/rladmin/upgrade.md +++ b/content/operate/rs/7.4/references/cli-utilities/rladmin/upgrade.md @@ -19,7 +19,7 @@ Upgrades the version of a module or Redis Enterprise Software for a database. Schedules a restart of the primary and replica processes of a database and then upgrades the database to the latest version of Redis Enterprise Software. -For more information, see [Upgrade an existing Redis Software Deployment]({{< relref "/operate/rs/installing-upgrading/upgrading" >}}). +For more information, see [Upgrade an existing Redis Software Deployment]({{< relref "/operate/rs/7.4/installing-upgrading/upgrading" >}}). ```sh rladmin upgrade db { db: | } @@ -34,7 +34,7 @@ rladmin upgrade db { db: | } [ { latest_with_modules | and module module_name version module_args } ] ``` -As of v6.2.4, the default behavior for `upgrade db` has changed. It is now controlled by a new parameter that sets the default upgrade policy used to create new databases and to upgrade ones already in the cluster. To learn more, see [`tune cluster default_redis_version`]({{< relref "/operate/rs/references/cli-utilities/rladmin/tune#tune-cluster" >}}). +As of v6.2.4, the default behavior for `upgrade db` has changed. It is now controlled by a new parameter that sets the default upgrade policy used to create new databases and to upgrade ones already in the cluster. To learn more, see [`tune cluster default_redis_version`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/tune#tune-cluster" >}}). ### Parameters diff --git a/content/operate/rs/7.4/references/cli-utilities/rladmin/verify.md b/content/operate/rs/7.4/references/cli-utilities/rladmin/verify.md index 0ce8768186..05744281af 100644 --- a/content/operate/rs/7.4/references/cli-utilities/rladmin/verify.md +++ b/content/operate/rs/7.4/references/cli-utilities/rladmin/verify.md @@ -23,15 +23,15 @@ Prints a balance report that displays all of the unbalanced endpoints or nodes i rladmin verify balance [ node ] ``` -The [proxy policy]({{< relref "/operate/rs/databases/configure/proxy-policy#proxy-policies" >}}) determines which nodes or endpoints to report as unbalanced. +The [proxy policy]({{< relref "/operate/rs/7.4/databases/configure/proxy-policy#proxy-policies" >}}) determines which nodes or endpoints to report as unbalanced. A node is unbalanced if: - `all-nodes` proxy policy and the node has no endpoint An endpoint is unbalanced in the following cases: - `single` proxy policy and one of the following is true: - - Shard placement is [`sparse`]({{< relref "/operate/rs/databases/memory-performance/shard-placement-policy.md#sparse-shard-placement-policy" >}}) and none of the master shards are on the node - - Shard placement is [`dense`]({{< relref "/operate/rs/databases/memory-performance/shard-placement-policy.md#dense-shard-placement-policy" >}}) and some master shards are on a different node from the endpoint + - Shard placement is [`sparse`]({{< relref "/operate/rs/7.4/databases/memory-performance/shard-placement-policy.md#sparse-shard-placement-policy" >}}) and none of the master shards are on the node + - Shard placement is [`dense`]({{< relref "/operate/rs/7.4/databases/memory-performance/shard-placement-policy.md#dense-shard-placement-policy" >}}) and some master shards are on a different node from the endpoint - `all-master-shards` proxy policy and one of the following is true: - None of the master shards are on the node - Some master shards are on a different node from the endpoint @@ -68,7 +68,7 @@ NODE:ID DB:ID NAME ENDPOINT:ID PROXY_POLICY LOCAL SHARDS TOTAL SHARDS ## `verify rack_aware` -Verifies that the cluster complies with the rack awareness policy and reports any discovered rack collisions, if [rack-zone awareness]({{< relref "/operate/rs/clusters/configure/rack-zone-awareness" >}}) is enabled. +Verifies that the cluster complies with the rack awareness policy and reports any discovered rack collisions, if [rack-zone awareness]({{< relref "/operate/rs/7.4/clusters/configure/rack-zone-awareness" >}}) is enabled. ```sh rladmin verify rack_aware diff --git a/content/operate/rs/7.4/references/clustering-redis.md b/content/operate/rs/7.4/references/clustering-redis.md index 1e10d54833..eb2a2c1469 100644 --- a/content/operate/rs/7.4/references/clustering-redis.md +++ b/content/operate/rs/7.4/references/clustering-redis.md @@ -28,4 +28,4 @@ There are several solutions to clustering Redis, most notable of which is the [R Redis Enterprise Software and Redis Cloud were built from the ground up to provide a Redis cluster of any size while supporting all Redis commands. Your dataset is distributed across multiple shards in multiple nodes of the Redis cluster and is constantly monitored to ensure optimal performance. When needed, more shards and nodes can be added to your dataset so it can scale continuously and limitlessly. -Redis Enterprise clusters provide a single endpoint to connect to, and do not require any code changes or special configuration from the application’s perspective. For more information on setting up and using Redis Enterprise clusters, see [Database clustering]({{< relref "/operate/rs/databases/durability-ha/clustering/" >}}). +Redis Enterprise clusters provide a single endpoint to connect to, and do not require any code changes or special configuration from the application’s perspective. For more information on setting up and using Redis Enterprise clusters, see [Database clustering]({{< relref "/operate/rs/7.4/databases/durability-ha/clustering/" >}}). diff --git a/content/operate/rs/7.4/references/compatibility/_index.md b/content/operate/rs/7.4/references/compatibility/_index.md index 2ff64c820b..54f716b756 100644 --- a/content/operate/rs/7.4/references/compatibility/_index.md +++ b/content/operate/rs/7.4/references/compatibility/_index.md @@ -19,8 +19,8 @@ Both Redis Enterprise Software and [Redis Cloud]({{< relref "/operate/rc" >}}) a ## RESP compatibility -Redis Enterprise Software and Redis Cloud support RESP2 and RESP3. See [RESP compatibility with Redis Enterprise]({{< relref "/operate/rs/references/compatibility/resp" >}}) for more information. +Redis Enterprise Software and Redis Cloud support RESP2 and RESP3. See [RESP compatibility with Redis Enterprise]({{< relref "/operate/rs/7.4/references/compatibility/resp" >}}) for more information. ## Compatibility with open source Redis Cluster API -Redis Enterprise supports [Redis OSS Cluster API]({{< relref "/operate/rs/clusters/optimize/oss-cluster-api" >}}) if it is enabled for a database. For more information, see [Enable OSS Cluster API]({{< relref "/operate/rs/databases/configure/oss-cluster-api" >}}). +Redis Enterprise supports [Redis OSS Cluster API]({{< relref "/operate/rs/7.4/clusters/optimize/oss-cluster-api" >}}) if it is enabled for a database. For more information, see [Enable OSS Cluster API]({{< relref "/operate/rs/7.4/databases/configure/oss-cluster-api" >}}). diff --git a/content/operate/rs/7.4/references/compatibility/commands/cluster.md b/content/operate/rs/7.4/references/compatibility/commands/cluster.md index 7585ee4638..d3bfe6cd8a 100644 --- a/content/operate/rs/7.4/references/compatibility/commands/cluster.md +++ b/content/operate/rs/7.4/references/compatibility/commands/cluster.md @@ -12,7 +12,7 @@ weight: 10 url: '/operate/rs/7.4/references/compatibility/commands/cluster/' --- -[Clustering in Redis Enterprise Software]({{< relref "/operate/rs/databases/durability-ha/clustering" >}}) and [Redis Cloud]({{< relref "/operate/rc/databases/configuration/clustering" >}}) differs from the [Redis Community Edition cluster]({{}}) and works with all standard Redis clients. +[Clustering in Redis Enterprise Software]({{< relref "/operate/rs/7.4/databases/durability-ha/clustering" >}}) and [Redis Cloud]({{< relref "/operate/rc/databases/configuration/clustering" >}}) differs from the [Redis Community Edition cluster]({{}}) and works with all standard Redis clients. Redis Enterprise blocks most [cluster commands]({{< relref "/commands" >}}?group=cluster). If you try to use a blocked cluster command, it returns an error. @@ -30,14 +30,14 @@ Redis Enterprise blocks most [cluster commands]({{< relref "/commands" >}}?group | [CLUSTER FLUSHSLOTS]({{< relref "/commands/cluster-flushslots" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | | [CLUSTER FORGET]({{< relref "/commands/cluster-forget" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | | [CLUSTER GETKEYSINSLOT]({{< relref "/commands/cluster-getkeysinslot" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [CLUSTER HELP]({{< relref "/commands/cluster-help" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Only supported with the [OSS cluster API]({{< relref "/operate/rs/databases/configure/oss-cluster-api" >}}). | -| [CLUSTER INFO]({{< relref "/commands/cluster-info" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Only supported with the [OSS cluster API]({{< relref "/operate/rs/databases/configure/oss-cluster-api" >}}). | -| [CLUSTER KEYSLOT]({{< relref "/commands/cluster-keyslot" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Only supported with the [OSS cluster API]({{< relref "/operate/rs/databases/configure/oss-cluster-api" >}}). | +| [CLUSTER HELP]({{< relref "/commands/cluster-help" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Only supported with the [OSS cluster API]({{< relref "/operate/rs/7.4/databases/configure/oss-cluster-api" >}}). | +| [CLUSTER INFO]({{< relref "/commands/cluster-info" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Only supported with the [OSS cluster API]({{< relref "/operate/rs/7.4/databases/configure/oss-cluster-api" >}}). | +| [CLUSTER KEYSLOT]({{< relref "/commands/cluster-keyslot" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Only supported with the [OSS cluster API]({{< relref "/operate/rs/7.4/databases/configure/oss-cluster-api" >}}). | | [CLUSTER LINKS]({{< relref "/commands/cluster-links" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | | [CLUSTER MEET]({{< relref "/commands/cluster-meet" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | | [CLUSTER MYID]({{< relref "/commands/cluster-myid" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | | [CLUSTER MYSHARDID]({{< relref "/commands/cluster-myshardid" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [CLUSTER NODES]({{< relref "/commands/cluster-nodes" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Only supported with the [OSS cluster API]({{< relref "/operate/rs/databases/configure/oss-cluster-api" >}}). | +| [CLUSTER NODES]({{< relref "/commands/cluster-nodes" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Only supported with the [OSS cluster API]({{< relref "/operate/rs/7.4/databases/configure/oss-cluster-api" >}}). | | [CLUSTER REPLICAS]({{< relref "/commands/cluster-replicas" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | | [CLUSTER REPLICATE]({{< relref "/commands/cluster-replicate" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | | [CLUSTER RESET]({{< relref "/commands/cluster-reset" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | @@ -46,6 +46,6 @@ Redis Enterprise blocks most [cluster commands]({{< relref "/commands" >}}?group | [CLUSTER SETSLOT]({{< relref "/commands/cluster-setslot" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | | [CLUSTER SHARDS]({{< relref "/commands/cluster-shards" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | | [CLUSTER SLAVES]({{< relref "/commands/cluster-slaves" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | Deprecated as of Redis v5.0.0. | -| [CLUSTER SLOTS]({{< relref "/commands/cluster-slots" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Only supported with the [OSS cluster API]({{< relref "/operate/rs/databases/configure/oss-cluster-api" >}}). Deprecated as of Redis v7.0.0. | +| [CLUSTER SLOTS]({{< relref "/commands/cluster-slots" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Only supported with the [OSS cluster API]({{< relref "/operate/rs/7.4/databases/configure/oss-cluster-api" >}}). Deprecated as of Redis v7.0.0. | | [READONLY]({{< relref "/commands/readonly" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | | [READWRITE]({{< relref "/commands/readwrite" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | diff --git a/content/operate/rs/7.4/references/compatibility/commands/connection.md b/content/operate/rs/7.4/references/compatibility/commands/connection.md index 36124c33a3..e331b5a680 100644 --- a/content/operate/rs/7.4/references/compatibility/commands/connection.md +++ b/content/operate/rs/7.4/references/compatibility/commands/connection.md @@ -21,7 +21,7 @@ The following tables show which Redis Community Edition [connection management c | [CLIENT CACHING]({{< relref "/commands/client-caching" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | | [CLIENT GETNAME]({{< relref "/commands/client-getname" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | | [CLIENT GETREDIR]({{< relref "/commands/client-getredir" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [CLIENT ID]({{< relref "/commands/client-id" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Because Redis Enterprise clustering allows [multiple active proxies]({{< relref "/operate/rs/databases/configure/proxy-policy" >}}), `CLIENT ID` cannot guarantee incremental IDs between clients that connect to different nodes under multi proxy policies. | +| [CLIENT ID]({{< relref "/commands/client-id" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Because Redis Enterprise clustering allows [multiple active proxies]({{< relref "/operate/rs/7.4/databases/configure/proxy-policy" >}}), `CLIENT ID` cannot guarantee incremental IDs between clients that connect to different nodes under multi proxy policies. | | [CLIENT INFO]({{< relref "/commands/client-info" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | | [CLIENT KILL]({{< relref "/commands/client-kill" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | | [CLIENT LIST]({{< relref "/commands/client-list" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | diff --git a/content/operate/rs/7.4/references/compatibility/commands/server.md b/content/operate/rs/7.4/references/compatibility/commands/server.md index 01d3d9ac6a..499352bdeb 100644 --- a/content/operate/rs/7.4/references/compatibility/commands/server.md +++ b/content/operate/rs/7.4/references/compatibility/commands/server.md @@ -17,7 +17,7 @@ The following tables show which Redis Community Edition [server management comma ## Access control commands -Several access control list (ACL) commands are not available in Redis Enterprise. Instead, you can manage access controls from the [Redis Enterprise Software Cluster Manager UI]({{< relref "/operate/rs/security/access-control" >}}) and the [Redis Cloud console]({{< relref "/operate/rc/security/access-control/data-access-control/role-based-access-control.md" >}}). +Several access control list (ACL) commands are not available in Redis Enterprise. Instead, you can manage access controls from the [Redis Enterprise Software Cluster Manager UI]({{< relref "/operate/rs/7.4/security/access-control" >}}) and the [Redis Cloud console]({{< relref "/operate/rc/security/access-control/data-access-control/role-based-access-control.md" >}}). | Command | Redis
Enterprise | Redis
Cloud | Notes | |:--------|:----------------------|:-----------------|:------| @@ -40,10 +40,10 @@ Several access control list (ACL) commands are not available in Redis Enterprise | Command | Redis
Enterprise | Redis
Cloud | Notes | |:--------|:----------------------|:-----------------|:------| -| [CONFIG GET]({{< relref "/commands/config-get" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | [Only supports a subset of configuration settings.]({{< relref "/operate/rs/references/compatibility/config-settings" >}}) | +| [CONFIG GET]({{< relref "/commands/config-get" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | [Only supports a subset of configuration settings.]({{< relref "/operate/rs/7.4/references/compatibility/config-settings" >}}) | | [CONFIG RESETSTAT]({{< relref "/commands/config-resetstat" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | | [CONFIG REWRITE]({{< relref "/commands/config-rewrite" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [CONFIG SET]({{< relref "/commands/config-set" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | [Only supports a subset of configuration settings.]({{< relref "/operate/rs/references/compatibility/config-settings" >}}) | +| [CONFIG SET]({{< relref "/commands/config-set" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | [Only supports a subset of configuration settings.]({{< relref "/operate/rs/7.4/references/compatibility/config-settings" >}}) | ## General server commands @@ -59,8 +59,8 @@ Several access control list (ACL) commands are not available in Redis Enterprise | [COMMAND INFO]({{< relref "/commands/command-info" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | | [COMMAND LIST]({{< relref "/commands/command-list" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | | [DEBUG]({{< relref "/commands/debug" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [FLUSHALL]({{< relref "/commands/flushall" >}}) | ✅ Standard
❌ Active-Active\* | ✅ Standard
❌ Active-Active | \*Can use the [Active-Active flush API request]({{< relref "/operate/rs/references/rest-api/requests/crdbs/flush" >}}). | -| [FLUSHDB]({{< relref "/commands/flushdb" >}}) | ✅ Standard
❌ Active-Active\* | ✅ Standard
❌ Active-Active | \*Can use the [Active-Active flush API request]({{< relref "/operate/rs/references/rest-api/requests/crdbs/flush" >}}). | +| [FLUSHALL]({{< relref "/commands/flushall" >}}) | ✅ Standard
❌ Active-Active\* | ✅ Standard
❌ Active-Active | \*Can use the [Active-Active flush API request]({{< relref "/operate/rs/7.4/references/rest-api/requests/crdbs/flush" >}}). | +| [FLUSHDB]({{< relref "/commands/flushdb" >}}) | ✅ Standard
❌ Active-Active\* | ✅ Standard
❌ Active-Active | \*Can use the [Active-Active flush API request]({{< relref "/operate/rs/7.4/references/rest-api/requests/crdbs/flush" >}}). | | [LOLWUT]({{< relref "/commands/lolwut" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | | [SHUTDOWN]({{< relref "/commands/shutdown" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | | [SWAPDB]({{< relref "/commands/swapdb" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | @@ -69,7 +69,7 @@ Several access control list (ACL) commands are not available in Redis Enterprise ## Module commands -For Redis Enterprise Software, you can [manage Redis modules]({{< relref "/operate/oss_and_stack/stack-with-enterprise/install/" >}}) from the Cluster Manager UI or with [REST API requests]({{< relref "/operate/rs/references/rest-api/requests/modules" >}}). +For Redis Enterprise Software, you can [manage Redis modules]({{< relref "/operate/oss_and_stack/stack-with-enterprise/install/" >}}) from the Cluster Manager UI or with [REST API requests]({{< relref "/operate/rs/7.4/references/rest-api/requests/modules" >}}). Redis Cloud manages modules for you and lets you [enable modules]({{< relref "/operate/rc/databases/create-database#modules" >}}) when you create a database. @@ -84,7 +84,7 @@ Redis Cloud manages modules for you and lets you [enable modules]({{< relref "/o ## Monitoring commands -Although Redis Enterprise does not support certain monitoring commands, you can use the Cluster Manager UI to view Redis Enterprise Software [metrics]({{< relref "/operate/rs/clusters/monitoring" >}}) and [logs]({{< relref "/operate/rs/clusters/logging" >}}) or the Redis Cloud console to view Redis Cloud [metrics]({{< relref "/operate/rc/databases/monitor-performance" >}}) and [logs]({{< relref "/operate/rc/logs-reports/system-logs" >}}). +Although Redis Enterprise does not support certain monitoring commands, you can use the Cluster Manager UI to view Redis Enterprise Software [metrics]({{< relref "/operate/rs/7.4/clusters/monitoring" >}}) and [logs]({{< relref "/operate/rs/7.4/clusters/logging" >}}) or the Redis Cloud console to view Redis Cloud [metrics]({{< relref "/operate/rc/databases/monitor-performance" >}}) and [logs]({{< relref "/operate/rc/logs-reports/system-logs" >}}). | Command | Redis
Enterprise | Redis
Cloud | Notes | |:--------|:----------------------|:-----------------|:------| @@ -111,7 +111,7 @@ Although Redis Enterprise does not support certain monitoring commands, you can ## Persistence commands -Data persistence and backup commands are not available in Redis Enterprise. Instead, you can [manage data persistence]({{< relref "/operate/rs/databases/configure/database-persistence" >}}) and [backups]({{< relref "/operate/rs/databases/import-export/schedule-backups" >}}) from the Redis Enterprise Software Cluster Manager UI and the [Redis Cloud console]({{< relref "/operate/rc/databases/view-edit-database#durability-section" >}}). +Data persistence and backup commands are not available in Redis Enterprise. Instead, you can [manage data persistence]({{< relref "/operate/rs/7.4/databases/configure/database-persistence" >}}) and [backups]({{< relref "/operate/rs/7.4/databases/import-export/schedule-backups" >}}) from the Redis Enterprise Software Cluster Manager UI and the [Redis Cloud console]({{< relref "/operate/rc/databases/view-edit-database#durability-section" >}}). | Command | Redis
Enterprise | Redis
Cloud | Notes | |:--------|:----------------------|:-----------------|:------| @@ -123,7 +123,7 @@ Data persistence and backup commands are not available in Redis Enterprise. Inst ## Replication commands -Redis Enterprise automatically manages [replication]({{< relref "/operate/rs/databases/durability-ha/replication" >}}). +Redis Enterprise automatically manages [replication]({{< relref "/operate/rs/7.4/databases/durability-ha/replication" >}}). | Command | Redis
Enterprise | Redis
Cloud | Notes | |:--------|:----------------------|:-----------------|:------| diff --git a/content/operate/rs/7.4/references/compatibility/resp.md b/content/operate/rs/7.4/references/compatibility/resp.md index f7091b9c62..a7fbd96488 100644 --- a/content/operate/rs/7.4/references/compatibility/resp.md +++ b/content/operate/rs/7.4/references/compatibility/resp.md @@ -39,7 +39,7 @@ To use RESP3 with a Redis Enterprise Software database: 1. Enable RESP3 support for your database (`enabled` by default): - - [`rladmin tune db`]({{< relref "/operate/rs/references/cli-utilities/rladmin/tune#tune-db" >}}): + - [`rladmin tune db`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/tune#tune-db" >}}): ```sh rladmin tune db db: resp3 enabled @@ -47,7 +47,7 @@ To use RESP3 with a Redis Enterprise Software database: You can use the database name in place of `db:` in the preceding command. - - [Update database configuration]({{< relref "/operate/rs/references/rest-api/requests/bdbs#put-bdbs" >}}) REST API request: + - [Update database configuration]({{< relref "/operate/rs/7.4/references/rest-api/requests/bdbs#put-bdbs" >}}) REST API request: ```sh PUT /v1/bdbs/ @@ -58,7 +58,7 @@ To use RESP3 with a Redis Enterprise Software database: To deactivate RESP3 support for a database: -- [`rladmin tune db`]({{< relref "/operate/rs/references/cli-utilities/rladmin/tune#tune-db" >}}): +- [`rladmin tune db`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/tune#tune-db" >}}): ```sh rladmin tune db db: resp3 disabled @@ -66,7 +66,7 @@ To use RESP3 with a Redis Enterprise Software database: You can use the database name in place of `db:` in the preceding command. -- [Update database configuration]({{< relref "/operate/rs/references/rest-api/requests/bdbs#put-bdbs" >}}) REST API request: +- [Update database configuration]({{< relref "/operate/rs/7.4/references/rest-api/requests/bdbs#put-bdbs" >}}) REST API request: ```sh PUT /v1/bdbs/ @@ -95,13 +95,13 @@ To change `resp3_default` to `disabled`, use one of the following methods: 1. Click **Save**. -- [`rladmin tune cluster`]({{< relref "/operate/rs/references/cli-utilities/rladmin/tune#tune-cluster" >}}) +- [`rladmin tune cluster`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/tune#tune-cluster" >}}) ```sh rladmin tune cluster resp3_default disabled ``` -- [Update cluster policy]({{< relref "/operate/rs/references/rest-api/requests/cluster/policy#put-cluster-policy" >}}) REST API request: +- [Update cluster policy]({{< relref "/operate/rs/7.4/references/rest-api/requests/cluster/policy#put-cluster-policy" >}}) REST API request: ```sh PUT /v1/cluster/policy diff --git a/content/operate/rs/7.4/references/memtier-benchmark.md b/content/operate/rs/7.4/references/memtier-benchmark.md index 4aed9f3a01..a7fbfe5ea4 100644 --- a/content/operate/rs/7.4/references/memtier-benchmark.md +++ b/content/operate/rs/7.4/references/memtier-benchmark.md @@ -57,8 +57,8 @@ You can run all of these tests on Amazon AWS with these hosts: To learn how to install Redis Enterprise Software and set up a cluster, see: -- [Redis Enterprise Software quickstart]({{< relref "/operate/rs/installing-upgrading/quickstarts/redis-enterprise-software-quickstart" >}}) for a test installation -- [Install and upgrade]({{< relref "/operate/rs/installing-upgrading" >}}) for a production installation +- [Redis Enterprise Software quickstart]({{< relref "/operate/rs/7.4/installing-upgrading/quickstarts/redis-enterprise-software-quickstart" >}}) for a test installation +- [Install and upgrade]({{< relref "/operate/rs/7.4/installing-upgrading" >}}) for a production installation These tests use a quorum node to reduce AWS EC2 instance use while maintaining the three nodes required to support a quorum node in case of node failure. Quorum nodes can be on less powerful instances because they do not have shards or support traffic. diff --git a/content/operate/rs/7.4/references/metrics/_index.md b/content/operate/rs/7.4/references/metrics/_index.md index 95b76abb21..5c792112b2 100644 --- a/content/operate/rs/7.4/references/metrics/_index.md +++ b/content/operate/rs/7.4/references/metrics/_index.md @@ -13,12 +13,12 @@ weight: $weight url: '/operate/rs/7.4/references/metrics/' --- -In the Redis Enterprise Cluster Manager UI, you can see real-time performance metrics for clusters, nodes, databases, and shards, and configure alerts that send notifications based on alert parameters. Select the **Metrics** tab to view the metrics for each component. For more information, see [Monitoring with metrics and alerts]({{< relref "/operate/rs/clusters/monitoring" >}}). +In the Redis Enterprise Cluster Manager UI, you can see real-time performance metrics for clusters, nodes, databases, and shards, and configure alerts that send notifications based on alert parameters. Select the **Metrics** tab to view the metrics for each component. For more information, see [Monitoring with metrics and alerts]({{< relref "/operate/rs/7.4/clusters/monitoring" >}}). See the following topics for metrics definitions: -- [Database operations]({{< relref "/operate/rs/references/metrics/database-operations" >}}) for database metrics -- [Resource usage]({{< relref "/operate/rs/references/metrics/resource-usage" >}}) for resource and database usage metrics -- [Auto Tiering]({{< relref "/operate/rs/references/metrics/auto-tiering" >}}) for additional metrics for [Auto Tiering ]({{< relref "/operate/rs/databases/auto-tiering" >}}) databases +- [Database operations]({{< relref "/operate/rs/7.4/references/metrics/database-operations" >}}) for database metrics +- [Resource usage]({{< relref "/operate/rs/7.4/references/metrics/resource-usage" >}}) for resource and database usage metrics +- [Auto Tiering]({{< relref "/operate/rs/7.4/references/metrics/auto-tiering" >}}) for additional metrics for [Auto Tiering ]({{< relref "/operate/rs/7.4/databases/auto-tiering" >}}) databases ## Prometheus metrics @@ -37,13 +37,13 @@ Metrics information is not shown for clusters with more than 128 shards. For lar ### Metrics not shown during shard migration -The following metrics are not measured during [shard migration]({{< relref "/operate/rs/databases/configure/replica-ha" >}}). If you view these metrics while resharding, the graph will be blank. +The following metrics are not measured during [shard migration]({{< relref "/operate/rs/7.4/databases/configure/replica-ha" >}}). If you view these metrics while resharding, the graph will be blank. -- [Evicted objects/sec]({{< relref "/operate/rs/references/metrics/database-operations#evicted-objectssec" >}}) -- [Expired objects/sec]({{< relref "/operate/rs/references/metrics/database-operations#expired-objectssec" >}}) -- [Read misses/sec]({{< relref "/operate/rs/references/metrics/database-operations#read-missessec" >}}) -- [Write misses/sec]({{< relref "/operate/rs/references/metrics/database-operations#write-missessec" >}}) -- [Total keys]({{< relref "/operate/rs/references/metrics/database-operations#total-keys" >}}) -- [Incoming traffic]({{< relref "/operate/rs/references/metrics/resource-usage#incoming-traffic" >}}) -- [Outgoing traffic]({{< relref "/operate/rs/references/metrics/resource-usage#outgoing-traffic" >}}) -- [Used memory]({{< relref "/operate/rs/references/metrics/resource-usage#used-memory" >}}) +- [Evicted objects/sec]({{< relref "/operate/rs/7.4/references/metrics/database-operations#evicted-objectssec" >}}) +- [Expired objects/sec]({{< relref "/operate/rs/7.4/references/metrics/database-operations#expired-objectssec" >}}) +- [Read misses/sec]({{< relref "/operate/rs/7.4/references/metrics/database-operations#read-missessec" >}}) +- [Write misses/sec]({{< relref "/operate/rs/7.4/references/metrics/database-operations#write-missessec" >}}) +- [Total keys]({{< relref "/operate/rs/7.4/references/metrics/database-operations#total-keys" >}}) +- [Incoming traffic]({{< relref "/operate/rs/7.4/references/metrics/resource-usage#incoming-traffic" >}}) +- [Outgoing traffic]({{< relref "/operate/rs/7.4/references/metrics/resource-usage#outgoing-traffic" >}}) +- [Used memory]({{< relref "/operate/rs/7.4/references/metrics/resource-usage#used-memory" >}}) diff --git a/content/operate/rs/7.4/references/metrics/auto-tiering.md b/content/operate/rs/7.4/references/metrics/auto-tiering.md index 0ad2c91d7d..e05170480a 100644 --- a/content/operate/rs/7.4/references/metrics/auto-tiering.md +++ b/content/operate/rs/7.4/references/metrics/auto-tiering.md @@ -11,7 +11,7 @@ weight: $weight url: '/operate/rs/7.4/references/metrics/auto-tiering/' --- -These metrics are additional metrics for [Auto Tiering ]({{< relref "/operate/rs/databases/auto-tiering" >}}) databases. +These metrics are additional metrics for [Auto Tiering ]({{< relref "/operate/rs/7.4/databases/auto-tiering" >}}) databases. #### % Values in RAM @@ -25,13 +25,13 @@ If the percent of values in RAM is low for a subset of the database's shards, it #### Values in flash -Number of keys with values stored in flash, not including [replication]({{< relref "/operate/rs/databases/durability-ha/replication" >}}). +Number of keys with values stored in flash, not including [replication]({{< relref "/operate/rs/7.4/databases/durability-ha/replication" >}}). **Components measured**: Database and Shard #### Values in RAM -Number of keys with values stored in RAM, not including [replication]({{< relref "/operate/rs/databases/durability-ha/replication" >}}). +Number of keys with values stored in RAM, not including [replication]({{< relref "/operate/rs/7.4/databases/durability-ha/replication" >}}). **Components measured**: Database and Shard @@ -85,7 +85,7 @@ Ratio between the used logical flash memory and the physical flash memory that i #### Used RAM -Total size of data stored in RAM, including keys, values, overheads, and [replication]({{< relref "/operate/rs/databases/durability-ha/replication" >}}) (if enabled). +Total size of data stored in RAM, including keys, values, overheads, and [replication]({{< relref "/operate/rs/7.4/databases/durability-ha/replication" >}}) (if enabled). **Components measured**: Database and Shard @@ -122,7 +122,7 @@ These RoF statistics can be calculated from other metrics. - RoF average key size with overhead ([ram_dataset_overhead](#ram-dataset-overhead) * [used_ram](#used-ram)) - / ([total_keys]({{< relref "/operate/rs/references/metrics/database-operations#total-keys" >}}) * 2) + / ([total_keys]({{< relref "/operate/rs/7.4/references/metrics/database-operations#total-keys" >}}) * 2) - RoF average value size in RAM diff --git a/content/operate/rs/7.4/references/metrics/database-operations.md b/content/operate/rs/7.4/references/metrics/database-operations.md index 3b3021cac1..c082457c33 100644 --- a/content/operate/rs/7.4/references/metrics/database-operations.md +++ b/content/operate/rs/7.4/references/metrics/database-operations.md @@ -16,9 +16,9 @@ url: '/operate/rs/7.4/references/metrics/database-operations/' Number of objects evicted from the database per second. -Objects are evicted from the database according to the [eviction policy]({{< relref "/operate/rs/databases/memory-performance/eviction-policy" >}}). +Objects are evicted from the database according to the [eviction policy]({{< relref "/operate/rs/7.4/databases/memory-performance/eviction-policy" >}}). -Object information is not measured during [shard migration]({{< relref "/operate/rs/databases/configure/replica-ha" >}}). +Object information is not measured during [shard migration]({{< relref "/operate/rs/7.4/databases/configure/replica-ha" >}}). **Components measured**: Database and Shard @@ -26,7 +26,7 @@ Object information is not measured during [shard migration]({{< relref "/operate Number of expired objects per second. -Object information is not measured during [shard migration]({{< relref "/operate/rs/databases/configure/replica-ha" >}}). +Object information is not measured during [shard migration]({{< relref "/operate/rs/7.4/databases/configure/replica-ha" >}}). **Components measured**: Database and Shard @@ -40,7 +40,7 @@ Ratio of the number of operations on existing keys out of the total number of op The number of [read operations](#readssec) per second on keys that do not exist. -Read misses are not measured during [shard migration]({{< relref "/operate/rs/databases/configure/replica-ha" >}}). +Read misses are not measured during [shard migration]({{< relref "/operate/rs/7.4/databases/configure/replica-ha" >}}). **Components measured**: Database @@ -48,7 +48,7 @@ Read misses are not measured during [shard migration]({{< relref "/operate/rs/da Number of [write operations](#writessec) per second on keys that do not exist. -Write misses are not measured during [shard migration]({{< relref "/operate/rs/databases/configure/replica-ha" >}}). +Write misses are not measured during [shard migration]({{< relref "/operate/rs/7.4/databases/configure/replica-ha" >}}). **Components measured**: Database and Shard @@ -88,7 +88,7 @@ Number of total operations per second, which includes [read operations](#readsse Number of total read operations per second. -To find out which commands are read operations, run the following command with [`redis-cli`]({{< relref "/operate/rs/references/cli-utilities/redis-cli" >}}): +To find out which commands are read operations, run the following command with [`redis-cli`]({{< relref "/operate/rs/7.4/references/cli-utilities/redis-cli" >}}): ```sh ACL CAT read @@ -100,7 +100,7 @@ ACL CAT read Number of total write operations per second. -To find out which commands are write operations, run the following command with [`redis-cli`]({{< relref "/operate/rs/references/cli-utilities/redis-cli" >}}): +To find out which commands are write operations, run the following command with [`redis-cli`]({{< relref "/operate/rs/7.4/references/cli-utilities/redis-cli" >}}): ```sh ACL CAT write @@ -110,11 +110,11 @@ ACL CAT write #### Pending writes min -Minimum number of write operations queued per [Active-Active]({{< relref "/operate/rs/databases/active-active" >}}) replica database. +Minimum number of write operations queued per [Active-Active]({{< relref "/operate/rs/7.4/databases/active-active" >}}) replica database. #### Pending writes max -Maximum number of write operations queued per [Active-Active]({{< relref "/operate/rs/databases/active-active" >}}) replica database. +Maximum number of write operations queued per [Active-Active]({{< relref "/operate/rs/7.4/databases/active-active" >}}) replica database. ### Other commands/sec @@ -128,9 +128,9 @@ Examples of other operations include [PING]({{< relref "/commands/ping" >}}), [A Total number of keys in the dataset. -Does not include replicated keys, even if [replication]({{< relref "/operate/rs/databases/durability-ha/replication" >}}) is enabled. +Does not include replicated keys, even if [replication]({{< relref "/operate/rs/7.4/databases/durability-ha/replication" >}}) is enabled. -Total keys is not measured during [shard migration]({{< relref "/operate/rs/databases/configure/replica-ha" >}}). +Total keys is not measured during [shard migration]({{< relref "/operate/rs/7.4/databases/configure/replica-ha" >}}). **Components measured**: Database diff --git a/content/operate/rs/7.4/references/metrics/resource-usage.md b/content/operate/rs/7.4/references/metrics/resource-usage.md index 9105741db8..980e35b527 100644 --- a/content/operate/rs/7.4/references/metrics/resource-usage.md +++ b/content/operate/rs/7.4/references/metrics/resource-usage.md @@ -50,7 +50,7 @@ Remaining unused disk space. ## Memory ### Used memory -Total memory used by the database, including RAM, [Flash]({{< relref "/operate/rs/databases/auto-tiering" >}}) (if enabled), and [replication]({{< relref "/operate/rs/databases/durability-ha/replication" >}}) (if enabled). +Total memory used by the database, including RAM, [Flash]({{< relref "/operate/rs/7.4/databases/auto-tiering" >}}) (if enabled), and [replication]({{< relref "/operate/rs/7.4/databases/durability-ha/replication" >}}) (if enabled). Used memory does not include: @@ -62,7 +62,7 @@ Used memory does not include: - A database snapshot process - AOF rewrite process -Used memory is not measured during [shard migration]({{< relref "/operate/rs/databases/configure/replica-ha" >}}). +Used memory is not measured during [shard migration]({{< relref "/operate/rs/7.4/databases/configure/replica-ha" >}}). **Components measured**: Database and Shard @@ -89,23 +89,23 @@ Percent of memory used by Redis out of the [memory limit](#memory-limit). Total incoming traffic to the database in bytes/sec. -All incoming traffic is not measured during [shard migration]({{< relref "/operate/rs/databases/configure/replica-ha" >}}). +All incoming traffic is not measured during [shard migration]({{< relref "/operate/rs/7.4/databases/configure/replica-ha" >}}). **Components measured**: Cluster, Node and Database #### Incoming traffic compressed -Total incoming compressed traffic (in bytes/sec) per [Active-Active]({{< relref "/operate/rs/databases/active-active" >}}) replica database. +Total incoming compressed traffic (in bytes/sec) per [Active-Active]({{< relref "/operate/rs/7.4/databases/active-active" >}}) replica database. #### Incoming traffic uncompressed -Total incoming uncompressed traffic (in bytes/sec) per [Active-Active]({{< relref "/operate/rs/databases/active-active" >}}) replica database. +Total incoming uncompressed traffic (in bytes/sec) per [Active-Active]({{< relref "/operate/rs/7.4/databases/active-active" >}}) replica database. ### Outgoing traffic Total outgoing traffic from the database in bytes per second. -Outgoing traffic is not measured during [shard migration]({{< relref "/operate/rs/databases/configure/replica-ha" >}}). +Outgoing traffic is not measured during [shard migration]({{< relref "/operate/rs/7.4/databases/configure/replica-ha" >}}). **Components measured**: Cluster, Node and Database diff --git a/content/operate/rs/7.4/references/rest-api/_index.md b/content/operate/rs/7.4/references/rest-api/_index.md index baef0e7f6e..7eca191d25 100644 --- a/content/operate/rs/7.4/references/rest-api/_index.md +++ b/content/operate/rs/7.4/references/rest-api/_index.md @@ -16,10 +16,10 @@ Here, you'll find the details of the API and how to use it. For more info, see: -- Supported [request endpoints]({{< relref "/operate/rs/references/rest-api/requests" >}}), organized by path -- Supported [objects]({{< relref "/operate/rs/references/rest-api/objects" >}}), both request and response -- Built-in roles and associated [permissions]({{< relref "/operate/rs/references/rest-api/permissions" >}}) -- [Redis Enterprise Software REST API quick start]({{< relref "/operate/rs/references/rest-api/quick-start" >}}) with examples +- Supported [request endpoints]({{< relref "/operate/rs/7.4/references/rest-api/requests" >}}), organized by path +- Supported [objects]({{< relref "/operate/rs/7.4/references/rest-api/objects" >}}), both request and response +- Built-in roles and associated [permissions]({{< relref "/operate/rs/7.4/references/rest-api/permissions" >}}) +- [Redis Enterprise Software REST API quick start]({{< relref "/operate/rs/7.4/references/rest-api/quick-start" >}}) with examples ## Authentication @@ -34,23 +34,23 @@ curl -u "demo@redislabs.com:password" \ https://localhost:9443/v1/bdbs ``` -For more examples, see the [Redis Enterprise Software REST API quick start]({{< relref "/operate/rs/references/rest-api/quick-start" >}}). +For more examples, see the [Redis Enterprise Software REST API quick start]({{< relref "/operate/rs/7.4/references/rest-api/quick-start" >}}). ### Permissions -By default, the admin user is authorized for access to all endpoints. Use [role-based access controls]({{< relref "/operate/rs/security/access-control" >}}) and [role permissions]({{< relref "/operate/rs/references/rest-api/permissions" >}}) to manage access. +By default, the admin user is authorized for access to all endpoints. Use [role-based access controls]({{< relref "/operate/rs/7.4/security/access-control" >}}) and [role permissions]({{< relref "/operate/rs/7.4/references/rest-api/permissions" >}}) to manage access. -If a user attempts to access an endpoint that is not allowed in their role, the request will fail with a [`403 Forbidden`](https://www.rfc-editor.org/rfc/rfc9110.html#name-403-forbidden) status code. For more details on which user roles can access certain endpoints, see [Permissions]({{< relref "/operate/rs/references/rest-api/permissions" >}}). +If a user attempts to access an endpoint that is not allowed in their role, the request will fail with a [`403 Forbidden`](https://www.rfc-editor.org/rfc/rfc9110.html#name-403-forbidden) status code. For more details on which user roles can access certain endpoints, see [Permissions]({{< relref "/operate/rs/7.4/references/rest-api/permissions" >}}). ### Certificates -The Redis Enterprise Software REST API uses [Self-signed certificates]({{< relref "/operate/rs/security/certificates" >}}) to ensure the product is secure. When you use the default self-signed certificates, the HTTPS requests will fail with `SSL certificate problem: self signed certificate` unless you turn off SSL certificate verification. +The Redis Enterprise Software REST API uses [Self-signed certificates]({{< relref "/operate/rs/7.4/security/certificates" >}}) to ensure the product is secure. When you use the default self-signed certificates, the HTTPS requests will fail with `SSL certificate problem: self signed certificate` unless you turn off SSL certificate verification. ## Ports All calls must be made over SSL to port 9443. For the API to work, port 9443 must be exposed to incoming traffic or mapped to a different port. -If you are using a [Redis Enterprise Software Docker image]({{< relref "/operate/rs/installing-upgrading/quickstarts/docker-quickstart" >}}), run the following command to start the Docker image with port 9443 exposed: +If you are using a [Redis Enterprise Software Docker image]({{< relref "/operate/rs/7.4/installing-upgrading/quickstarts/docker-quickstart" >}}), run the following command to start the Docker image with port 9443 exposed: ```sh docker run -p 9443:9443 redislabs/redis @@ -67,7 +67,7 @@ Specify the version in the request [URI](https://en.wikipedia.org/wiki/Uniform_R | POST `/v1/bdbs` | A version 1 request for the `/bdbs` endpoint. | | POST `/v2/bdbs` | A version 2 request for the `/bdbs` endpoint. | -When an endpoint supports multiple versions, each version is documented on the corresponding endpoint. For example, the [bdbs request]({{< relref "/operate/rs/references/rest-api/requests/bdbs/" >}}) page documents POST requests for [version 1]({{< relref "/operate/rs/references/rest-api/requests/bdbs/#post-bdbs-v1" >}}) and [version 2]({{< relref "/operate/rs/references/rest-api/requests/bdbs/#post-bdbs-v2" >}}). +When an endpoint supports multiple versions, each version is documented on the corresponding endpoint. For example, the [bdbs request]({{< relref "/operate/rs/7.4/references/rest-api/requests/bdbs/" >}}) page documents POST requests for [version 1]({{< relref "/operate/rs/7.4/references/rest-api/requests/bdbs/#post-bdbs-v1" >}}) and [version 2]({{< relref "/operate/rs/7.4/references/rest-api/requests/bdbs/#post-bdbs-v2" >}}). ## Headers diff --git a/content/operate/rs/7.4/references/rest-api/objects/_index.md b/content/operate/rs/7.4/references/rest-api/objects/_index.md index 5fa93c3751..b04f4f1689 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/_index.md +++ b/content/operate/rs/7.4/references/rest-api/objects/_index.md @@ -12,7 +12,7 @@ weight: 40 url: '/operate/rs/7.4/references/rest-api/objects/' --- -Certain [REST API requests]({{< relref "/operate/rs/references/rest-api/requests" >}}) require you to include specific objects in the request body. Many requests also return objects in the response body. +Certain [REST API requests]({{< relref "/operate/rs/7.4/references/rest-api/requests" >}}) require you to include specific objects in the request body. Many requests also return objects in the response body. Both REST API requests and responses represent these objects as [JSON](https://www.json.org). diff --git a/content/operate/rs/7.4/references/rest-api/objects/alert.md b/content/operate/rs/7.4/references/rest-api/objects/alert.md index 234931e693..73e4e8e565 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/alert.md +++ b/content/operate/rs/7.4/references/rest-api/objects/alert.md @@ -13,7 +13,7 @@ url: '/operate/rs/7.4/references/rest-api/objects/alert/' You can view, configure, and enable various alerts for the cluster. -Alerts are bound to a cluster object (such as a [BDB]({{< relref "/operate/rs/references/rest-api/objects/bdb" >}}) or [node]({{< relref "/operate/rs/references/rest-api/objects/node" >}})), and the cluster's state determines whether the alerts turn on or off. +Alerts are bound to a cluster object (such as a [BDB]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb" >}}) or [node]({{< relref "/operate/rs/7.4/references/rest-api/objects/node" >}})), and the cluster's state determines whether the alerts turn on or off. Name | Type/Value | Description | Writable |-------|------------|-------------|----------| diff --git a/content/operate/rs/7.4/references/rest-api/objects/bdb/_index.md b/content/operate/rs/7.4/references/rest-api/objects/bdb/_index.md index 2e6bb4f7eb..b77a37443a 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/bdb/_index.md +++ b/content/operate/rs/7.4/references/rest-api/objects/bdb/_index.md @@ -36,7 +36,7 @@ An API object that represents a managed database in the cluster. | backup_history | integer (default: 0); Backup history retention policy (number of days, 0 is forever) | | backup_interval | integer; Interval in seconds in which automatic backup will be initiated | | backup_interval_offset | integer; Offset (in seconds) from round backup interval when automatic backup will be initiated (should be less than backup_interval) | -| backup_location | [complex object]({{< relref "/operate/rs/references/rest-api/objects/bdb/backup_location" >}}); Target for automatic database backups.
Call `GET` `/jsonschema` to retrieve the object's structure. | +| backup_location | [complex object]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb/backup_location" >}}); Target for automatic database backups.
Call `GET` `/jsonschema` to retrieve the object's structure. | | backup_progress | number, (range: 0-100); Database scheduled periodic backup progress (percentage) (read-only) | | backup_status | Status of scheduled periodic backup process (read-only)
Values:
'exporting'
'succeeded'
'failed' | | bigstore | boolean (default: false); Database bigstore option | @@ -56,16 +56,16 @@ An API object that represents a managed database in the cluster. | crdt_repl_backlog_size | string; Active-Active replication backlog size ('auto' or size in bytes) | | crdt_replica_id | integer; Local replica ID, for internal use only. | | crdt_replicas | string; Replica set configuration, for internal use only. | -| crdt_sources | array of [syncer_sources]({{< relref "/operate/rs/references/rest-api/objects/bdb/syncer_sources" >}}) objects; Remote endpoints/peers of CRDB database to sync from. See the 'bdb -\> replica_sources' section | -| crdt_sync | Enable, disable, or pause syncing from specified crdt_sources. Applicable only for Active-Active databases. See [replica_sync]({{< relref "/operate/rs/references/rest-api/objects/bdb/replica_sync" >}}) for more details.
Values:
'enabled'
**'disabled'**
'paused'
'stopped' | +| crdt_sources | array of [syncer_sources]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb/syncer_sources" >}}) objects; Remote endpoints/peers of CRDB database to sync from. See the 'bdb -\> replica_sources' section | +| crdt_sync | Enable, disable, or pause syncing from specified crdt_sources. Applicable only for Active-Active databases. See [replica_sync]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb/replica_sync" >}}) for more details.
Values:
'enabled'
**'disabled'**
'paused'
'stopped' | | crdt_sync_dist | boolean; Enable/disable distributed syncer in master-master | | crdt_syncer_auto_oom_unlatch | boolean (default: true); Syncer automatically attempts to recover synchronisation from peers after this database throws an Out-Of-Memory error. Otherwise, the syncer exits | | crdt_xadd_id_uniqueness_mode | XADD strict ID uniqueness mode. CRDT only.
Values:
‘liberal’
**‘strict’**
‘semi-strict’ | | created_time | string; The date and time the database was created (read-only) | | data_internode_encryption | boolean; Should the data plane internode communication for this database be encrypted | -| data_persistence | Database on-disk persistence policy. For snapshot persistence, a [snapshot_policy]({{< relref "/operate/rs/references/rest-api/objects/bdb/snapshot_policy" >}}) must be provided
Values:
**'disabled'**
'snapshot'
'aof' | -| dataset_import_sources | [complex object]({{< relref "/operate/rs/references/rest-api/objects/bdb/dataset_import_sources" >}}); Array of source file location description objects to import from when performing an import action. This is write-only and cannot be read after set.
Call `GET /v1/jsonschema` to retrieve the object's structure. | -| db_conns_auditing | boolean; Enables/deactivates [database connection auditing]({{< relref "/operate/rs/security/audit-events" >}}) | +| data_persistence | Database on-disk persistence policy. For snapshot persistence, a [snapshot_policy]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb/snapshot_policy" >}}) must be provided
Values:
**'disabled'**
'snapshot'
'aof' | +| dataset_import_sources | [complex object]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb/dataset_import_sources" >}}); Array of source file location description objects to import from when performing an import action. This is write-only and cannot be read after set.
Call `GET /v1/jsonschema` to retrieve the object's structure. | +| db_conns_auditing | boolean; Enables/deactivates [database connection auditing]({{< relref "/operate/rs/7.4/security/audit-events" >}}) | | default_user | boolean (default: true); Allow/disallow a default user to connect | | disabled_commands | string (default: ); Redis commands which are disabled in db | | dns_address_master | string; Database private address endpoint FQDN (read-only) (deprecated as of Redis Enterprise v4.3.3) | @@ -116,8 +116,8 @@ An API object that represents a managed database in the cluster. | recovery_wait_time | integer (default: -1); Defines how many seconds to wait for the persistence file to become available during auto recovery. After the wait time expires, auto recovery completes with potential data loss. The default `-1` means to wait forever. | | redis_version | string; Version of the redis-server processes: e.g. 6.0, 5.0-big | | repl_backlog_size | string; Redis replication backlog size ('auto' or size in bytes) | -| replica_sources | array of [syncer_sources]({{< relref "/operate/rs/references/rest-api/objects/bdb/syncer_sources" >}}) objects; Remote endpoints of database to sync from. See the 'bdb -\> replica_sources' section | -| [replica_sync]({{< relref "/operate/rs/references/rest-api/objects/bdb/replica_sync" >}}) | Enable, disable, or pause syncing from specified replica_sources
Values:
'enabled'
**'disabled'**
'paused'
'stopped' | +| replica_sources | array of [syncer_sources]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb/syncer_sources" >}}) objects; Remote endpoints of database to sync from. See the 'bdb -\> replica_sources' section | +| [replica_sync]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb/replica_sync" >}}) | Enable, disable, or pause syncing from specified replica_sources
Values:
'enabled'
**'disabled'**
'paused'
'stopped' | | replica_sync_dist | boolean; Enable/disable distributed syncer in replica-of | | replication | boolean (default: false); In-memory database replication mode | | resp3 | boolean (default: true); Enables or deactivates RESP3 support | @@ -134,11 +134,11 @@ An API object that represents a managed database in the cluster. | slave_buffer | Redis replica output buffer limits
Values:
'auto'
value in MB
hard:soft:time | | slave_ha | boolean; Enable replica high availability mechanism for this database (default takes the cluster setting) | | slave_ha_priority | integer; Priority of the BDB in replica high availability mechanism | -| snapshot_policy | array of [snapshot_policy]({{< relref "/operate/rs/references/rest-api/objects/bdb/snapshot_policy" >}}) objects; Policy for snapshot-based data persistence. A dataset snapshot will be taken every N secs if there are at least M writes changes in the dataset | +| snapshot_policy | array of [snapshot_policy]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb/snapshot_policy" >}}) objects; Policy for snapshot-based data persistence. A dataset snapshot will be taken every N secs if there are at least M writes changes in the dataset | | ssl | boolean (default: false); Require SSL authenticated and encrypted connections to the database (deprecated as of Redis Enterprise v5.0.1) | -| [status]({{< relref "/operate/rs/references/rest-api/objects/bdb/status" >}}) | Database lifecycle status (read-only)
Values:
'pending'
'active'
'active-change-pending'
'delete-pending'
'import-pending'
'creation-failed'
'recovery' | +| [status]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb/status" >}}) | Database lifecycle status (read-only)
Values:
'pending'
'active'
'active-change-pending'
'delete-pending'
'import-pending'
'creation-failed'
'recovery' | | support_syncer_reconf | boolean; Determines whether the syncer handles its own configuration changes. If false, the DMC restarts the syncer upon a configuration change. | -| sync | (deprecated as of Redis Enterprise v5.0.1, use [replica_sync]({{< relref "/operate/rs/references/rest-api/objects/bdb/replica_sync" >}}) or crdt_sync instead) Enable, disable, or pause syncing from specified sync_sources
Values:
'enabled'
**'disabled'**
'paused'
'stopped' | +| sync | (deprecated as of Redis Enterprise v5.0.1, use [replica_sync]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb/replica_sync" >}}) or crdt_sync instead) Enable, disable, or pause syncing from specified sync_sources
Values:
'enabled'
**'disabled'**
'paused'
'stopped' | | sync_dedicated_threads | integer (range: 0-10) (default: 5); Number of dedicated Replica Of threads | | sync_sources | {{}}[{
"uid": integer,
"uri": string,
"compression": integer,
"status": string,
"rdb_transferred": integer,
"rdb_size": integer,
"last_update": string,
"lag": integer,
"last_error": string
}, ...]{{}} (deprecated as of Redis Enterprise v5.0.1, instead use replica_sources or crdt_sources) Remote endpoints of database to sync from. See the 'bdb -\> replica_sources' section
**uid**: Numeric unique identification of this source
**uri**: Source Redis URI
**compression**: Compression level for the replication link
**status**: Sync status of this source
**rdb_transferred**: Number of bytes transferred from the source's RDB during the syncing phase
**rdb_size**: The source's RDB size to be transferred during the syncing phase
**last_update**: Time last update was received from the source
**lag**: Lag in millisec between source and destination (while synced)
**last_error**: Last error encountered when syncing from the source | | syncer_log_level | Minimum syncer log level to log. Only logs with this level or higher will be logged.
Values:
‘crit’
‘error’
‘warn’
**‘info’**
‘trace’
‘debug’ | diff --git a/content/operate/rs/7.4/references/rest-api/objects/bdb/dataset_import_sources.md b/content/operate/rs/7.4/references/rest-api/objects/bdb/dataset_import_sources.md index b20814efc9..49b2d7bea4 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/bdb/dataset_import_sources.md +++ b/content/operate/rs/7.4/references/rest-api/objects/bdb/dataset_import_sources.md @@ -22,7 +22,7 @@ You can import data to a database from the following location types: - Microsoft Azure Storage - NAS/Local Storage -The source file to import should be in the [RDB]({{< relref "/operate/rs/databases/configure/database-persistence.md" >}}) format. It can also be in a compressed (gz) RDB file. +The source file to import should be in the [RDB]({{< relref "/operate/rs/7.4/databases/configure/database-persistence.md" >}}) format. It can also be in a compressed (gz) RDB file. Supply an array of dataset import source objects to import data from multiple files. diff --git a/content/operate/rs/7.4/references/rest-api/objects/bdb/replica_sources_status.md b/content/operate/rs/7.4/references/rest-api/objects/bdb/replica_sources_status.md index 7d3ba5f895..4f914e4b42 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/bdb/replica_sources_status.md +++ b/content/operate/rs/7.4/references/rest-api/objects/bdb/replica_sources_status.md @@ -12,7 +12,7 @@ weight: $weight url: '/operate/rs/7.4/references/rest-api/objects/bdb/replica_sources_status/' --- -The `replica_sources` status field relates to the [Replica Of]({{< relref "/operate/rs/databases/import-export/replica-of/create.md" >}}) feature, which enables the creation of a Redis database (single- or multi-shard) that synchronizes data from another Redis database (single- or multi-shard). +The `replica_sources` status field relates to the [Replica Of]({{< relref "/operate/rs/7.4/databases/import-export/replica-of/create.md" >}}) feature, which enables the creation of a Redis database (single- or multi-shard) that synchronizes data from another Redis database (single- or multi-shard). The status field represents the Replica Of sync status for a specific sync source. diff --git a/content/operate/rs/7.4/references/rest-api/objects/bdb/replica_sync.md b/content/operate/rs/7.4/references/rest-api/objects/bdb/replica_sync.md index 1eff558f0c..f7ae8725ef 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/bdb/replica_sync.md +++ b/content/operate/rs/7.4/references/rest-api/objects/bdb/replica_sync.md @@ -12,9 +12,9 @@ weight: $weight url: '/operate/rs/7.4/references/rest-api/objects/bdb/replica_sync/' --- -The BDB `replica_sync` field relates to the [Replica Of]({{< relref "/operate/rs/databases/import-export/replica-of/create.md" >}}) feature, which enables the creation of a Redis database (single- or multi-shard) that synchronizes data from another Redis database (single- or multi-shard). +The BDB `replica_sync` field relates to the [Replica Of]({{< relref "/operate/rs/7.4/databases/import-export/replica-of/create.md" >}}) feature, which enables the creation of a Redis database (single- or multi-shard) that synchronizes data from another Redis database (single- or multi-shard). -You can use the `replica_sync` field to enable, disable, or pause the [Replica Of]({{< relref "/operate/rs/databases/import-export/replica-of/create.md" >}}) sync process. The BDB `crdt_sync` field has a similar purpose for the Redis CRDB. +You can use the `replica_sync` field to enable, disable, or pause the [Replica Of]({{< relref "/operate/rs/7.4/databases/import-export/replica-of/create.md" >}}) sync process. The BDB `crdt_sync` field has a similar purpose for the Redis CRDB. Possible BDB sync values: diff --git a/content/operate/rs/7.4/references/rest-api/objects/bootstrap/_index.md b/content/operate/rs/7.4/references/rest-api/objects/bootstrap/_index.md index 1eb73d2311..4b46651825 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/bootstrap/_index.md +++ b/content/operate/rs/7.4/references/rest-api/objects/bootstrap/_index.md @@ -17,10 +17,10 @@ A bootstrap configuration object. | Name | Type/Value | Description | |------|------------|-------------| | action | 'create_cluster'
'join_cluster'
'recover_cluster' | Action to perform | -| cluster | [cluster_identity]({{< relref "/operate/rs/references/rest-api/objects/bootstrap/cluster_identity" >}}) object | Cluster to join or create | +| cluster | [cluster_identity]({{< relref "/operate/rs/7.4/references/rest-api/objects/bootstrap/cluster_identity" >}}) object | Cluster to join or create | | cnm_https_port | integer | Port to join a cluster with non-default cnm_https port | | crdb_coordinator_port | integer, (range: 1024-65535) (default: 9081) | CRDB coordinator port | -| credentials | [credentials]({{< relref "/operate/rs/references/rest-api/objects/bootstrap/credentials" >}}) object | Cluster admin credentials | +| credentials | [credentials]({{< relref "/operate/rs/7.4/references/rest-api/objects/bootstrap/credentials" >}}) object | Cluster admin credentials | | dns_suffixes | {{}} [{ "name": string, @@ -35,8 +35,8 @@ A bootstrap configuration object. | gossip_envoy_admin_port | integer, (range: 1024-65535) | Gossip envoy admin port| | license | string | License string. If not provided, a trial license is set by default. | | max_retries | integer | Max number of retries in case of recoverable errors | -| node | [node_identity]({{< relref "/operate/rs/references/rest-api/objects/bootstrap/node_identity" >}}) object | Node description | -| policy | [policy]({{< relref "/operate/rs/references/rest-api/objects/bootstrap/policy" >}}) object | Policy object | +| node | [node_identity]({{< relref "/operate/rs/7.4/references/rest-api/objects/bootstrap/node_identity" >}}) object | Node description | +| policy | [policy]({{< relref "/operate/rs/7.4/references/rest-api/objects/bootstrap/policy" >}}) object | Policy object | | recovery_filename | string | Name of backup file to recover from | | required_version | string | This node can only join the cluster if all nodes in the cluster have a version greater than the required_version | | retry_time | integer | Max waiting time between retries (in seconds) | diff --git a/content/operate/rs/7.4/references/rest-api/objects/bootstrap/node_identity.md b/content/operate/rs/7.4/references/rest-api/objects/bootstrap/node_identity.md index dfe32fe3ee..702a51abde 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/bootstrap/node_identity.md +++ b/content/operate/rs/7.4/references/rest-api/objects/bootstrap/node_identity.md @@ -16,6 +16,6 @@ url: '/operate/rs/7.4/references/rest-api/objects/bootstrap/node_identity/' |------|------------|-------------| | bigstore_driver | 'rocksdb' | Bigstore driver name or none (deprecated) | | bigstore_enabled | boolean | Bigstore enabled or disabled | -| identity | [identity]({{< relref "/operate/rs/references/rest-api/objects/bootstrap/identity" >}}) object | Node identity | -| limits | [limits]({{< relref "/operate/rs/references/rest-api/objects/bootstrap/limits" >}}) object | Node limits | -| paths | [paths]({{< relref "/operate/rs/references/rest-api/objects/bootstrap/paths" >}}) object | Storage paths object | +| identity | [identity]({{< relref "/operate/rs/7.4/references/rest-api/objects/bootstrap/identity" >}}) object | Node identity | +| limits | [limits]({{< relref "/operate/rs/7.4/references/rest-api/objects/bootstrap/limits" >}}) object | Node limits | +| paths | [paths]({{< relref "/operate/rs/7.4/references/rest-api/objects/bootstrap/paths" >}}) object | Storage paths object | diff --git a/content/operate/rs/7.4/references/rest-api/objects/cluster/_index.md b/content/operate/rs/7.4/references/rest-api/objects/cluster/_index.md index a20c2ec5fe..b847dcf30f 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/cluster/_index.md +++ b/content/operate/rs/7.4/references/rest-api/objects/cluster/_index.md @@ -16,7 +16,7 @@ An API object that represents the cluster. | Name | Type/Value | Description | |------|------------|-------------| -| alert_settings | [alert_settings]({{< relref "/operate/rs/references/rest-api/objects/cluster/alert_settings" >}}) object | Cluster and node alert settings | +| alert_settings | [alert_settings]({{< relref "/operate/rs/7.4/references/rest-api/objects/cluster/alert_settings" >}}) object | Cluster and node alert settings | | bigstore_driver | 'speedb'
'rocksdb' | Storage engine for Auto Tiering | | cluster_ssh_public_key | string | Cluster's autogenerated SSH public key | | cm_port | integer, (range: 1024-65535) | UI HTTPS listening port | diff --git a/content/operate/rs/7.4/references/rest-api/objects/cluster/alert_settings.md b/content/operate/rs/7.4/references/rest-api/objects/cluster/alert_settings.md index 9760fbc983..efe35eae2c 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/cluster/alert_settings.md +++ b/content/operate/rs/7.4/references/rest-api/objects/cluster/alert_settings.md @@ -14,7 +14,7 @@ url: '/operate/rs/7.4/references/rest-api/objects/cluster/alert_settings/' | Name | Type/Value | Description | |------|------------|-------------| -| cluster_certs_about_to_expire | [cluster_alert_settings_with_threshold]({{< relref "/operate/rs/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold" >}}) object | Cluster certificate will expire in x days | +| cluster_certs_about_to_expire | [cluster_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold" >}}) object | Cluster certificate will expire in x days | | cluster_even_node_count | boolean (default: false) | True high availability requires an odd number of nodes in the cluster | | cluster_flash_overcommit | boolean (default: false) | Flash memory committed to databases is larger than cluster total flash memory | | cluster_inconsistent_redis_sw | boolean (default: false) | Some shards in the cluster are running different versions of Redis software | @@ -32,12 +32,12 @@ url: '/operate/rs/7.4/references/rest-api/objects/cluster/alert_settings/' | cluster_too_few_nodes_for_replication | boolean (default: false) | Replication requires at least 2 nodes in the cluster | | node_aof_slow_disk_io | boolean (default: false) | AOF reaching disk I/O limits | node_checks_error | boolean (default: false) | Some node checks have failed | -| node_cpu_utilization | [cluster_alert_settings_with_threshold]({{< relref "/operate/rs/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold" >}}) object | Node CPU utilization has reached the threshold value (% of the utilization limit) | -| node_ephemeral_storage | [cluster_alert_settings_with_threshold]({{< relref "/operate/rs/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold" >}}) object | Node ephemeral storage has reached the threshold value (% of the storage limit) | +| node_cpu_utilization | [cluster_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold" >}}) object | Node CPU utilization has reached the threshold value (% of the utilization limit) | +| node_ephemeral_storage | [cluster_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold" >}}) object | Node ephemeral storage has reached the threshold value (% of the storage limit) | | node_failed | boolean (default: false) | Node failed | -| node_free_flash | [cluster_alert_settings_with_threshold]({{< relref "/operate/rs/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold" >}}) object | Node flash storage has reached the threshold value (% of the storage limit) | +| node_free_flash | [cluster_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold" >}}) object | Node flash storage has reached the threshold value (% of the storage limit) | | node_insufficient_disk_aofrw | boolean (default: false) | Insufficient AOF disk space | -| node_internal_certs_about_to_expire | [cluster_alert_settings_with_threshold]({{< relref "/operate/rs/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold" >}}) object| Internal certificate on node will expire in x days | -| node_memory | [cluster_alert_settings_with_threshold]({{< relref "/operate/rs/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold" >}}) object | Node memory has reached the threshold value (% of the memory limit) | -| node_net_throughput | [cluster_alert_settings_with_threshold]({{< relref "/operate/rs/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold" >}}) object | Node network throughput has reached the threshold value (bytes/s) | -| node_persistent_storage | [cluster_alert_settings_with_threshold]({{< relref "/operate/rs/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold" >}}) object | Node persistent storage has reached the threshold value (% of the storage limit) | +| node_internal_certs_about_to_expire | [cluster_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold" >}}) object| Internal certificate on node will expire in x days | +| node_memory | [cluster_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold" >}}) object | Node memory has reached the threshold value (% of the memory limit) | +| node_net_throughput | [cluster_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold" >}}) object | Node network throughput has reached the threshold value (bytes/s) | +| node_persistent_storage | [cluster_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold" >}}) object | Node persistent storage has reached the threshold value (% of the storage limit) | diff --git a/content/operate/rs/7.4/references/rest-api/objects/cluster_settings.md b/content/operate/rs/7.4/references/rest-api/objects/cluster_settings.md index e07077e8ac..82185f9de8 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/cluster_settings.md +++ b/content/operate/rs/7.4/references/rest-api/objects/cluster_settings.md @@ -23,7 +23,7 @@ Cluster resources management policy | bigstore_provision_node_threshold | integer | Minimum free memory (excluding reserved memory) allowed on a node before new shards can no longer be added to it | | bigstore_provision_node_threshold_p | integer | Minimum free memory (excluding reserved memory) allowed on a node before new shards can no longer be added to it | | data_internode_encryption | boolean | Enable/deactivate encryption of the data plane internode communication | -| db_conns_auditing | boolean | [Audit connections]({{< relref "/operate/rs/security/audit-events" >}}) for new databases by default if set to true. | +| db_conns_auditing | boolean | [Audit connections]({{< relref "/operate/rs/7.4/security/audit-events" >}}) for new databases by default if set to true. | | default_concurrent_restore_actions | integer | Default number of restore actions allowed at the same time. Set to 0 to allow any number of simultaneous restore actions. | | default_fork_evict_ram | boolean | If true, the bdbs should evict data from RAM to ensure successful replication or persistence | | default_non_sharded_proxy_policy | `single`

`all-master-shards`

`all-nodes` | Default proxy_policy for newly created non-sharded databases' endpoints | diff --git a/content/operate/rs/7.4/references/rest-api/objects/crdb/_index.md b/content/operate/rs/7.4/references/rest-api/objects/crdb/_index.md index e5ad74ef70..5e0804d6e9 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/crdb/_index.md +++ b/content/operate/rs/7.4/references/rest-api/objects/crdb/_index.md @@ -18,10 +18,10 @@ An object that represents an Active-Active database. |------|------------|-------------| | guid | string | The global unique ID of the Active-Active database | | causal_consistency | boolean | Enables causal consistency across CRDT instances | -| default_db_config| [CRDB database_config]({{< relref "/operate/rs/references/rest-api/objects/crdb/database_config" >}}) object | Default database configuration | +| default_db_config| [CRDB database_config]({{< relref "/operate/rs/7.4/references/rest-api/objects/crdb/database_config" >}}) object | Default database configuration | | encryption | boolean | Encrypt communication | | featureset_version | integer | Active-Active database active FeatureSet version -| instances | array of [CRDB instance_info]({{< relref "/operate/rs/references/rest-api/objects/crdb/instance_info" >}}) objects | | +| instances | array of [CRDB instance_info]({{< relref "/operate/rs/7.4/references/rest-api/objects/crdb/instance_info" >}}) objects | | | local_databases | {{}}[{ "bdb_uid": string, "id": integer diff --git a/content/operate/rs/7.4/references/rest-api/objects/crdb/database_config.md b/content/operate/rs/7.4/references/rest-api/objects/crdb/database_config.md index f8a7e6dcf3..2790f01f87 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/crdb/database_config.md +++ b/content/operate/rs/7.4/references/rest-api/objects/crdb/database_config.md @@ -36,5 +36,5 @@ An object that represents the database configuration. | shard_key_regex | `[{ "regex": string }, ...]` | Custom keyname-based sharding rules (required if sharding is enabled)

To use the default rules you should set the value to:
`[{"regex": ".*\\{(?.*)\\}.*"}, {"regex": "(?.*)"}]` | | shards_count | integer | Number of database shards | | shards_placement | string | Control the density of shards: should they reside on as few or as many nodes as possible | -| snapshot_policy | array of [snapshot_policy]({{< relref "/operate/rs/references/rest-api/objects/bdb/snapshot_policy" >}}) objects | Policy for snapshot-based data persistence (required) | +| snapshot_policy | array of [snapshot_policy]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb/snapshot_policy" >}}) objects | Policy for snapshot-based data persistence (required) | | tls_mode | string | Encrypt communication | diff --git a/content/operate/rs/7.4/references/rest-api/objects/crdb/health_report/_index.md b/content/operate/rs/7.4/references/rest-api/objects/crdb/health_report/_index.md index 885155998f..3cab372e3d 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/crdb/health_report/_index.md +++ b/content/operate/rs/7.4/references/rest-api/objects/crdb/health_report/_index.md @@ -18,7 +18,7 @@ An object that represents an Active-Active database health report. |------|------------|-------------| | active_config_version | integer | Active configuration version | | cluster_name | string | Name of local Active-Active cluster | -| configurations | array of [health_report_configuration]({{< relref "/operate/rs/references/rest-api/objects/crdb/health_report/health_report_configuration" >}}) objects | Stored database configurations | +| configurations | array of [health_report_configuration]({{< relref "/operate/rs/7.4/references/rest-api/objects/crdb/health_report/health_report_configuration" >}}) objects | Stored database configurations | | connection_error | string | Error string if remote cluster is not available | | connections | {{}} [{ @@ -29,5 +29,5 @@ An object that represents an Active-Active database health report. "status": "up | down" } ], "status": string -}, ...] {{}} | Connections to other clusters and their statuses. A replication link's `bdb_uid` is the unique ID of a local database instance ([bdb]({{< relref "/operate/rs/references/rest-api/objects/bdb" >}})) in the current cluster. The `replica_uid` is the unique ID of the database's remote replica, located in the connected cluster. | +}, ...] {{}} | Connections to other clusters and their statuses. A replication link's `bdb_uid` is the unique ID of a local database instance ([bdb]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb" >}})) in the current cluster. The `replica_uid` is the unique ID of the database's remote replica, located in the connected cluster. | | name | string | Name of the Active-Active database | diff --git a/content/operate/rs/7.4/references/rest-api/objects/crdb/instance_info.md b/content/operate/rs/7.4/references/rest-api/objects/crdb/instance_info.md index 699f186c5a..bb85aaef98 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/crdb/instance_info.md +++ b/content/operate/rs/7.4/references/rest-api/objects/crdb/instance_info.md @@ -16,7 +16,7 @@ An object that represents Active-Active instance info. | Name | Type/Value | Description | |------|------------|-------------| | id | integer | Unique instance ID | -| cluster | [CRDB cluster_info]({{< relref "/operate/rs/references/rest-api/objects/crdb/cluster_info" >}}) object | | +| cluster | [CRDB cluster_info]({{< relref "/operate/rs/7.4/references/rest-api/objects/crdb/cluster_info" >}}) object | | | compression | integer | Compression level when syncing from this source | -| db_config | [CRDB database_config]({{< relref "/operate/rs/references/rest-api/objects/crdb/database_config" >}}) object | Database configuration | +| db_config | [CRDB database_config]({{< relref "/operate/rs/7.4/references/rest-api/objects/crdb/database_config" >}}) object | Database configuration | | db_uid | string | ID of local database instance. This field is likely to be empty for instances other than the local one. | diff --git a/content/operate/rs/7.4/references/rest-api/objects/crdb/modify_request.md b/content/operate/rs/7.4/references/rest-api/objects/crdb/modify_request.md index c73bba219b..440c115458 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/crdb/modify_request.md +++ b/content/operate/rs/7.4/references/rest-api/objects/crdb/modify_request.md @@ -15,8 +15,8 @@ An object to update an Active-Active database. | Name | Type/Value | Description | |------|------------|-------------| -| add_instances | array of [CRDB instance_info]({{< relref "/operate/rs/references/rest-api/objects/crdb/instance_info" >}}) objects | List of new CRDB instances | -| crdb | [CRDB]({{< relref "/operate/rs/references/rest-api/objects/crdb" >}}) object | An object that represents an Active-Active database | +| add_instances | array of [CRDB instance_info]({{< relref "/operate/rs/7.4/references/rest-api/objects/crdb/instance_info" >}}) objects | List of new CRDB instances | +| crdb | [CRDB]({{< relref "/operate/rs/7.4/references/rest-api/objects/crdb" >}}) object | An object that represents an Active-Active database | | force_update | boolean | (Warning: This flag can cause unintended and dangerous changes) Force the configuration update and increment the configuration version even if there is no change to the configuration parameters. If you use force, you can mistakenly cause the other instances to update to the configuration version even though it was not changed. | | remove_instances | array of integers | List of unique instance IDs | | remove_instances.force_remove | boolean | Force removal of instance from the Active-Active database. Before we remove an instance from an Active-Active database, all of the operations that the instance received from clients must be propagated to the other instances. This is the safe method to remove an instance from the Active-Active database. If the instance does not have connectivity to other instances, the propagation fails and removal fails. To remove an instance that does not have connectivity to other instances, you must use the force flag. The removed instance keeps its data and configuration for the instance. After you remove an instance by force, you must use the purge_instances API on the removed instance. | diff --git a/content/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/_index.md b/content/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/_index.md index 69f07a7cc5..8384f64231 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/_index.md +++ b/content/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/_index.md @@ -16,21 +16,21 @@ An API object that represents the database alerts configuration. | Name | Type/Value | Description | |------|------------|-------------| -| bdb_backup_delayed | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | Periodic backup has been delayed for longer than specified threshold value (minutes) | -| bdb_crdt_src_high_syncer_lag | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | CRDB source sync lag is higher than specified threshold value (seconds) | -| bdb_crdt_src_syncer_connection_error | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | CRDB source sync had a connection error while trying to connect to replica source | -| bdb_crdt_src_syncer_general_error | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | CRDB sync encountered in general error | -| bdb_high_latency | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | Latency is higher than specified threshold value (microsec) | -| bdb_high_syncer_lag | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | Replica of sync lag is higher than specified threshold value (seconds) (deprecated as of Redis Enterprise v5.0.1) | -| bdb_high_throughput | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | Throughput is higher than specified threshold value (requests / sec) | -| bdb_long_running_action | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | An alert for state machines that are running for too long | -| bdb_low_throughput | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | Throughput is lower than specified threshold value (requests / sec) | -| bdb_ram_dataset_overhead | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | Dataset RAM overhead of a shard has reached the threshold value (% of its RAM limit) | -| bdb_ram_values | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | Percent of values kept in a shard's RAM is lower than (% of its key count) | -| bdb_replica_src_high_syncer_lag | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | Replica of source sync lag is higher than specified threshold value (seconds) | -| bdb_replica_src_syncer_connection_error | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | Replica of source sync has connection error while trying to connect replica source | -| bdb_replica_src_syncer_general_error | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | Replica of sync encountered in general error | -| bdb_shard_num_ram_values | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | Number of values kept in a shard's RAM is lower than (values) | -| bdb_size | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | Dataset size has reached the threshold value \(% of the memory limit) | -| bdb_syncer_connection_error | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | Replica of sync has connection error while trying to connect replica source (deprecated as of Redis Enterprise v5.0.1) | -| bdb_syncer_general_error | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | Replica of sync encountered in general error (deprecated as of Redis Enterprise v5.0.1) | +| bdb_backup_delayed | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | Periodic backup has been delayed for longer than specified threshold value (minutes) | +| bdb_crdt_src_high_syncer_lag | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | CRDB source sync lag is higher than specified threshold value (seconds) | +| bdb_crdt_src_syncer_connection_error | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | CRDB source sync had a connection error while trying to connect to replica source | +| bdb_crdt_src_syncer_general_error | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | CRDB sync encountered in general error | +| bdb_high_latency | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | Latency is higher than specified threshold value (microsec) | +| bdb_high_syncer_lag | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | Replica of sync lag is higher than specified threshold value (seconds) (deprecated as of Redis Enterprise v5.0.1) | +| bdb_high_throughput | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | Throughput is higher than specified threshold value (requests / sec) | +| bdb_long_running_action | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | An alert for state machines that are running for too long | +| bdb_low_throughput | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | Throughput is lower than specified threshold value (requests / sec) | +| bdb_ram_dataset_overhead | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | Dataset RAM overhead of a shard has reached the threshold value (% of its RAM limit) | +| bdb_ram_values | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | Percent of values kept in a shard's RAM is lower than (% of its key count) | +| bdb_replica_src_high_syncer_lag | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | Replica of source sync lag is higher than specified threshold value (seconds) | +| bdb_replica_src_syncer_connection_error | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | Replica of source sync has connection error while trying to connect replica source | +| bdb_replica_src_syncer_general_error | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | Replica of sync encountered in general error | +| bdb_shard_num_ram_values | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | Number of values kept in a shard's RAM is lower than (values) | +| bdb_size | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | Dataset size has reached the threshold value \(% of the memory limit) | +| bdb_syncer_connection_error | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | Replica of sync has connection error while trying to connect replica source (deprecated as of Redis Enterprise v5.0.1) | +| bdb_syncer_general_error | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/7.4/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | Replica of sync encountered in general error (deprecated as of Redis Enterprise v5.0.1) | diff --git a/content/operate/rs/7.4/references/rest-api/objects/job_scheduler/_index.md b/content/operate/rs/7.4/references/rest-api/objects/job_scheduler/_index.md index 80c08b41df..7dacc3d874 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/job_scheduler/_index.md +++ b/content/operate/rs/7.4/references/rest-api/objects/job_scheduler/_index.md @@ -16,9 +16,9 @@ An API object that represents the job scheduler settings in the cluster. | Name | Type/Value | Description | |------|------------|-------------| -| backup_job_settings | [backup_job_settings]({{< relref "/operate/rs/references/rest-api/objects/job_scheduler/backup_job_settings" >}}) object | Backup job settings | -| cert_rotation_job_settings | [cert_rotation_job_settings]({{< relref "/operate/rs/references/rest-api/objects/job_scheduler/cert_rotation_job_settings" >}}) object | Job settings for internal certificate rotation | -| log_rotation_job_settings | [log_rotation_job_settings]({{< relref "/operate/rs/references/rest-api/objects/job_scheduler/log_rotation_job_settings" >}}) object | Log rotation job settings | -| node_checks_job_settings | [node_checks_job_settings]({{< relref "/operate/rs/references/rest-api/objects/job_scheduler/node_checks_job_settings" >}}) object | Node checks job settings | -| redis_cleanup_job_settings | [redis_cleanup_job_settings]({{< relref "/operate/rs/references/rest-api/objects/job_scheduler/redis_cleanup_job_settings" >}}) object | Redis cleanup job settings (deprecated as of Redis Enterprise v6.4.2, replaced with persistence_cleanup_scan_interval) | -| rotate_ccs_job_settings | [rotate_ccs_job_settings]({{< relref "/operate/rs/references/rest-api/objects/job_scheduler/rotate_ccs_job_settings" >}}) object | Rotate CCS job settings | +| backup_job_settings | [backup_job_settings]({{< relref "/operate/rs/7.4/references/rest-api/objects/job_scheduler/backup_job_settings" >}}) object | Backup job settings | +| cert_rotation_job_settings | [cert_rotation_job_settings]({{< relref "/operate/rs/7.4/references/rest-api/objects/job_scheduler/cert_rotation_job_settings" >}}) object | Job settings for internal certificate rotation | +| log_rotation_job_settings | [log_rotation_job_settings]({{< relref "/operate/rs/7.4/references/rest-api/objects/job_scheduler/log_rotation_job_settings" >}}) object | Log rotation job settings | +| node_checks_job_settings | [node_checks_job_settings]({{< relref "/operate/rs/7.4/references/rest-api/objects/job_scheduler/node_checks_job_settings" >}}) object | Node checks job settings | +| redis_cleanup_job_settings | [redis_cleanup_job_settings]({{< relref "/operate/rs/7.4/references/rest-api/objects/job_scheduler/redis_cleanup_job_settings" >}}) object | Redis cleanup job settings (deprecated as of Redis Enterprise v6.4.2, replaced with persistence_cleanup_scan_interval) | +| rotate_ccs_job_settings | [rotate_ccs_job_settings]({{< relref "/operate/rs/7.4/references/rest-api/objects/job_scheduler/rotate_ccs_job_settings" >}}) object | Rotate CCS job settings | diff --git a/content/operate/rs/7.4/references/rest-api/objects/ldap.md b/content/operate/rs/7.4/references/rest-api/objects/ldap.md index f0ec1f6e8c..e52617d580 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/ldap.md +++ b/content/operate/rs/7.4/references/rest-api/objects/ldap.md @@ -11,7 +11,7 @@ weight: $weight url: '/operate/rs/7.4/references/rest-api/objects/ldap/' --- -An API object that represents the cluster's [LDAP]({{< relref "/operate/rs/security/access-control/ldap" >}}) configuration. +An API object that represents the cluster's [LDAP]({{< relref "/operate/rs/7.4/security/access-control/ldap" >}}) configuration. | Name | Type/Value | Description | |------|------------|-------------| diff --git a/content/operate/rs/7.4/references/rest-api/objects/ldap_mapping.md b/content/operate/rs/7.4/references/rest-api/objects/ldap_mapping.md index e01fe579c0..6d55c6d90c 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/ldap_mapping.md +++ b/content/operate/rs/7.4/references/rest-api/objects/ldap_mapping.md @@ -11,7 +11,7 @@ weight: $weight url: '/operate/rs/7.4/references/rest-api/objects/ldap_mapping/' --- -An API object that represents an [LDAP mapping]({{< relref "/operate/rs/security/access-control/ldap/map-ldap-groups-to-roles" >}}) between an LDAP group and [roles]({{< relref "/operate/rs/references/rest-api/objects/role" >}}). +An API object that represents an [LDAP mapping]({{< relref "/operate/rs/7.4/security/access-control/ldap/map-ldap-groups-to-roles" >}}) between an LDAP group and [roles]({{< relref "/operate/rs/7.4/references/rest-api/objects/role" >}}). | Name | Type/Value | Description | |------|------------|-------------| diff --git a/content/operate/rs/7.4/references/rest-api/objects/node.md b/content/operate/rs/7.4/references/rest-api/objects/node.md index d9551756d9..af0c2187b5 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/node.md +++ b/content/operate/rs/7.4/references/rest-api/objects/node.md @@ -20,7 +20,7 @@ An API object that represents a node in the cluster. | addr | string | Internal IP address of node | | architecture | string | Hardware architecture (read-only) | | bigredis_storage_path | string | Flash storage path (read-only) | -| bigstore_driver | 'ibm-capi-ga1'
'ibm-capi-ga2'
'ibm-capi-ga4'
'speedb'
'rocksdb' | Bigstore driver name or none (deprecated as of Redis Enterprise v7.2, use the [cluster object]({{< relref "/operate/rs/references/rest-api/objects/cluster" >}})'s bigstore_driver instead) | +| bigstore_driver | 'ibm-capi-ga1'
'ibm-capi-ga2'
'ibm-capi-ga4'
'speedb'
'rocksdb' | Bigstore driver name or none (deprecated as of Redis Enterprise v7.2, use the [cluster object]({{< relref "/operate/rs/7.4/references/rest-api/objects/cluster" >}})'s bigstore_driver instead) | | bigstore_size | integer | Storage size of bigstore storage (read-only) | | cores | integer | Total number of CPU cores (read-only) | | ephemeral_storage_path | string | Ephemeral storage path (read-only) | diff --git a/content/operate/rs/7.4/references/rest-api/objects/redis_acl.md b/content/operate/rs/7.4/references/rest-api/objects/redis_acl.md index 05c063ae07..036ebe763a 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/redis_acl.md +++ b/content/operate/rs/7.4/references/rest-api/objects/redis_acl.md @@ -11,7 +11,7 @@ weight: $weight url: '/operate/rs/7.4/references/rest-api/objects/redis_acl/' --- -An API object that represents a Redis [access control list (ACL)]({{< relref "/operate/rs/security/access-control/create-db-roles" >}}) +An API object that represents a Redis [access control list (ACL)]({{< relref "/operate/rs/7.4/security/access-control/create-db-roles" >}}) | Name | Type/Value | Description | |------|------------|-------------| diff --git a/content/operate/rs/7.4/references/rest-api/objects/role.md b/content/operate/rs/7.4/references/rest-api/objects/role.md index 2fb7a70439..10a588b692 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/role.md +++ b/content/operate/rs/7.4/references/rest-api/objects/role.md @@ -18,5 +18,5 @@ An API object that represents a role. | uid | integer | Role's unique ID | | account_id | integer | SM account ID | | action_uid | string | Action UID. If it exists, progress can be tracked by the GET /actions/{uid} API (read-only) | -| management | 'admin'
'db_member'
'db_viewer'
'cluster_member'
'cluster_viewer'
'none' | [Management role]({{< relref "/operate/rs/references/rest-api/permissions#roles" >}}) | +| management | 'admin'
'db_member'
'db_viewer'
'cluster_member'
'cluster_viewer'
'none' | [Management role]({{< relref "/operate/rs/7.4/references/rest-api/permissions#roles" >}}) | | name | string | Role's name | diff --git a/content/operate/rs/7.4/references/rest-api/objects/services_configuration/_index.md b/content/operate/rs/7.4/references/rest-api/objects/services_configuration/_index.md index 1a3ef3919c..e6357bb1e6 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/services_configuration/_index.md +++ b/content/operate/rs/7.4/references/rest-api/objects/services_configuration/_index.md @@ -16,10 +16,10 @@ Optional cluster services settings | Name | Type/Value | Description | |------|------------|-------------| -| alert_mgr | [alert_mgr]({{< relref "/operate/rs/references/rest-api/objects/services_configuration/alert_mgr" >}}) object | Whether to enable/disable the alert manager processes | -| cm_server | [cm_server]({{< relref "/operate/rs/references/rest-api/objects/services_configuration/cm_server" >}}) object | Whether to enable/disable the CM server | -| crdb_coordinator | [crdb_coordinator]({{< relref "/operate/rs/references/rest-api/objects/services_configuration/crdb_coordinator" >}}) object | Whether to enable/disable the CRDB coordinator process | -| crdb_worker | [crdb_worker]({{< relref "/operate/rs/references/rest-api/objects/services_configuration/crdb_worker" >}}) object | Whether to enable/disable the CRDB worker processes | -| mdns_server | [mdns_server]({{< relref "/operate/rs/references/rest-api/objects/services_configuration/mdns_server" >}}) object | Whether to enable/disable the multicast DNS server | -| pdns_server | [pdns_server]({{< relref "/operate/rs/references/rest-api/objects/services_configuration/pdns_server" >}}) object | Whether to enable/disable the PDNS server | -| stats_archiver | [stats_archiver]({{< relref "/operate/rs/references/rest-api/objects/services_configuration/stats_archiver" >}}) object | Whether to enable/disable the stats archiver service | +| alert_mgr | [alert_mgr]({{< relref "/operate/rs/7.4/references/rest-api/objects/services_configuration/alert_mgr" >}}) object | Whether to enable/disable the alert manager processes | +| cm_server | [cm_server]({{< relref "/operate/rs/7.4/references/rest-api/objects/services_configuration/cm_server" >}}) object | Whether to enable/disable the CM server | +| crdb_coordinator | [crdb_coordinator]({{< relref "/operate/rs/7.4/references/rest-api/objects/services_configuration/crdb_coordinator" >}}) object | Whether to enable/disable the CRDB coordinator process | +| crdb_worker | [crdb_worker]({{< relref "/operate/rs/7.4/references/rest-api/objects/services_configuration/crdb_worker" >}}) object | Whether to enable/disable the CRDB worker processes | +| mdns_server | [mdns_server]({{< relref "/operate/rs/7.4/references/rest-api/objects/services_configuration/mdns_server" >}}) object | Whether to enable/disable the multicast DNS server | +| pdns_server | [pdns_server]({{< relref "/operate/rs/7.4/references/rest-api/objects/services_configuration/pdns_server" >}}) object | Whether to enable/disable the PDNS server | +| stats_archiver | [stats_archiver]({{< relref "/operate/rs/7.4/references/rest-api/objects/services_configuration/stats_archiver" >}}) object | Whether to enable/disable the stats archiver service | diff --git a/content/operate/rs/7.4/references/rest-api/objects/shard/_index.md b/content/operate/rs/7.4/references/rest-api/objects/shard/_index.md index 616acdaa92..080fd1792b 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/shard/_index.md +++ b/content/operate/rs/7.4/references/rest-api/objects/shard/_index.md @@ -18,14 +18,14 @@ An API object that represents a Redis shard in a database. |------|------------|-------------| | uid | string | Cluster unique ID of shard | | assigned_slots | string | Shards hash slot range | -| backup | [backup]({{< relref "/operate/rs/references/rest-api/objects/shard/backup" >}}) object | Current status of scheduled periodic backup process | +| backup | [backup]({{< relref "/operate/rs/7.4/references/rest-api/objects/shard/backup" >}}) object | Current status of scheduled periodic backup process | | bdb_uid | integer | The ID of the database this shard belongs to | | bigstore_ram_weight | number | Shards RAM distribution weight | | detailed_status | 'busy'
'down'
'importing'
'loading'
'ok'
'timeout'
'trimming'
'unknown' | A more detailed status of the shard | -| loading | [loading]({{< relref "/operate/rs/references/rest-api/objects/shard/loading" >}}) object | Current status of dump file loading | +| loading | [loading]({{< relref "/operate/rs/7.4/references/rest-api/objects/shard/loading" >}}) object | Current status of dump file loading | | node_uid | string | The ID of the node this shard is located on | | redis_info | redis_info object | A sub-dictionary of the [Redis INFO command]({{< relref "/commands/info" >}}) | | report_timestamp | string | The time in which the shard's info was collected (read-only) | | role | 'master'
'slave' | Role of this shard | | status | 'active'
'inactive'
'trimming' | The current status of the shard | -| sync | [sync]({{< relref "/operate/rs/references/rest-api/objects/shard/sync.md" >}}) object | Shard's current sync status and progress | +| sync | [sync]({{< relref "/operate/rs/7.4/references/rest-api/objects/shard/sync.md" >}}) object | Shard's current sync status and progress | diff --git a/content/operate/rs/7.4/references/rest-api/objects/statistics/_index.md b/content/operate/rs/7.4/references/rest-api/objects/statistics/_index.md index 124ebe8ce0..4a980658ba 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/statistics/_index.md +++ b/content/operate/rs/7.4/references/rest-api/objects/statistics/_index.md @@ -15,13 +15,13 @@ url: '/operate/rs/7.4/references/rest-api/objects/statistics/' ## Statistics overview Clusters, databases, nodes, and shards collect various statistics at regular time intervals. View the statistics for these objects using `GET stats` requests to their respective endpoints: -- [Cluster stats]({{< relref "/operate/rs/references/rest-api/requests/cluster/stats" >}}) -- [Database stats]({{< relref "/operate/rs/references/rest-api/requests/bdbs/stats" >}}) -- [Node stats]({{< relref "/operate/rs/references/rest-api/requests/nodes/stats" >}}) -- [Shard stats]({{< relref "/operate/rs/references/rest-api/requests/shards/stats" >}}) +- [Cluster stats]({{< relref "/operate/rs/7.4/references/rest-api/requests/cluster/stats" >}}) +- [Database stats]({{< relref "/operate/rs/7.4/references/rest-api/requests/bdbs/stats" >}}) +- [Node stats]({{< relref "/operate/rs/7.4/references/rest-api/requests/nodes/stats" >}}) +- [Shard stats]({{< relref "/operate/rs/7.4/references/rest-api/requests/shards/stats" >}}) View endpoint stats using `GET` requests, see: -- [Endpoint stats]({{< relref "/operate/rs/references/rest-api/requests/endpoints-stats" >}}) +- [Endpoint stats]({{< relref "/operate/rs/7.4/references/rest-api/requests/endpoints-stats" >}}) ### Response object @@ -40,10 +40,10 @@ Statistics returned from API requests always contain the following fields: The statistics returned by the API also contain fields that represent the values of different metrics for an object during the specified time interval. More details about the metrics relevant to each object: -- [Cluster metrics]({{< relref "/operate/rs/references/rest-api/objects/statistics/cluster-metrics" >}}) -- [DB metrics]({{< relref "/operate/rs/references/rest-api/objects/statistics/db-metrics" >}}) -- [Node metrics]({{< relref "/operate/rs/references/rest-api/objects/statistics/node-metrics" >}}) -- [Shard metrics]({{< relref "/operate/rs/references/rest-api/objects/statistics/shard-metrics" >}}) +- [Cluster metrics]({{< relref "/operate/rs/7.4/references/rest-api/objects/statistics/cluster-metrics" >}}) +- [DB metrics]({{< relref "/operate/rs/7.4/references/rest-api/objects/statistics/db-metrics" >}}) +- [Node metrics]({{< relref "/operate/rs/7.4/references/rest-api/objects/statistics/node-metrics" >}}) +- [Shard metrics]({{< relref "/operate/rs/7.4/references/rest-api/objects/statistics/shard-metrics" >}}) {{}} Certain statistics are not documented because they are for internal use only and should be ignored. Some statistics will only appear in API responses when they are relevant. diff --git a/content/operate/rs/7.4/references/rest-api/objects/user.md b/content/operate/rs/7.4/references/rest-api/objects/user.md index 29e4fbdf42..8393983060 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/user.md +++ b/content/operate/rs/7.4/references/rest-api/objects/user.md @@ -27,6 +27,6 @@ An API object that represents a Redis Enterprise user. | password | string | User's password. If `password_hash_method` is set to `1`, the password should be hashed using SHA-256. The format before hashing is `username:clustername:password`. | | password_hash_method | '1' | Used when password is passed pre-hashed to specify the hashing method | | password_issue_date | string | The date in which the password was set (read-only) | -| role | 'admin'
'cluster_member'
'cluster_viewer'
'db_member'
**'db_viewer'**
'none' | User's [role]({{< relref "/operate/rs/references/rest-api/permissions#roles" >}}) | +| role | 'admin'
'cluster_member'
'cluster_viewer'
'db_member'
**'db_viewer'**
'none' | User's [role]({{< relref "/operate/rs/7.4/references/rest-api/permissions#roles" >}}) | | role_uids | array of integers | UIDs of user's roles for role-based access control | | status | 'active'
'locked' | User sign-in status (read-only)
**active**: able to sign in
**locked**: unable to sign in | diff --git a/content/operate/rs/7.4/references/rest-api/permissions.md b/content/operate/rs/7.4/references/rest-api/permissions.md index f52924963c..cd5ddfe0b4 100644 --- a/content/operate/rs/7.4/references/rest-api/permissions.md +++ b/content/operate/rs/7.4/references/rest-api/permissions.md @@ -12,9 +12,9 @@ weight: 60 url: '/operate/rs/7.4/references/rest-api/permissions/' --- -Some Redis Enterprise [REST API requests]({{< relref "/operate/rs/references/rest-api/requests" >}}) may require the user to have specific permissions. +Some Redis Enterprise [REST API requests]({{< relref "/operate/rs/7.4/references/rest-api/requests" >}}) may require the user to have specific permissions. -Administrators can assign a predefined role to a user with the [Cluster Manager UI]({{< relref "/operate/rs/security/access-control/create-users" >}}) or a [`PUT /v1/users/{uid}` API request]({{< relref "/operate/rs/references/rest-api/requests/users#put-user" >}}) to grant necessary permissions to them. +Administrators can assign a predefined role to a user with the [Cluster Manager UI]({{< relref "/operate/rs/7.4/security/access-control/create-users" >}}) or a [`PUT /v1/users/{uid}` API request]({{< relref "/operate/rs/7.4/references/rest-api/requests/users#put-user" >}}) to grant necessary permissions to them. ## Roles diff --git a/content/operate/rs/7.4/references/rest-api/quick-start.md b/content/operate/rs/7.4/references/rest-api/quick-start.md index ef70676313..a103f645dd 100644 --- a/content/operate/rs/7.4/references/rest-api/quick-start.md +++ b/content/operate/rs/7.4/references/rest-api/quick-start.md @@ -19,13 +19,13 @@ No matter which method you use to send API requests, there are a few common conc | Type | Description | |------|-------------| -| [Authentication]({{< relref "/operate/rs/references/rest-api#authentication" >}}) | Use [Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication) with your cluster username (email) and password | -| [Ports]({{< relref "/operate/rs/references/rest-api#ports" >}}) | All calls are made to port 9443 by default | -| [Versions]({{< relref "/operate/rs/references/rest-api#versions" >}}) | Specify the version in the request [URI](https://en.wikipedia.org/wiki/Uniform_Resource_Identifier) | -| [Headers]({{< relref "/operate/rs/references/rest-api#headers" >}}) | `Accept` and `Content-Type` should be `application/json` | -| [Response types and error codes]({{< relref "/operate/rs/references/rest-api#response-types-and-error-codes" >}}) | A response of `200 OK` means success; otherwise, the request failed due to an error | +| [Authentication]({{< relref "/operate/rs/7.4/references/rest-api#authentication" >}}) | Use [Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication) with your cluster username (email) and password | +| [Ports]({{< relref "/operate/rs/7.4/references/rest-api#ports" >}}) | All calls are made to port 9443 by default | +| [Versions]({{< relref "/operate/rs/7.4/references/rest-api#versions" >}}) | Specify the version in the request [URI](https://en.wikipedia.org/wiki/Uniform_Resource_Identifier) | +| [Headers]({{< relref "/operate/rs/7.4/references/rest-api#headers" >}}) | `Accept` and `Content-Type` should be `application/json` | +| [Response types and error codes]({{< relref "/operate/rs/7.4/references/rest-api#response-types-and-error-codes" >}}) | A response of `200 OK` means success; otherwise, the request failed due to an error | -For more information, see [Redis Enterprise Software REST API]({{< relref "/operate/rs/references/rest-api/" >}}). +For more information, see [Redis Enterprise Software REST API]({{< relref "/operate/rs/7.4/references/rest-api/" >}}). ## cURL example requests @@ -39,7 +39,7 @@ You can use the following options to build a cURL request: | -H | Request header, can be specified multiple times | | -u | Username and password information | | -d | JSON data for PUT or POST requests | -| -F | Form data for PUT or POST requests, such as for the [`POST /v1/modules`]({{< relref "/operate/rs/references/rest-api/requests/modules/#post-module" >}}) or [`POST /v2/modules`]({{< relref "/operate/rs/references/rest-api/requests/modules/#post-module-v2" >}}) endpoint | +| -F | Form data for PUT or POST requests, such as for the [`POST /v1/modules`]({{< relref "/operate/rs/7.4/references/rest-api/requests/modules/#post-module" >}}) or [`POST /v2/modules`]({{< relref "/operate/rs/7.4/references/rest-api/requests/modules/#post-module-v2" >}}) endpoint | | -k | Turn off SSL verification | | -i | Show headers and status code as well as the response body | @@ -47,7 +47,7 @@ See the [cURL documentation](https://curl.se/docs/) for more information. ### GET request -Use the following cURL command to get a list of databases with the [GET `/v1/bdbs/`]({{< relref "/operate/rs/references/rest-api/requests/bdbs/#get-all-bdbs" >}}) endpoint. +Use the following cURL command to get a list of databases with the [GET `/v1/bdbs/`]({{< relref "/operate/rs/7.4/references/rest-api/requests/bdbs/#get-all-bdbs" >}}) endpoint. ```sh $ curl -X GET -H "accept: application/json" \ @@ -76,11 +76,11 @@ x-envoy-upstream-service-time: 25 In the response body, the `uid` is the database ID. You can use the database ID to view or update the database using the API. -For more information about the fields returned by [GET `/v1/bdbs/`]({{< relref "/operate/rs/references/rest-api/requests/bdbs/#get-all-bdbs" >}}), see the [`bdbs` object]({{< relref "/operate/rs/references/rest-api/objects/bdb/" >}}). +For more information about the fields returned by [GET `/v1/bdbs/`]({{< relref "/operate/rs/7.4/references/rest-api/requests/bdbs/#get-all-bdbs" >}}), see the [`bdbs` object]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb/" >}}). ### PUT request -Once you have the database ID, you can use [PUT `/v1/bdbs/`]({{< relref "/operate/rs/references/rest-api/requests/bdbs/#put-bdbs" >}}) to update the configuration of the database. +Once you have the database ID, you can use [PUT `/v1/bdbs/`]({{< relref "/operate/rs/7.4/references/rest-api/requests/bdbs/#put-bdbs" >}}) to update the configuration of the database. For example, you can pass the database `uid` 1 as a URL parameter and use the `-d` option to specify the new `name` when you send the request. This changes the database's `name` from `tr01` to `database1`: @@ -108,7 +108,7 @@ x-envoy-upstream-service-time: 159 } ``` -For more information about the fields you can update with [PUT `/v1/bdbs/`]({{< relref "/operate/rs/references/rest-api/requests/bdbs/#put-bdbs" >}}), see the [`bdbs` object]({{< relref "/operate/rs/references/rest-api/objects/bdb/" >}}). +For more information about the fields you can update with [PUT `/v1/bdbs/`]({{< relref "/operate/rs/7.4/references/rest-api/requests/bdbs/#put-bdbs" >}}), see the [`bdbs` object]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb/" >}}). ## Client examples @@ -116,7 +116,7 @@ You can also use client libraries to make API requests in your preferred languag To follow these examples, you need: -- A [Redis Enterprise Software]({{< relref "/operate/rs/installing-upgrading/quickstarts/redis-enterprise-software-quickstart" >}}) node +- A [Redis Enterprise Software]({{< relref "/operate/rs/7.4/installing-upgrading/quickstarts/redis-enterprise-software-quickstart" >}}) node - Python 3 and the [requests](https://pypi.org/project/requests/) Python library - [node.js](https://nodejs.dev/) and [node-fetch](https://www.npmjs.com/package/node-fetch) @@ -319,5 +319,5 @@ PUT https://[host]:[port]/v1/bdbs/1 ## More info -- [Redis Enterprise Software REST API]({{< relref "/operate/rs/references/rest-api/" >}}) -- [Redis Enterprise Software REST API requests]({{< relref "/operate/rs/references/rest-api/requests/" >}}) +- [Redis Enterprise Software REST API]({{< relref "/operate/rs/7.4/references/rest-api/" >}}) +- [Redis Enterprise Software REST API requests]({{< relref "/operate/rs/7.4/references/rest-api/requests/" >}}) diff --git a/content/operate/rs/7.4/references/rest-api/requests/_index.md b/content/operate/rs/7.4/references/rest-api/requests/_index.md index c6bd4d5682..6eb05eb7ac 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/_index.md @@ -22,6 +22,6 @@ Some requests may also require: - URL parameters - [Query parameters](https://en.wikipedia.org/wiki/Query_string) - [JSON](http://www.json.org) request body -- [Permissions]({{< relref "/operate/rs/references/rest-api/permissions" >}}) +- [Permissions]({{< relref "/operate/rs/7.4/references/rest-api/permissions" >}}) {{< table-children columnNames="Request,Description" columnSources="LinkTitle,Description" enableLinks="LinkTitle" >}} diff --git a/content/operate/rs/7.4/references/rest-api/requests/actions/_index.md b/content/operate/rs/7.4/references/rest-api/requests/actions/_index.md index 4569bc1ca0..6236919717 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/actions/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/actions/_index.md @@ -30,7 +30,7 @@ Get the status of all actions (executing, queued, or completed) on all entities | Permission name | |-----------------| -| [view_status_of_cluster_action]({{< relref "/operate/rs/references/rest-api/permissions#view_status_of_cluster_action" >}}) | +| [view_status_of_cluster_action]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_status_of_cluster_action" >}}) | ### Request {#get-all-request} @@ -42,7 +42,7 @@ GET /v1/actions ### Response {#get-all-response} -Returns a JSON array of [action objects]({{< relref "/operate/rs/references/rest-api/objects/action" >}}) and an array of [state-machine objects]({{< relref "/operate/rs/references/rest-api/objects/state-machine" >}}). +Returns a JSON array of [action objects]({{< relref "/operate/rs/7.4/references/rest-api/objects/action" >}}) and an array of [state-machine objects]({{< relref "/operate/rs/7.4/references/rest-api/objects/state-machine" >}}). Regardless of an action’s source, each action in the response contains the following attributes: `name`, `action_uid`, `status`, and `progress`. @@ -100,7 +100,7 @@ Get the status of a currently executing, queued, or completed action. | Permission name | |-----------------| -| [view_status_of_cluster_action]({{< relref "/operate/rs/references/rest-api/permissions#view_status_of_cluster_action" >}}) | +| [view_status_of_cluster_action]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_status_of_cluster_action" >}}) | ### Request {#get-request} @@ -118,7 +118,7 @@ GET /v1/actions/{uid} ### Response {#get-response} -Returns an [action object]({{< relref "/operate/rs/references/rest-api/objects/action" >}}). +Returns an [action object]({{< relref "/operate/rs/7.4/references/rest-api/objects/action" >}}). Regardless of an action’s source, each action contains the following attributes: `name`, `action_uid`, `status`, and `progress`. diff --git a/content/operate/rs/7.4/references/rest-api/requests/actions/bdb.md b/content/operate/rs/7.4/references/rest-api/requests/actions/bdb.md index f8a6965ca2..35faf90723 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/actions/bdb.md +++ b/content/operate/rs/7.4/references/rest-api/requests/actions/bdb.md @@ -28,7 +28,7 @@ Get the status of all currently executing, pending, or completed state-machine-r | Permission name | |-----------------| -| [view_status_of_cluster_action]({{< relref "/operate/rs/references/rest-api/permissions#view_status_of_cluster_action" >}}) | +| [view_status_of_cluster_action]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_status_of_cluster_action" >}}) | ### Request {#get-request} @@ -46,7 +46,7 @@ GET /v1/actions/bdb/1 ### Response {#get-response} -Returns an array of JSON objects with attributes from [actions]({{< relref "/operate/rs/references/rest-api/objects/action" >}}) and [state machines]({{< relref "/operate/rs/references/rest-api/objects/state-machine" >}}). +Returns an array of JSON objects with attributes from [actions]({{< relref "/operate/rs/7.4/references/rest-api/objects/action" >}}) and [state machines]({{< relref "/operate/rs/7.4/references/rest-api/objects/state-machine" >}}). Each action contains the following attributes: `name`, `action_uid`, `status`, and `progress`. diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/_index.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/_index.md index e74cba831b..959db950d0 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/_index.md @@ -35,7 +35,7 @@ Get all databases in the cluster. | Permission name | Roles | |-----------------|---------| -| [view_all_bdbs_info]({{< relref "/operate/rs/references/rest-api/permissions#view_all_bdbs_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | +| [view_all_bdbs_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_all_bdbs_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | ### Request {#get-all-request} @@ -60,7 +60,7 @@ GET /v1/bdbs?fields=uid,name ### Response {#get-all-response} -The response body contains a JSON array with all databases, represented as [BDB objects]({{< relref "/operate/rs/references/rest-api/objects/bdb" >}}). +The response body contains a JSON array with all databases, represented as [BDB objects]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb" >}}). #### Body @@ -125,7 +125,7 @@ Get a single database. | Permission name | Roles | |-----------------|-------| -| [view_bdb_info]({{< relref "/operate/rs/references/rest-api/permissions#view_bdb_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | +| [view_bdb_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_bdb_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | ### Request {#get-request} @@ -158,7 +158,7 @@ GET /v1/bdbs/1 ### Response {#get-response} -Returns a [BDB object]({{< relref "/operate/rs/references/rest-api/objects/bdb" >}}). +Returns a [BDB object]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb" >}}). #### Example JSON body @@ -184,17 +184,17 @@ PUT /v1/bdbs/{int: uid} ``` Update the configuration of an active database. -If called with the `dry_run` URL query string, the function will validate the [BDB object]({{< relref "/operate/rs/references/rest-api/objects/bdb" >}}) against the existing database, but will not invoke the state machine that will update it. +If called with the `dry_run` URL query string, the function will validate the [BDB object]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb" >}}) against the existing database, but will not invoke the state machine that will update it. This is the basic version of the update request. See [Update database and perform action](#put-bdbs-action) to send an update request with an additional action. -To track this request's progress, poll the [`/actions/` endpoint]({{< relref "/operate/rs/references/rest-api/requests/bdbs/actions" >}}) with the action_uid returned in the response body. +To track this request's progress, poll the [`/actions/` endpoint]({{< relref "/operate/rs/7.4/references/rest-api/requests/bdbs/actions" >}}) with the action_uid returned in the response body. ### Permissions | Permission name | Roles | |-----------------|-------| -| [update_bdb]({{< relref "/operate/rs/references/rest-api/permissions#update_bdb" >}}) | admin
cluster_member
db_member | +| [update_bdb]({{< relref "/operate/rs/7.4/references/rest-api/permissions#update_bdb" >}}) | admin
cluster_member
db_member | ### Request {#put-request} @@ -216,7 +216,7 @@ PUT /v1/bdbs/1 | Field | Type | Description | |---------|------|---------------| -| dry_run | | Validate the new [BDB object]({{< relref "/operate/rs/references/rest-api/objects/bdb" >}}) but don't apply the update. | +| dry_run | | Validate the new [BDB object]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb" >}}) but don't apply the update. | #### URL parameters @@ -226,7 +226,7 @@ PUT /v1/bdbs/1 #### Body -Include a [BDB object]({{< relref "/operate/rs/references/rest-api/objects/bdb" >}}) with updated fields in the request body. +Include a [BDB object]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb" >}}) with updated fields in the request body. ##### Example JSON body @@ -241,7 +241,7 @@ The above request attempts to modify a database configuration to enable in-memor ### Response {#put-response} -Returns the updated [BDB object]({{< relref "/operate/rs/references/rest-api/objects/bdb" >}}). +Returns the updated [BDB object]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb" >}}). #### Example JSON body @@ -296,13 +296,13 @@ PUT /v1/bdbs/{int: uid}/{action} ``` Update the configuration of an active database and perform an additional action. -If called with the `dry_run` URL query string, the function will validate the [BDB object]({{< relref "/operate/rs/references/rest-api/objects/bdb" >}}) against the existing database, but will not invoke the state machine that will update it. +If called with the `dry_run` URL query string, the function will validate the [BDB object]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb" >}}) against the existing database, but will not invoke the state machine that will update it. #### Permissions | Permission name | Roles | |-----------------|-------| -| [update_bdb_with_action]({{< relref "/operate/rs/references/rest-api/permissions#update_bdb_with_action" >}}) | admin
cluster_member
db_member | +| [update_bdb_with_action]({{< relref "/operate/rs/7.4/references/rest-api/permissions#update_bdb_with_action" >}}) | admin
cluster_member
db_member | ### Request {#put-request-action} @@ -332,11 +332,11 @@ The above request resets the admin password after updating the database. | Field | Type | Description | |---------|------|---------------| -| dry_run | | Validate the new [BDB object]({{< relref "/operate/rs/references/rest-api/objects/bdb" >}}) but don't apply the update. | +| dry_run | | Validate the new [BDB object]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb" >}}) but don't apply the update. | #### Body -Include a [BDB object]({{< relref "/operate/rs/references/rest-api/objects/bdb" >}}) with updated fields in the request body. +Include a [BDB object]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb" >}}) with updated fields in the request body. ##### Example JSON body @@ -355,7 +355,7 @@ To change the shard hashing policy, you must flush all keys from the database. ### Response {#put-response-action} -If the request succeeds, the response body returns the updated [BDB object]({{< relref "/operate/rs/references/rest-api/objects/bdb" >}}). If an error occurs, the response body may include an error code and message with more details. +If the request succeeds, the response body returns the updated [BDB object]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb" >}}). If an error occurs, the response body may include an error code and message with more details. #### Status codes {#put-status-codes-action} @@ -400,7 +400,7 @@ POST /v1/bdbs ``` Create a new database in the cluster. -The request must contain a single JSON [BDB object]({{< relref "/operate/rs/references/rest-api/objects/bdb" >}}) with the configuration parameters for the new database. +The request must contain a single JSON [BDB object]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb" >}}) with the configuration parameters for the new database. The following parameters are required to create the database: @@ -409,9 +409,9 @@ The following parameters are required to create the database: | name | string | Name of the new database | | memory_size | integer | Size of the database, in bytes | -If passed with the `dry_run` URL query string, the function will validate the [BDB object]({{< relref "/operate/rs/references/rest-api/objects/bdb" >}}), but will not invoke the state machine that will create it. +If passed with the `dry_run` URL query string, the function will validate the [BDB object]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb" >}}), but will not invoke the state machine that will create it. -To track this request's progress, poll the [`/actions/` endpoint]({{< relref "/operate/rs/references/rest-api/requests/bdbs/actions" >}}) with the `action_uid` returned in the response body. +To track this request's progress, poll the [`/actions/` endpoint]({{< relref "/operate/rs/7.4/references/rest-api/requests/bdbs/actions" >}}) with the `action_uid` returned in the response body. The cluster will use default configuration for any missing database field. The cluster creates a database UID if it is missing. @@ -419,7 +419,7 @@ The cluster will use default configuration for any missing database field. The c | Permission name | Roles | |-----------------|-------| -| [create_bdb]({{< relref "/operate/rs/references/rest-api/permissions#create_bdb" >}}) | admin
cluster_member
db_member | +| [create_bdb]({{< relref "/operate/rs/7.4/references/rest-api/permissions#create_bdb" >}}) | admin
cluster_member
db_member | ### Request {#post-request-v1} @@ -441,11 +441,11 @@ POST /v1/bdbs | Field | Type | Description | |-------|------|-------------| -| dry_run | | Validate the new [BDB object]({{< relref "/operate/rs/references/rest-api/objects/bdb" >}}) but don't create the database. | +| dry_run | | Validate the new [BDB object]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb" >}}) but don't create the database. | #### Body -Include a [BDB object]({{< relref "/operate/rs/references/rest-api/objects/bdb" >}}) in the request body. +Include a [BDB object]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb" >}}) in the request body. The following parameters are required to create the database: @@ -472,7 +472,7 @@ The above request is an attempt to create a Redis database with a user-specified ### Response {#post-response-v1} -The response includes the newly created [BDB object]({{< relref "/operate/rs/references/rest-api/objects/bdb" >}}). +The response includes the newly created [BDB object]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb" >}}). #### Example JSON body @@ -535,7 +535,7 @@ When errors are reported, the server may return a JSON object with `error_code` ```sh POST /v2/bdbs ``` -Create a new database in the cluster. See [`POST /v1/bdbs`]({{< relref "/operate/rs/references/rest-api/requests/bdbs#post-bdbs-v1" >}}) for more information. +Create a new database in the cluster. See [`POST /v1/bdbs`]({{< relref "/operate/rs/7.4/references/rest-api/requests/bdbs#post-bdbs-v1" >}}) for more information. The database's configuration should be under the "bdb" field. @@ -565,11 +565,11 @@ POST /v2/bdbs | Field | Type | Description | |-------|------|-------------| -| dry_run | | Validate the new [BDB object]({{< relref "/operate/rs/references/rest-api/objects/bdb" >}}) but don't create the database. | +| dry_run | | Validate the new [BDB object]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb" >}}) but don't create the database. | #### Body -Include a JSON object that contains a [BDB object]({{< relref "/operate/rs/references/rest-api/objects/bdb" >}}) and an optional `recovery_plan` object in the request body. +Include a JSON object that contains a [BDB object]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb" >}}) and an optional `recovery_plan` object in the request body. ##### Example JSON body @@ -595,7 +595,7 @@ Include a JSON object that contains a [BDB object]({{< relref "/operate/rs/refer ### Response {#post-response-v2} -The response includes the newly created [BDB object]({{< relref "/operate/rs/references/rest-api/objects/bdb" >}}). +The response includes the newly created [BDB object]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb" >}}). #### Example JSON body @@ -621,7 +621,7 @@ Delete an active database. | Permission name | Roles | |-----------------|-------| -| [delete_bdb]({{< relref "/operate/rs/references/rest-api/permissions#delete_bdb" >}}) | admin
cluster_member
db_member | +| [delete_bdb]({{< relref "/operate/rs/7.4/references/rest-api/permissions#delete_bdb" >}}) | admin
cluster_member
db_member | ### Request {#delete-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/_index.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/_index.md index 141482b1f5..66a3867745 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/_index.md @@ -43,5 +43,5 @@ url: '/operate/rs/7.4/references/rest-api/requests/bdbs/actions/' | Method | Path | Description | |--------|------|-------------| -| [GET]({{}}) | `/v1/bdbs/{uid}/actions/recover` | Get database recovery plan | -| [POST]({{}}) | `/v1/bdbs/{uid}/actions/recover` | Recover database | +| [GET]({{}}) | `/v1/bdbs/{uid}/actions/recover` | Get database recovery plan | +| [POST]({{}}) | `/v1/bdbs/{uid}/actions/recover` | Recover database | diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/backup_reset_status.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/backup_reset_status.md index 9b070d4983..37af6b8f4c 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/backup_reset_status.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/backup_reset_status.md @@ -28,7 +28,7 @@ Resets the database's `backup_status` to idle if a backup is not in progress and | Permission name | Roles | |-----------------|-------| -| [reset_bdb_current_backup_status]({{< relref "/operate/rs/references/rest-api/permissions#reset_bdb_current_backup_status" >}}) | admin
cluster_member
db_member | +| [reset_bdb_current_backup_status]({{< relref "/operate/rs/7.4/references/rest-api/permissions#reset_bdb_current_backup_status" >}}) | admin
cluster_member
db_member | ### Request {#put-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/export.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/export.md index 36156a2671..ceb36e50d7 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/export.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/export.md @@ -28,7 +28,7 @@ Initiate a database export. | Permission name | Roles | |-----------------|-------| -| [start_bdb_export]({{< relref "/operate/rs/references/rest-api/permissions#start_bdb_export" >}}) | admin
cluster_member
db_member | +| [start_bdb_export]({{< relref "/operate/rs/7.4/references/rest-api/permissions#start_bdb_export" >}}) | admin
cluster_member
db_member | ### Request {#post-request} @@ -59,7 +59,7 @@ The request body should contain a JSON object with the following export paramete | Field | Type | Description | |-------|------|-------------| -| export_location | [backup_location/export_location]({{< relref "/operate/rs/references/rest-api/objects/bdb/backup_location" >}}) object | Details for the export destination. Call [`GET /v1/jsonschema`]({{< relref "/operate/rs/references/rest-api/requests/jsonschema#get-jsonschema" >}}) on the bdb object and review the `backup_location` field to retrieve the object's structure. | +| export_location | [backup_location/export_location]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb/backup_location" >}}) object | Details for the export destination. Call [`GET /v1/jsonschema`]({{< relref "/operate/rs/7.4/references/rest-api/requests/jsonschema#get-jsonschema" >}}) on the bdb object and review the `backup_location` field to retrieve the object's structure. | | email_notification | boolean | Enable/disable an email notification on export failure/ completion. (optional) | ##### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/export_reset_status.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/export_reset_status.md index dd649ddce6..481eacfcfe 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/export_reset_status.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/export_reset_status.md @@ -26,7 +26,7 @@ Resets the database's `export_status` to idle if an export is not in progress an | Permission name | Roles | |-----------------|-------| -| [reset_bdb_current_export_status]({{< relref "/operate/rs/references/rest-api/permissions#reset_bdb_current_export_status" >}}) | admin
cluster_member
db_member | +| [reset_bdb_current_export_status]({{< relref "/operate/rs/7.4/references/rest-api/permissions#reset_bdb_current_export_status" >}}) | admin
cluster_member
db_member | ### Request {#put-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/import.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/import.md index 3e4b5cf7f0..a68212489c 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/import.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/import.md @@ -28,7 +28,7 @@ Initiate a manual import process. | Permission name | Roles | |-----------------|-------| -| [start_bdb_import]({{< relref "/operate/rs/references/rest-api/permissions#start_bdb_import" >}}) | admin
cluster_member
db_member | +| [start_bdb_import]({{< relref "/operate/rs/7.4/references/rest-api/permissions#start_bdb_import" >}}) | admin
cluster_member
db_member | ### Request {#post-request} @@ -54,11 +54,11 @@ POST /v1/bdbs/1/actions/import #### Body -The request _may_ contain a subset of the [BDB JSON object]({{< relref "/operate/rs/references/rest-api/objects/bdb" >}}), which includes the following import-related attributes: +The request _may_ contain a subset of the [BDB JSON object]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb" >}}), which includes the following import-related attributes: | Field | Type | Description | |-------|------|-------------| -| dataset_import_sources | array of [dataset_import_sources]({{< relref "/operate/rs/references/rest-api/objects/bdb/dataset_import_sources" >}}) objects | Details for the import sources. Call [`GET /v1/jsonschema`]({{< relref "/operate/rs/references/rest-api/requests/jsonschema#get-jsonschema" >}}) on the bdb object and review the `dataset_import_sources` field to retrieve the object's structure. | +| dataset_import_sources | array of [dataset_import_sources]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb/dataset_import_sources" >}}) objects | Details for the import sources. Call [`GET /v1/jsonschema`]({{< relref "/operate/rs/7.4/references/rest-api/requests/jsonschema#get-jsonschema" >}}) on the bdb object and review the `dataset_import_sources` field to retrieve the object's structure. | | email_notification | boolean | Enable/disable an email notification on import failure/ completion. (optional) | {{}} diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/import_reset_status.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/import_reset_status.md index a56b78999d..bdfb8d7d27 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/import_reset_status.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/import_reset_status.md @@ -26,7 +26,7 @@ Reset the database’s `import_status` to idle if a backup is not in progress an | Permission name | Roles | |-----------------|-------| -| [reset_bdb_current_import_status]({{< relref "/operate/rs/references/rest-api/permissions#reset_bdb_current_import_status" >}}) | admin
cluster_member
db_member | +| [reset_bdb_current_import_status]({{< relref "/operate/rs/7.4/references/rest-api/permissions#reset_bdb_current_import_status" >}}) | admin
cluster_member
db_member | ### Request {#put-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/optimize_shards_placement.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/optimize_shards_placement.md index 47978f615c..40d57812f7 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/optimize_shards_placement.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/optimize_shards_placement.md @@ -29,7 +29,7 @@ Get optimized shards placement for the given database. | Permission name | Roles | |-----------------|-------| -| [view_bdb_info]({{< relref "/operate/rs/references/rest-api/permissions#view_bdb_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | +| [view_bdb_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_bdb_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | ### Request {#get-request} @@ -125,9 +125,9 @@ To rearrange the database shards, you can submit the blueprint returned in this ## Rearrange database shards {#put-bdbs-rearrange-shards} -Use the blueprint returned by the [`GET` `/v1/bdbs/{uid}/actions/optimize_shards_placement`]({{< relref "/operate/rs/references/rest-api/requests/bdbs/actions/optimize_shards_placement#get-bdbs-actions-optimize-shards-placement" >}}) request as the value of the `shards_blueprint` field to rearrange the database shards. +Use the blueprint returned by the [`GET` `/v1/bdbs/{uid}/actions/optimize_shards_placement`]({{< relref "/operate/rs/7.4/references/rest-api/requests/bdbs/actions/optimize_shards_placement#get-bdbs-actions-optimize-shards-placement" >}}) request as the value of the `shards_blueprint` field to rearrange the database shards. -To ensure that the optimized shard placement is relevant for the current cluster state, pass the `cluster-state-id`, taken from the response header of the `GET` request, in the [`PUT` `/v1/bdbs/{uid}`]({{< relref "/operate/rs/references/rest-api/requests/bdbs#put-bdbs" >}}) request headers. +To ensure that the optimized shard placement is relevant for the current cluster state, pass the `cluster-state-id`, taken from the response header of the `GET` request, in the [`PUT` `/v1/bdbs/{uid}`]({{< relref "/operate/rs/7.4/references/rest-api/requests/bdbs#put-bdbs" >}}) request headers. The cluster will reject the update if its state was changed since the optimal shards placement was obtained. diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/recover.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/recover.md index df25db46d5..5e65b4e5b0 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/recover.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/recover.md @@ -29,7 +29,7 @@ Fetches the recovery plan for a database. The recovery plan provides information | Permission name | Roles | |-----------------|-------| -| [view_bdb_recovery_plan]({{< relref "/operate/rs/references/rest-api/permissions#view_bdb_recovery_plan" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | +| [view_bdb_recovery_plan]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_bdb_recovery_plan" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | ### Request {#get-request} @@ -90,13 +90,13 @@ Returns a JSON object that represents the database's recovery plan, including re POST /v1/bdbs/{int: uid}/actions/recover ``` -Initiates [recovery for a database]({{}}) in a recoverable state where all the database's files are available after [cluster recovery]({{}}). +Initiates [recovery for a database]({{}}) in a recoverable state where all the database's files are available after [cluster recovery]({{}}). #### Required permissions | Permission name | Roles | |-----------------|-------| -| [start_bdb_recovery]({{< relref "/operate/rs/references/rest-api/permissions#start_bdb_recovery" >}}) | admin
cluster_member
db_member | +| [start_bdb_recovery]({{< relref "/operate/rs/7.4/references/rest-api/permissions#start_bdb_recovery" >}}) | admin
cluster_member
db_member | ### Request {#post-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/alerts.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/alerts.md index 547f533238..b2e32d3cef 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/alerts.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/alerts.md @@ -29,7 +29,7 @@ Get all alert states for all databases. | Permission name | |-----------------| -| [view_all_bdbs_alerts]({{< relref "/operate/rs/references/rest-api/permissions#view_all_bdbs_alerts" >}}) | +| [view_all_bdbs_alerts]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_all_bdbs_alerts" >}}) | ### Request {#get-all-request} @@ -46,7 +46,7 @@ Get all alert states for all databases. ### Response {#get-all-response} -Returns a hash of alert UIDs and the [alerts]({{< relref "/operate/rs/references/rest-api/objects/alert" >}}) states for each database. +Returns a hash of alert UIDs and the [alerts]({{< relref "/operate/rs/7.4/references/rest-api/objects/alert" >}}) states for each database. #### Example JSON body @@ -87,7 +87,7 @@ Get all alert states for a database. | Permission name | |-----------------| -| [view_bdb_alerts]({{< relref "/operate/rs/references/rest-api/permissions#view_bdb_alerts" >}}) | +| [view_bdb_alerts]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_bdb_alerts" >}}) | ### Request {#get-request-alerts} @@ -104,7 +104,7 @@ Get all alert states for a database. ### Response {#get-response-alerts} -Returns a hash of [alert objects]({{< relref "/operate/rs/references/rest-api/objects/alert" >}}) and their states. +Returns a hash of [alert objects]({{< relref "/operate/rs/7.4/references/rest-api/objects/alert" >}}) and their states. #### Example JSON body @@ -143,7 +143,7 @@ Get a database alert state. | Permission name | |-----------------| -| [view_bdb_alerts]({{< relref "/operate/rs/references/rest-api/permissions#view_bdb_alerts" >}}) | +| [view_bdb_alerts]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_bdb_alerts" >}}) | ### Request {#get-request} @@ -169,7 +169,7 @@ Get a database alert state. ### Response {#get-response} -Returns an [alert object]({{< relref "/operate/rs/references/rest-api/objects/alert" >}}). +Returns an [alert object]({{< relref "/operate/rs/7.4/references/rest-api/objects/alert" >}}). #### Example JSON body @@ -206,7 +206,7 @@ Updates a database's alerts configuration. | Permission name | |-----------------| -| [update_bdb_alerts]({{< relref "/operate/rs/references/rest-api/permissions#update_bdb_alerts" >}}) | +| [update_bdb_alerts]({{< relref "/operate/rs/7.4/references/rest-api/permissions#update_bdb_alerts" >}}) | ### Request {#post-request} @@ -264,11 +264,11 @@ If passed with the dry_run URL query string, the function will validate the aler #### Request body -The request must contain a single JSON object with one or many database [alert objects]({{< relref "/operate/rs/references/rest-api/objects/alert" >}}). +The request must contain a single JSON object with one or many database [alert objects]({{< relref "/operate/rs/7.4/references/rest-api/objects/alert" >}}). ### Response {#post-response} -The response includes the updated database [alerts]({{< relref "/operate/rs/references/rest-api/objects/alert" >}}). +The response includes the updated database [alerts]({{< relref "/operate/rs/7.4/references/rest-api/objects/alert" >}}). ### Status codes {#post-status-codes} diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/crdt_sources-alerts.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/crdt_sources-alerts.md index e33c683fe5..5a42aad26f 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/crdt_sources-alerts.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/crdt_sources-alerts.md @@ -29,7 +29,7 @@ Get all alert states for all CRDT sources of all CRDBs. | Permission name | |-----------------| -| [view_all_bdbs_alerts]({{< relref "/operate/rs/references/rest-api/permissions#view_all_bdbs_alerts" >}}) | +| [view_all_bdbs_alerts]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_all_bdbs_alerts" >}}) | ### Request {#get-all-request} @@ -46,7 +46,7 @@ Get all alert states for all CRDT sources of all CRDBs. ### Response {#get-all-response} -Returns a hash of alert UIDs and the [alerts states]({{< relref "/operate/rs/references/rest-api/objects/alert" >}}) for each local BDB of CRDB. +Returns a hash of alert UIDs and the [alerts states]({{< relref "/operate/rs/7.4/references/rest-api/objects/alert" >}}) for each local BDB of CRDB. #### Example JSON body @@ -87,7 +87,7 @@ Get all alert states for all crdt sources for a specific local bdb of a CRDB. | Permission name | |-----------------| -| [view_bdb_alerts]({{< relref "/operate/rs/references/rest-api/permissions#view_bdb_alerts" >}}) | +| [view_bdb_alerts]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_bdb_alerts" >}}) | ### Request {#get-request-all-crdt-alerts} @@ -110,7 +110,7 @@ Get all alert states for all crdt sources for a specific local bdb of a CRDB. ### Response {#get-response-all-crdt-alerts} -Returns a hash of [alert objects]({{< relref "/operate/rs/references/rest-api/objects/alert" >}}) and their states. +Returns a hash of [alert objects]({{< relref "/operate/rs/7.4/references/rest-api/objects/alert" >}}) and their states. #### Example JSON body @@ -150,7 +150,7 @@ of a CRDB. | Permission name | |-----------------| -| [view_bdb_alerts]({{< relref "/operate/rs/references/rest-api/permissions#view_bdb_alerts" >}}) | +| [view_bdb_alerts]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_bdb_alerts" >}}) | ### Request {#get-request-crdt-alerts} @@ -174,7 +174,7 @@ of a CRDB. ### Response {#get-response-crdt-alerts} -Returns a hash of [alert objects]({{< relref "/operate/rs/references/rest-api/objects/alert" >}}) and their states. +Returns a hash of [alert objects]({{< relref "/operate/rs/7.4/references/rest-api/objects/alert" >}}) and their states. #### Example JSON body @@ -213,7 +213,7 @@ Get a BDB alert state. | Permission name | |-----------------| -| [view_bdb_alerts]({{< relref "/operate/rs/references/rest-api/permissions#view_bdb_alerts" >}}) | +| [view_bdb_alerts]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_bdb_alerts" >}}) | ### Request {#get-request-alert} @@ -239,7 +239,7 @@ Get a BDB alert state. ### Response {#get-response-alert} -Returns an [alert object]({{< relref "/operate/rs/references/rest-api/objects/alert" >}}). +Returns an [alert object]({{< relref "/operate/rs/7.4/references/rest-api/objects/alert" >}}). #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/debuginfo.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/debuginfo.md index d31b8c1916..85b7bdb474 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/debuginfo.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/debuginfo.md @@ -27,7 +27,7 @@ Downloads a tar file that contains debug info from all databases. | Permission name | |-----------------| -| [view_debugging_info]({{< relref "/operate/rs/references/rest-api/permissions#view_debugging_info" >}}) | +| [view_debugging_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_debugging_info" >}}) | ### Request {#get-all-request} @@ -65,7 +65,7 @@ Downloads a tar file that contains debug info from the database specified by `bd | Permission name | |-----------------| -| [view_debugging_info]({{< relref "/operate/rs/references/rest-api/permissions#view_debugging_info" >}}) | +| [view_debugging_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_debugging_info" >}}) | ### Request {#get-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/modules/_index.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/modules/_index.md index 311602976a..9f232f74f3 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/modules/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/modules/_index.md @@ -16,9 +16,9 @@ url: '/operate/rs/7.4/references/rest-api/requests/bdbs/modules/' ## Configure module | Method | Path | Description | |--------|------|-------------| -| [POST]({{< relref "/operate/rs/references/rest-api/requests/bdbs/modules/config#post-bdb-modules-config" >}}) | `/v1/bdbs/{uid}/modules/config` | Configure module | +| [POST]({{< relref "/operate/rs/7.4/references/rest-api/requests/bdbs/modules/config#post-bdb-modules-config" >}}) | `/v1/bdbs/{uid}/modules/config` | Configure module | ## Upgrade module | Method | Path | Description | |--------|------|-------------| -| [POST]({{< relref "/operate/rs/references/rest-api/requests/bdbs/modules/upgrade#post-bdb-modules-upgrade" >}}) | `/v1/bdbs/{uid}/modules/upgrade` | Upgrade module | +| [POST]({{< relref "/operate/rs/7.4/references/rest-api/requests/bdbs/modules/upgrade#post-bdb-modules-upgrade" >}}) | `/v1/bdbs/{uid}/modules/upgrade` | Upgrade module | diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/modules/config.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/modules/config.md index a30f376ba8..31d70ef179 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/modules/config.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/modules/config.md @@ -26,7 +26,7 @@ Use the module runtime configuration command (if defined) to configure new argum | Permission name | |-----------------| -| [edit_bdb_module]({{< relref "/operate/rs/references/rest-api/permissions#edit_bdb_module" >}}) | +| [edit_bdb_module]({{< relref "/operate/rs/7.4/references/rest-api/permissions#edit_bdb_module" >}}) | ### Request {#post-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/modules/upgrade.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/modules/upgrade.md index 36c0f569e5..9ce3a26a79 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/modules/upgrade.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/modules/upgrade.md @@ -26,7 +26,7 @@ Upgrades module version on a specific BDB. | Permission name | |-----------------| -| [edit_bdb_module]({{< relref "/operate/rs/references/rest-api/permissions#edit_bdb_module" >}}) | +| [edit_bdb_module]({{< relref "/operate/rs/7.4/references/rest-api/permissions#edit_bdb_module" >}}) | ### Request {#post-request} @@ -67,7 +67,7 @@ Upgrades module version on a specific BDB. ### Response {#post-response} -Returns the upgraded [module object]({{< relref "/operate/rs/references/rest-api/objects/module" >}}). +Returns the upgraded [module object]({{< relref "/operate/rs/7.4/references/rest-api/objects/module" >}}). #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/passwords.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/passwords.md index 3b3aa9c49e..deb7e657cf 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/passwords.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/passwords.md @@ -28,7 +28,7 @@ Set a single password for the bdb's default user (i.e., for `AUTH` `}}) | +| [update_bdb]({{< relref "/operate/rs/7.4/references/rest-api/permissions#update_bdb" >}}) | ### Request {#put-request} @@ -89,7 +89,7 @@ Add a password to the bdb's default user (i.e., for `AUTH` `` aut | Permission name | |-----------------| -| [update_bdb]({{< relref "/operate/rs/references/rest-api/permissions#update_bdb" >}}) | +| [update_bdb]({{< relref "/operate/rs/7.4/references/rest-api/permissions#update_bdb" >}}) | ### Request {#post-request} @@ -148,7 +148,7 @@ Delete a password from the bdb's default user (i.e., for `AUTH` ` | Permission name | |-----------------| -| [update_bdb]({{< relref "/operate/rs/references/rest-api/permissions#update_bdb" >}}) | +| [update_bdb]({{< relref "/operate/rs/7.4/references/rest-api/permissions#update_bdb" >}}) | ### Request {#delete-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/peer_stats.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/peer_stats.md index dfdece6abe..4e8f3e9fda 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/peer_stats.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/peer_stats.md @@ -29,7 +29,7 @@ Get statistics for all peer instances of a local CRDB instance. | Permission name | Roles | |-----------------|-------| -| [view_bdb_stats]({{< relref "/operate/rs/references/rest-api/permissions#view_bdb_stats" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | +| [view_bdb_stats]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_bdb_stats" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | ### Request {#get-all-request} @@ -62,7 +62,7 @@ GET /v1/bdbs/1/peer_stats?interval=5min ### Response {#get-all-response} -Returns [statistics]({{< relref "/operate/rs/references/rest-api/objects/statistics" >}}) for all CRDB peer instances. +Returns [statistics]({{< relref "/operate/rs/7.4/references/rest-api/objects/statistics" >}}) for all CRDB peer instances. #### Example JSON body @@ -121,7 +121,7 @@ Get statistics for a specific CRDB peer instance. | Permission name | Roles | |-----------------|-------| -| [view_bdb_stats]({{< relref "/operate/rs/references/rest-api/permissions#view_bdb_stats" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | +| [view_bdb_stats]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_bdb_stats" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | ### Request {#get-request} @@ -155,7 +155,7 @@ GET /v1/bdbs/1/peer_stats/3?interval=5min ### Response {#get-response} -Returns [statistics]({{< relref "/operate/rs/references/rest-api/objects/statistics" >}}) for a specific CRDB peer instance. +Returns [statistics]({{< relref "/operate/rs/7.4/references/rest-api/objects/statistics" >}}) for a specific CRDB peer instance. #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/replica_sources-alerts.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/replica_sources-alerts.md index e1cd90af13..f74be5c6db 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/replica_sources-alerts.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/replica_sources-alerts.md @@ -29,7 +29,7 @@ Get all alert states for all replica sources of all BDBs. | Permission name | |-----------------| -| [view_all_bdbs_alerts]({{< relref "/operate/rs/references/rest-api/permissions#view_all_bdbs_alerts" >}}) | +| [view_all_bdbs_alerts]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_all_bdbs_alerts" >}}) | ### Request {#get-all-request} @@ -48,7 +48,7 @@ Get all alert states for all replica sources of all BDBs. Returns a hash of alert UIDs and the alerts states for each BDB. -See [REST API alerts overview]({{< relref "/operate/rs/references/rest-api/objects/alert" >}}) for a description of the alert state object. +See [REST API alerts overview]({{< relref "/operate/rs/7.4/references/rest-api/objects/alert" >}}) for a description of the alert state object. #### Example JSON body @@ -89,7 +89,7 @@ Get all alert states for all replica sources of a specific bdb. | Permission name | |-----------------| -| [view_bdb_alerts]({{< relref "/operate/rs/references/rest-api/permissions#view_bdb_alerts" >}}) | +| [view_bdb_alerts]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_bdb_alerts" >}}) | ### Request {#get-request-all-replica-alerts} @@ -112,7 +112,7 @@ Get all alert states for all replica sources of a specific bdb. ### Response {#get-response-all-replica-alerts} -Returns a hash of [alert objects]({{< relref "/operate/rs/references/rest-api/objects/alert" >}}) and their states. +Returns a hash of [alert objects]({{< relref "/operate/rs/7.4/references/rest-api/objects/alert" >}}) and their states. #### Example JSON body @@ -151,7 +151,7 @@ Get all alert states for a specific replica source of a bdb. | Permission name | |-----------------| -| [view_bdb_alerts]({{< relref "/operate/rs/references/rest-api/permissions#view_bdb_alerts" >}}) | +| [view_bdb_alerts]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_bdb_alerts" >}}) | ### Request {#get-request-replica-alerts} @@ -175,7 +175,7 @@ Get all alert states for a specific replica source of a bdb. ### Response {#get-response-replica-alerts} -Returns a hash of [alert objects]({{< relref "/operate/rs/references/rest-api/objects/alert" >}}) and their states. +Returns a hash of [alert objects]({{< relref "/operate/rs/7.4/references/rest-api/objects/alert" >}}) and their states. #### Example JSON body @@ -214,7 +214,7 @@ Get a replica source alert state of a specific bdb. | Permission name | |-----------------| -| [view_bdb_alerts]({{< relref "/operate/rs/references/rest-api/permissions#view_bdb_alerts" >}}) | +| [view_bdb_alerts]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_bdb_alerts" >}}) | ### Request {#get-request-alert} @@ -240,7 +240,7 @@ Get a replica source alert state of a specific bdb. ### Response {#get-response-alert} -Returns an [alert state object]({{< relref "/operate/rs/references/rest-api/objects/alert" >}}). +Returns an [alert state object]({{< relref "/operate/rs/7.4/references/rest-api/objects/alert" >}}). #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/shards.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/shards.md index 2cf90147c5..7c0e2f8ac6 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/shards.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/shards.md @@ -43,7 +43,7 @@ Gets the status for all shards that belong to the specified database. ### Response {#get-response} -The response body contains a JSON array with all shards, represented as [shard objects]({{}}). +The response body contains a JSON array with all shards, represented as [shard objects]({{}}). #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/stats/_index.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/stats/_index.md index eb537d50f7..15e5ac22c9 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/stats/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/stats/_index.md @@ -30,7 +30,7 @@ Get statistics for all databases. | Permission name | Roles | |-----------------|-------| -| [view_all_bdb_stats]({{< relref "/operate/rs/references/rest-api/permissions#view_all_bdb_stats" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | +| [view_all_bdb_stats]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_all_bdb_stats" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | ### Request {#get-all-request} @@ -57,7 +57,7 @@ GET /v1/bdbs/stats?interval=1hour&stime=2014-08-28T10:00:00Z ### Response {#get-all-response} -Returns [statistics]({{< relref "/operate/rs/references/rest-api/objects/statistics" >}}) for all databases. +Returns [statistics]({{< relref "/operate/rs/7.4/references/rest-api/objects/statistics" >}}) for all databases. #### Example JSON body @@ -171,7 +171,7 @@ Get statistics for a specific database. | Permission name | Roles | |-----------------|-------| -| [view_bdb_stats]({{< relref "/operate/rs/references/rest-api/permissions#view_bdb_stats" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | +| [view_bdb_stats]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_bdb_stats" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | ### Request {#get-request} @@ -204,7 +204,7 @@ GET /v1/bdbs/stats/1?interval=1hour&stime=2014-08-28T10:00:00Z ### Response {#get-response} -Returns [statistics]({{< relref "/operate/rs/references/rest-api/objects/statistics" >}}) for a specific database. +Returns [statistics]({{< relref "/operate/rs/7.4/references/rest-api/objects/statistics" >}}) for a specific database. #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/stats/last.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/stats/last.md index 7cb03b3f31..2b630c0e15 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/stats/last.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/stats/last.md @@ -29,7 +29,7 @@ Get the most recent statistics for all databases. | Permission name | Roles | |-----------------|-------| -| [view_all_bdb_stats]({{< relref "/operate/rs/references/rest-api/permissions#view_all_bdb_stats" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | +| [view_all_bdb_stats]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_all_bdb_stats" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | ### Request {#get-all-request} @@ -60,7 +60,7 @@ Get the most recent statistics for all databases. ### Response {#get-all-response} -Returns [statistics]({{< relref "/operate/rs/references/rest-api/objects/statistics" >}}) for all databases. +Returns [statistics]({{< relref "/operate/rs/7.4/references/rest-api/objects/statistics" >}}) for all databases. #### Example JSON body @@ -147,7 +147,7 @@ Get the most recent statistics for a specific database. | Permission name | Roles | |-----------------|-------| -| [view_bdb_stats]({{< relref "/operate/rs/references/rest-api/permissions#view_bdb_stats" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | +| [view_bdb_stats]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_bdb_stats" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | ### Request {#get-request} @@ -178,7 +178,7 @@ GET /v1/bdbs/stats/last/1?metrics=no_of_keys,used_memory ### Response {#get-response} -Returns the most recent [statistics]({{< relref "/operate/rs/references/rest-api/objects/statistics" >}}) for a specific database. +Returns the most recent [statistics]({{< relref "/operate/rs/7.4/references/rest-api/objects/statistics" >}}) for a specific database. #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/sync_source_stats.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/sync_source_stats.md index 0fc59b9e7f..b5ffe3e298 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/sync_source_stats.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/sync_source_stats.md @@ -29,7 +29,7 @@ Get stats for all syncer sources of a local database. | Permission name | Roles | |-----------------|-------| -| [view_bdb_stats]({{< relref "/operate/rs/references/rest-api/permissions#view_bdb_stats" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | +| [view_bdb_stats]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_bdb_stats" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | ### Request {#get-all-request} @@ -62,7 +62,7 @@ GET /v1/bdbs/1/sync_source_stats?interval=5min ### Response {#get-all-response} -Returns [statistics]({{< relref "/operate/rs/references/rest-api/objects/statistics" >}}) for all syncer sources. +Returns [statistics]({{< relref "/operate/rs/7.4/references/rest-api/objects/statistics" >}}) for all syncer sources. #### Example JSON body @@ -112,7 +112,7 @@ Get stats for a specific syncer (Replica Of) instance. | Permission name | Roles | |-----------------|-------| -| [view_bdb_stats]({{< relref "/operate/rs/references/rest-api/permissions#view_bdb_stats" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | +| [view_bdb_stats]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_bdb_stats" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | ### Request {#get-request} @@ -146,7 +146,7 @@ GET /v1/bdbs/1/sync_source_stats/1?interval=5min ### Response {#get-response} -Returns [statistics]({{< relref "/operate/rs/references/rest-api/objects/statistics" >}}) for a specific syncer instance. +Returns [statistics]({{< relref "/operate/rs/7.4/references/rest-api/objects/statistics" >}}) for a specific syncer instance. #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/syncer_state/_index.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/syncer_state/_index.md index d84f1dcdaf..7128502722 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/syncer_state/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/syncer_state/_index.md @@ -26,14 +26,14 @@ GET /v1/bdbs/{int: uid}/syncer_state Get a CRDB's syncer state as JSON. {{}} -This endpoint is deprecated as of Redis Enterprise Software version 7.2.4 and will be removed in a future release. Use [`/v1/bdbs//syncer_state/crdt`]({{< relref "/operate/rs/references/rest-api/requests/bdbs/syncer_state/crdt" >}}) instead. +This endpoint is deprecated as of Redis Enterprise Software version 7.2.4 and will be removed in a future release. Use [`/v1/bdbs//syncer_state/crdt`]({{< relref "/operate/rs/7.4/references/rest-api/requests/bdbs/syncer_state/crdt" >}}) instead. {{}} ### Permissions | Permission name | Roles | |-----------------|---------| -| [view_bdb_info]({{< relref "/operate/rs/references/rest-api/permissions#view_bdb_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | +| [view_bdb_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_bdb_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | ### Request {#get-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/syncer_state/crdt.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/syncer_state/crdt.md index 6cbe7c253c..e40faacdc3 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/syncer_state/crdt.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/syncer_state/crdt.md @@ -28,7 +28,7 @@ Get a CRDB's syncer state as JSON. | Permission name | Roles | |-----------------|---------| -| [view_bdb_info]({{< relref "/operate/rs/references/rest-api/permissions#view_bdb_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | +| [view_bdb_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_bdb_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | ### Request {#get-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/syncer_state/replica.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/syncer_state/replica.md index 6bec6bede2..67db359d0a 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/syncer_state/replica.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/syncer_state/replica.md @@ -28,7 +28,7 @@ Get a CRDB replica's syncer state as JSON. | Permission name | Roles | |-----------------|---------| -| [view_bdb_info]({{< relref "/operate/rs/references/rest-api/permissions#view_bdb_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | +| [view_bdb_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_bdb_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | ### Request {#get-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/upgrade.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/upgrade.md index f01b0616e8..b58829d295 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/upgrade.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/upgrade.md @@ -26,7 +26,7 @@ Upgrade a database. | Permission name | |-----------------| -| [update_bdb_with_action]({{< relref "/operate/rs/references/rest-api/permissions#update_bdb_with_action" >}}) | +| [update_bdb_with_action]({{< relref "/operate/rs/7.4/references/rest-api/permissions#update_bdb_with_action" >}}) | ### Request {#post-request} @@ -67,7 +67,7 @@ Upgrade a database. ### Response {#post-response} -Returns the upgraded [BDB object]({{< relref "/operate/rs/references/rest-api/objects/bdb" >}}). +Returns the upgraded [BDB object]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb" >}}). #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/bootstrap/_index.md b/content/operate/rs/7.4/references/rest-api/requests/bootstrap/_index.md index d14ca796d8..dc11581005 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bootstrap/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bootstrap/_index.md @@ -58,7 +58,7 @@ The `bootstrap_status` object contains the following information: | error_code | If state is `error`, this error code describes the type of error encountered. | | error_details | An error-specific object that may contain additional information about the error. A common field in use is `message` which provides a more verbose error message. -The `local_node_info` object is a subset of a [node object]({{< relref "/operate/rs/references/rest-api/objects/node" >}}) that provides information about the node configuration. +The `local_node_info` object is a subset of a [node object]({{< relref "/operate/rs/7.4/references/rest-api/objects/node" >}}) that provides information about the node configuration. #### Example JSON body @@ -141,7 +141,7 @@ POST /v1/bootstrap/{action} Initiate bootstrapping. The request must contain a bootstrap configuration JSON object, as -described in [Object attributes]({{< relref "/operate/rs/references/rest-api/objects/" >}}) or a minimal subset. +described in [Object attributes]({{< relref "/operate/rs/7.4/references/rest-api/objects/" >}}) or a minimal subset. Bootstrapping is permitted only when the current bootstrap state is `idle` or `error` (in which case the process will restart with the new @@ -226,7 +226,7 @@ POST /v1/bootstrap/create_cluster #### Request body -Include a [bootstrap object]({{< relref "/operate/rs/references/rest-api/objects/bootstrap" >}}) in the request body. +Include a [bootstrap object]({{< relref "/operate/rs/7.4/references/rest-api/objects/bootstrap" >}}) in the request body. ### Response {#post-response} diff --git a/content/operate/rs/7.4/references/rest-api/requests/bootstrap/validate.md b/content/operate/rs/7.4/references/rest-api/requests/bootstrap/validate.md index c75ef51c79..cd32b05af9 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bootstrap/validate.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bootstrap/validate.md @@ -33,7 +33,7 @@ returns with a response. #### Request body -The request must contain a [bootstrap configuration object]({{< relref "/operate/rs/references/rest-api/objects/bootstrap" >}}), similar to the one used for actual bootstrapping. +The request must contain a [bootstrap configuration object]({{< relref "/operate/rs/7.4/references/rest-api/objects/bootstrap" >}}), similar to the one used for actual bootstrapping. ### Response {#post-response} diff --git a/content/operate/rs/7.4/references/rest-api/requests/cluster/_index.md b/content/operate/rs/7.4/references/rest-api/requests/cluster/_index.md index 98da5b29ce..65d64a3e54 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/cluster/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/cluster/_index.md @@ -28,7 +28,7 @@ Get cluster info. | Permission name | |-----------------| -| [view_cluster_info]({{< relref "/operate/rs/references/rest-api/permissions#view_cluster_info" >}}) | +| [view_cluster_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_cluster_info" >}}) | ### Request {#get-request} @@ -45,7 +45,7 @@ Get cluster info. ### Response {#get-response} -Returns a [cluster object]({{< relref "/operate/rs/references/rest-api/objects/cluster" >}}). +Returns a [cluster object]({{< relref "/operate/rs/7.4/references/rest-api/objects/cluster" >}}). #### Example JSON body @@ -78,14 +78,14 @@ Returns a [cluster object]({{< relref "/operate/rs/references/rest-api/objects/c Update cluster settings. If called with the `dry_run` URL query string, the function will -validate the [cluster object]({{< relref "/operate/rs/references/rest-api/objects/cluster" >}}), but will not apply the requested +validate the [cluster object]({{< relref "/operate/rs/7.4/references/rest-api/objects/cluster" >}}), but will not apply the requested changes. #### Required permissions | Permission name | |-----------------| -| [update_cluster]({{< relref "/operate/rs/references/rest-api/permissions#update_cluster" >}}) | +| [update_cluster]({{< relref "/operate/rs/7.4/references/rest-api/permissions#update_cluster" >}}) | ### Request {#put-request} @@ -125,7 +125,7 @@ The above request will enable email alerts and alert reporting for node failures #### Request body -Include a [cluster object]({{< relref "/operate/rs/references/rest-api/objects/cluster" >}}) with updated fields in the request body. +Include a [cluster object]({{< relref "/operate/rs/7.4/references/rest-api/objects/cluster" >}}) with updated fields in the request body. ### Response {#put-response} diff --git a/content/operate/rs/7.4/references/rest-api/requests/cluster/actions.md b/content/operate/rs/7.4/references/rest-api/requests/cluster/actions.md index a047d7eba8..65e57c915e 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/cluster/actions.md +++ b/content/operate/rs/7.4/references/rest-api/requests/cluster/actions.md @@ -29,7 +29,7 @@ Get the status of all currently executing, queued, or completed cluster actions. | Permission name | |-----------------| -| [view_status_of_cluster_action]({{< relref "/operate/rs/references/rest-api/permissions#view_status_of_cluster_action" >}}) | +| [view_status_of_cluster_action]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_status_of_cluster_action" >}}) | ### Request {#get-all-request} @@ -39,7 +39,7 @@ Get the status of all currently executing, queued, or completed cluster actions. ### Response {#get-all-response} -Returns a JSON array of [action objects]({{< relref "/operate/rs/references/rest-api/objects/action" >}}). +Returns a JSON array of [action objects]({{< relref "/operate/rs/7.4/references/rest-api/objects/action" >}}). #### Example JSON body @@ -72,7 +72,7 @@ Get the status of a currently executing, queued, or completed cluster action. | Permission name | |-----------------| -| [view_status_of_cluster_action]({{< relref "/operate/rs/references/rest-api/permissions#view_status_of_cluster_action" >}}) | +| [view_status_of_cluster_action]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_status_of_cluster_action" >}}) | ### Request {#get-request} @@ -88,7 +88,7 @@ Get the status of a currently executing, queued, or completed cluster action. ### Response {#get-response} -Returns an [action object]({{< relref "/operate/rs/references/rest-api/objects/action" >}}). +Returns an [action object]({{< relref "/operate/rs/7.4/references/rest-api/objects/action" >}}). #### Example JSON body @@ -125,7 +125,7 @@ removed as soon as the new one is submitted. | Permission name | |-----------------| -| [start_cluster_action]({{< relref "/operate/rs/references/rest-api/permissions#start_cluster_action" >}}) | +| [start_cluster_action]({{< relref "/operate/rs/7.4/references/rest-api/permissions#start_cluster_action" >}}) | ### Request {#post-request} @@ -173,7 +173,7 @@ a previously executed and completed action. | Permission name | |-----------------| -| [cancel_cluster_action]({{< relref "/operate/rs/references/rest-api/permissions#cancel_cluster_action" >}}) | +| [cancel_cluster_action]({{< relref "/operate/rs/7.4/references/rest-api/permissions#cancel_cluster_action" >}}) | ### Request {#delete-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/cluster/alerts.md b/content/operate/rs/7.4/references/rest-api/requests/cluster/alerts.md index 897e83948e..85795b066f 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/cluster/alerts.md +++ b/content/operate/rs/7.4/references/rest-api/requests/cluster/alerts.md @@ -27,7 +27,7 @@ Get all alert states for the cluster object. | Permission name | |-----------------| -| [view_cluster_alerts]({{< relref "/operate/rs/references/rest-api/permissions#view_cluster_alerts" >}}) | +| [view_cluster_alerts]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_cluster_alerts" >}}) | ### Request {#get-all-request} @@ -50,7 +50,7 @@ Get all alert states for the cluster object. ### Response {#get-all-response} -Returns a hash of [alert objects]({{< relref "/operate/rs/references/rest-api/objects/alert" >}}) and their states. +Returns a hash of [alert objects]({{< relref "/operate/rs/7.4/references/rest-api/objects/alert" >}}) and their states. #### Example JSON body @@ -85,7 +85,7 @@ Get a cluster alert state. | Permission name | |-----------------| -| [view_cluster_alerts]({{< relref "/operate/rs/references/rest-api/permissions#view_cluster_alerts" >}}) | +| [view_cluster_alerts]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_cluster_alerts" >}}) | ### Request {#get-request} @@ -108,7 +108,7 @@ Get a cluster alert state. ### Response {#get-response} -Returns an [alert object]({{< relref "/operate/rs/references/rest-api/objects/alert" >}}). +Returns an [alert object]({{< relref "/operate/rs/7.4/references/rest-api/objects/alert" >}}). #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/cluster/auditing-db-conns.md b/content/operate/rs/7.4/references/rest-api/requests/cluster/auditing-db-conns.md index 38207d4bdd..716c96fff1 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/cluster/auditing-db-conns.md +++ b/content/operate/rs/7.4/references/rest-api/requests/cluster/auditing-db-conns.md @@ -22,13 +22,13 @@ url: '/operate/rs/7.4/references/rest-api/requests/cluster/auditing-db-conns/' GET /v1/cluster/auditing/db_conns -Gets the configuration settings for [auditing database connections]({{< relref "/operate/rs/security/audit-events" >}}). +Gets the configuration settings for [auditing database connections]({{< relref "/operate/rs/7.4/security/audit-events" >}}). #### Required permissions | Permission name | |-----------------| -| [view_cluster_info]({{< relref "/operate/rs/references/rest-api/permissions#view_cluster_info" >}}) | +| [view_cluster_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_cluster_info" >}}) | ### Request {#get-request} @@ -46,7 +46,7 @@ Gets the configuration settings for [auditing database connections]({{< relref " ### Response {#get-response} -Returns a [database connection auditing configuration object]({{< relref "/operate/rs/references/rest-api/objects/db-conns-auditing-config" >}}). +Returns a [database connection auditing configuration object]({{< relref "/operate/rs/7.4/references/rest-api/objects/db-conns-auditing-config" >}}). #### Example JSON body @@ -79,13 +79,13 @@ When errors are reported, the server may return a JSON object with `error_code` PUT /v1/cluster/auditing/db_conns -Updates the configuration settings for [auditing database connections]({{< relref "/operate/rs/security/audit-events" >}}). +Updates the configuration settings for [auditing database connections]({{< relref "/operate/rs/7.4/security/audit-events" >}}). #### Required permissions | Permission name | |-----------------| -| [update_cluster]({{< relref "/operate/rs/references/rest-api/permissions#update_cluster" >}}) | +| [update_cluster]({{< relref "/operate/rs/7.4/references/rest-api/permissions#update_cluster" >}}) | ### Request {#put-request} @@ -114,11 +114,11 @@ Updates the configuration settings for [auditing database connections]({{< relre #### Request body -Include a [database connection auditing configuration object]({{< relref "/operate/rs/references/rest-api/objects/db-conns-auditing-config" >}}) with updated fields in the request body. +Include a [database connection auditing configuration object]({{< relref "/operate/rs/7.4/references/rest-api/objects/db-conns-auditing-config" >}}) with updated fields in the request body. ### Response {#put-response} -Returns the updated [database connection auditing configuration object]({{< relref "/operate/rs/references/rest-api/objects/db-conns-auditing-config" >}}). +Returns the updated [database connection auditing configuration object]({{< relref "/operate/rs/7.4/references/rest-api/objects/db-conns-auditing-config" >}}). #### Example JSON body @@ -151,13 +151,13 @@ When errors are reported, the server may return a JSON object with `error_code` DELETE /v1/cluster/auditing/db_conns -Resets the configuration settings for [auditing database connections]({{< relref "/operate/rs/security/audit-events" >}}). +Resets the configuration settings for [auditing database connections]({{< relref "/operate/rs/7.4/security/audit-events" >}}). #### Required permissions | Permission name | |-----------------| -| [update_cluster]({{< relref "/operate/rs/references/rest-api/permissions#update_cluster" >}}) | +| [update_cluster]({{< relref "/operate/rs/7.4/references/rest-api/permissions#update_cluster" >}}) | ### Request {#delete-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/cluster/certificates/_index.md b/content/operate/rs/7.4/references/rest-api/requests/cluster/certificates/_index.md index 9fc05e7ac2..a568fe751b 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/cluster/certificates/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/cluster/certificates/_index.md @@ -31,7 +31,7 @@ Get the cluster's certificates. | Permission name | |-----------------| -| [view_cluster_info]({{< relref "/operate/rs/references/rest-api/permissions#view_cluster_info" >}}) | +| [view_cluster_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_cluster_info" >}}) | ### Request {#get-request} @@ -76,7 +76,7 @@ PUT /v1/cluster/update_cert Replaces an existing certificate on all nodes within the cluster with a new certificate. The new certificate must pass validation before it can replace the old certificate. -See the [certificates table]({{< relref "/operate/rs/security/certificates" >}}) for the list of cluster certificates and their descriptions. +See the [certificates table]({{< relref "/operate/rs/7.4/security/certificates" >}}) for the list of cluster certificates and their descriptions. ### Request {#put-request} @@ -122,7 +122,7 @@ Otherwise, retry the certificate update in case the failure was due to a tempora Removes the specified cluster certificate from both CCS and disk across all nodes. Only optional certificates can be deleted through -this endpoint. See the [certificates table]({{< relref "/operate/rs/security/certificates" >}}) for the list of cluster certificates and their descriptions. +this endpoint. See the [certificates table]({{< relref "/operate/rs/7.4/security/certificates" >}}) for the list of cluster certificates and their descriptions. ### Request {#delete-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/cluster/check.md b/content/operate/rs/7.4/references/rest-api/requests/cluster/check.md index ad01c1b4fa..181a038a77 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/cluster/check.md +++ b/content/operate/rs/7.4/references/rest-api/requests/cluster/check.md @@ -38,7 +38,7 @@ Runs the following checks on all cluster nodes: | Permission name | |-----------------| -| [view_all_nodes_checks]({{< relref "/operate/rs/references/rest-api/permissions#view_all_nodes_checks" >}}) | +| [view_all_nodes_checks]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_all_nodes_checks" >}}) | ### Request {#get-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/cluster/debuginfo.md b/content/operate/rs/7.4/references/rest-api/requests/cluster/debuginfo.md index 21cb82f14d..4a6a1044c0 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/cluster/debuginfo.md +++ b/content/operate/rs/7.4/references/rest-api/requests/cluster/debuginfo.md @@ -26,7 +26,7 @@ Downloads a tar file that contains debug info from all nodes and databases. | Permission name | |-----------------| -| [view_debugging_info]({{< relref "/operate/rs/references/rest-api/permissions#view_debugging_info" >}}) | +| [view_debugging_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_debugging_info" >}}) | ### Request {#get-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/cluster/ldap.md b/content/operate/rs/7.4/references/rest-api/requests/cluster/ldap.md index 7e84809818..81c03a80f9 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/cluster/ldap.md +++ b/content/operate/rs/7.4/references/rest-api/requests/cluster/ldap.md @@ -28,7 +28,7 @@ Get the LDAP configuration. | Permission name | |-----------------| -| [view_ldap_config]({{< relref "/operate/rs/references/rest-api/permissions#view_ldap_config" >}}) | +| [view_ldap_config]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_ldap_config" >}}) | ### Request {#get-request} @@ -45,7 +45,7 @@ Get the LDAP configuration. ### Response {#get-response} -Returns an [LDAP object]({{< relref "/operate/rs/references/rest-api/objects/ldap" >}}). +Returns an [LDAP object]({{< relref "/operate/rs/7.4/references/rest-api/objects/ldap" >}}). #### Example JSON body @@ -81,7 +81,7 @@ Set or update the cluster LDAP configuration. | Permission name | |-----------------| -| [config_ldap]({{< relref "/operate/rs/references/rest-api/permissions#config_ldap" >}}) | +| [config_ldap]({{< relref "/operate/rs/7.4/references/rest-api/permissions#config_ldap" >}}) | ### Request {#put-request} @@ -114,7 +114,7 @@ Set or update the cluster LDAP configuration. #### Request body -Include an [LDAP object]({{< relref "/operate/rs/references/rest-api/objects/ldap" >}}) with updated fields in the request body. +Include an [LDAP object]({{< relref "/operate/rs/7.4/references/rest-api/objects/ldap" >}}) with updated fields in the request body. ### Response {#put-response} @@ -145,7 +145,7 @@ Clear the LDAP configuration. | Permission name | |-----------------| -| [config_ldap]({{< relref "/operate/rs/references/rest-api/permissions#config_ldap" >}}) | +| [config_ldap]({{< relref "/operate/rs/7.4/references/rest-api/permissions#config_ldap" >}}) | ### Request {#delete-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/cluster/module-capabilities.md b/content/operate/rs/7.4/references/rest-api/requests/cluster/module-capabilities.md index f6e6932a48..3bbae5fb26 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/cluster/module-capabilities.md +++ b/content/operate/rs/7.4/references/rest-api/requests/cluster/module-capabilities.md @@ -26,7 +26,7 @@ List possible Redis module capabilities. | Permission name | |-----------------| -| [view_cluster_modules]({{< relref "/operate/rs/references/rest-api/permissions#view_cluster_modules" >}}) | +| [view_cluster_modules]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_cluster_modules" >}}) | ### Request {#get-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/cluster/policy.md b/content/operate/rs/7.4/references/rest-api/requests/cluster/policy.md index c44efdb722..7646155ab7 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/cluster/policy.md +++ b/content/operate/rs/7.4/references/rest-api/requests/cluster/policy.md @@ -27,7 +27,7 @@ Gets the cluster's current policy settings. | Permission name | |-----------------| -| [view_cluster_info]({{< relref "/operate/rs/references/rest-api/permissions#view_cluster_info" >}}) | +| [view_cluster_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_cluster_info" >}}) | ### Request {#get-request} @@ -45,7 +45,7 @@ Gets the cluster's current policy settings. ### Response {#get-response} -Returns a [cluster settings object]({{< relref "/operate/rs/references/rest-api/objects/cluster_settings" >}}). +Returns a [cluster settings object]({{< relref "/operate/rs/7.4/references/rest-api/objects/cluster_settings" >}}). #### Example JSON body @@ -77,7 +77,7 @@ Update cluster policy settings. | Permission name | |-----------------| -| [update_cluster]({{< relref "/operate/rs/references/rest-api/permissions#update_cluster" >}}) | +| [update_cluster]({{< relref "/operate/rs/7.4/references/rest-api/permissions#update_cluster" >}}) | ### Request {#put-request} @@ -103,7 +103,7 @@ Update cluster policy settings. #### Request body -Include a [cluster settings object]({{< relref "/operate/rs/references/rest-api/objects/cluster_settings" >}}) with updated fields in the request body. +Include a [cluster settings object]({{< relref "/operate/rs/7.4/references/rest-api/objects/cluster_settings" >}}) with updated fields in the request body. ### Response {#put-response} diff --git a/content/operate/rs/7.4/references/rest-api/requests/cluster/services_configuration.md b/content/operate/rs/7.4/references/rest-api/requests/cluster/services_configuration.md index be938eb107..1dda89ebae 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/cluster/services_configuration.md +++ b/content/operate/rs/7.4/references/rest-api/requests/cluster/services_configuration.md @@ -27,7 +27,7 @@ Get cluster services settings. | Permission name | |-----------------| -| [view_cluster_info]({{< relref "/operate/rs/references/rest-api/permissions#view_cluster_info" >}}) | +| [view_cluster_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_cluster_info" >}}) | ### Request {#get-request} @@ -44,7 +44,7 @@ Get cluster services settings. ### Response {#get-response} -Returns a [services configuration object]({{< relref "/operate/rs/references/rest-api/objects/services_configuration" >}}). +Returns a [services configuration object]({{< relref "/operate/rs/7.4/references/rest-api/objects/services_configuration" >}}). #### Example JSON body @@ -76,7 +76,7 @@ Update the cluster services settings. | Permission name | |-----------------| -| [update_cluster]({{< relref "/operate/rs/references/rest-api/permissions#update_cluster" >}}) | +| [update_cluster]({{< relref "/operate/rs/7.4/references/rest-api/permissions#update_cluster" >}}) | ### Request {#put-request} @@ -104,11 +104,11 @@ Update the cluster services settings. #### Request body -Include a [services configuration object]({{< relref "/operate/rs/references/rest-api/objects/services_configuration" >}}) with updated fields in the request body. +Include a [services configuration object]({{< relref "/operate/rs/7.4/references/rest-api/objects/services_configuration" >}}) with updated fields in the request body. ### Response {#put-response} -Returns the updated [services configuration object]({{< relref "/operate/rs/references/rest-api/objects/services_configuration" >}}). +Returns the updated [services configuration object]({{< relref "/operate/rs/7.4/references/rest-api/objects/services_configuration" >}}). #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/cluster/stats/_index.md b/content/operate/rs/7.4/references/rest-api/requests/cluster/stats/_index.md index 02fa17ce85..8f7105b98f 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/cluster/stats/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/cluster/stats/_index.md @@ -29,7 +29,7 @@ Get cluster statistics. | Permission name | Roles | |-----------------|-------| -| [view_cluster_stats]({{< relref "/operate/rs/references/rest-api/permissions#view_cluster_stats" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | +| [view_cluster_stats]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_cluster_stats" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | ### Request {#get-request} @@ -56,7 +56,7 @@ GET /v1/cluster/stats/1?interval=1hour&stime=2014-08-28T10:00:00Z ### Response {#get-response} -Returns [statistics]({{< relref "/operate/rs/references/rest-api/objects/statistics" >}}) for the cluster. +Returns [statistics]({{< relref "/operate/rs/7.4/references/rest-api/objects/statistics" >}}) for the cluster. #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/cluster/stats/last.md b/content/operate/rs/7.4/references/rest-api/requests/cluster/stats/last.md index 1306039f3c..0d0efb1886 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/cluster/stats/last.md +++ b/content/operate/rs/7.4/references/rest-api/requests/cluster/stats/last.md @@ -26,7 +26,7 @@ Get the most recent cluster statistics. | Permission name | |-----------------| -| [view_cluster_stats]({{< relref "/operate/rs/references/rest-api/permissions#view_cluster_stats" >}}) | +| [view_cluster_stats]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_cluster_stats" >}}) | ### Request {#get-request} @@ -52,7 +52,7 @@ Get the most recent cluster statistics. ### Response {#get-response} -Returns the most recent [statistics]({{< relref "/operate/rs/references/rest-api/objects/statistics" >}}) for the cluster. +Returns the most recent [statistics]({{< relref "/operate/rs/7.4/references/rest-api/objects/statistics" >}}) for the cluster. #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/crdb_tasks/_index.md b/content/operate/rs/7.4/references/rest-api/requests/crdb_tasks/_index.md index 7349dbc387..c293942707 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/crdb_tasks/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/crdb_tasks/_index.md @@ -45,7 +45,7 @@ The status of a completed task is kept for 500 seconds by default. ### Response {#get-response} -Returns a [CRDB task object]({{< relref "/operate/rs/references/rest-api/objects/crdb_task" >}}). +Returns a [CRDB task object]({{< relref "/operate/rs/7.4/references/rest-api/objects/crdb_task" >}}). ### Status codes {#get-status-codes} diff --git a/content/operate/rs/7.4/references/rest-api/requests/crdbs/_index.md b/content/operate/rs/7.4/references/rest-api/requests/crdbs/_index.md index 16a88f3bfb..9d3f35b9c8 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/crdbs/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/crdbs/_index.md @@ -46,7 +46,7 @@ GET /v1/crdbs ### Response {#get-all-response} -Returns a JSON array of [CRDB objects]({{< relref "/operate/rs/references/rest-api/objects/crdb" >}}). +Returns a JSON array of [CRDB objects]({{< relref "/operate/rs/7.4/references/rest-api/objects/crdb" >}}). ##### Status codes {#get-all-status-codes} @@ -92,7 +92,7 @@ Get a specific Active-Active database. ### Response {#get-response} -Returns a [CRDB object]({{< relref "/operate/rs/references/rest-api/objects/crdb" >}}). +Returns a [CRDB object]({{< relref "/operate/rs/7.4/references/rest-api/objects/crdb" >}}). #### Status codes {#get-status-codes} @@ -110,7 +110,7 @@ PATCH /v1/crdbs/{crdb_guid} Update an Active-Active database's configuration. -In order to add or remove instances, use [`POST crdbs/{crdb_guid}/updates`]({{< relref "/operate/rs/references/rest-api/requests/crdbs/updates#post-crdbs-updates" >}}) instead. +In order to add or remove instances, use [`POST crdbs/{crdb_guid}/updates`]({{< relref "/operate/rs/7.4/references/rest-api/requests/crdbs/updates#post-crdbs-updates" >}}) instead. ### Request {#patch-request} @@ -135,11 +135,11 @@ In order to add or remove instances, use [`POST crdbs/{crdb_guid}/updates` #### Request body -Include a [CRDB object]({{< relref "/operate/rs/references/rest-api/objects/crdb" >}}) with updated fields in the request body. +Include a [CRDB object]({{< relref "/operate/rs/7.4/references/rest-api/objects/crdb" >}}) with updated fields in the request body. ### Response {#patch-response} -Returns a [CRDB task object]({{< relref "/operate/rs/references/rest-api/objects/crdb_task" >}}). +Returns a [CRDB task object]({{< relref "/operate/rs/7.4/references/rest-api/objects/crdb_task" >}}). #### Status codes {#patch-status-codes} @@ -176,7 +176,7 @@ Create a new Active-Active database. #### Request body -Include a [CRDB object]({{< relref "/operate/rs/references/rest-api/objects/crdb" >}}), which defines the Active-Active database, in the request body. +Include a [CRDB object]({{< relref "/operate/rs/7.4/references/rest-api/objects/crdb" >}}), which defines the Active-Active database, in the request body. ##### Example body @@ -224,7 +224,7 @@ This JSON body creates an Active-Active database without TLS and with two partic ### Response {#post-response} -Returns a [CRDB task object]({{< relref "/operate/rs/references/rest-api/objects/crdb_task" >}}). +Returns a [CRDB task object]({{< relref "/operate/rs/7.4/references/rest-api/objects/crdb_task" >}}). #### Status codes {#post-status-codes} @@ -266,7 +266,7 @@ Delete an Active-Active database. ### Response {#delete-response} -Returns a [CRDB task object]({{< relref "/operate/rs/references/rest-api/objects/crdb_task" >}}). +Returns a [CRDB task object]({{< relref "/operate/rs/7.4/references/rest-api/objects/crdb_task" >}}). #### Status codes {#delete-status-codes} diff --git a/content/operate/rs/7.4/references/rest-api/requests/crdbs/flush.md b/content/operate/rs/7.4/references/rest-api/requests/crdbs/flush.md index be5086b049..da612d8509 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/crdbs/flush.md +++ b/content/operate/rs/7.4/references/rest-api/requests/crdbs/flush.md @@ -47,7 +47,7 @@ PUT /v1/crdbs/552bbccb-99f3-4142-bd17-93d245f0bc79/flush ### Response {#put-response} -Returns a [CRDB task object]({{< relref "/operate/rs/references/rest-api/objects/crdb_task" >}}). +Returns a [CRDB task object]({{< relref "/operate/rs/7.4/references/rest-api/objects/crdb_task" >}}). #### Status codes {#put-status-codes} diff --git a/content/operate/rs/7.4/references/rest-api/requests/crdbs/health_report.md b/content/operate/rs/7.4/references/rest-api/requests/crdbs/health_report.md index 9ff24fcb6f..880163e03e 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/crdbs/health_report.md +++ b/content/operate/rs/7.4/references/rest-api/requests/crdbs/health_report.md @@ -42,7 +42,7 @@ Get a health report for an Active-Active database. ### Response {#get-response} -Returns a JSON array of [CRDB health report objects]({{< relref "/operate/rs/references/rest-api/objects/crdb/health_report" >}}). +Returns a JSON array of [CRDB health report objects]({{< relref "/operate/rs/7.4/references/rest-api/objects/crdb/health_report" >}}). ### Status codes {#get-status-codes} diff --git a/content/operate/rs/7.4/references/rest-api/requests/crdbs/purge.md b/content/operate/rs/7.4/references/rest-api/requests/crdbs/purge.md index 0adeb40fa0..4283ec4f86 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/crdbs/purge.md +++ b/content/operate/rs/7.4/references/rest-api/requests/crdbs/purge.md @@ -51,7 +51,7 @@ removed instance). ### Response {#put-response} -Returns a [CRDB task object]({{< relref "/operate/rs/references/rest-api/objects/crdb_task" >}}). +Returns a [CRDB task object]({{< relref "/operate/rs/7.4/references/rest-api/objects/crdb_task" >}}). ### Status codes {#put-status-codes} diff --git a/content/operate/rs/7.4/references/rest-api/requests/crdbs/updates.md b/content/operate/rs/7.4/references/rest-api/requests/crdbs/updates.md index 8e1e57203c..446c9598a4 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/crdbs/updates.md +++ b/content/operate/rs/7.4/references/rest-api/requests/crdbs/updates.md @@ -53,11 +53,11 @@ When you update db_config, it changes the configuration of the database that you #### Request body -Include a [CRDB modify_request object]({{< relref "/operate/rs/references/rest-api/objects/crdb/modify_request" >}}) with updated fields in the request body. +Include a [CRDB modify_request object]({{< relref "/operate/rs/7.4/references/rest-api/objects/crdb/modify_request" >}}) with updated fields in the request body. ### Response {#post-response} -Returns a [CRDB task object]({{< relref "/operate/rs/references/rest-api/objects/crdb_task" >}}). +Returns a [CRDB task object]({{< relref "/operate/rs/7.4/references/rest-api/objects/crdb_task" >}}). ### Status codes {#post-status-codes} diff --git a/content/operate/rs/7.4/references/rest-api/requests/debuginfo/_index.md b/content/operate/rs/7.4/references/rest-api/requests/debuginfo/_index.md index 15f8a3e7a7..ffa5a19872 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/debuginfo/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/debuginfo/_index.md @@ -13,7 +13,7 @@ url: '/operate/rs/7.4/references/rest-api/requests/debuginfo/' --- {{}} -These REST API paths are deprecated as of Redis Enterprise Software version 7.4.2. Use the new paths [`/v1/cluster/debuginfo`]({{< relref "/operate/rs/references/rest-api/requests/cluster/debuginfo" >}}), [`/v1/nodes/debuginfo`]({{< relref "/operate/rs/references/rest-api/requests/nodes/debuginfo" >}}), and [`/v1/bdbs/debuginfo`]({{< relref "/operate/rs/references/rest-api/requests/bdbs/debuginfo" >}}) instead. +These REST API paths are deprecated as of Redis Enterprise Software version 7.4.2. Use the new paths [`/v1/cluster/debuginfo`]({{< relref "/operate/rs/7.4/references/rest-api/requests/cluster/debuginfo" >}}), [`/v1/nodes/debuginfo`]({{< relref "/operate/rs/7.4/references/rest-api/requests/nodes/debuginfo" >}}), and [`/v1/bdbs/debuginfo`]({{< relref "/operate/rs/7.4/references/rest-api/requests/bdbs/debuginfo" >}}) instead. {{}} Downloads a support package, which includes logs and information about the cluster, nodes, databases, and shards, as a tar file called `filename.tar.gz`. Extract the files from the tar file to access the debug info. diff --git a/content/operate/rs/7.4/references/rest-api/requests/debuginfo/all/_index.md b/content/operate/rs/7.4/references/rest-api/requests/debuginfo/all/_index.md index 5134d65ea2..d780c7e262 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/debuginfo/all/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/debuginfo/all/_index.md @@ -14,7 +14,7 @@ url: '/operate/rs/7.4/references/rest-api/requests/debuginfo/all/' --- {{}} -This REST API path is deprecated as of Redis Enterprise Software version 7.4.2. Use the new path [`/v1/cluster/debuginfo`]({{< relref "/operate/rs/references/rest-api/requests/cluster/debuginfo" >}}) instead. +This REST API path is deprecated as of Redis Enterprise Software version 7.4.2. Use the new path [`/v1/cluster/debuginfo`]({{< relref "/operate/rs/7.4/references/rest-api/requests/cluster/debuginfo" >}}) instead. {{}} | Method | Path | Description | @@ -31,7 +31,7 @@ Downloads a tar file that contains debug info from all nodes. | Permission name | |-----------------| -| [view_debugging_info]({{< relref "/operate/rs/references/rest-api/permissions#view_debugging_info" >}}) | +| [view_debugging_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_debugging_info" >}}) | ### Request {#get-all-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/debuginfo/all/bdb.md b/content/operate/rs/7.4/references/rest-api/requests/debuginfo/all/bdb.md index ee5ef1bbba..a25969eb93 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/debuginfo/all/bdb.md +++ b/content/operate/rs/7.4/references/rest-api/requests/debuginfo/all/bdb.md @@ -13,7 +13,7 @@ url: '/operate/rs/7.4/references/rest-api/requests/debuginfo/all/bdb/' --- {{}} -This REST API path is deprecated as of Redis Enterprise Software version 7.4.2. Use the new path [`/v1/bdbs/debuginfo`]({{< relref "/operate/rs/references/rest-api/requests/bdbs/debuginfo" >}}) instead. +This REST API path is deprecated as of Redis Enterprise Software version 7.4.2. Use the new path [`/v1/bdbs/debuginfo`]({{< relref "/operate/rs/7.4/references/rest-api/requests/bdbs/debuginfo" >}}) instead. {{}} | Method | Path | Description | @@ -30,7 +30,7 @@ Downloads a tar file that contains debug info for the specified database (`bdb_u | Permission name | |-----------------| -| [view_debugging_info]({{< relref "/operate/rs/references/rest-api/permissions#view_debugging_info" >}}) | +| [view_debugging_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_debugging_info" >}}) | ### Request {#get-all-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/debuginfo/node/_index.md b/content/operate/rs/7.4/references/rest-api/requests/debuginfo/node/_index.md index 25f3bc1853..6e110de7a2 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/debuginfo/node/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/debuginfo/node/_index.md @@ -14,7 +14,7 @@ url: '/operate/rs/7.4/references/rest-api/requests/debuginfo/node/' --- {{}} -This REST API path is deprecated as of Redis Enterprise Software version 7.4.2. Use the new path [`/v1/nodes/debuginfo`]({{< relref "/operate/rs/references/rest-api/requests/nodes/debuginfo" >}}) instead. +This REST API path is deprecated as of Redis Enterprise Software version 7.4.2. Use the new path [`/v1/nodes/debuginfo`]({{< relref "/operate/rs/7.4/references/rest-api/requests/nodes/debuginfo" >}}) instead. {{}} | Method | Path | Description | @@ -31,7 +31,7 @@ Downloads a tar file that contains debug info for the current node. | Permission name | |-----------------| -| [view_debugging_info]({{< relref "/operate/rs/references/rest-api/permissions#view_debugging_info" >}}) | +| [view_debugging_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_debugging_info" >}}) | ### Request {#get-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/debuginfo/node/bdb.md b/content/operate/rs/7.4/references/rest-api/requests/debuginfo/node/bdb.md index dff4e5117e..f2545af119 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/debuginfo/node/bdb.md +++ b/content/operate/rs/7.4/references/rest-api/requests/debuginfo/node/bdb.md @@ -13,7 +13,7 @@ url: '/operate/rs/7.4/references/rest-api/requests/debuginfo/node/bdb/' --- {{}} -This REST API path is deprecated as of Redis Enterprise Software version 7.4.2. Use the new path [`/v1/bdbs/debuginfo`]({{< relref "/operate/rs/references/rest-api/requests/bdbs/debuginfo" >}}) instead. +This REST API path is deprecated as of Redis Enterprise Software version 7.4.2. Use the new path [`/v1/bdbs/debuginfo`]({{< relref "/operate/rs/7.4/references/rest-api/requests/bdbs/debuginfo" >}}) instead. {{}} | Method | Path | Description | @@ -30,7 +30,7 @@ Downloads a tar file that contains debug info for the specified database (`bdb_u | Permission name | |-----------------| -| [view_debugging_info]({{< relref "/operate/rs/references/rest-api/permissions#view_debugging_info" >}}) | +| [view_debugging_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_debugging_info" >}}) | ### Request {#get-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/endpoints-stats/_index.md b/content/operate/rs/7.4/references/rest-api/requests/endpoints-stats/_index.md index 3afee71037..13a90dbc57 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/endpoints-stats/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/endpoints-stats/_index.md @@ -32,7 +32,7 @@ compatability. | Permission name | |-----------------| -| [view_endpoint_stats]({{< relref "/operate/rs/references/rest-api/permissions#view_endpoint_stats" >}}) | +| [view_endpoint_stats]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_endpoint_stats" >}}) | ### Request {#get-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/jsonschema/_index.md b/content/operate/rs/7.4/references/rest-api/requests/jsonschema/_index.md index 286e1dfc5f..c119b6daff 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/jsonschema/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/jsonschema/_index.md @@ -21,7 +21,7 @@ url: '/operate/rs/7.4/references/rest-api/requests/jsonschema/' GET /v1/jsonschema -Get the JSON schema of various [Redis Enterprise REST API objects]({{< relref "/operate/rs/references/rest-api/objects" >}}). +Get the JSON schema of various [Redis Enterprise REST API objects]({{< relref "/operate/rs/7.4/references/rest-api/objects" >}}). ### Request {#get-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/ldap_mappings/_index.md b/content/operate/rs/7.4/references/rest-api/requests/ldap_mappings/_index.md index 5b395b4da2..92edd370c1 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/ldap_mappings/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/ldap_mappings/_index.md @@ -31,7 +31,7 @@ Get all LDAP mappings. | Permission name | |-----------------| -| [view_all_ldap_mappings_info]({{< relref "/operate/rs/references/rest-api/permissions#view_all_ldap_mappings_info" >}}) | +| [view_all_ldap_mappings_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_all_ldap_mappings_info" >}}) | ### Request {#get-all-request} @@ -48,7 +48,7 @@ Get all LDAP mappings. ### Response {#get-all-response} -Returns a JSON array of [LDAP mapping objects]({{< relref "/operate/rs/references/rest-api/objects/ldap_mapping" >}}). +Returns a JSON array of [LDAP mapping objects]({{< relref "/operate/rs/7.4/references/rest-api/objects/ldap_mapping" >}}). #### Example JSON body @@ -83,7 +83,7 @@ Get a specific LDAP mapping. | Permission name | |-----------------| -| [view_ldap_mapping_info]({{< relref "/operate/rs/references/rest-api/permissions#view_ldap_mapping_info" >}}) | +| [view_ldap_mapping_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_ldap_mapping_info" >}}) | ### Request {#get-request} @@ -106,7 +106,7 @@ Get a specific LDAP mapping. ### Response {#get-response} -Returns an [LDAP mapping object]({{< relref "/operate/rs/references/rest-api/objects/ldap_mapping" >}}). +Returns an [LDAP mapping object]({{< relref "/operate/rs/7.4/references/rest-api/objects/ldap_mapping" >}}). #### Example JSON body @@ -151,7 +151,7 @@ Update an existing ldap_mapping object. | Permission name | |-----------------| -| [update_ldap_mapping]({{< relref "/operate/rs/references/rest-api/permissions#update_ldap_mapping" >}}) | +| [update_ldap_mapping]({{< relref "/operate/rs/7.4/references/rest-api/permissions#update_ldap_mapping" >}}) | ### Request {#put-request} @@ -181,7 +181,7 @@ Update an existing ldap_mapping object. #### Request body -Include an [LDAP mapping object]({{< relref "/operate/rs/references/rest-api/objects/ldap_mapping" >}}) with updated fields in the request body. +Include an [LDAP mapping object]({{< relref "/operate/rs/7.4/references/rest-api/objects/ldap_mapping" >}}) with updated fields in the request body. ### Response {#put-response} @@ -233,7 +233,7 @@ Create a new LDAP mapping. | Permission name | |-----------------| -| [create_ldap_mapping]({{< relref "/operate/rs/references/rest-api/permissions#create_ldap_mapping" >}}) | +| [create_ldap_mapping]({{< relref "/operate/rs/7.4/references/rest-api/permissions#create_ldap_mapping" >}}) | ### Request {#post-request} @@ -262,7 +262,7 @@ Create a new LDAP mapping. #### Request body -Include an [LDAP mapping object]({{< relref "/operate/rs/references/rest-api/objects/ldap_mapping" >}}) in the request body. +Include an [LDAP mapping object]({{< relref "/operate/rs/7.4/references/rest-api/objects/ldap_mapping" >}}) in the request body. ### Response {#post-response} @@ -309,7 +309,7 @@ Delete an LDAP mapping object. | Permission name | |-----------------| -| [delete_ldap_mapping]({{< relref "/operate/rs/references/rest-api/permissions#delete_ldap_mapping" >}}) | +| [delete_ldap_mapping]({{< relref "/operate/rs/7.4/references/rest-api/permissions#delete_ldap_mapping" >}}) | ### Request {#delete-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/license/_index.md b/content/operate/rs/7.4/references/rest-api/requests/license/_index.md index 69db16a811..072b35b69f 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/license/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/license/_index.md @@ -29,7 +29,7 @@ and supported features. | Permission name | |-----------------| -| [view_license]({{< relref "/operate/rs/references/rest-api/permissions#view_license" >}}) | +| [view_license]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_license" >}}) | ### Request {#get-request} @@ -98,13 +98,13 @@ Returns a JSON object that contains the license details: Validate and install a new license string. -If you do not provide a valid license, the cluster behaves as if the license was deleted. See [Expired cluster license]({{< relref "/operate/rs/clusters/configure/license-keys#expired-cluster-license" >}}) for a list of available actions and restrictions. +If you do not provide a valid license, the cluster behaves as if the license was deleted. See [Expired cluster license]({{< relref "/operate/rs/7.4/clusters/configure/license-keys#expired-cluster-license" >}}) for a list of available actions and restrictions. #### Required permissions | Permission name | |-----------------| -| [install_new_license]({{< relref "/operate/rs/references/rest-api/permissions#install_new_license" >}}) | +| [install_new_license]({{< relref "/operate/rs/7.4/references/rest-api/permissions#install_new_license" >}}) | ### Request {#put-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/logs/_index.md b/content/operate/rs/7.4/references/rest-api/requests/logs/_index.md index da2aa5f88f..0952ffe848 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/logs/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/logs/_index.md @@ -27,7 +27,7 @@ Get cluster events log. | Permission name | |-----------------| -| [view_logged_events]({{< relref "/operate/rs/references/rest-api/permissions#view_logged_events" >}}) | +| [view_logged_events]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_logged_events" >}}) | ### Request {#get-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/modules/_index.md b/content/operate/rs/7.4/references/rest-api/requests/modules/_index.md index 6a4dd786f6..bb05387907 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/modules/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/modules/_index.md @@ -34,7 +34,7 @@ List available modules, i.e. modules stored within the CCS. | Permission name | Roles | |-----------------|-------| -| [view_cluster_modules]({{< relref "/operate/rs/references/rest-api/permissions#view_cluster_modules" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | +| [view_cluster_modules]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_cluster_modules" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | ### Request {#list-request} @@ -53,7 +53,7 @@ GET /v1/modules ### Response {#list-response} -Returns a JSON array of [module objects]({{< relref "/operate/rs/references/rest-api/objects/module" >}}). +Returns a JSON array of [module objects]({{< relref "/operate/rs/7.4/references/rest-api/objects/module" >}}). #### Status codes {#list-status-codes} @@ -73,7 +73,7 @@ Get specific available modules, i.e. modules stored within the CCS. | Permission name | Roles | |-----------------|-------| -| [view_cluster_modules]({{< relref "/operate/rs/references/rest-api/permissions#view_cluster_modules" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | +| [view_cluster_modules]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_cluster_modules" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | ### Request {#get-request} @@ -98,7 +98,7 @@ GET /v1/modules/1 ### Response {#get-response} -Returns a [module object]({{< relref "/operate/rs/references/rest-api/objects/module" >}}). +Returns a [module object]({{< relref "/operate/rs/7.4/references/rest-api/objects/module" >}}). ### Status codes {#get-status-codes} @@ -128,7 +128,7 @@ See [Install a module on a cluster]({{< relref "/operate/oss_and_stack/stack-wit | Permission name | Roles | |-----------------|-------| -| [update_cluster]({{< relref "/operate/rs/references/rest-api/permissions#update_cluster" >}}) | admin | +| [update_cluster]({{< relref "/operate/rs/7.4/references/rest-api/permissions#update_cluster" >}}) | admin | ### Request {#post-request} @@ -220,7 +220,7 @@ For modules in Redis Stack, download the module from the [download center](https | Permission name | Roles | |-----------------|-------| -| [update_cluster]({{< relref "/operate/rs/references/rest-api/permissions#update_cluster" >}}) | admin | +| [update_cluster]({{< relref "/operate/rs/7.4/references/rest-api/permissions#update_cluster" >}}) | admin | ### Request {#post-request-v2} @@ -242,7 +242,7 @@ POST /v2/modules ### Response {#post-response-v2} -Returns a [module object]({{< relref "/operate/rs/references/rest-api/objects/module" >}}) with an additional `action_uid` field. +Returns a [module object]({{< relref "/operate/rs/7.4/references/rest-api/objects/module" >}}) with an additional `action_uid` field. You can use the `action_uid` to track the progress of the module upload. @@ -324,7 +324,7 @@ Delete a module. | Permission name | Roles | |-----------------|-------| -| [update_cluster]({{< relref "/operate/rs/references/rest-api/permissions#update_cluster" >}}) | admin | +| [update_cluster]({{< relref "/operate/rs/7.4/references/rest-api/permissions#update_cluster" >}}) | admin | ### Request {#delete-request} @@ -377,7 +377,7 @@ Delete a module. | Permission name | Roles | |-----------------|-------| -| [update_cluster]({{< relref "/operate/rs/references/rest-api/permissions#update_cluster" >}}) | admin | +| [update_cluster]({{< relref "/operate/rs/7.4/references/rest-api/permissions#update_cluster" >}}) | admin | ### Request {#delete-request-v2} diff --git a/content/operate/rs/7.4/references/rest-api/requests/modules/config.md b/content/operate/rs/7.4/references/rest-api/requests/modules/config.md index 608f5075d3..104c39c8fa 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/modules/config.md +++ b/content/operate/rs/7.4/references/rest-api/requests/modules/config.md @@ -26,7 +26,7 @@ Use the module runtime configuration command (if defined) to configure new argum | Permission name | |-----------------| -| [edit_bdb_module]({{< relref "/operate/rs/references/rest-api/permissions#edit_bdb_module" >}}) | +| [edit_bdb_module]({{< relref "/operate/rs/7.4/references/rest-api/permissions#edit_bdb_module" >}}) | ### Request {#post-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/modules/upgrade.md b/content/operate/rs/7.4/references/rest-api/requests/modules/upgrade.md index 6211ac9f25..ab08610e26 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/modules/upgrade.md +++ b/content/operate/rs/7.4/references/rest-api/requests/modules/upgrade.md @@ -26,7 +26,7 @@ Upgrades the module version on a specific database. | Permission name | |-----------------| -| [edit_bdb_module]({{< relref "/operate/rs/references/rest-api/permissions#edit_bdb_module" >}}) | +| [edit_bdb_module]({{< relref "/operate/rs/7.4/references/rest-api/permissions#edit_bdb_module" >}}) | ### Request {#post-request} @@ -67,7 +67,7 @@ Upgrades the module version on a specific database. ### Response {#post-response} -Returns the upgraded [module object]({{< relref "/operate/rs/references/rest-api/objects/module" >}}). +Returns the upgraded [module object]({{< relref "/operate/rs/7.4/references/rest-api/objects/module" >}}). #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/nodes/_index.md b/content/operate/rs/7.4/references/rest-api/requests/nodes/_index.md index 0f6212e54c..0d8c197fcf 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/nodes/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/nodes/_index.md @@ -31,7 +31,7 @@ Get all cluster nodes. | Permission name | Roles | |-----------------|-------| -| [view_all_nodes_info]({{< relref "/operate/rs/references/rest-api/permissions#view_all_nodes_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | +| [view_all_nodes_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_all_nodes_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | ### Request {#get-all-request} @@ -50,7 +50,7 @@ GET /v1/nodes ### Response {#get-all-response} -Returns a JSON array of [node objects]({{< relref "/operate/rs/references/rest-api/objects/node" >}}). +Returns a JSON array of [node objects]({{< relref "/operate/rs/7.4/references/rest-api/objects/node" >}}). #### Example JSON body @@ -115,7 +115,7 @@ Get a single cluster node. | Permission name | Roles | |-----------------|-------| -| [view_node_info]({{< relref "/operate/rs/references/rest-api/permissions#view_node_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | +| [view_node_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_node_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | ### Request {#get-request} @@ -140,7 +140,7 @@ GET /v1/nodes/1 ### Response {#get-response} -Returns a [node object]({{< relref "/operate/rs/references/rest-api/objects/node" >}}). +Returns a [node object]({{< relref "/operate/rs/7.4/references/rest-api/objects/node" >}}). #### Example JSON body @@ -165,7 +165,7 @@ Returns a [node object]({{< relref "/operate/rs/references/rest-api/objects/node PUT /v1/nodes/{int: uid} ``` -Update a [node object]({{< relref "/operate/rs/references/rest-api/objects/node" >}}). +Update a [node object]({{< relref "/operate/rs/7.4/references/rest-api/objects/node" >}}). Currently, you can edit the following attributes: @@ -185,7 +185,7 @@ You can only update the `addr` attribute for offline nodes. Otherwise, the reque | Permission name | Roles | |-----------------|-------| -| [update_node]({{< relref "/operate/rs/references/rest-api/permissions#update_node" >}}) | admin | +| [update_node]({{< relref "/operate/rs/7.4/references/rest-api/permissions#update_node" >}}) | admin | ### Request {#put-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/nodes/actions.md b/content/operate/rs/7.4/references/rest-api/requests/nodes/actions.md index f5f463a298..a04045aa64 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/nodes/actions.md +++ b/content/operate/rs/7.4/references/rest-api/requests/nodes/actions.md @@ -33,7 +33,7 @@ actions on all nodes. | Permission name | Roles | |-----------------|-------| -| [view_status_of_all_node_actions]({{< relref "/operate/rs/references/rest-api/permissions#view_status_of_all_node_actions" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | +| [view_status_of_all_node_actions]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_status_of_all_node_actions" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | ### Request {#get-all-request} @@ -52,7 +52,7 @@ GET /v1/nodes/actions ### Response {#get-all-response} -Returns a list of [action objects]({{< relref "/operate/rs/references/rest-api/objects/action" >}}). +Returns a list of [action objects]({{< relref "/operate/rs/7.4/references/rest-api/objects/action" >}}). ### Status codes {#get-all-status-codes} @@ -72,7 +72,7 @@ Get the status of all actions on a specific node. | Permission name | Roles | |-----------------|-------| -| [view_status_of_node_action]({{< relref "/operate/rs/references/rest-api/permissions#view_status_of_node_action" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | +| [view_status_of_node_action]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_status_of_node_action" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | ### Request {#get-request-all-actions} @@ -97,7 +97,7 @@ GET /v1/nodes/1/actions ### Response {#get-response-all-actions} -Returns a JSON object that includes a list of [action objects]({{< relref "/operate/rs/references/rest-api/objects/action" >}}) for the specified node. +Returns a JSON object that includes a list of [action objects]({{< relref "/operate/rs/7.4/references/rest-api/objects/action" >}}) for the specified node. If no actions are available, the response will include an empty array. @@ -155,7 +155,7 @@ GET /v1/nodes/1/actions/remove ### Response {#get-response} -Returns an [action object]({{< relref "/operate/rs/references/rest-api/objects/action" >}}) for the specified node. +Returns an [action object]({{< relref "/operate/rs/7.4/references/rest-api/objects/action" >}}) for the specified node. ### Error codes {#get-error-codes} @@ -191,7 +191,7 @@ removed as soon as the new one is submitted. | Permission name | Roles | |-----------------|-------| -| [start_node_action]({{< relref "/operate/rs/references/rest-api/permissions#start_node_action" >}}) | admin | +| [start_node_action]({{< relref "/operate/rs/7.4/references/rest-api/permissions#start_node_action" >}}) | admin | ### Request {#post-request} @@ -220,7 +220,7 @@ Currently supported actions are: - 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]({{}}) `persistent_node_removal` to `true` to change the cluster's default behavior. ```sh POST /v1/nodes//actions/remove @@ -229,7 +229,7 @@ Currently supported actions are: } ``` -- `maintenance_on`: Creates a snapshot of the node, migrates shards to other nodes, and prepares the node for maintenance. See [maintenance mode]({{< relref "/operate/rs/clusters/maintenance-mode" >}}) for more information. +- `maintenance_on`: Creates a snapshot of the node, migrates shards to other nodes, and prepares the node for maintenance. See [maintenance mode]({{< relref "/operate/rs/7.4/clusters/maintenance-mode" >}}) for more information. - As of Redis Enterprise Software version 7.4.2, a new node snapshot is created only if no maintenance mode snapshots already exist or if you set `"overwrite_snapshot": true` in the request body. @@ -261,7 +261,7 @@ Currently supported actions are: } ``` -- `maintenance_off`: Restores node to its previous state before maintenance started. See [maintenance mode]({{< relref "/operate/rs/clusters/maintenance-mode" >}}) for more information. +- `maintenance_off`: Restores node to its previous state before maintenance started. See [maintenance mode]({{< relref "/operate/rs/7.4/clusters/maintenance-mode" >}}) for more information. - By default, it uses the latest node snapshot. @@ -323,7 +323,7 @@ previously executed and completed action. | Permission name | |-----------------| -| [cancel_node_action]({{< relref "/operate/rs/references/rest-api/permissions#cancel_node_action" >}}) | +| [cancel_node_action]({{< relref "/operate/rs/7.4/references/rest-api/permissions#cancel_node_action" >}}) | ### Request {#delete-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/nodes/alerts.md b/content/operate/rs/7.4/references/rest-api/requests/nodes/alerts.md index 896e0775b7..95675a2d2e 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/nodes/alerts.md +++ b/content/operate/rs/7.4/references/rest-api/requests/nodes/alerts.md @@ -28,7 +28,7 @@ Get all alert states for all nodes. | Permission name | |-----------------| -| [view_all_nodes_alerts]({{< relref "/operate/rs/references/rest-api/permissions#view_all_nodes_alerts" >}}) | +| [view_all_nodes_alerts]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_all_nodes_alerts" >}}) | ### Request {#get-all-request} @@ -51,7 +51,7 @@ Get all alert states for all nodes. ### Response {#get-all-response} -Returns a hash of node UIDs and the [alert states]({{< relref "/operate/rs/references/rest-api/objects/alert" >}}) for each node. +Returns a hash of node UIDs and the [alert states]({{< relref "/operate/rs/7.4/references/rest-api/objects/alert" >}}) for each node. #### Example JSON body @@ -91,7 +91,7 @@ Get all alert states for a node. | Permission name | |-----------------| -| [view_node_alerts]({{< relref "/operate/rs/references/rest-api/permissions#view_node_alerts" >}}) | +| [view_node_alerts]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_node_alerts" >}}) | ### Request {#get-request-all-alerts} @@ -116,7 +116,7 @@ Get all alert states for a node. ### Response {#get-response-all-alerts} -Returns a hash of [alert objects]({{< relref "/operate/rs/references/rest-api/objects/alert" >}}) and their states for a specific node. +Returns a hash of [alert objects]({{< relref "/operate/rs/7.4/references/rest-api/objects/alert" >}}) and their states for a specific node. #### Example JSON body @@ -154,7 +154,7 @@ Get a node alert state. | Permission name | |-----------------| -| [view_node_alerts]({{< relref "/operate/rs/references/rest-api/permissions#view_node_alerts" >}}) | +| [view_node_alerts]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_node_alerts" >}}) | ### Request {#get-request} @@ -179,7 +179,7 @@ Get a node alert state. ### Response {#get-response} -Returns an [alert object]({{< relref "/operate/rs/references/rest-api/objects/alert" >}}). +Returns an [alert object]({{< relref "/operate/rs/7.4/references/rest-api/objects/alert" >}}). #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/nodes/check.md b/content/operate/rs/7.4/references/rest-api/requests/nodes/check.md index da6a171acd..9cf59b382a 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/nodes/check.md +++ b/content/operate/rs/7.4/references/rest-api/requests/nodes/check.md @@ -38,7 +38,7 @@ Runs the following checks on a cluster node: | Permission name | |-----------------| -| [view_node_check]({{< relref "/operate/rs/references/rest-api/permissions#view_node_check" >}}) | +| [view_node_check]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_node_check" >}}) | ### Request {#get-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/nodes/debuginfo.md b/content/operate/rs/7.4/references/rest-api/requests/nodes/debuginfo.md index 86b130aeae..5f192927e5 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/nodes/debuginfo.md +++ b/content/operate/rs/7.4/references/rest-api/requests/nodes/debuginfo.md @@ -27,7 +27,7 @@ Downloads a tar file that contains debug info from all nodes. | Permission name | |-----------------| -| [view_debugging_info]({{< relref "/operate/rs/references/rest-api/permissions#view_debugging_info" >}}) | +| [view_debugging_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_debugging_info" >}}) | ### Request {#get-all-request} @@ -64,7 +64,7 @@ Downloads a tar file that contains debug info from a specific node. | Permission name | |-----------------| -| [view_debugging_info]({{< relref "/operate/rs/references/rest-api/permissions#view_debugging_info" >}}) | +| [view_debugging_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_debugging_info" >}}) | ### Request {#get-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/nodes/snapshots.md b/content/operate/rs/7.4/references/rest-api/requests/nodes/snapshots.md index f2b7d97a1f..d19fbf4472 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/nodes/snapshots.md +++ b/content/operate/rs/7.4/references/rest-api/requests/nodes/snapshots.md @@ -29,7 +29,7 @@ Get all cluster node snapshots of the specified node. | Permission name | Roles | |-----------------|-------| -| [view_node_info]({{< relref "/operate/rs/references/rest-api/permissions#view_node_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | +| [view_node_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_node_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | ### Request {#get-request} @@ -92,7 +92,7 @@ Delete a cluster node snapshot. Snapshots created by maintenance mode are not de | Permission name | Roles | |-----------------|-------| -| [update_node]({{< relref "/operate/rs/references/rest-api/permissions#update_node" >}}) | admin | +| [update_node]({{< relref "/operate/rs/7.4/references/rest-api/permissions#update_node" >}}) | admin | ### Request {#delete-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/nodes/stats/_index.md b/content/operate/rs/7.4/references/rest-api/requests/nodes/stats/_index.md index 969e5c2b2a..24a17da6f3 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/nodes/stats/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/nodes/stats/_index.md @@ -30,7 +30,7 @@ Get statistics for all nodes. | Permission name | |-----------------| -| [view_all_nodes_stats]({{< relref "/operate/rs/references/rest-api/permissions#view_all_nodes_stats" >}}) | +| [view_all_nodes_stats]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_all_nodes_stats" >}}) | ### Request {#get-all-request} @@ -57,7 +57,7 @@ GET /v1/nodes/stats?interval=1hour&stime=2014-08-28T10:00:00Z ### Response {#get-all-response} -Returns a JSON array of [statistics]({{< relref "/operate/rs/references/rest-api/objects/statistics" >}}) for all nodes. +Returns a JSON array of [statistics]({{< relref "/operate/rs/7.4/references/rest-api/objects/statistics" >}}) for all nodes. #### Example JSON body @@ -143,7 +143,7 @@ Get statistics for a node. | Permission name | |-----------------| -| [view_node_stats]({{< relref "/operate/rs/references/rest-api/permissions#view_node_stats" >}}) | +| [view_node_stats]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_node_stats" >}}) | ### Request {#get-request} @@ -176,7 +176,7 @@ GET /v1/nodes/stats/1?interval=1hour&stime=2014-08-28T10:00:00Z ### Response {#get-response} -Returns [statistics]({{< relref "/operate/rs/references/rest-api/objects/statistics" >}}) for the specified node. +Returns [statistics]({{< relref "/operate/rs/7.4/references/rest-api/objects/statistics" >}}) for the specified node. #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/nodes/stats/last.md b/content/operate/rs/7.4/references/rest-api/requests/nodes/stats/last.md index e54cde5b1e..8db0dd47f5 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/nodes/stats/last.md +++ b/content/operate/rs/7.4/references/rest-api/requests/nodes/stats/last.md @@ -29,7 +29,7 @@ Get latest statistics for all nodes. | Permission name | |-----------------| -| [view_all_nodes_stats]({{< relref "/operate/rs/references/rest-api/permissions#view_all_nodes_stats" >}}) | +| [view_all_nodes_stats]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_all_nodes_stats" >}}) | ### Request {#get-all-request} @@ -58,7 +58,7 @@ GET /v1/nodes/stats/last?interval=1sec&stime=2015-10-14T06:29:43Z ### Response {#get-all-response} -Returns most recent [statistics]({{< relref "/operate/rs/references/rest-api/objects/statistics" >}}) for all nodes. +Returns most recent [statistics]({{< relref "/operate/rs/7.4/references/rest-api/objects/statistics" >}}) for all nodes. #### Example JSON body @@ -109,7 +109,7 @@ Get the latest statistics of a node. | Permission name | |-----------------| -| [view_node_stats]({{< relref "/operate/rs/references/rest-api/permissions#view_node_stats" >}}) | +| [view_node_stats]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_node_stats" >}}) | ### Request {#get-request} @@ -145,7 +145,7 @@ GET /v1/nodes/stats/last/1?interval=1sec&stime=2015-10-13T09:01:54Z ### Response {#get-response} -Returns the most recent [statistics]({{< relref "/operate/rs/references/rest-api/objects/statistics" >}}) for the specified node. +Returns the most recent [statistics]({{< relref "/operate/rs/7.4/references/rest-api/objects/statistics" >}}) for the specified node. #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/nodes/status.md b/content/operate/rs/7.4/references/rest-api/requests/nodes/status.md index a0e38802b0..19380cc0a3 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/nodes/status.md +++ b/content/operate/rs/7.4/references/rest-api/requests/nodes/status.md @@ -32,7 +32,7 @@ Gets the status of all nodes. Includes each node's hostname and role in the clus | Permission name | |-----------------| -| [view_node_info]({{< relref "/operate/rs/references/rest-api/permissions#view_node_info" >}}) | +| [view_node_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_node_info" >}}) | ### Request {#get-all-request} @@ -51,7 +51,7 @@ Gets the status of all nodes. Includes each node's hostname and role in the clus For each node in the cluster, returns a JSON object that contains each node's hostname, role, and other status details. -If a maintenance snapshot exists due to an in-progress or improperly stopped [node maintenance]({{}}) process, the response includes a `maintenance_snapshot` field. +If a maintenance snapshot exists due to an in-progress or improperly stopped [node maintenance]({{}}) process, the response includes a `maintenance_snapshot` field. #### Example JSON body @@ -111,7 +111,7 @@ Gets the status of a node. Includes the node's hostname and role in the cluster: | Permission name | |-----------------| -| [view_node_info]({{< relref "/operate/rs/references/rest-api/permissions#view_node_info" >}}) | +| [view_node_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_node_info" >}}) | ### Request {#get-request} @@ -139,7 +139,7 @@ Gets the status of a node. Includes the node's hostname and role in the cluster: Returns a JSON object that contains the node's hostname, role, and other status details. -If a maintenance snapshot exists due to an in-progress or improperly stopped [node maintenance]({{}}) process, the response includes a `maintenance_snapshot` field. +If a maintenance snapshot exists due to an in-progress or improperly stopped [node maintenance]({{}}) process, the response includes a `maintenance_snapshot` field. #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/ocsp/_index.md b/content/operate/rs/7.4/references/rest-api/requests/ocsp/_index.md index 8a0a91cb45..af43603569 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/ocsp/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/ocsp/_index.md @@ -28,7 +28,7 @@ Gets the cluster's OCSP configuration. | Permission name | |-----------------| -| [view_ocsp_config]({{< relref "/operate/rs/references/rest-api/permissions#view_ocsp_config" >}}) | +| [view_ocsp_config]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_ocsp_config" >}}) | ### Request {#get-request} @@ -46,7 +46,7 @@ Gets the cluster's OCSP configuration. ### Response {#get-response} -Returns an [OCSP configuration object]({{< relref "/operate/rs/references/rest-api/objects/ocsp" >}}). +Returns an [OCSP configuration object]({{< relref "/operate/rs/7.4/references/rest-api/objects/ocsp" >}}). #### Example JSON body @@ -86,7 +86,7 @@ Updates the cluster's OCSP configuration. | Permission name | |-----------------| -| [config_ocsp]({{< relref "/operate/rs/references/rest-api/permissions#config_ocsp" >}}) | +| [config_ocsp]({{< relref "/operate/rs/7.4/references/rest-api/permissions#config_ocsp" >}}) | ### Request {#put-request} @@ -115,11 +115,11 @@ Updates the cluster's OCSP configuration. #### Request body -Include an [OCSP configuration object]({{< relref "/operate/rs/references/rest-api/objects/ocsp" >}}) with updated fields in the request body. +Include an [OCSP configuration object]({{< relref "/operate/rs/7.4/references/rest-api/objects/ocsp" >}}) with updated fields in the request body. ### Response {#put-response} -Returns the updated [OCSP configuration object]({{< relref "/operate/rs/references/rest-api/objects/ocsp" >}}). +Returns the updated [OCSP configuration object]({{< relref "/operate/rs/7.4/references/rest-api/objects/ocsp" >}}). ### Error codes {#put-error-codes} diff --git a/content/operate/rs/7.4/references/rest-api/requests/ocsp/status.md b/content/operate/rs/7.4/references/rest-api/requests/ocsp/status.md index 395473f17b..bced0c20b0 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/ocsp/status.md +++ b/content/operate/rs/7.4/references/rest-api/requests/ocsp/status.md @@ -26,7 +26,7 @@ Gets the latest cached status of the proxy certificate’s OCSP response. | Permission name | |-----------------| -| [view_ocsp_status]({{< relref "/operate/rs/references/rest-api/permissions#view_ocsp_status" >}}) | +| [view_ocsp_status]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_ocsp_status" >}}) | ### Request {#get-request} @@ -44,7 +44,7 @@ Gets the latest cached status of the proxy certificate’s OCSP response. ### Response {#get-response} -Returns an [OCSP status object]({{< relref "/operate/rs/references/rest-api/objects/ocsp_status" >}}). +Returns an [OCSP status object]({{< relref "/operate/rs/7.4/references/rest-api/objects/ocsp_status" >}}). #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/ocsp/test.md b/content/operate/rs/7.4/references/rest-api/requests/ocsp/test.md index d362535b38..6274182e02 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/ocsp/test.md +++ b/content/operate/rs/7.4/references/rest-api/requests/ocsp/test.md @@ -26,7 +26,7 @@ Queries the OCSP server for the proxy certificate’s latest status and returns | Permission name | |-----------------| -| [test_ocsp_status]({{< relref "/operate/rs/references/rest-api/permissions#test_ocsp_status" >}}) | +| [test_ocsp_status]({{< relref "/operate/rs/7.4/references/rest-api/permissions#test_ocsp_status" >}}) | ### Request {#post-request} @@ -43,7 +43,7 @@ Queries the OCSP server for the proxy certificate’s latest status and returns ### Response {#post-response} -Returns an [OCSP status object]({{< relref "/operate/rs/references/rest-api/objects/ocsp_status" >}}). +Returns an [OCSP status object]({{< relref "/operate/rs/7.4/references/rest-api/objects/ocsp_status" >}}). #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/proxies/_index.md b/content/operate/rs/7.4/references/rest-api/requests/proxies/_index.md index 728b46f203..65345d9ac5 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/proxies/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/proxies/_index.md @@ -32,7 +32,7 @@ Get all the proxies in the cluster. | Permission name | Roles | |-----------------|-------| -| [view_all_proxies_info]({{< relref "/operate/rs/references/rest-api/permissions#view_all_proxies_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | +| [view_all_proxies_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_all_proxies_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | ### Request {#get-all-request} @@ -51,7 +51,7 @@ GET /v1/proxies ### Response {#get-all-response} -Returns a JSON array of [proxy objects]({{< relref "/operate/rs/references/rest-api/objects/proxy" >}}). +Returns a JSON array of [proxy objects]({{< relref "/operate/rs/7.4/references/rest-api/objects/proxy" >}}). #### Example JSON body @@ -103,7 +103,7 @@ Get a single proxy's info. | Permission name | Roles | |-----------------|-------| -| [view_proxy_info]({{< relref "/operate/rs/references/rest-api/permissions#view_proxy_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | +| [view_proxy_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_proxy_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | ### Request {#get-request} @@ -128,7 +128,7 @@ GET /v1/proxies/1 ### Response {#get-response} -Returns a [proxy object]({{< relref "/operate/rs/references/rest-api/objects/proxy" >}}). +Returns a [proxy object]({{< relref "/operate/rs/7.4/references/rest-api/objects/proxy" >}}). #### Example JSON body @@ -178,7 +178,7 @@ However, if `allow_restart` is `false`, such changes only take effect after the | Permission name | Roles | |-----------------|-------| -| [update_proxy]({{< relref "/operate/rs/references/rest-api/permissions#update_proxy" >}}) | admin | +| [update_proxy]({{< relref "/operate/rs/7.4/references/rest-api/permissions#update_proxy" >}}) | admin | ### Request {#put-request} @@ -215,7 +215,7 @@ PUT /v1/proxies/1 #### Request body -Include a JSON object in the request body. The JSON object can contain the boolean field `allow_restart` and a [proxy object]({{< relref "/operate/rs/references/rest-api/objects/proxy" >}}) with updated fields. +Include a JSON object in the request body. The JSON object can contain the boolean field `allow_restart` and a [proxy object]({{< relref "/operate/rs/7.4/references/rest-api/objects/proxy" >}}) with updated fields. ### Response {#put-response} @@ -247,7 +247,7 @@ However, if `allow_restart` is `false`, such changes only take effect after the | Permission name | Roles | |-----------------|-------| -| [update_proxy]({{< relref "/operate/rs/references/rest-api/permissions#update_proxy" >}}) | admin | +| [update_proxy]({{< relref "/operate/rs/7.4/references/rest-api/permissions#update_proxy" >}}) | admin | ### Request {#put-all-request} @@ -279,7 +279,7 @@ PUT /v1/proxies #### Request body -Include a JSON object in the request body. The JSON object can contain the boolean field `allow_restart` and a [proxy object]({{< relref "/operate/rs/references/rest-api/objects/proxy" >}}) with updated fields. +Include a JSON object in the request body. The JSON object can contain the boolean field `allow_restart` and a [proxy object]({{< relref "/operate/rs/7.4/references/rest-api/objects/proxy" >}}) with updated fields. ### Response {#put-all-response} diff --git a/content/operate/rs/7.4/references/rest-api/requests/redis_acls/_index.md b/content/operate/rs/7.4/references/rest-api/requests/redis_acls/_index.md index 8c757d7a36..950039210f 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/redis_acls/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/redis_acls/_index.md @@ -33,7 +33,7 @@ Get all Redis ACL objects. | Permission name | Roles | |-----------------|-------| -| [view_all_redis_acls_info]({{< relref "/operate/rs/references/rest-api/permissions#view_all_redis_acls_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | +| [view_all_redis_acls_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_all_redis_acls_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | ### Request {#get-all-request} @@ -52,7 +52,7 @@ GET /v1/redis_acls ### Response {#get-all-response} -Returns a JSON array of [Redis ACL objects]({{< relref "/operate/rs/references/rest-api/objects/redis_acl" >}}). +Returns a JSON array of [Redis ACL objects]({{< relref "/operate/rs/7.4/references/rest-api/objects/redis_acl" >}}). #### Example JSON body @@ -100,7 +100,7 @@ Get a single Redis ACL object. | Permission name | Roles | |-----------------|-------| -| [view_redis_acl_info]({{< relref "/operate/rs/references/rest-api/permissions#view_redis_acl_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | +| [view_redis_acl_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_redis_acl_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | ### Request {#get-request} @@ -126,7 +126,7 @@ GET /v1/redis_acls/1 ### Response {#get-response} -Returns a [Redis ACL object]({{< relref "/operate/rs/references/rest-api/objects/redis_acl" >}}). +Returns a [Redis ACL object]({{< relref "/operate/rs/7.4/references/rest-api/objects/redis_acl" >}}). #### Example JSON body @@ -159,7 +159,7 @@ Update an existing Redis ACL object. | Permission name | Roles | |-----------------|-------| -| [update_redis_acl]({{< relref "/operate/rs/references/rest-api/permissions#update_redis_acl" >}}) | admin | +| [update_redis_acl]({{< relref "/operate/rs/7.4/references/rest-api/permissions#update_redis_acl" >}}) | admin | ### Request {#put-request} @@ -187,11 +187,11 @@ PUT /v1/redis_acls/17 #### Request body -Include a [Redis ACL object]({{< relref "/operate/rs/references/rest-api/objects/redis_acl" >}}) with updated fields in the request body. +Include a [Redis ACL object]({{< relref "/operate/rs/7.4/references/rest-api/objects/redis_acl" >}}) with updated fields in the request body. ### Response {#put-response} -Returns the updated [Redis ACL object]({{< relref "/operate/rs/references/rest-api/objects/redis_acl" >}}). +Returns the updated [Redis ACL object]({{< relref "/operate/rs/7.4/references/rest-api/objects/redis_acl" >}}). #### Example JSON body @@ -233,7 +233,7 @@ Create a new Redis ACL object. | Permission name | Roles | |-----------------|-------| -| [create_redis_acl]({{< relref "/operate/rs/references/rest-api/permissions#create_redis_acl" >}}) | admin | +| [create_redis_acl]({{< relref "/operate/rs/7.4/references/rest-api/permissions#create_redis_acl" >}}) | admin | ### Request {#post-request} @@ -262,11 +262,11 @@ POST /v1/redis_acls #### Request body -Include a [Redis ACL object]({{< relref "/operate/rs/references/rest-api/objects/redis_acl" >}}) in the request body. +Include a [Redis ACL object]({{< relref "/operate/rs/7.4/references/rest-api/objects/redis_acl" >}}) in the request body. ### Response {#post-response} -Returns the newly created [Redis ACL object]({{< relref "/operate/rs/references/rest-api/objects/redis_acl" >}}). +Returns the newly created [Redis ACL object]({{< relref "/operate/rs/7.4/references/rest-api/objects/redis_acl" >}}). #### Example JSON body @@ -344,7 +344,7 @@ Delete a Redis ACL object. | Permission name | Roles | |-----------------|-------| -| [delete_redis_acl]({{< relref "/operate/rs/references/rest-api/permissions#delete_redis_acl" >}}) | admin | +| [delete_redis_acl]({{< relref "/operate/rs/7.4/references/rest-api/permissions#delete_redis_acl" >}}) | admin | ### Request {#delete-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/roles/_index.md b/content/operate/rs/7.4/references/rest-api/requests/roles/_index.md index abca747a6c..541d47e5b4 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/roles/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/roles/_index.md @@ -33,7 +33,7 @@ Get all roles' details. | Permission name | Roles | |-----------------|-------| -| [view_all_roles_info]({{< relref "/operate/rs/references/rest-api/permissions#view_all_roles_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | +| [view_all_roles_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_all_roles_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | ### Request {#get-all-request} @@ -52,7 +52,7 @@ GET /v1/roles ### Response {#get-all-response} -Returns a JSON array of [role objects]({{< relref "/operate/rs/references/rest-api/objects/role" >}}). +Returns a JSON array of [role objects]({{< relref "/operate/rs/7.4/references/rest-api/objects/role" >}}). #### Example JSON body @@ -115,7 +115,7 @@ Get the details of a single role. | Permission name | Roles | |-----------------|-------| -| [view_role_info]({{< relref "/operate/rs/references/rest-api/permissions#view_role_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | +| [view_role_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_role_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | ### Request {#get-request} @@ -142,7 +142,7 @@ GET /v1/roles/1 ### Response {#get-response} -Returns a [role object]({{< relref "/operate/rs/references/rest-api/objects/role" >}}). +Returns a [role object]({{< relref "/operate/rs/7.4/references/rest-api/objects/role" >}}). #### Example JSON body @@ -175,7 +175,7 @@ Update an existing role's details. | Permission name | Roles | |-----------------|-------| -| [update_role]({{< relref "/operate/rs/references/rest-api/permissions#update_role" >}}) | admin | +| [update_role]({{< relref "/operate/rs/7.4/references/rest-api/permissions#update_role" >}}) | admin | ### Request {#put-request} @@ -203,11 +203,11 @@ PUT /v1/roles/17 #### Body -Include a [role object]({{< relref "/operate/rs/references/rest-api/objects/role" >}}) with updated fields in the request body. +Include a [role object]({{< relref "/operate/rs/7.4/references/rest-api/objects/role" >}}) with updated fields in the request body. ### Response {#put-response} -Returns a [role object]({{< relref "/operate/rs/references/rest-api/objects/role" >}}) with the updated fields. +Returns a [role object]({{< relref "/operate/rs/7.4/references/rest-api/objects/role" >}}) with the updated fields. #### Example JSON body @@ -250,7 +250,7 @@ Create a new role. | Permission name | Roles | |-----------------|-------| -| [create_role]({{< relref "/operate/rs/references/rest-api/permissions#create_role" >}}) | admin | +| [create_role]({{< relref "/operate/rs/7.4/references/rest-api/permissions#create_role" >}}) | admin | ### Request {#post-request} @@ -279,11 +279,11 @@ POST /v1/roles #### Body -Include a [role object]({{< relref "/operate/rs/references/rest-api/objects/role" >}}) in the request body. +Include a [role object]({{< relref "/operate/rs/7.4/references/rest-api/objects/role" >}}) in the request body. ### Response {#post-response} -Returns the newly created [role object]({{< relref "/operate/rs/references/rest-api/objects/role" >}}). +Returns the newly created [role object]({{< relref "/operate/rs/7.4/references/rest-api/objects/role" >}}). #### Example JSON body @@ -360,7 +360,7 @@ Delete a role object. | Permission name | Roles | |-----------------|-------| -| [delete_role]({{< relref "/operate/rs/references/rest-api/permissions#delete_role" >}}) | admin | +| [delete_role]({{< relref "/operate/rs/7.4/references/rest-api/permissions#delete_role" >}}) | admin | ### Request {#delete-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/shards/_index.md b/content/operate/rs/7.4/references/rest-api/requests/shards/_index.md index a852fed836..0bd26a7aeb 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/shards/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/shards/_index.md @@ -45,7 +45,7 @@ Get information about all shards in the cluster. ### Response {#get-all-response} -Returns a JSON array of [shard objects]({{}}). +Returns a JSON array of [shard objects]({{}}). #### Example JSON body @@ -115,7 +115,7 @@ Gets information about a single shard. ### Response {#get-response} -Returns a [shard object]({{}}). +Returns a [shard object]({{}}). #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/shards/actions/_index.md b/content/operate/rs/7.4/references/rest-api/requests/shards/actions/_index.md index 66874ee9cf..face5f54a4 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/shards/actions/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/shards/actions/_index.md @@ -17,5 +17,5 @@ url: '/operate/rs/7.4/references/rest-api/requests/shards/actions/' | Method | Path | Description | |--------|------|-------------| -| [POST]({{}}) | `/v1/shards/actions/migrate` | Migrate multiple shards | -| [POST]({{}}) | `/v1/shards/{uid}/actions/migrate` | Migrate a specific shard | +| [POST]({{}}) | `/v1/shards/actions/migrate` | Migrate multiple shards | +| [POST]({{}}) | `/v1/shards/{uid}/actions/migrate` | Migrate a specific shard | diff --git a/content/operate/rs/7.4/references/rest-api/requests/shards/actions/migrate.md b/content/operate/rs/7.4/references/rest-api/requests/shards/actions/migrate.md index 32530c0218..70b0ce26ac 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/shards/actions/migrate.md +++ b/content/operate/rs/7.4/references/rest-api/requests/shards/actions/migrate.md @@ -23,13 +23,13 @@ url: '/operate/rs/7.4/references/rest-api/requests/shards/actions/migrate/' Migrates the list of given shard UIDs to the node specified by `target_node_uid`. The shards can be from multiple databases. This request is asynchronous. -For more information about shard migration use cases and considerations, see [Migrate database shards]({{}}). +For more information about shard migration use cases and considerations, see [Migrate database shards]({{}}). #### Required permissions | Permission name | Roles | |-----------------|-------| -| [migrate_shard]({{< relref "/operate/rs/references/rest-api/permissions#migrate_shard" >}}) | admin
cluster_member
db_member | +| [migrate_shard]({{< relref "/operate/rs/7.4/references/rest-api/permissions#migrate_shard" >}}) | admin
cluster_member
db_member | ### Request {#post-multi-request} @@ -71,7 +71,7 @@ The request body is a JSON object that can contain the following fields: ### Response {#post-multi-response} -Returns a JSON object with an `action_uid`. You can track the action's progress with a [`GET /v1/actions/`]({{}}) request. +Returns a JSON object with an `action_uid`. You can track the action's progress with a [`GET /v1/actions/`]({{}}) request. #### Example JSON body @@ -98,13 +98,13 @@ Returns a JSON object with an `action_uid`. You can track the action's progress Migrates the shard with the given `shard_uid` to the node specified by `target_node_uid`. If the shard is already on the target node, nothing happens. This request is asynchronous. -For more information about shard migration use cases and considerations, see [Migrate database shards]({{}}). +For more information about shard migration use cases and considerations, see [Migrate database shards]({{}}). #### Required permissions | Permission name | Roles | |-----------------|-------| -| [migrate_shard]({{< relref "/operate/rs/references/rest-api/permissions#migrate_shard" >}}) | admin
cluster_member
db_member | +| [migrate_shard]({{< relref "/operate/rs/7.4/references/rest-api/permissions#migrate_shard" >}}) | admin
cluster_member
db_member | ### Request {#post-request} @@ -150,7 +150,7 @@ The request body is a JSON object that can contain the following fields: ### Response {#post-response} -Returns a JSON object with an `action_uid`. You can track the action's progress with a [`GET /v1/actions/`]({{}}) request. +Returns a JSON object with an `action_uid`. You can track the action's progress with a [`GET /v1/actions/`]({{}}) request. #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/shards/stats/_index.md b/content/operate/rs/7.4/references/rest-api/requests/shards/stats/_index.md index 66d847d994..b38ee2eb29 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/shards/stats/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/shards/stats/_index.md @@ -29,7 +29,7 @@ Get statistics for all shards. | Permission name | |-----------------| -| [view_all_shard_stats]({{< relref "/operate/rs/references/rest-api/permissions#view_all_shard_stats" >}}) | +| [view_all_shard_stats]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_all_shard_stats" >}}) | ### Request {#get-all-request} @@ -54,11 +54,11 @@ Get statistics for all shards. | interval | string | Time interval for which we want stats: 1sec/10sec/5min/15min/1hour/12hour/1week (optional) | | stime | ISO_8601 | Start time from which we want the stats. Should comply with the [ISO_8601](https://en.wikipedia.org/wiki/ISO_8601) format (optional) | | etime | ISO_8601 | End time after which we don't want the stats. Should comply with the [ISO_8601](https://en.wikipedia.org/wiki/ISO_8601) format (optional) | -| metrics | list | Comma-separated list of [metric names]({{< relref "/operate/rs/references/rest-api/objects/statistics/shard-metrics" >}}) for which we want statistics (default is all) (optional) | +| metrics | list | Comma-separated list of [metric names]({{< relref "/operate/rs/7.4/references/rest-api/objects/statistics/shard-metrics" >}}) for which we want statistics (default is all) (optional) | ### Response {#get-all-response} -Returns a JSON array of [statistics]({{< relref "/operate/rs/references/rest-api/objects/statistics" >}}) for all shards. +Returns a JSON array of [statistics]({{< relref "/operate/rs/7.4/references/rest-api/objects/statistics" >}}) for all shards. #### Example JSON body @@ -147,7 +147,7 @@ Get statistics for a specific shard. | Permission name | |-----------------| -| [view_shard_stats]({{< relref "/operate/rs/references/rest-api/permissions#view_shard_stats" >}}) | +| [view_shard_stats]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_shard_stats" >}}) | ### Request {#get-request} @@ -181,7 +181,7 @@ Get statistics for a specific shard. ### Response {#get-response} -Returns [statistics]({{< relref "/operate/rs/references/rest-api/objects/statistics" >}}) for the specified shard. +Returns [statistics]({{< relref "/operate/rs/7.4/references/rest-api/objects/statistics" >}}) for the specified shard. #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/shards/stats/last.md b/content/operate/rs/7.4/references/rest-api/requests/shards/stats/last.md index 5a833a42f7..ccb50306fb 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/shards/stats/last.md +++ b/content/operate/rs/7.4/references/rest-api/requests/shards/stats/last.md @@ -28,7 +28,7 @@ Get most recent statistics for all shards. | Permission name | |-----------------| -| [view_all_shard_stats]({{< relref "/operate/rs/references/rest-api/permissions#view_all_shard_stats" >}}) | +| [view_all_shard_stats]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_all_shard_stats" >}}) | ### Request {#get-all-request} @@ -55,7 +55,7 @@ Get most recent statistics for all shards. ### Response {#get-all-response} -Returns most recent [statistics]({{< relref "/operate/rs/references/rest-api/objects/statistics" >}}) for all shards. +Returns most recent [statistics]({{< relref "/operate/rs/7.4/references/rest-api/objects/statistics" >}}) for all shards. #### Example JSON body @@ -116,7 +116,7 @@ Get most recent statistics for a specific shard. | Permission name | |-----------------| -| [view_shard_stats]({{< relref "/operate/rs/references/rest-api/permissions#view_shard_stats" >}}) | +| [view_shard_stats]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_shard_stats" >}}) | ### Request {#get-request} @@ -150,7 +150,7 @@ Get most recent statistics for a specific shard. ### Response {#get-response} -Returns the most recent [statistics]({{< relref "/operate/rs/references/rest-api/objects/statistics" >}}) for the specified shard. +Returns the most recent [statistics]({{< relref "/operate/rs/7.4/references/rest-api/objects/statistics" >}}) for the specified shard. #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/suffix/_index.md b/content/operate/rs/7.4/references/rest-api/requests/suffix/_index.md index 337cab14dc..65da8f65e9 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/suffix/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/suffix/_index.md @@ -46,7 +46,7 @@ Get a single DNS suffix. ### Response {#get-response} -Returns a [suffix object]({{< relref "/operate/rs/references/rest-api/objects/suffix" >}}). +Returns a [suffix object]({{< relref "/operate/rs/7.4/references/rest-api/objects/suffix" >}}). #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/suffixes/_index.md b/content/operate/rs/7.4/references/rest-api/requests/suffixes/_index.md index c81c8b3c18..dace7689f2 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/suffixes/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/suffixes/_index.md @@ -39,7 +39,7 @@ Get all DNS suffixes in the cluster. ### Response {#get-all-response} -The response body contains a JSON array with all suffixes, represented as [suffix objects]({{< relref "/operate/rs/references/rest-api/objects/suffix" >}}). +The response body contains a JSON array with all suffixes, represented as [suffix objects]({{< relref "/operate/rs/7.4/references/rest-api/objects/suffix" >}}). #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/users/_index.md b/content/operate/rs/7.4/references/rest-api/requests/users/_index.md index 270d7c878e..43f30a8644 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/users/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/users/_index.md @@ -33,7 +33,7 @@ Get a list of all users. | Permission name | Roles | |-----------------|-------| -| [view_all_users_info]({{< relref "/operate/rs/references/rest-api/permissions#view_all_users_info" >}}) | admin | +| [view_all_users_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_all_users_info" >}}) | admin | ### Request {#get-all-request} @@ -52,7 +52,7 @@ GET /v1/users ### Response {#get-all-response} -Returns a JSON array of [user objects]({{< relref "/operate/rs/references/rest-api/objects/user" >}}). +Returns a JSON array of [user objects]({{< relref "/operate/rs/7.4/references/rest-api/objects/user" >}}). #### Example JSON body @@ -100,7 +100,7 @@ Get a single user's details. | Permission name | Roles | |-----------------|-------| -| [view_user_info]({{< relref "/operate/rs/references/rest-api/permissions#view_user_info" >}}) | admin | +| [view_user_info]({{< relref "/operate/rs/7.4/references/rest-api/permissions#view_user_info" >}}) | admin | ### Request {#get-request} @@ -125,7 +125,7 @@ GET /v1/users/1 ### Response {#get-response} -Returns a [user object]({{< relref "/operate/rs/references/rest-api/objects/user" >}}) that contains the details for the specified user ID. +Returns a [user object]({{< relref "/operate/rs/7.4/references/rest-api/objects/user" >}}) that contains the details for the specified user ID. #### Example JSON body @@ -163,7 +163,7 @@ Update an existing user's configuration. | Permission name | Roles | |-----------------|-------| -| [update_user]({{< relref "/operate/rs/references/rest-api/permissions#update_user" >}}) | admin | +| [update_user]({{< relref "/operate/rs/7.4/references/rest-api/permissions#update_user" >}}) | admin | Any user can change their own name, password, or alert preferences. @@ -201,11 +201,11 @@ PUT /v1/users/1 #### Request body -Include a [user object]({{< relref "/operate/rs/references/rest-api/objects/user" >}}) with updated fields in the request body. +Include a [user object]({{< relref "/operate/rs/7.4/references/rest-api/objects/user" >}}) with updated fields in the request body. ### Response {#put-response} -Returns the updated [user object]({{< relref "/operate/rs/references/rest-api/objects/user" >}}). +Returns the updated [user object]({{< relref "/operate/rs/7.4/references/rest-api/objects/user" >}}). #### Example JSON body @@ -223,7 +223,7 @@ Returns the updated [user object]({{< relref "/operate/rs/references/rest-api/ob ``` {{}} -For [RBAC-enabled clusters]({{< relref "/operate/rs/security/access-control" >}}), the returned user details include `role_uids` instead of `role`. +For [RBAC-enabled clusters]({{< relref "/operate/rs/7.4/security/access-control" >}}), the returned user details include `role_uids` instead of `role`. {{}} ### Error codes {#put-error-codes} @@ -258,7 +258,7 @@ Create a new user. | Permission name | Roles | |-----------------|-------| -| [create_new_user]({{< relref "/operate/rs/references/rest-api/permissions#create_new_user" >}}) | admin | +| [create_new_user]({{< relref "/operate/rs/7.4/references/rest-api/permissions#create_new_user" >}}) | admin | ### Request {#post-request} @@ -277,10 +277,10 @@ POST /v1/users #### Body -Include a single [user object]({{< relref "/operate/rs/references/rest-api/objects/user" >}}) in the request body. The user object must have an email, password, and role. +Include a single [user object]({{< relref "/operate/rs/7.4/references/rest-api/objects/user" >}}) in the request body. The user object must have an email, password, and role. {{}} -For [RBAC-enabled clusters]({{< relref "/operate/rs/security/access-control" >}}), use `role_uids` instead of `role` in the request body. +For [RBAC-enabled clusters]({{< relref "/operate/rs/7.4/security/access-control" >}}), use `role_uids` instead of `role` in the request body. {{}} `email_alerts` can be configured either as: @@ -305,7 +305,7 @@ For [RBAC-enabled clusters]({{< relref "/operate/rs/security/access-control" >}} ### Response {#post-response} -Returns the newly created [user object]({{< relref "/operate/rs/references/rest-api/objects/user" >}}). +Returns the newly created [user object]({{< relref "/operate/rs/7.4/references/rest-api/objects/user" >}}). #### Example JSON body @@ -406,7 +406,7 @@ Delete a user. | Permission name | Roles | |-----------------|-------| -| [delete_user]({{< relref "/operate/rs/references/rest-api/permissions#delete_user" >}}) | admin | +| [delete_user]({{< relref "/operate/rs/7.4/references/rest-api/permissions#delete_user" >}}) | admin | ### Request {#delete-request} diff --git a/content/operate/rs/7.4/references/rest-api/requests/users/authorize.md b/content/operate/rs/7.4/references/rest-api/requests/users/authorize.md index 869ff0ca08..216992e33b 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/users/authorize.md +++ b/content/operate/rs/7.4/references/rest-api/requests/users/authorize.md @@ -45,7 +45,7 @@ Generate a JSON Web Token (JWT) for a user to use as authorization to access the #### Request body -Include a [JWT authorize object]({{< relref "/operate/rs/references/rest-api/objects/jwt_authorize" >}}) with a valid username and password in the request body. +Include a [JWT authorize object]({{< relref "/operate/rs/7.4/references/rest-api/objects/jwt_authorize" >}}) with a valid username and password in the request body. ### Response {#post-response} diff --git a/content/operate/rs/7.4/references/upgrade-paths.md b/content/operate/rs/7.4/references/upgrade-paths.md index 2fd4cbb81f..af2d6c9c9e 100644 --- a/content/operate/rs/7.4/references/upgrade-paths.md +++ b/content/operate/rs/7.4/references/upgrade-paths.md @@ -14,6 +14,6 @@ url: '/operate/rs/7.4/references/upgrade-paths/' {{}} -For detailed upgrade instructions, see [Upgrade a Redis Enterprise Software cluster]({{}}). +For detailed upgrade instructions, see [Upgrade a Redis Enterprise Software cluster]({{}}). -See the [Redis Enterprise Software product lifecycle]({{}}) for more information about release numbers and the end-of-life schedule. +See the [Redis Enterprise Software product lifecycle]({{}}) for more information about release numbers and the end-of-life schedule. diff --git a/content/operate/rs/7.4/security/_index.md b/content/operate/rs/7.4/security/_index.md index d9efb4d3ed..d79e22ee3c 100644 --- a/content/operate/rs/7.4/security/_index.md +++ b/content/operate/rs/7.4/security/_index.md @@ -17,15 +17,15 @@ Redis Enterprise Software provides various features to secure your Redis Enterpr | Login and passwords | Users and roles | Encryption and TLS | Certificates and audit | |---------------------|-----------------|--------------------|-----------------------| -| [Password attempts and session timeout]({{}}) | [Cluster and database access explained]({{}}) | [Enable TLS]({{}}) | [Create certificates]({{}}) | -| [Password complexity]({{}}) | [Create users]({{}}) | [Configure TLS protocols]({{}}) | [Monitor certificates]({{}}) | -| [Password expiration]({{}}) | [Create roles]({{}}) | [Configure cipher suites]({{}}) | [Update certificates]({{}}) | -| [Default database access]({{}}) | [Redis ACLs]({{}}) | [Encrypt private keys on disk]({{}}) | [Enable OCSP stapling]({{}}) | -| [Rotate user passwords]({{}}) | [Integrate with LDAP]({{}}) | [Internode encryption]({{}}) | [Audit database connections]({{}}) | +| [Password attempts and session timeout]({{}}) | [Cluster and database access explained]({{}}) | [Enable TLS]({{}}) | [Create certificates]({{}}) | +| [Password complexity]({{}}) | [Create users]({{}}) | [Configure TLS protocols]({{}}) | [Monitor certificates]({{}}) | +| [Password expiration]({{}}) | [Create roles]({{}}) | [Configure cipher suites]({{}}) | [Update certificates]({{}}) | +| [Default database access]({{}}) | [Redis ACLs]({{}}) | [Encrypt private keys on disk]({{}}) | [Enable OCSP stapling]({{}}) | +| [Rotate user passwords]({{}}) | [Integrate with LDAP]({{}}) | [Internode encryption]({{}}) | [Audit database connections]({{}}) | ## Recommended security practices -See [Recommended security practices]({{}}) to learn how to protect Redis Enterprise Software. +See [Recommended security practices]({{}}) to learn how to protect Redis Enterprise Software. ## Redis Trust Center diff --git a/content/operate/rs/7.4/security/access-control/_index.md b/content/operate/rs/7.4/security/access-control/_index.md index 42617ac0c8..c98f2b0a23 100644 --- a/content/operate/rs/7.4/security/access-control/_index.md +++ b/content/operate/rs/7.4/security/access-control/_index.md @@ -43,12 +43,12 @@ The following diagram shows three different options for roles and users: ## Default database access -When you create a database, [default user access]({{< relref "/operate/rs/security/access-control/manage-users/default-user" >}}) is enabled automatically. +When you create a database, [default user access]({{< relref "/operate/rs/7.4/security/access-control/manage-users/default-user" >}}) is enabled automatically. -If you set up role-based access controls for your database and don't require compatibility with versions earlier than Redis 6, you can [deactivate the default user]({{< relref "/operate/rs/security/access-control/manage-users/default-user" >}}). +If you set up role-based access controls for your database and don't require compatibility with versions earlier than Redis 6, you can [deactivate the default user]({{< relref "/operate/rs/7.4/security/access-control/manage-users/default-user" >}}). {{}} -Before you [deactivate default user access]({{< relref "/operate/rs/security/access-control/manage-users/default-user#deactivate-default-user" >}}), make sure the role associated with the database is [assigned to a user]({{< relref "/operate/rs/security/access-control/create-users#assign-roles-to-users" >}}). Otherwise, the database will be inaccessible. +Before you [deactivate default user access]({{< relref "/operate/rs/7.4/security/access-control/manage-users/default-user#deactivate-default-user" >}}), make sure the role associated with the database is [assigned to a user]({{< relref "/operate/rs/7.4/security/access-control/create-users#assign-roles-to-users" >}}). Otherwise, the database will be inaccessible. {{}} ## More info diff --git a/content/operate/rs/7.4/security/access-control/create-cluster-roles.md b/content/operate/rs/7.4/security/access-control/create-cluster-roles.md index ded25a719e..9e50fcba4e 100644 --- a/content/operate/rs/7.4/security/access-control/create-cluster-roles.md +++ b/content/operate/rs/7.4/security/access-control/create-cluster-roles.md @@ -17,7 +17,7 @@ Roles with cluster access allow access to the Cluster Management UI and REST API ## Default management roles -Redis Enterprise Software includes five predefined roles that determine a user's level of access to the Cluster Manager UI and [REST API]({{}}). +Redis Enterprise Software includes five predefined roles that determine a user's level of access to the Cluster Manager UI and [REST API]({{}}). 1. **DB Viewer** - Read database settings 1. **DB Member** - Administer databases @@ -26,7 +26,7 @@ Redis Enterprise Software includes five predefined roles that determine a user's 1. **Admin** - Full cluster access 1. **None** - For data access only - cannot access the Cluster Manager UI or use the REST API -For more details about the privileges granted by each of these roles, see [Cluster Manager UI permissions](#cluster-manager-ui-permissions) or [REST API permissions]({{}}). +For more details about the privileges granted by each of these roles, see [Cluster Manager UI permissions](#cluster-manager-ui-permissions) or [REST API permissions]({{}}). ## Cluster Manager UI permissions @@ -70,4 +70,4 @@ To create a role that grants cluster access but does not grant access to any dat 1. Select **Save**. -You can [assign the new role to users]({{}}) to grant cluster access. +You can [assign the new role to users]({{}}) to grant cluster access. diff --git a/content/operate/rs/7.4/security/access-control/create-combined-roles.md b/content/operate/rs/7.4/security/access-control/create-combined-roles.md index c81f5d1df0..c71425acdc 100644 --- a/content/operate/rs/7.4/security/access-control/create-combined-roles.md +++ b/content/operate/rs/7.4/security/access-control/create-combined-roles.md @@ -29,7 +29,7 @@ To define a Redis ACL rule that you can assign to a role: 1. Enter a descriptive name for the Redis ACL. This will be used to associate the ACL rule with the role. -1. Define the ACL rule. For more information about Redis ACL rules and syntax, see the [Redis ACL overview]({{}}). +1. Define the ACL rule. For more information about Redis ACL rules and syntax, see the [Redis ACL overview]({{}}). {{}} The **ACL builder** does not support selectors and key permissions. Use **Free text command** to manually define them instead. @@ -55,7 +55,7 @@ To create a role that grants database access privileges and allows access to the 1. Enter a descriptive name for the role. This will be used to reference the role when configuring users. -1. Choose a **Cluster management role** other than **None**. For details about permissions granted by each role, see [Cluster Manager UI permissions]({{}}) and [REST API permissions]({{}}). +1. Choose a **Cluster management role** other than **None**. For details about permissions granted by each role, see [Cluster Manager UI permissions]({{}}) and [REST API permissions]({{}}). {{Add role with name}} @@ -73,4 +73,4 @@ To create a role that grants database access privileges and allows access to the {{Add databases to access}} -You can [assign the new role to users]({{}}) to grant database access and access to the Cluster Manager UI and REST API. +You can [assign the new role to users]({{}}) to grant database access and access to the Cluster Manager UI and REST API. diff --git a/content/operate/rs/7.4/security/access-control/create-db-roles.md b/content/operate/rs/7.4/security/access-control/create-db-roles.md index bbd65e9c42..46d866a2d5 100644 --- a/content/operate/rs/7.4/security/access-control/create-db-roles.md +++ b/content/operate/rs/7.4/security/access-control/create-db-roles.md @@ -13,7 +13,7 @@ aliases: url: '/operate/rs/7.4/security/access-control/create-db-roles/' --- -Roles with database access grant the ability to access and interact with a database's data. Database access privileges are determined by defining [Redis ACLs]({{}}) and adding them to roles. +Roles with database access grant the ability to access and interact with a database's data. Database access privileges are determined by defining [Redis ACLs]({{}}) and adding them to roles. To create a role that grants database access without granting access to the Redis Enterprise Cluster Manager UI and REST API: @@ -33,7 +33,7 @@ To define a Redis ACL rule that you can assign to a role: 1. Enter a descriptive name for the Redis ACL. This will be used to associate the ACL rule with the role. -1. Define the ACL rule. For more information about Redis ACL rules and syntax, see the [Redis ACL overview]({{}}). +1. Define the ACL rule. For more information about Redis ACL rules and syntax, see the [Redis ACL overview]({{}}). {{}} The **ACL builder** does not support selectors and key permissions. Use **Free text command** to manually define them instead. @@ -79,4 +79,4 @@ To define a role for database access: {{Add databases to access}} -You can [assign the new role to users]({{}}) to grant database access. +You can [assign the new role to users]({{}}) to grant database access. diff --git a/content/operate/rs/7.4/security/access-control/create-users.md b/content/operate/rs/7.4/security/access-control/create-users.md index 31313989c7..7741c97fe1 100644 --- a/content/operate/rs/7.4/security/access-control/create-users.md +++ b/content/operate/rs/7.4/security/access-control/create-users.md @@ -18,9 +18,9 @@ url: '/operate/rs/7.4/security/access-control/create-users/' Before you create other users: -1. Review the [access control overview]({{}}) to learn how to use role-based access control (RBAC) to manage users' cluster access and database access. +1. Review the [access control overview]({{}}) to learn how to use role-based access control (RBAC) to manage users' cluster access and database access. -1. Create roles you can assign to users. See [Create roles with cluster access only]({{}}), [Create roles with database access only]({{}}), or [Create roles with combined access]({{}}) for instructions. +1. Create roles you can assign to users. See [Create roles with cluster access only]({{}}), [Create roles with database access only]({{}}), or [Create roles with combined access]({{}}) for instructions. ## Add users @@ -54,7 +54,7 @@ Assign a role, associated with specific databases and access control lists (ACLs - Point to an existing user and select {{< image filename="/images/rs/buttons/edit-button.png#no-click" alt="The Edit button" width="25px" class="inline" >}} to edit the user. - - Select **+ Add user** to [create a new user]({{< relref "/operate/rs/security/access-control/create-users" >}}). + - Select **+ Add user** to [create a new user]({{< relref "/operate/rs/7.4/security/access-control/create-users" >}}). 1. Select a role to assign to the user. @@ -66,8 +66,8 @@ Assign a role, associated with specific databases and access control lists (ACLs Depending on the type of the user's assigned role (cluster management role or data access role), the user can now: -- [Connect to a database]({{< relref "/operate/rs/databases/connect" >}}) associated with the role and run limited Redis commands, depending on the role's Redis ACLs. +- [Connect to a database]({{< relref "/operate/rs/7.4/databases/connect" >}}) associated with the role and run limited Redis commands, depending on the role's Redis ACLs. - Sign in to the Redis Enterprise Software Cluster Manager UI. -- Make a [REST API]({{< relref "/operate/rs/references/rest-api" >}}) request. +- Make a [REST API]({{< relref "/operate/rs/7.4/references/rest-api" >}}) request. diff --git a/content/operate/rs/7.4/security/access-control/ldap/_index.md b/content/operate/rs/7.4/security/access-control/ldap/_index.md index d99dda07f3..1a76247c95 100644 --- a/content/operate/rs/7.4/security/access-control/ldap/_index.md +++ b/content/operate/rs/7.4/security/access-control/ldap/_index.md @@ -14,9 +14,9 @@ weight: 50 url: '/operate/rs/7.4/security/access-control/ldap/' --- -Redis Enterprise Software supports [Lightweight Directory Access Protocol](https://en.wikipedia.org/wiki/Lightweight_Directory_Access_Protocol) (LDAP) authentication and authorization through its [role-based access controls]({{< relref "/operate/rs/security/access-control" >}}) (RBAC). You can use LDAP to authorize access to the Cluster Manager UI and to control database access. +Redis Enterprise Software supports [Lightweight Directory Access Protocol](https://en.wikipedia.org/wiki/Lightweight_Directory_Access_Protocol) (LDAP) authentication and authorization through its [role-based access controls]({{< relref "/operate/rs/7.4/security/access-control" >}}) (RBAC). You can use LDAP to authorize access to the Cluster Manager UI and to control database access. -You can configure LDAP roles using the Redis Enterprise Cluster Manager UI or [REST API]({{< relref "/operate/rs/references/rest-api/requests/ldap_mappings/" >}}). +You can configure LDAP roles using the Redis Enterprise Cluster Manager UI or [REST API]({{< relref "/operate/rs/7.4/references/rest-api/requests/ldap_mappings/" >}}). ## How it works @@ -57,26 +57,26 @@ Before you enable LDAP in Redis Enterprise, you need: 1. The LDAP groups that correspond to the levels of access you wish to authorize. Each LDAP group will be mapped to a Redis Enterprise access control role. -1. A Redis Enterprise access control role for each LDAP group. Before you enable LDAP, you need to set up [role-based access controls]({{< relref "/operate/rs/security/access-control" >}}) (RBAC). +1. A Redis Enterprise access control role for each LDAP group. Before you enable LDAP, you need to set up [role-based access controls]({{< relref "/operate/rs/7.4/security/access-control" >}}) (RBAC). ## Enable LDAP To enable LDAP: -1. From **Access Control > LDAP** in the Cluster Manager UI, select the **Configuration** tab and [enable LDAP access]({{< relref "/operate/rs/security/access-control/ldap/enable-role-based-ldap" >}}). +1. From **Access Control > LDAP** in the Cluster Manager UI, select the **Configuration** tab and [enable LDAP access]({{< relref "/operate/rs/7.4/security/access-control/ldap/enable-role-based-ldap" >}}). {{Enable LDAP Panel}} -2. Map LDAP groups to [access control roles]({{< relref "/operate/rs/security/access-control/ldap/map-ldap-groups-to-roles" >}}). +2. Map LDAP groups to [access control roles]({{< relref "/operate/rs/7.4/security/access-control/ldap/map-ldap-groups-to-roles" >}}). -3. Update database access control lists (ACLs) to [authorize role access]({{< relref "/operate/rs/security/access-control/ldap/update-database-acls" >}}). +3. Update database access control lists (ACLs) to [authorize role access]({{< relref "/operate/rs/7.4/security/access-control/ldap/update-database-acls" >}}). If you already have appropriate roles, you can update them to include LDAP groups. ## More info -- Enable and configure [role-based LDAP]({{< relref "/operate/rs/security/access-control/ldap/enable-role-based-ldap" >}}) -- Map LDAP groups to [access control roles]({{< relref "/operate/rs/security/access-control/ldap/map-ldap-groups-to-roles" >}}) -- Update database ACLs to [authorize LDAP access]({{< relref "/operate/rs/security/access-control/ldap/update-database-acls" >}}) -- Learn more about Redis Enterprise Software [security and practices]({{< relref "/operate/rs/security/" >}}) +- Enable and configure [role-based LDAP]({{< relref "/operate/rs/7.4/security/access-control/ldap/enable-role-based-ldap" >}}) +- Map LDAP groups to [access control roles]({{< relref "/operate/rs/7.4/security/access-control/ldap/map-ldap-groups-to-roles" >}}) +- Update database ACLs to [authorize LDAP access]({{< relref "/operate/rs/7.4/security/access-control/ldap/update-database-acls" >}}) +- Learn more about Redis Enterprise Software [security and practices]({{< relref "/operate/rs/7.4/security/" >}}) diff --git a/content/operate/rs/7.4/security/access-control/ldap/enable-role-based-ldap.md b/content/operate/rs/7.4/security/access-control/ldap/enable-role-based-ldap.md index 1b64a84f78..9261dd92d2 100644 --- a/content/operate/rs/7.4/security/access-control/ldap/enable-role-based-ldap.md +++ b/content/operate/rs/7.4/security/access-control/ldap/enable-role-based-ldap.md @@ -94,6 +94,6 @@ However, if you enable multi-factor authentication (MFA) for your LDAP server, y ## More info -- Map LDAP groups to [access control roles]({{< relref "/operate/rs/security/access-control/ldap/map-ldap-groups-to-roles" >}}) -- Update database ACLs to [authorize LDAP access]({{< relref "/operate/rs/security/access-control/ldap/update-database-acls" >}}) -- Learn more about Redis Software [security and practices]({{< relref "/operate/rs/security/" >}}) +- Map LDAP groups to [access control roles]({{< relref "/operate/rs/7.4/security/access-control/ldap/map-ldap-groups-to-roles" >}}) +- Update database ACLs to [authorize LDAP access]({{< relref "/operate/rs/7.4/security/access-control/ldap/update-database-acls" >}}) +- Learn more about Redis Software [security and practices]({{< relref "/operate/rs/7.4/security/" >}}) diff --git a/content/operate/rs/7.4/security/access-control/ldap/map-ldap-groups-to-roles.md b/content/operate/rs/7.4/security/access-control/ldap/map-ldap-groups-to-roles.md index 9e364859e1..8a8fd0a8b2 100644 --- a/content/operate/rs/7.4/security/access-control/ldap/map-ldap-groups-to-roles.md +++ b/content/operate/rs/7.4/security/access-control/ldap/map-ldap-groups-to-roles.md @@ -22,7 +22,7 @@ To map LDAP groups to access control roles in the Cluster Manager UI: 1. Select **Access Control > LDAP > Mapping**. {{}} -You can map LDAP roles when LDAP configuration is not enabled, but they won't have any effect until you [configure and enable LDAP]({{< relref "/operate/rs/security/access-control/ldap/enable-role-based-ldap" >}}). +You can map LDAP roles when LDAP configuration is not enabled, but they won't have any effect until you [configure and enable LDAP]({{< relref "/operate/rs/7.4/security/access-control/ldap/enable-role-based-ldap" >}}). {{}} {{Enable LDAP mappings Panel}} @@ -53,6 +53,6 @@ The scope of the authorization depends on the access control role: ## More info -- Enable and configure [role-based LDAP]({{< relref "/operate/rs/security/access-control/ldap/enable-role-based-ldap" >}}) -- Update database ACLs to [authorize LDAP access]({{< relref "/operate/rs/security/access-control/ldap/update-database-acls" >}}) -- Learn more about Redis Enterprise Software [security and practices]({{< relref "/operate/rs/security/" >}}) +- Enable and configure [role-based LDAP]({{< relref "/operate/rs/7.4/security/access-control/ldap/enable-role-based-ldap" >}}) +- Update database ACLs to [authorize LDAP access]({{< relref "/operate/rs/7.4/security/access-control/ldap/update-database-acls" >}}) +- Learn more about Redis Enterprise Software [security and practices]({{< relref "/operate/rs/7.4/security/" >}}) diff --git a/content/operate/rs/7.4/security/access-control/ldap/migrate-to-role-based-ldap.md b/content/operate/rs/7.4/security/access-control/ldap/migrate-to-role-based-ldap.md index 01325f7976..d90ea9d2d7 100644 --- a/content/operate/rs/7.4/security/access-control/ldap/migrate-to-role-based-ldap.md +++ b/content/operate/rs/7.4/security/access-control/ldap/migrate-to-role-based-ldap.md @@ -11,7 +11,7 @@ weight: 55 url: '/operate/rs/7.4/security/access-control/ldap/migrate-to-role-based-ldap/' --- -Redis Enterprise Software supports LDAP through a [role-based mechanism]({{< relref "/operate/rs/security/access-control/ldap/" >}}), first introduced [in v6.0.20]({{< relref "/operate/rs/release-notes/rs-6-0-20-april-2021" >}}). +Redis Enterprise Software supports LDAP through a [role-based mechanism]({{< relref "/operate/rs/7.4/security/access-control/ldap/" >}}), first introduced [in v6.0.20]({{< relref "/operate/rs/release-notes/rs-6-0-20-april-2021" >}}). Earlier versions of Redis Enterprise Software supported a cluster-based mechanism; however, that mechanism was removed in v6.2.12. @@ -65,11 +65,11 @@ To test your LDAP integration, you can: - Use [Redis Insight]({{< relref "/develop/tools/insight/" >}}) to access a database using authorized LDAP credentials. -- Use the [REST API]({{< relref "/operate/rs/references/rest-api" >}}) to connect using authorized LDAP credentials. +- Use the [REST API]({{< relref "/operate/rs/7.4/references/rest-api" >}}) to connect using authorized LDAP credentials. ## More info -- Enable and configure [role-based LDAP]({{< relref "/operate/rs/security/access-control/ldap/enable-role-based-ldap" >}}) -- Map LDAP groups to [access control roles]({{< relref "/operate/rs/security/access-control/ldap/map-ldap-groups-to-roles" >}}) -- Update database ACLs to [authorize LDAP access]({{< relref "/operate/rs/security/access-control/ldap/update-database-acls" >}}) -- Learn more about Redis Enterprise Software [security and practices]({{< relref "/operate/rs/security/" >}}) +- Enable and configure [role-based LDAP]({{< relref "/operate/rs/7.4/security/access-control/ldap/enable-role-based-ldap" >}}) +- Map LDAP groups to [access control roles]({{< relref "/operate/rs/7.4/security/access-control/ldap/map-ldap-groups-to-roles" >}}) +- Update database ACLs to [authorize LDAP access]({{< relref "/operate/rs/7.4/security/access-control/ldap/update-database-acls" >}}) +- Learn more about Redis Enterprise Software [security and practices]({{< relref "/operate/rs/7.4/security/" >}}) diff --git a/content/operate/rs/7.4/security/access-control/ldap/update-database-acls.md b/content/operate/rs/7.4/security/access-control/ldap/update-database-acls.md index a9bc3a2e61..a7c8705211 100644 --- a/content/operate/rs/7.4/security/access-control/ldap/update-database-acls.md +++ b/content/operate/rs/7.4/security/access-control/ldap/update-database-acls.md @@ -32,6 +32,6 @@ As a result, we recommend ordering roles so that higher access roles appear befo ## More info -- Enable and configure [role-based LDAP]({{< relref "/operate/rs/security/access-control/ldap/enable-role-based-ldap.md" >}}) -- Map LDAP groups to [access control roles]({{< relref "/operate/rs/security/access-control/ldap/map-ldap-groups-to-roles.md" >}}) -- Learn more about Redis Enterprise Software [security and practices]({{< relref "/operate/rs/security/" >}}) +- Enable and configure [role-based LDAP]({{< relref "/operate/rs/7.4/security/access-control/ldap/enable-role-based-ldap.md" >}}) +- Map LDAP groups to [access control roles]({{< relref "/operate/rs/7.4/security/access-control/ldap/map-ldap-groups-to-roles.md" >}}) +- Learn more about Redis Enterprise Software [security and practices]({{< relref "/operate/rs/7.4/security/" >}}) diff --git a/content/operate/rs/7.4/security/access-control/manage-passwords/_index.md b/content/operate/rs/7.4/security/access-control/manage-passwords/_index.md index a15bd966a4..e271cd45f0 100644 --- a/content/operate/rs/7.4/security/access-control/manage-passwords/_index.md +++ b/content/operate/rs/7.4/security/access-control/manage-passwords/_index.md @@ -15,15 +15,15 @@ url: '/operate/rs/7.4/security/access-control/manage-passwords/' Redis Enterprise Software provides several ways to manage the passwords of local accounts, including: -- [Password complexity rules]({{< relref "/operate/rs/security/access-control/manage-passwords/password-complexity-rules" >}}) +- [Password complexity rules]({{< relref "/operate/rs/7.4/security/access-control/manage-passwords/password-complexity-rules" >}}) -- [Password expiration]({{< relref "/operate/rs/security/access-control/manage-passwords/password-expiration" >}}) +- [Password expiration]({{< relref "/operate/rs/7.4/security/access-control/manage-passwords/password-expiration" >}}) -- [Password rotation]({{< relref "/operate/rs/security/access-control/manage-passwords/rotate-passwords" >}}) +- [Password rotation]({{< relref "/operate/rs/7.4/security/access-control/manage-passwords/rotate-passwords" >}}) -You can also manage a user's ability to [sign in]({{< relref "/operate/rs/security/access-control/manage-users/login-lockout#user-login-lockout" >}}) and control [session timeout]({{< relref "/operate/rs/security/access-control/manage-users/login-lockout#session-timeout" >}}). +You can also manage a user's ability to [sign in]({{< relref "/operate/rs/7.4/security/access-control/manage-users/login-lockout#user-login-lockout" >}}) and control [session timeout]({{< relref "/operate/rs/7.4/security/access-control/manage-users/login-lockout#session-timeout" >}}). -To enforce more advanced password policies, we recommend using [LDAP integration]({{< relref "/operate/rs/security/access-control/ldap" >}}) with an external identity provider, such as Active Directory. +To enforce more advanced password policies, we recommend using [LDAP integration]({{< relref "/operate/rs/7.4/security/access-control/ldap" >}}) with an external identity provider, such as Active Directory. {{}} Redis Enterprise Software stores all user passwords using the SHA-256 cryptographic hash function. diff --git a/content/operate/rs/7.4/security/access-control/manage-passwords/rotate-passwords.md b/content/operate/rs/7.4/security/access-control/manage-passwords/rotate-passwords.md index fb1d747299..6d7c821d0c 100644 --- a/content/operate/rs/7.4/security/access-control/manage-passwords/rotate-passwords.md +++ b/content/operate/rs/7.4/security/access-control/manage-passwords/rotate-passwords.md @@ -12,18 +12,18 @@ weight: 70 url: '/operate/rs/7.4/security/access-control/manage-passwords/rotate-passwords/' --- -Redis Enterprise Software lets you implement password rotation policies using the [REST API]({{< relref "/operate/rs/references/rest-api" >}}). +Redis Enterprise Software lets you implement password rotation policies using the [REST API]({{< relref "/operate/rs/7.4/references/rest-api" >}}). You can add a new password for a database user without immediately invalidating the old one (which might cause authentication errors in production). {{< note >}} -Password rotation does not work for the default user. [Add additional users]({{< relref "/operate/rs/security/access-control/create-users" >}}) to enable password rotation. +Password rotation does not work for the default user. [Add additional users]({{< relref "/operate/rs/7.4/security/access-control/create-users" >}}) to enable password rotation. {{< /note >}} ## Password rotation policies For user access to the Redis Enterprise Software Cluster Manager UI, -you can set a [password expiration policy]({{< relref "/operate/rs/security/access-control/manage-passwords/password-expiration" >}}) to prompt the user to change their password. +you can set a [password expiration policy]({{< relref "/operate/rs/7.4/security/access-control/manage-passwords/password-expiration" >}}) to prompt the user to change their password. However, for database connections that rely on password authentication, you need to allow for authentication with the existing password while you roll out the new password to your systems. @@ -38,13 +38,13 @@ If you reset the password for a user in the Cluster Manager UI, the new password replaces all other passwords for that user. {{< /warning >}} -The new password cannot already exist as a password for the user and must meet the [password complexity]({{< relref "/operate/rs/security/access-control/manage-passwords/password-complexity-rules" >}}) requirements, if enabled. +The new password cannot already exist as a password for the user and must meet the [password complexity]({{< relref "/operate/rs/7.4/security/access-control/manage-passwords/password-complexity-rules" >}}) requirements, if enabled. ## Rotate password To rotate the password of a user account: -1. Add an additional password to a user account with [`POST /v1/users/password`]({{< relref "/operate/rs/references/rest-api/requests/users/password#add-password" >}}): +1. Add an additional password to a user account with [`POST /v1/users/password`]({{< relref "/operate/rs/7.4/references/rest-api/requests/users/password#add-password" >}}): ```sh POST https://[host][:port]/v1/users/password @@ -54,7 +54,7 @@ To rotate the password of a user account: After you send this request, you can authenticate with both the old and the new password. 1. Update the password in all database connections that connect with the user account. -1. Delete the original password with [`DELETE /v1/users/password`]({{< relref "/operate/rs/references/rest-api/requests/users/password#update-password" >}}): +1. Delete the original password with [`DELETE /v1/users/password`]({{< relref "/operate/rs/7.4/references/rest-api/requests/users/password#update-password" >}}): ```sh DELETE https://[host][:port]/v1/users/password @@ -68,7 +68,7 @@ To rotate the password of a user account: You can also replace all existing passwords for a user account with a single password that does not match any existing passwords. This can be helpful if you suspect that your passwords are compromised and you want to quickly resecure the account. -To replace all existing passwords for a user account with a single new password, use [`PUT /v1/users/password`]({{< relref "/operate/rs/references/rest-api/requests/users/password#delete-password" >}}): +To replace all existing passwords for a user account with a single new password, use [`PUT /v1/users/password`]({{< relref "/operate/rs/7.4/references/rest-api/requests/users/password#delete-password" >}}): ```sh PUT https://[host][:port]/v1/users/password diff --git a/content/operate/rs/7.4/security/access-control/manage-users/default-user.md b/content/operate/rs/7.4/security/access-control/manage-users/default-user.md index 8863c7990a..9a332098ea 100644 --- a/content/operate/rs/7.4/security/access-control/manage-users/default-user.md +++ b/content/operate/rs/7.4/security/access-control/manage-users/default-user.md @@ -12,7 +12,7 @@ weight: 60 url: '/operate/rs/7.4/security/access-control/manage-users/default-user/' --- -When you [create a database]({{< relref "/operate/rs/databases/create" >}}), default user database access is enabled by default (**Unauthenticated access** is selected). This gives the default user full access to the database and enables compatibility with versions of Redis before Redis 6. +When you [create a database]({{< relref "/operate/rs/7.4/databases/create" >}}), default user database access is enabled by default (**Unauthenticated access** is selected). This gives the default user full access to the database and enables compatibility with versions of Redis before Redis 6. Select **Password-only authentication**, then enter and confirm a default database password to require authentication for connections to the database. @@ -40,10 +40,10 @@ To change the default user's password: ## Deactivate default user -If you set up [role-based access control]({{< relref "/operate/rs/security/access-control" >}}) with [access control lists]({{< relref "/operate/rs/security/access-control/create-db-roles" >}}) (ACLs) for your database and don't require backwards compatibility with versions earlier than Redis 6, you can [deactivate the default user]({{< relref "/operate/rs/security/access-control/manage-users/default-user" >}}). +If you set up [role-based access control]({{< relref "/operate/rs/7.4/security/access-control" >}}) with [access control lists]({{< relref "/operate/rs/7.4/security/access-control/create-db-roles" >}}) (ACLs) for your database and don't require backwards compatibility with versions earlier than Redis 6, you can [deactivate the default user]({{< relref "/operate/rs/7.4/security/access-control/manage-users/default-user" >}}). {{}} -Before you deactivate default user access, make sure the role associated with the database is [assigned to a user]({{< relref "/operate/rs/security/access-control/create-users" >}}). Otherwise, the database will be inaccessible. +Before you deactivate default user access, make sure the role associated with the database is [assigned to a user]({{< relref "/operate/rs/7.4/security/access-control/create-users" >}}). Otherwise, the database will be inaccessible. {{}} To deactivate the default user: diff --git a/content/operate/rs/7.4/security/access-control/manage-users/login-lockout.md b/content/operate/rs/7.4/security/access-control/manage-users/login-lockout.md index d616c02407..ccb8a72d97 100644 --- a/content/operate/rs/7.4/security/access-control/manage-users/login-lockout.md +++ b/content/operate/rs/7.4/security/access-control/manage-users/login-lockout.md @@ -22,11 +22,11 @@ Here, you learn how to configure the relevant settings. ## User login lockout -By default, after 5 failed login attempts within 15 minutes, the user account is locked for 30 minutes. You can change the user login lockout settings in the Cluster Manager UI or with [`rladmin`]({{< relref "/operate/rs/references/cli-utilities/rladmin" >}}). +By default, after 5 failed login attempts within 15 minutes, the user account is locked for 30 minutes. You can change the user login lockout settings in the Cluster Manager UI or with [`rladmin`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin" >}}). ### View login lockout settings -You can view the cluster's user login lockout settings from **Cluster > Security > Preferences > Lockout threshold** in the Cluster Manager UI or with [`rladmin info cluster`]({{< relref "/operate/rs/references/cli-utilities/rladmin/info#info-cluster" >}}): +You can view the cluster's user login lockout settings from **Cluster > Security > Preferences > Lockout threshold** in the Cluster Manager UI or with [`rladmin info cluster`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/info#info-cluster" >}}): ```sh $ rladmin info cluster | grep login_lockout @@ -65,7 +65,7 @@ To change the number of failed login attempts allowed before the user account is - [Cluster Manager UI](#configure-user-login-lockout) -- [`rladmin tune cluster`]({{< relref "/operate/rs/references/cli-utilities/rladmin/tune#tune-cluster" >}}): +- [`rladmin tune cluster`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/tune#tune-cluster" >}}): ```sh rladmin tune cluster login_lockout_threshold @@ -89,7 +89,7 @@ To change the amount of time during which failed login attempts are counted, use - [Cluster Manager UI](#configure-user-login-lockout) -- [`rladmin tune cluster`]({{< relref "/operate/rs/references/cli-utilities/rladmin/tune#tune-cluster" >}}): +- [`rladmin tune cluster`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/tune#tune-cluster" >}}): ```sh rladmin tune cluster login_lockout_counter_reset_after @@ -107,7 +107,7 @@ To change the amount of time that the user account is locked after excessive fai - [Cluster Manager UI](#configure-user-login-lockout) -- [`rladmin tune cluster`]({{< relref "/operate/rs/references/cli-utilities/rladmin/tune#tune-cluster" >}}): +- [`rladmin tune cluster`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/tune#tune-cluster" >}}): ```sh rladmin tune cluster login_lockout_duration @@ -151,7 +151,7 @@ To unlock a user account or reset a user password with `rladmin`, run: rladmin cluster reset_password ``` -To unlock a user account or reset a user password with the REST API, use [`PUT /v1/users`]({{< relref "/operate/rs/references/rest-api/requests/users#put-user" >}}): +To unlock a user account or reset a user password with the REST API, use [`PUT /v1/users`]({{< relref "/operate/rs/7.4/references/rest-api/requests/users#put-user" >}}): ```sh PUT /v1/users @@ -170,7 +170,7 @@ To turn off user login lockout and allow unlimited login attempts, use one of th 1. Select **Save**. -- [`rladmin tune cluster`]({{< relref "/operate/rs/references/cli-utilities/rladmin/tune#tune-cluster" >}}): +- [`rladmin tune cluster`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/tune#tune-cluster" >}}): ```sh rladmin tune cluster login_lockout_threshold 0 @@ -192,7 +192,7 @@ To customize the session timeout, use one of the following methods: 1. Select **Save**. -- [`rladmin cluster config`]({{< relref "/operate/rs/references/cli-utilities/rladmin/cluster/config" >}}): +- [`rladmin cluster config`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/cluster/config" >}}): ```sh rladmin cluster config cm_session_timeout_minutes diff --git a/content/operate/rs/7.4/security/access-control/redis-acl-overview.md b/content/operate/rs/7.4/security/access-control/redis-acl-overview.md index 78dcd38eca..29c7179e13 100644 --- a/content/operate/rs/7.4/security/access-control/redis-acl-overview.md +++ b/content/operate/rs/7.4/security/access-control/redis-acl-overview.md @@ -147,7 +147,7 @@ As of Redis Enterprise version 6.4.2, you can configure `acl_pubsub_default`, wh To make default pub/sub permissions restrictive: -1. [Upgrade all databases]({{< relref "/operate/rs/installing-upgrading/upgrading/upgrade-database" >}}) in the cluster to Redis version 6.2 or later. +1. [Upgrade all databases]({{< relref "/operate/rs/7.4/installing-upgrading/upgrading/upgrade-database" >}}) in the cluster to Redis version 6.2 or later. 1. Set the default to restrictive (`resetchannels`) using one of the following methods: @@ -157,13 +157,13 @@ To make default pub/sub permissions restrictive: 1. For **Default permissions for Pub/Sub ACLs**, select **Restrictive**, then **Save**. - - [`rladmin tune cluster`]({{< relref "/operate/rs/references/cli-utilities/rladmin/tune#tune-cluster" >}}): + - [`rladmin tune cluster`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/tune#tune-cluster" >}}): ```sh rladmin tune cluster acl_pubsub_default resetchannels ``` - - [Update cluster policy]({{< relref "/operate/rs/references/rest-api/requests/cluster/policy#put-cluster-policy" >}}) REST API request: + - [Update cluster policy]({{< relref "/operate/rs/7.4/references/rest-api/requests/cluster/policy#put-cluster-policy" >}}) REST API request: ```sh PUT /v1/cluster/policy @@ -190,11 +190,11 @@ Redis ACLs also have the following differences in Redis Enterprise Software: To configure passwords in Redis Enterprise Software, use one of the following methods: - - [`rladmin cluster reset_password`]({{< relref "/operate/rs/references/cli-utilities/rladmin/cluster/reset_password" >}}): + - [`rladmin cluster reset_password`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/cluster/reset_password" >}}): ```sh rladmin cluster reset_password ``` - - REST API [`PUT /v1/users`]({{< relref "/operate/rs/references/rest-api/requests/users#put-user" >}}) request and provide `password` + - REST API [`PUT /v1/users`]({{< relref "/operate/rs/7.4/references/rest-api/requests/users#put-user" >}}) request and provide `password` diff --git a/content/operate/rs/7.4/security/audit-events.md b/content/operate/rs/7.4/security/audit-events.md index ffb206b20c..e0b41490d0 100644 --- a/content/operate/rs/7.4/security/audit-events.md +++ b/content/operate/rs/7.4/security/audit-events.md @@ -65,7 +65,7 @@ To enable auditing for your cluster, use: The output file (and path) must be accessible by the user and group running Redis Enterprise Software. -- the [REST API]({{< relref "/operate/rs/references/rest-api/requests/cluster/auditing-db-conns#put-cluster-audit-db-conns" >}}) +- the [REST API]({{< relref "/operate/rs/7.4/references/rest-api/requests/cluster/auditing-db-conns#put-cluster-audit-db-conns" >}}) ``` PUT /v1/cluster/auditing/db_conns @@ -101,7 +101,7 @@ Once auditing is enabled for your cluster, you can audit individual databases. rladmin info cluster ``` -- the [REST API]({{< relref "/operate/rs/references/rest-api/requests/bdbs#put-bdbs" >}}) +- the [REST API]({{< relref "/operate/rs/7.4/references/rest-api/requests/bdbs#put-bdbs" >}}) ``` PUT /v1/bdbs/1 @@ -129,7 +129,7 @@ To audit connections for new databases by default, use: To deactivate this policy, set `db_conns_auditing` to `disabled`. -- the [REST API]({{< relref "/operate/rs/references/rest-api/requests/cluster/policy#put-cluster-policy" >}}) +- the [REST API]({{< relref "/operate/rs/7.4/references/rest-api/requests/cluster/policy#put-cluster-policy" >}}) ``` PUT /v1/cluster/policy diff --git a/content/operate/rs/7.4/security/certificates/_index.md b/content/operate/rs/7.4/security/certificates/_index.md index 2f27ae56f3..1036608b77 100644 --- a/content/operate/rs/7.4/security/certificates/_index.md +++ b/content/operate/rs/7.4/security/certificates/_index.md @@ -18,12 +18,12 @@ Here's the list of self-signed certificates that create secure, encrypted connec | Certificate name | Description | |------------------|-------------| -| `api` | Encrypts [REST API]({{< relref "/operate/rs/references/rest-api/" >}}) requests and responses. | +| `api` | Encrypts [REST API]({{< relref "/operate/rs/7.4/references/rest-api/" >}}) requests and responses. | | `cm` | Secures connections to the Redis Enterprise Cluster Manager UI. | | `ldap_client` | Secures connections between LDAP clients and LDAP servers. | -| `metrics_exporter` | Sends Redis Enterprise metrics to external [monitoring tools]({{< relref "/operate/rs/clusters/monitoring/" >}}) over a secure connection. | +| `metrics_exporter` | Sends Redis Enterprise metrics to external [monitoring tools]({{< relref "/operate/rs/7.4/clusters/monitoring/" >}}) over a secure connection. | | `proxy` | Creates secure, encrypted connections between clients and databases. | -| `syncer` | For [Active-Active]({{< relref "/operate/rs/databases/active-active/" >}}) or [Replica Of]({{< relref "/operate/rs/databases/import-export/replica-of/" >}}) databases, encrypts data during the synchronization of participating clusters. | +| `syncer` | For [Active-Active]({{< relref "/operate/rs/7.4/databases/active-active/" >}}) or [Replica Of]({{< relref "/operate/rs/7.4/databases/import-export/replica-of/" >}}) databases, encrypts data during the synchronization of participating clusters. | These self-signed certificates are generated on the first node of each Redis Enterprise Software installation and are copied to all other nodes added to the cluster. diff --git a/content/operate/rs/7.4/security/certificates/create-certificates.md b/content/operate/rs/7.4/security/certificates/create-certificates.md index 24c75a0de7..ec79b33a2a 100644 --- a/content/operate/rs/7.4/security/certificates/create-certificates.md +++ b/content/operate/rs/7.4/security/certificates/create-certificates.md @@ -117,7 +117,7 @@ The following values are supported for the _\_ parameter: | `proxy` | The database endpoint | | `syncer` | The synchronization process | -You can also use the REST API. To learn more, see [Update certificates]({{< relref "/operate/rs/security/certificates/updating-certificates#how-to-update-certificates" >}}). +You can also use the REST API. To learn more, see [Update certificates]({{< relref "/operate/rs/7.4/security/certificates/updating-certificates#how-to-update-certificates" >}}). ## Create CA-signed certificates @@ -223,7 +223,7 @@ However you choose to create the certificates, be sure to incorporate the guidel 4. Upload the certificate to your cluster. - You can use [`rladmin`]({{< relref "/operate/rs/references/cli-utilities/rladmin/cluster/certificate" >}}) to replace the existing certificates with new certificates: + You can use [`rladmin`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/cluster/certificate" >}}) to replace the existing certificates with new certificates: ``` console $ rladmin cluster certificate set certificate_file \ @@ -232,5 +232,5 @@ However you choose to create the certificates, be sure to incorporate the guidel For a list of values supported by the `` parameter, see the [earlier table](#replace-self-signed). - You can also use the REST API. To learn more, see [Update certificates]({{< relref "/operate/rs/security/certificates/updating-certificates#how-to-update-certificates" >}}). + You can also use the REST API. To learn more, see [Update certificates]({{< relref "/operate/rs/7.4/security/certificates/updating-certificates#how-to-update-certificates" >}}). diff --git a/content/operate/rs/7.4/security/certificates/monitor-certificates.md b/content/operate/rs/7.4/security/certificates/monitor-certificates.md index 2e9135a730..1e51415452 100644 --- a/content/operate/rs/7.4/security/certificates/monitor-certificates.md +++ b/content/operate/rs/7.4/security/certificates/monitor-certificates.md @@ -27,7 +27,7 @@ node_cert_expiration_seconds{cluster="mycluster.local",logical_name="metrics_exp node_cert_expiration_seconds{cluster="mycluster.local",logical_name="syncer",node="1",path="/etc/opt/redislabs/syncer_cert.pem"} 31104000.0 ``` -The following certificates relate to [internode communication TLS encryption]({{< relref "/operate/rs/security/encryption/internode-encryption" >}}) and are automatically rotated by Redis Enterprise Software: +The following certificates relate to [internode communication TLS encryption]({{< relref "/operate/rs/7.4/security/encryption/internode-encryption" >}}) and are automatically rotated by Redis Enterprise Software: ```sh node_cert_expiration_seconds{cluster="mycluster.local",logical_name="ccs_internode_encryption",node="1",path="/etc/opt/redislabs/ccs_internode_encryption_cert.pem"} 2592000.0 diff --git a/content/operate/rs/7.4/security/certificates/ocsp-stapling.md b/content/operate/rs/7.4/security/certificates/ocsp-stapling.md index 15aaedf121..2ffdde97da 100644 --- a/content/operate/rs/7.4/security/certificates/ocsp-stapling.md +++ b/content/operate/rs/7.4/security/certificates/ocsp-stapling.md @@ -59,11 +59,11 @@ To set up OCSP stapling with the Redis Enterprise Cluster Manager UI: ### REST API method -To set up OCSP stapling with the [REST API]({{< relref "/operate/rs/references/rest-api" >}}): +To set up OCSP stapling with the [REST API]({{< relref "/operate/rs/7.4/references/rest-api" >}}): -1. Use the REST API to [replace the proxy certificate]({{< relref "/operate/rs/security/certificates/updating-certificates#use-the-rest-api" >}}) with a certificate signed by your third-party CA. +1. Use the REST API to [replace the proxy certificate]({{< relref "/operate/rs/7.4/security/certificates/updating-certificates#use-the-rest-api" >}}) with a certificate signed by your third-party CA. -1. To configure and enable OCSP, send a [`PUT` request to the `/v1/ocsp`]({{< relref "/operate/rs/references/rest-api/requests/ocsp#put-ocsp" >}}) endpoint and include an [OCSP JSON object]({{< relref "/operate/rs/references/rest-api/objects/ocsp" >}}) in the request body: +1. To configure and enable OCSP, send a [`PUT` request to the `/v1/ocsp`]({{< relref "/operate/rs/7.4/references/rest-api/requests/ocsp#put-ocsp" >}}) endpoint and include an [OCSP JSON object]({{< relref "/operate/rs/7.4/references/rest-api/objects/ocsp" >}}) in the request body: ```json { @@ -77,11 +77,11 @@ To set up OCSP stapling with the [REST API]({{< relref "/operate/rs/references/r ### `rladmin` method -To set up OCSP stapling with the [`rladmin`]({{< relref "/operate/rs/references/cli-utilities/rladmin" >}}) command-line utility: +To set up OCSP stapling with the [`rladmin`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin" >}}) command-line utility: -1. Use [`rladmin`]({{< relref "/operate/rs/references/cli-utilities/rladmin/cluster/certificate" >}}) to [replace the proxy certificate]({{< relref "/operate/rs/security/certificates/updating-certificates#use-the-cli" >}}) with a certificate signed by your third-party CA. +1. Use [`rladmin`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/cluster/certificate" >}}) to [replace the proxy certificate]({{< relref "/operate/rs/7.4/security/certificates/updating-certificates#use-the-cli" >}}) with a certificate signed by your third-party CA. -1. Update the cluster's OCSP settings with the [`rladmin cluster ocsp config`]({{< relref "/operate/rs/references/cli-utilities/rladmin/cluster/ocsp#ocsp-config" >}}) command if you don't want to use their default values. +1. Update the cluster's OCSP settings with the [`rladmin cluster ocsp config`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/cluster/ocsp#ocsp-config" >}}) command if you don't want to use their default values. For example: diff --git a/content/operate/rs/7.4/security/certificates/updating-certificates.md b/content/operate/rs/7.4/security/certificates/updating-certificates.md index 377b0626b1..e6ac117236 100644 --- a/content/operate/rs/7.4/security/certificates/updating-certificates.md +++ b/content/operate/rs/7.4/security/certificates/updating-certificates.md @@ -17,7 +17,7 @@ When you update the certificates, the new certificate replaces the same certific ## How to update certificates -You can use the [`rladmin`]({{< relref "/operate/rs/references/cli-utilities/rladmin" >}}) command-line interface (CLI) or the [REST API]({{< relref "/operate/rs/references/rest-api" >}}) to update certificates. The Cluster Manager UI lets you update proxy and syncer certificates on the **Cluster > Security > Certificates** screen. +You can use the [`rladmin`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin" >}}) command-line interface (CLI) or the [REST API]({{< relref "/operate/rs/7.4/references/rest-api" >}}) to update certificates. The Cluster Manager UI lets you update proxy and syncer certificates on the **Cluster > Security > Certificates** screen. The new certificates are used the next time the clients connect to the database. @@ -51,7 +51,7 @@ To replace proxy or syncer certificates using the Cluster Manager UI: ### Use the CLI -To replace certificates with the `rladmin` CLI, run the [`cluster certificate set`]({{< relref "/operate/rs/references/cli-utilities/rladmin/cluster/certificate" >}}) command: +To replace certificates with the `rladmin` CLI, run the [`cluster certificate set`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/cluster/certificate" >}}) command: ```sh rladmin cluster certificate set certificate_file .pem key_file .pem @@ -59,7 +59,7 @@ To replace certificates with the `rladmin` CLI, run the [`cluster certificate se Replace the following variables with your own values: -- `` - The name of the certificate you want to replace. See the [certificates table]({{< relref "/operate/rs/security/certificates" >}}) for the list of valid certificate names. +- `` - The name of the certificate you want to replace. See the [certificates table]({{< relref "/operate/rs/7.4/security/certificates" >}}) for the list of valid certificate names. - `` - The name of your certificate file - `` - The name of your key file @@ -71,7 +71,7 @@ rladmin cluster certificate set cm certificate_file cluster.pem key_file key.pem ### Use the REST API -To replace a certificate using the REST API, use [`PUT /v1/cluster/update_cert`]({{< relref "/operate/rs/references/rest-api/requests/cluster/certificates#put-cluster-update_cert" >}}): +To replace a certificate using the REST API, use [`PUT /v1/cluster/update_cert`]({{< relref "/operate/rs/7.4/references/rest-api/requests/cluster/certificates#put-cluster-update_cert" >}}): ```sh PUT https://[host][:port]/v1/cluster/update_cert @@ -80,7 +80,7 @@ PUT https://[host][:port]/v1/cluster/update_cert Replace the following variables with your own values: -- `` - The name of the certificate to replace. See the [certificates table]({{< relref "/operate/rs/security/certificates" >}}) for the list of valid certificate names. +- `` - The name of the certificate to replace. See the [certificates table]({{< relref "/operate/rs/7.4/security/certificates" >}}) for the list of valid certificate names. - `` - The contents of the \*\_key.pem file {{< tip >}} @@ -101,7 +101,7 @@ To update the proxy certificate on clusters running Replica Of databases: 1. Use the Cluster Manager UI, `rladmin`, or the REST API to update the proxy certificate on the source database cluster. -1. From the Cluster Manager UI, update the destination database (_replica_) configuration with the [new certificate]({{< relref "/operate/rs/databases/import-export/replica-of/create#encrypt-replica-database-traffic" >}}). +1. From the Cluster Manager UI, update the destination database (_replica_) configuration with the [new certificate]({{< relref "/operate/rs/7.4/databases/import-export/replica-of/create#encrypt-replica-database-traffic" >}}). {{}} - Perform step 2 as quickly as possible after performing step 1. Connections using the previous certificate are rejected after applying the new certificate. Until both steps are performed, recovery of the database sync cannot be established. @@ -115,7 +115,7 @@ To update proxy certificate on clusters running Active-Active databases: 1. Use the Cluster Manager UI, `rladmin`, or the REST API to update proxy certificates on a single cluster, multiple clusters, or all participating clusters. -1. Use the [`crdb-cli`]({{< relref "/operate/rs/references/cli-utilities/crdb-cli" >}}) utility to update Active-Active database configuration from the command line. Run the following command once for each Active-Active database residing on the modified clusters: +1. Use the [`crdb-cli`]({{< relref "/operate/rs/7.4/references/cli-utilities/crdb-cli" >}}) utility to update Active-Active database configuration from the command line. Run the following command once for each Active-Active database residing on the modified clusters: ```sh crdb-cli crdb update --crdb-guid --force @@ -132,7 +132,7 @@ To update your syncer certificate on clusters running Active-Active databases, f 1. Update your syncer certificate on one or more of the participating clusters using the Cluster Manager UI, `rladmin`, or the REST API. You can update a single cluster, multiple clusters, or all participating clusters. -1. Update the Active-Active database configuration from the command line with the [`crdb-cli`]({{< relref "/operate/rs/references/cli-utilities/crdb-cli" >}}) utility. Run this command once for each Active-Active database that resides on the modified clusters: +1. Update the Active-Active database configuration from the command line with the [`crdb-cli`]({{< relref "/operate/rs/7.4/references/cli-utilities/crdb-cli" >}}) utility. Run this command once for each Active-Active database that resides on the modified clusters: ```sh crdb-cli crdb update --crdb-guid --force diff --git a/content/operate/rs/7.4/security/encryption/_index.md b/content/operate/rs/7.4/security/encryption/_index.md index 808d8b47b7..b89e9f957b 100644 --- a/content/operate/rs/7.4/security/encryption/_index.md +++ b/content/operate/rs/7.4/security/encryption/_index.md @@ -19,7 +19,7 @@ Redis Enterprise Software uses encryption to secure communications between clust ### TLS -Redis Enterprise Software uses [Transport Layer Security (TLS)]({{}}) to encrypt communications for the following: +Redis Enterprise Software uses [Transport Layer Security (TLS)]({{}}) to encrypt communications for the following: - Cluster Manager UI @@ -29,23 +29,23 @@ Redis Enterprise Software uses [Transport Layer Security (TLS)]({{}}) for the following: +You can also [enable TLS authentication]({{< relref "/operate/rs/7.4/security/encryption/tls/enable-tls" >}}) for the following: - Communication from clients or applications to your database -- Communication from your database to other clusters for replication using [Replica Of]({{< relref "/operate/rs/databases/import-export/replica-of/" >}}) +- Communication from your database to other clusters for replication using [Replica Of]({{< relref "/operate/rs/7.4/databases/import-export/replica-of/" >}}) -- Communication to and from your database to other clusters for [Active-Active]({{< relref "/operate/rs/databases/active-active/_index.md" >}}) synchronization +- Communication to and from your database to other clusters for [Active-Active]({{< relref "/operate/rs/7.4/databases/active-active/_index.md" >}}) synchronization ### Internode encryption -[Internode encryption]({{}}) uses TLS to encrypt data in transit between cluster nodes. +[Internode encryption]({{}}) uses TLS to encrypt data in transit between cluster nodes. -By default, internode encryption is enabled for the control plane, which manages the cluster and databases. If you also want to encrypt replication and proxy communications between database shards on different nodes, [enable data internode encryption]({{< relref "/operate/rs/security/encryption/internode-encryption#enable-data-internode-encryption" >}}). +By default, internode encryption is enabled for the control plane, which manages the cluster and databases. If you also want to encrypt replication and proxy communications between database shards on different nodes, [enable data internode encryption]({{< relref "/operate/rs/7.4/security/encryption/internode-encryption#enable-data-internode-encryption" >}}). ### Require HTTPS for REST API endpoints -By default, the Redis Enterprise Software API supports communication over HTTP and HTTPS. However, you can [turn off HTTP support]({{< relref "/operate/rs/references/rest-api/encryption" >}}) to ensure that API requests are encrypted. +By default, the Redis Enterprise Software API supports communication over HTTP and HTTPS. However, you can [turn off HTTP support]({{< relref "/operate/rs/7.4/references/rest-api/encryption" >}}) to ensure that API requests are encrypted. ## Encrypt data at rest @@ -55,7 +55,7 @@ To encrypt data stored on disk, use file system-based encryption capabilities av ### Private key encryption -Enable PEM encryption to [encrypt all private keys]({{< relref "/operate/rs/security/encryption/pem-encryption" >}}) on disk. +Enable PEM encryption to [encrypt all private keys]({{< relref "/operate/rs/7.4/security/encryption/pem-encryption" >}}) on disk. ## Encrypt data in use diff --git a/content/operate/rs/7.4/security/encryption/internode-encryption.md b/content/operate/rs/7.4/security/encryption/internode-encryption.md index aa9a819461..cb33cf0480 100644 --- a/content/operate/rs/7.4/security/encryption/internode-encryption.md +++ b/content/operate/rs/7.4/security/encryption/internode-encryption.md @@ -42,7 +42,7 @@ To enable internode encryption for a database (also called _data internode encry - Use the Cluster Manager UI to enable the **Internode Encryption** setting from the database **Security** screen. -- Use the `rladmin` command-line utility to set the [data_internode_encryption]({{< relref "/operate/rs/references/cli-utilities/rladmin/tune#tune-db" >}}) setting for the database: +- Use the `rladmin` command-line utility to set the [data_internode_encryption]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/tune#tune-db" >}}) setting for the database: ``` shell rladmin tune db data_internode_encryption enabled @@ -75,13 +75,13 @@ To enable internode encryption for new databases by default, use one of the foll 1. Select **Save**. -- [rladmin tune cluster]({{< relref "/operate/rs/references/cli-utilities/rladmin/tune#tune-cluster" >}}): +- [rladmin tune cluster]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/tune#tune-cluster" >}}): ```sh rladmin tune cluster data_internode_encryption enabled ``` -- [Update cluster policy]({{< relref "/operate/rs/references/rest-api/requests/cluster/policy#put-cluster-policy" >}}) REST API request: +- [Update cluster policy]({{< relref "/operate/rs/7.4/references/rest-api/requests/cluster/policy#put-cluster-policy" >}}) REST API request: ```sh PUT /v1/cluster/policy diff --git a/content/operate/rs/7.4/security/encryption/pem-encryption.md b/content/operate/rs/7.4/security/encryption/pem-encryption.md index 4304a1087c..077f5c5c02 100644 --- a/content/operate/rs/7.4/security/encryption/pem-encryption.md +++ b/content/operate/rs/7.4/security/encryption/pem-encryption.md @@ -18,16 +18,16 @@ When certificates are rotated, the encrypted private keys are also rotated. ## Enable PEM encryption -To enable PEM encryption and encrypt private keys on the disk, use [`rladmin`]({{< relref "/operate/rs/references/cli-utilities/rladmin" >}}) or the [REST API]({{< relref "/operate/rs/references/rest-api" >}}). +To enable PEM encryption and encrypt private keys on the disk, use [`rladmin`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin" >}}) or the [REST API]({{< relref "/operate/rs/7.4/references/rest-api" >}}). -- [`rladmin cluster config`]({{< relref "/operate/rs/references/cli-utilities/rladmin/cluster/config" >}}): +- [`rladmin cluster config`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/cluster/config" >}}): ```sh rladmin cluster config encrypt_pkeys enabled ``` -- [Update cluster settings]({{< relref "/operate/rs/references/rest-api/requests/cluster#put-cluster" >}}) REST API request: +- [Update cluster settings]({{< relref "/operate/rs/7.4/references/rest-api/requests/cluster#put-cluster" >}}) REST API request: ```sh PUT /v1/cluster @@ -36,15 +36,15 @@ To enable PEM encryption and encrypt private keys on the disk, use [`rladmin`]({ ## Deactivate PEM encryption -To deactivate PEM encryption and decrypt private keys on the disk, use [`rladmin`]({{< relref "/operate/rs/references/cli-utilities/rladmin" >}}) or the [REST API]({{< relref "/operate/rs/references/rest-api" >}}). +To deactivate PEM encryption and decrypt private keys on the disk, use [`rladmin`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin" >}}) or the [REST API]({{< relref "/operate/rs/7.4/references/rest-api" >}}). -- [`rladmin cluster config`]({{< relref "/operate/rs/references/cli-utilities/rladmin/cluster/config" >}}): +- [`rladmin cluster config`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/cluster/config" >}}): ```sh rladmin cluster config encrypt_pkeys disabled ``` -- [Update cluster settings]({{< relref "/operate/rs/references/rest-api/requests/cluster#put-cluster" >}}) REST API request: +- [Update cluster settings]({{< relref "/operate/rs/7.4/references/rest-api/requests/cluster#put-cluster" >}}) REST API request: ```sh PUT /v1/cluster diff --git a/content/operate/rs/7.4/security/encryption/tls/_index.md b/content/operate/rs/7.4/security/encryption/tls/_index.md index f05dfd85e1..22b3c7e302 100644 --- a/content/operate/rs/7.4/security/encryption/tls/_index.md +++ b/content/operate/rs/7.4/security/encryption/tls/_index.md @@ -13,14 +13,14 @@ url: '/operate/rs/7.4/security/encryption/tls/' --- [Transport Layer Security (TLS)](https://en.wikipedia.org/wiki/Transport_Layer_Security), a successor to SSL, ensures the privacy of data sent between applications and Redis databases. TLS also secures connections between Redis Enterprise Software nodes. -You can [use TLS authentication]({{< relref "/operate/rs/security/encryption/tls/enable-tls" >}}) for the following types of communication: +You can [use TLS authentication]({{< relref "/operate/rs/7.4/security/encryption/tls/enable-tls" >}}) for the following types of communication: - Communication from clients (applications) to your database -- Communication from your database to other clusters for replication using [Replica Of]({{< relref "/operate/rs/databases/import-export/replica-of" >}}) -- Communication to and from your database to other clusters for synchronization using [Active-Active]({{< relref "/operate/rs/databases/active-active/" >}}) +- Communication from your database to other clusters for replication using [Replica Of]({{< relref "/operate/rs/7.4/databases/import-export/replica-of" >}}) +- Communication to and from your database to other clusters for synchronization using [Active-Active]({{< relref "/operate/rs/7.4/databases/active-active/" >}}) ## Protocols and ciphers TLS protocols and ciphers define the overall suite of algorithms that clients are able to connect to the servers with. -You can change the [TLS protocols]({{< relref "/operate/rs/security/encryption/tls/tls-protocols" >}}) and [ciphers]({{< relref "/operate/rs/security/encryption/tls/ciphers" >}}) to improve the security of your Redis Enterprise cluster and databases. The default settings are in line with industry best practices, but you can customize them to match the security policy of your organization. +You can change the [TLS protocols]({{< relref "/operate/rs/7.4/security/encryption/tls/tls-protocols" >}}) and [ciphers]({{< relref "/operate/rs/7.4/security/encryption/tls/ciphers" >}}) to improve the security of your Redis Enterprise cluster and databases. The default settings are in line with industry best practices, but you can customize them to match the security policy of your organization. diff --git a/content/operate/rs/7.4/security/encryption/tls/ciphers.md b/content/operate/rs/7.4/security/encryption/tls/ciphers.md index bfbf6a6021..f0f6ad182e 100644 --- a/content/operate/rs/7.4/security/encryption/tls/ciphers.md +++ b/content/operate/rs/7.4/security/encryption/tls/ciphers.md @@ -19,7 +19,7 @@ Ciphers are algorithms that help secure connections between clients and servers. |------------|--------------|-------------| | control_cipher_suites | ✅ Yes | Cipher list for TLS 1.2 communications for cluster administration (control plane) | | data_cipher_list | ✅ Yes | Cipher list for TLS 1.2 communications between applications and databases (data plane) | -| sentinel_cipher_suites | ✅ Yes | Cipher list for [discovery service]({{< relref "/operate/rs/databases/durability-ha/discovery-service" >}}) (Sentinel) TLS 1.2 communications | +| sentinel_cipher_suites | ✅ Yes | Cipher list for [discovery service]({{< relref "/operate/rs/7.4/databases/durability-ha/discovery-service" >}}) (Sentinel) TLS 1.2 communications | ## TLS 1.3 cipher suites @@ -27,11 +27,11 @@ Ciphers are algorithms that help secure connections between clients and servers. |------------|--------------|-------------| | control_cipher_suites_tls_1_3 | ❌ No | Cipher list for TLS 1.3 communications for cluster administration (control plane) | | data_cipher_suites_tls_1_3 | ✅ Yes | Cipher list for TLS 1.3 communications between applications and databases (data plane) | -| sentinel_cipher_suites_tls_1_3 | ❌ No | Cipher list for [discovery service]({{< relref "/operate/rs/databases/durability-ha/discovery-service" >}}) (Sentinel) TLS 1.3 communications | +| sentinel_cipher_suites_tls_1_3 | ❌ No | Cipher list for [discovery service]({{< relref "/operate/rs/7.4/databases/durability-ha/discovery-service" >}}) (Sentinel) TLS 1.3 communications | ## Configure cipher suites -You can configure ciphers with the [Cluster Manager UI](#edit-ciphers-ui), [`rladmin`]({{< relref "/operate/rs/references/cli-utilities/rladmin/cluster/config" >}}), or the [REST API]({{< relref "/operate/rs/references/rest-api/requests/cluster#put-cluster" >}}). +You can configure ciphers with the [Cluster Manager UI](#edit-ciphers-ui), [`rladmin`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/cluster/config" >}}), or the [REST API]({{< relref "/operate/rs/7.4/references/rest-api/requests/cluster#put-cluster" >}}). {{}} Configuring cipher suites overwrites existing ciphers rather than appending new ciphers to the list. @@ -70,7 +70,7 @@ As of Redis Enterprise Software version 6.0.12, control plane cipher suites can #### Configure TLS 1.2 control plane cipher suites -To configure TLS 1.2 cipher suites for cluster communication, use the following [`rladmin`]({{< relref "/operate/rs/references/cli-utilities/rladmin" >}}) command syntax: +To configure TLS 1.2 cipher suites for cluster communication, use the following [`rladmin`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin" >}}) command syntax: ```sh rladmin cluster config control_cipher_suites @@ -92,7 +92,7 @@ Data plane cipher suites use the OpenSSL library format in Redis Enterprise Soft #### Configure TLS 1.2 data plane cipher suites -To configure TLS 1.2 cipher suites for communications between applications and databases, use the following [`rladmin`]({{< relref "/operate/rs/references/cli-utilities/rladmin" >}}) command syntax: +To configure TLS 1.2 cipher suites for communications between applications and databases, use the following [`rladmin`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin" >}}) command syntax: ```sh rladmin cluster config data_cipher_list @@ -109,7 +109,7 @@ rladmin cluster config data_cipher_list AES128-SHA:AES256-SHA #### Configure TLS 1.3 data plane cipher suites -To configure TLS 1.3 cipher suites for communications between applications and databases, use the following [`rladmin`]({{< relref "/operate/rs/references/cli-utilities/rladmin" >}}) command syntax: +To configure TLS 1.3 cipher suites for communications between applications and databases, use the following [`rladmin`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin" >}}) command syntax: ```sh rladmin cluster config data_cipher_suites_tls_1_3 @@ -123,11 +123,11 @@ rladmin cluster config data_cipher_suites_tls_1_3 TLS_AES_256_GCM_SHA384:TLS_CHA ### Discovery service cipher suites {#discovery-service-ciphers-tls-1-2} -Sentinel service cipher suites use the golang.org OpenSSL format for [discovery service]({{< relref "/operate/rs/databases/durability-ha/discovery-service" >}}) TLS connections in Redis Enterprise Software version 6.0.20 or later. See their documentation for a list of [available configurations](https://golang.org/src/crypto/tls/cipher_suites.go). +Sentinel service cipher suites use the golang.org OpenSSL format for [discovery service]({{< relref "/operate/rs/7.4/databases/durability-ha/discovery-service" >}}) TLS connections in Redis Enterprise Software version 6.0.20 or later. See their documentation for a list of [available configurations](https://golang.org/src/crypto/tls/cipher_suites.go). #### Configure TLS 1.2 discovery service cipher suites -To configure TLS 1.2 cipher suites for the discovery service cipher suites, use the following [`rladmin`]({{< relref "/operate/rs/references/cli-utilities/rladmin" >}}) command syntax: +To configure TLS 1.2 cipher suites for the discovery service cipher suites, use the following [`rladmin`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin" >}}) command syntax: ```sh rladmin cluster config sentinel_cipher_suites diff --git a/content/operate/rs/7.4/security/encryption/tls/enable-tls.md b/content/operate/rs/7.4/security/encryption/tls/enable-tls.md index ca7f627091..a13fb0b6ea 100644 --- a/content/operate/rs/7.4/security/encryption/tls/enable-tls.md +++ b/content/operate/rs/7.4/security/encryption/tls/enable-tls.md @@ -14,8 +14,8 @@ url: '/operate/rs/7.4/security/encryption/tls/enable-tls/' You can use TLS authentication for one or more of the following types of communication: - Communication from clients (applications) to your database -- Communication from your database to other clusters for replication using [Replica Of]({{< relref "/operate/rs/databases/import-export/replica-of/" >}}) -- Communication to and from your database to other clusters for synchronization using [Active-Active]({{< relref "/operate/rs/databases/active-active/_index.md" >}}) +- Communication from your database to other clusters for replication using [Replica Of]({{< relref "/operate/rs/7.4/databases/import-export/replica-of/" >}}) +- Communication to and from your database to other clusters for synchronization using [Active-Active]({{< relref "/operate/rs/7.4/databases/active-active/_index.md" >}}) {{}} When you enable or turn off TLS, the change applies to new connections but does not affect existing connections. Clients must close existing connections and reconnect to apply the change. @@ -70,7 +70,7 @@ To enable mutual TLS for client connections: {{An example that shows adding a certificate validation with multiple organizational units.}} - **Breaking change:** If you use the [REST API]({{< relref "/operate/rs/references/rest-api" >}}) instead of the Cluster Manager UI to configure additional certificate validations, note that `authorized_names` is deprecated as of Redis Enterprise v6.4.2. Use `authorized_subjects` instead. See the [BDB object reference]({{< relref "/operate/rs/references/rest-api/objects/bdb" >}}) for more details. + **Breaking change:** If you use the [REST API]({{< relref "/operate/rs/7.4/references/rest-api" >}}) instead of the Cluster Manager UI to configure additional certificate validations, note that `authorized_names` is deprecated as of Redis Enterprise v6.4.2. Use `authorized_subjects` instead. See the [BDB object reference]({{< relref "/operate/rs/7.4/references/rest-api/objects/bdb" >}}) for more details. 1. Select **Save**. @@ -109,7 +109,7 @@ For each participating cluster, copy the syncer certificate from the **general** ### Configure TLS certificates for Active-Active -1. During database creation (see [Create an Active-Active Geo-Replicated Database]({{< relref "/operate/rs/databases/active-active/create.md" >}}), select **Edit** from the **configuration** tab. +1. During database creation (see [Create an Active-Active Geo-Replicated Database]({{< relref "/operate/rs/7.4/databases/active-active/create.md" >}}), select **Edit** from the **configuration** tab. 1. Enable **TLS**. - **Enforce client authentication** is selected by default. If you clear this option, you will still enforce encryption, but TLS client authentication will be deactivated. 1. Select **Require TLS for CRDB communication only** from the dropdown menu. diff --git a/content/operate/rs/7.4/security/encryption/tls/tls-protocols.md b/content/operate/rs/7.4/security/encryption/tls/tls-protocols.md index 18563c8d7b..63e1492058 100644 --- a/content/operate/rs/7.4/security/encryption/tls/tls-protocols.md +++ b/content/operate/rs/7.4/security/encryption/tls/tls-protocols.md @@ -19,9 +19,9 @@ The communications for which you can modify TLS protocols are: - Control plane - The TLS configuration for cluster administration. - Data plane - The TLS configuration for the communication between applications and databases. -- Discovery service (Sentinel) - The TLS configuration for the [discovery service]({{< relref "/operate/rs/databases/durability-ha/discovery-service.md" >}}). +- Discovery service (Sentinel) - The TLS configuration for the [discovery service]({{< relref "/operate/rs/7.4/databases/durability-ha/discovery-service.md" >}}). -You can configure TLS protocols with the [Cluster Manager UI](#edit-tls-ui), [`rladmin`]({{< relref "/operate/rs/references/cli-utilities/rladmin/cluster/config" >}}), or the [REST API]({{< relref "/operate/rs/references/rest-api/requests/cluster#put-cluster" >}}). +You can configure TLS protocols with the [Cluster Manager UI](#edit-tls-ui), [`rladmin`]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin/cluster/config" >}}), or the [REST API]({{< relref "/operate/rs/7.4/references/rest-api/requests/cluster#put-cluster" >}}). {{}} - After you set the minimum TLS version, Redis Enterprise Software does not accept communications with TLS versions older than the specified version. diff --git a/content/operate/rs/7.4/security/recommended-security-practices.md b/content/operate/rs/7.4/security/recommended-security-practices.md index f6af0c3fa1..45ceabce55 100644 --- a/content/operate/rs/7.4/security/recommended-security-practices.md +++ b/content/operate/rs/7.4/security/recommended-security-practices.md @@ -36,7 +36,7 @@ For antivirus solutions that intercept processes, binary files may have to be ex | /opt/redislabs/lib | System library files | | /opt/redislabs/sbin | System binaries for tweaking provisioning | -- **Send logs to a remote logging server**: Redis Enterprise is configured to send logs by default to syslog. To send these logs to a remote logging server you must [configure syslog]({{}}) based the requirements of the remote logging server vendor. Remote logging helps ensure that the logs are not deleted so that you can rotate the logs to prevent your server disk from filling up. +- **Send logs to a remote logging server**: Redis Enterprise is configured to send logs by default to syslog. To send these logs to a remote logging server you must [configure syslog]({{}}) based the requirements of the remote logging server vendor. Remote logging helps ensure that the logs are not deleted so that you can rotate the logs to prevent your server disk from filling up. - **Deploy clusters with an odd number of 3 or more nodes**: Redis is an available and partition-tolerant database. We recommend that Redis Enterprise be deployed in a cluster of an odd number of 3 or more nodes so that you are able to successfully failover in the event of a failure. @@ -46,11 +46,11 @@ For antivirus solutions that intercept processes, binary files may have to be ex ## Cluster security -- **Control the level of access to your system**: Redis Enterprise lets you decide which users can access the cluster, which users can access databases, and which users can access both. We recommend preventing database users from accessing the cluster. See [Access control]({{}}) for more information. +- **Control the level of access to your system**: Redis Enterprise lets you decide which users can access the cluster, which users can access databases, and which users can access both. We recommend preventing database users from accessing the cluster. See [Access control]({{}}) for more information. - **Enable LDAP authentication**: If your organization uses the Lightweight Directory Access Protocol (LDAP), we recommend enabling Redis Enterprise Software support for role-based LDAP authentication. -- **Require HTTPS for API endpoints**: Redis Enterprise comes with a REST API to help automate tasks. This API is available in both an encrypted and unencrypted endpoint for backward compatibility. You can [disable the unencrypted endpoint]({{}}) with no loss in functionality. +- **Require HTTPS for API endpoints**: Redis Enterprise comes with a REST API to help automate tasks. This API is available in both an encrypted and unencrypted endpoint for backward compatibility. You can [disable the unencrypted endpoint]({{}}) with no loss in functionality. ## Database security @@ -58,12 +58,12 @@ Redis Enterprise offers several database security controls to help protect your - **Use strong Redis passwords**: A frequent recommendation in the security industry is to use strong passwords to authenticate users. This helps to prevent brute force password guessing attacks against your database. Its important to check that your password aligns with your organizations security policy. -- **Deactivate default user access**: Redis Enterprise comes with a "default" user for backwards compatibility with applications designed with versions of Redis prior to Redis Enterprise 6. The default user is turned on by default. This allows you to access the database without specifying a username and only using a shared secret. For applications designed to use access control lists, we recommend that you [deactivate default user access]({{}}). +- **Deactivate default user access**: Redis Enterprise comes with a "default" user for backwards compatibility with applications designed with versions of Redis prior to Redis Enterprise 6. The default user is turned on by default. This allows you to access the database without specifying a username and only using a shared secret. For applications designed to use access control lists, we recommend that you [deactivate default user access]({{}}). -- **Configure Transport Layer Security (TLS)**: Similar to the control plane, you can also [configure TLS protocols]({{}}) to help support your security and compliance needs. +- **Configure Transport Layer Security (TLS)**: Similar to the control plane, you can also [configure TLS protocols]({{}}) to help support your security and compliance needs. -- **Enable client certificate authentication**: To prevent unauthorized access to your data, Redis Enterprise databases support the [TLS protocol]({{}}), which includes authentication and encryption. Client certificate authentication can be used to ensure only authorized hosts can access the database. +- **Enable client certificate authentication**: To prevent unauthorized access to your data, Redis Enterprise databases support the [TLS protocol]({{}}), which includes authentication and encryption. Client certificate authentication can be used to ensure only authorized hosts can access the database. -- **Install trusted certificates**: Redis implements self-signed certificates for the database proxy and replication service, but many organizations prefer to [use their own certificates]({{}}). +- **Install trusted certificates**: Redis implements self-signed certificates for the database proxy and replication service, but many organizations prefer to [use their own certificates]({{}}). -- **Configure and verify database backups**: Implementing a disaster recovery strategy is an important part of data security. Redis Enterprise supports [database backups to many destinations]({{}}). +- **Configure and verify database backups**: Implementing a disaster recovery strategy is an important part of data security. Redis Enterprise supports [database backups to many destinations]({{}}).