From bd0c8b15f74d252bb4908b12643d53793b37a20b Mon Sep 17 00:00:00 2001 From: Andy Stark Date: Wed, 23 Sep 2026 14:49:15 +0100 Subject: [PATCH 1/3] DOC-7104: Migrate content/operate/rs/8.0/references/ (incl. rest-api) to render hooks Unit 14 of 15: converts the frozen 8.0 references tree (283 files, 193 carrying relref/callout shortcodes) from {{< relref >}} and {{< note >}}/{{< warning >}} shortcodes to plain markdown links and > [!NOTE]/> [!WARNING] blockquotes resolved by the DOC-6909 render hooks. The rest-api/ subtree (199 of the 283 files) is explicitly in scope per the ticket: it was generated once when 8.0 was frozen and never regenerated since, so a one-time conversion is safe and permanent. Real counts (re-measured by grep against the pre-conversion tree, not taken from the ticket estimate): 1265 relref shortcodes (1132 as `{{< relref`, 133 as the no-space `{{}} indented inside a numbered list item, with only the header line indented and the continuation/closing lines flush left (the known converter limitation), plus a stray whitespace-only `>` artifact line left by the closing tag's indentation -- the same defect pattern already fixed in the 7.4, 7.22, and 7.8 units, recurring a 4th time as predicted. Fixed by re-indenting all blockquote lines to match the list item and dropping the stray line. Checked all 19 other callout-bearing files in this tree: none are indented inside a list, so no further nesting fixes were needed. cli-utilities/redis-cli/_index.md's relrefs were all well-formed here -- unlike 7.22/7.4, this snapshot (like 7.8) has no missing-paren instance. No relref-missing-slash instances found anywhere in this unit either. Verification: full-site hugo builds before/after (non-minified -- the esbuild/cf.reserve minify bug and the develop/clients jupyter-example error are both pre-existing and unrelated), diffed with the DOC-7104-diff-hrefs-fix build/diff_rendered_hrefs.py scoped to operate/rs/8.0/references: 281/281 pages compared, 0 href-set changes. The verification-only patched diff script was staged from origin/DOC-7104-diff-hrefs-fix, then unstaged and reverted before this commit; build/diff_rendered_hrefs.py carries no changes here. Build note: both before and after builds hit the same pre-existing fatal error on content/develop/clients/hiredis/_index.md (jupyter-example shortcode failing on a missing data/examples.json entry, unrelated to this unit's path) after Hugo had already finished rendering and copying all pages, including the full operate/rs/8.0/references tree (281 HTML pages present in both output trees) -- confirmed pre-existing and identical in both builds, so the comparison is unaffected. Co-Authored-By: Claude Sonnet 5 --- .../rs/8.0/references/alerts/_index.md | 11 +- .../8.0/references/alerts/alerts-v1-to-v2.md | 2 +- .../rs/8.0/references/cli-utilities/_index.md | 5 +- .../cli-utilities/crdb-cli/_index.md | 6 +- .../cli-utilities/crdb-cli/crdb/create.md | 18 +- .../crdb-cli/crdb/purge-instance.md | 2 +- .../crdb-cli/crdb/remove-instance.md | 4 +- .../cli-utilities/crdb-cli/crdb/update.md | 10 +- .../cli-utilities/crdb-cli/task/status.md | 2 +- .../cli-utilities/redis-cli/_index.md | 28 +- .../cli-utilities/rladmin/_index.md | 9 +- .../references/cli-utilities/rladmin/bind.md | 6 +- .../rladmin/cluster/certificate.md | 8 +- .../cli-utilities/rladmin/cluster/config.md | 6 +- .../cli-utilities/rladmin/failover.md | 2 +- .../cli-utilities/rladmin/migrate.md | 12 +- .../cli-utilities/rladmin/node/addr.md | 4 +- .../cli-utilities/rladmin/node/enslave.md | 6 +- .../rladmin/node/external-addr.md | 6 +- .../rladmin/node/maintenance-mode.md | 6 +- .../rladmin/node/recovery-path.md | 2 +- .../cli-utilities/rladmin/node/remove.md | 2 +- .../cli-utilities/rladmin/node/snapshot.md | 5 +- .../cli-utilities/rladmin/placement.md | 7 +- .../cli-utilities/rladmin/recover.md | 4 +- .../references/cli-utilities/rladmin/tune.md | 36 +- .../cli-utilities/rladmin/upgrade.md | 4 +- .../cli-utilities/rladmin/verify.md | 8 +- .../references/client_references/_index.md | 12 +- .../rs/8.0/references/clustering-redis.md | 2 +- .../rs/8.0/references/compatibility/_index.md | 8 +- .../compatibility/client-side-caching.md | 14 +- .../compatibility/commands/_index.md | 2 +- .../compatibility/commands/cluster.md | 70 +-- .../compatibility/commands/connection.md | 50 +-- .../compatibility/commands/data-types.md | 402 +++++++++--------- .../compatibility/commands/generic.md | 66 +-- .../compatibility/commands/pub-sub.md | 28 +- .../compatibility/commands/scripting.md | 42 +- .../compatibility/commands/server.md | 162 +++---- .../compatibility/commands/transactions.md | 12 +- .../compatibility/config-settings.md | 4 +- .../rs/8.0/references/compatibility/resp.md | 24 +- .../rs/8.0/references/memtier-benchmark.md | 4 +- .../rs/8.0/references/metrics/_index.md | 38 +- .../rs/8.0/references/metrics/auto-tiering.md | 10 +- .../references/metrics/database-operations.md | 24 +- .../metrics/prometheus-metrics-v1-to-v2.md | 4 +- .../metrics/prometheus-metrics-v1.md | 4 +- .../metrics/prometheus-metrics-v2.md | 4 +- .../8.0/references/metrics/resource-usage.md | 16 +- .../rs/8.0/references/rest-api/_index.md | 20 +- .../8.0/references/rest-api/objects/_index.md | 2 +- .../8.0/references/rest-api/objects/alert.md | 2 +- .../references/rest-api/objects/bdb/_index.md | 36 +- .../rest-api/objects/bdb/backup_location.md | 7 +- .../objects/bdb/dataset_import_sources.md | 9 +- .../objects/bdb/query_performance_factor.md | 2 +- .../objects/bdb/replica_sources_status.md | 2 +- .../rest-api/objects/bdb/replica_sync.md | 4 +- .../rest-api/objects/bootstrap/_index.md | 10 +- .../objects/bootstrap/node_identity.md | 10 +- .../rest-api/objects/certificates.md | 2 +- .../rest-api/objects/cluster/_index.md | 10 +- .../objects/cluster/alert_settings.md | 20 +- .../rest-api/objects/cluster_settings.md | 2 +- .../rest-api/objects/crdb/_index.md | 4 +- .../rest-api/objects/crdb/database_config.md | 14 +- .../objects/crdb/health_report/_index.md | 4 +- .../rest-api/objects/crdb/instance_info.md | 4 +- .../rest-api/objects/crdb/modify_request.md | 4 +- .../objects/db_alerts_settings/_index.md | 36 +- .../rest-api/objects/job_scheduler/_index.md | 14 +- .../8.0/references/rest-api/objects/ldap.md | 4 +- .../rest-api/objects/ldap_mapping.md | 2 +- .../8.0/references/rest-api/objects/module.md | 2 +- .../rest-api/objects/module_metadata.md | 2 +- .../8.0/references/rest-api/objects/node.md | 4 +- .../references/rest-api/objects/redis_acl.md | 2 +- .../8.0/references/rest-api/objects/role.md | 2 +- .../objects/services_configuration/_index.md | 22 +- .../rest-api/objects/shard/_index.md | 8 +- .../rest-api/objects/statistics/_index.md | 30 +- .../objects/statistics/cluster-metrics.md | 2 +- .../rest-api/objects/statistics/db-metrics.md | 2 +- .../objects/statistics/node-metrics.md | 2 +- .../objects/statistics/shard-metrics.md | 2 +- .../8.0/references/rest-api/objects/user.md | 2 +- .../rs/8.0/references/rest-api/permissions.md | 4 +- .../rs/8.0/references/rest-api/quick-start.md | 28 +- .../references/rest-api/requests/_index.md | 2 +- .../rest-api/requests/actions/_index.md | 16 +- .../rest-api/requests/actions/bdb.md | 4 +- .../rest-api/requests/bdbs/_index.md | 59 ++- .../rest-api/requests/bdbs/actions/_index.md | 22 +- .../bdbs/actions/backup_reset_status.md | 2 +- .../rest-api/requests/bdbs/actions/export.md | 4 +- .../bdbs/actions/export_reset_status.md | 2 +- .../rest-api/requests/bdbs/actions/import.md | 11 +- .../bdbs/actions/import_reset_status.md | 2 +- .../bdbs/actions/optimize_shards_placement.md | 13 +- .../requests/bdbs/actions/rebalance.md | 8 +- .../rest-api/requests/bdbs/actions/recover.md | 6 +- .../requests/bdbs/actions/resume_traffic.md | 6 +- .../rest-api/requests/bdbs/actions/revamp.md | 4 +- .../requests/bdbs/actions/stop_traffic.md | 6 +- .../rest-api/requests/bdbs/alerts.md | 18 +- .../rest-api/requests/bdbs/availability.md | 4 +- .../requests/bdbs/crdt_sources-alerts.md | 16 +- .../rest-api/requests/bdbs/debuginfo.md | 4 +- .../rest-api/requests/bdbs/modules/_index.md | 4 +- .../rest-api/requests/bdbs/modules/config.md | 4 +- .../rest-api/requests/bdbs/modules/upgrade.md | 4 +- .../rest-api/requests/bdbs/passwords.md | 6 +- .../rest-api/requests/bdbs/peer_stats.md | 8 +- .../requests/bdbs/replica_sources-alerts.md | 16 +- .../rest-api/requests/bdbs/shards.md | 2 +- .../rest-api/requests/bdbs/stats/_index.md | 10 +- .../rest-api/requests/bdbs/stats/last.md | 8 +- .../requests/bdbs/sync_source_stats.md | 8 +- .../requests/bdbs/syncer_state/_index.md | 7 +- .../requests/bdbs/syncer_state/crdt.md | 2 +- .../requests/bdbs/syncer_state/replica.md | 2 +- .../rest-api/requests/bdbs/upgrade.md | 4 +- .../rest-api/requests/bootstrap/_index.md | 6 +- .../rest-api/requests/bootstrap/validate.md | 2 +- .../rest-api/requests/cluster/_index.md | 10 +- .../rest-api/requests/cluster/actions.md | 12 +- .../rest-api/requests/cluster/alerts.md | 8 +- .../requests/cluster/auditing-db-conns.md | 18 +- .../requests/cluster/certificates/_index.md | 15 +- .../change_password_hashing_algorithm.md | 2 +- .../rest-api/requests/cluster/check.md | 2 +- .../rest-api/requests/cluster/debuginfo.md | 2 +- .../rest-api/requests/cluster/ldap.md | 10 +- .../requests/cluster/module-capabilities.md | 2 +- .../rest-api/requests/cluster/policy.md | 8 +- .../cluster/services_configuration.md | 10 +- .../rest-api/requests/cluster/sso.md | 16 +- .../rest-api/requests/cluster/stats/_index.md | 6 +- .../rest-api/requests/cluster/stats/last.md | 4 +- .../rest-api/requests/cm_settings/_index.md | 10 +- .../rest-api/requests/crdb_tasks/_index.md | 4 +- .../rest-api/requests/crdbs/_index.md | 20 +- .../rest-api/requests/crdbs/flush.md | 2 +- .../rest-api/requests/crdbs/health_report.md | 2 +- .../rest-api/requests/crdbs/purge.md | 2 +- .../rest-api/requests/crdbs/updates.md | 13 +- .../rest-api/requests/crdbs/upgrade.md | 2 +- .../rest-api/requests/debuginfo/_index.md | 10 +- .../rest-api/requests/debuginfo/all/_index.md | 4 +- .../rest-api/requests/debuginfo/all/bdb.md | 4 +- .../requests/debuginfo/node/_index.md | 4 +- .../rest-api/requests/debuginfo/node/bdb.md | 4 +- .../rest-api/requests/diagnostics/_index.md | 4 +- .../requests/endpoints-stats/_index.md | 11 +- .../rest-api/requests/job_scheduler/_index.md | 10 +- .../rest-api/requests/jsonschema/_index.md | 2 +- .../rest-api/requests/ldap_mappings/_index.md | 18 +- .../rest-api/requests/license/_index.md | 6 +- .../rest-api/requests/logs/_index.md | 2 +- .../rest-api/requests/migrations/_index.md | 2 +- .../rest-api/requests/modules/_index.md | 8 +- .../rest-api/requests/modules/config.md | 4 +- .../rest-api/requests/modules/user-defined.md | 12 +- .../node_master_healthcheck/_index.md | 2 +- .../rest-api/requests/nodes/_index.md | 17 +- .../rest-api/requests/nodes/actions.md | 20 +- .../rest-api/requests/nodes/alerts.md | 12 +- .../rest-api/requests/nodes/check.md | 2 +- .../rest-api/requests/nodes/debuginfo.md | 4 +- .../rest-api/requests/nodes/snapshots.md | 4 +- .../rest-api/requests/nodes/stats/_index.md | 10 +- .../rest-api/requests/nodes/stats/last.md | 8 +- .../rest-api/requests/nodes/status.md | 8 +- .../rest-api/requests/ocsp/_index.md | 10 +- .../rest-api/requests/ocsp/status.md | 4 +- .../references/rest-api/requests/ocsp/test.md | 4 +- .../rest-api/requests/proxies/_index.md | 16 +- .../rest-api/requests/redis_acls/_index.md | 26 +- .../rest-api/requests/roles/_index.md | 26 +- .../rest-api/requests/services/_index.md | 39 +- .../rest-api/requests/shards/_index.md | 10 +- .../requests/shards/actions/_index.md | 4 +- .../requests/shards/actions/failover.md | 8 +- .../requests/shards/actions/migrate.md | 12 +- .../rest-api/requests/shards/stats/_index.md | 12 +- .../rest-api/requests/shards/stats/last.md | 8 +- .../rest-api/requests/suffix/_index.md | 2 +- .../rest-api/requests/suffixes/_index.md | 2 +- .../rest-api/requests/users/_index.md | 36 +- .../operate/rs/8.0/references/terminology.md | 24 +- .../rs/8.0/references/upgrade-paths.md | 9 +- 193 files changed, 1231 insertions(+), 1256 deletions(-) diff --git a/content/operate/rs/8.0/references/alerts/_index.md b/content/operate/rs/8.0/references/alerts/_index.md index 7eb283c1f3..feb635ffcc 100644 --- a/content/operate/rs/8.0/references/alerts/_index.md +++ b/content/operate/rs/8.0/references/alerts/_index.md @@ -25,10 +25,9 @@ Configured alerts are shown: - In the **log** - In email notifications, if you configure [email alerts](#send-alerts-by-email) -{{< note >}} -If you enable alerts for "Node joined" or "Node removed" actions, -you must also enable "Receive email alerts" so that the notifications are sent. -{{< /note >}} +> [!NOTE] +> If you enable alerts for "Node joined" or "Node removed" actions, +> you must also enable "Receive email alerts" so that the notifications are sent. To enable alerts for a cluster: @@ -56,8 +55,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/8.0/clusters/configure/cluster-settings#configure-email-server-settings" >}}). +1. Select **Set an email** to configure the [email server settings](/content/operate/rs/8.0/clusters/configure/cluster-settings.md#configure-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/8.0/security/access-control/create-users#add-users" >}}) that you want each user to receive. +1. In **Access Control**, select the [database and cluster alerts](/content/operate/rs/8.0/security/access-control/create-users.md#add-users) that you want each user to receive. diff --git a/content/operate/rs/8.0/references/alerts/alerts-v1-to-v2.md b/content/operate/rs/8.0/references/alerts/alerts-v1-to-v2.md index 0a1fe4a2bc..8ffc6fd387 100644 --- a/content/operate/rs/8.0/references/alerts/alerts-v1-to-v2.md +++ b/content/operate/rs/8.0/references/alerts/alerts-v1-to-v2.md @@ -11,7 +11,7 @@ weight: 50 url: '/operate/rs/8.0/references/alerts/alerts-v1-to-v2/' --- -As Redis Software transitions from the [deprecated monitoring system]({{}}) to the [new metrics stream engine]({{}}), some internal cluster manager alerts were deprecated in favor of external monitoring solutions. +As Redis Software transitions from the [deprecated monitoring system](/content/operate/rs/8.0/monitoring/v1_monitoring.md) to the [new metrics stream engine](/content/operate/rs/8.0/monitoring/metrics_stream_engine/_index.md), some internal cluster manager alerts were deprecated in favor of external monitoring solutions. You can use the following table to transition from the deprecated alerts and set up equivalent alerts in Prometheus with [PromQL (Prometheus Query Language)](https://prometheus.io/docs/prometheus/latest/querying/basics/): diff --git a/content/operate/rs/8.0/references/cli-utilities/_index.md b/content/operate/rs/8.0/references/cli-utilities/_index.md index b60207b148..8ed2817400 100644 --- a/content/operate/rs/8.0/references/cli-utilities/_index.md +++ b/content/operate/rs/8.0/references/cli-utilities/_index.md @@ -24,9 +24,8 @@ Administrators can use these CLI tools to manage and test a Redis Software clust The `/opt/redislabs/bin/` directory also contains utilities used internally by Redis Software and for troubleshooting. -{{}} -Do not use these tools for normal operations. -{{}} +> [!WARNING] +> Do not use these tools for normal operations. | Utility | Description | |---------|-------------| diff --git a/content/operate/rs/8.0/references/cli-utilities/crdb-cli/_index.md b/content/operate/rs/8.0/references/cli-utilities/crdb-cli/_index.md index 3a19496d5a..73bd75b5f3 100644 --- a/content/operate/rs/8.0/references/cli-utilities/crdb-cli/_index.md +++ b/content/operate/rs/8.0/references/cli-utilities/crdb-cli/_index.md @@ -12,7 +12,7 @@ weight: $weight url: '/operate/rs/8.0/references/cli-utilities/crdb-cli/' --- -An [Active-Active database]({{< relref "/operate/rs/8.0/databases/active-active/_index.md" >}}) (also known as CRDB or conflict-free replicated database) +An [Active-Active database](/content/operate/rs/8.0/databases/active-active/_index.md) (also known as CRDB or conflict-free replicated database) replicates your data across Redis 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/8.0/databases/active-active" >}}) (CRDTs). +Write conflicts are resolved using [conflict-free replicated data types](/content/operate/rs/8.0/databases/active-active/_index.md) (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/8.0/references/cli-utilities/crdb-cli/task/" >}}) to manage Active-Active database tasks. +Use the [`crdb-cli task` commands](/content/operate/rs/8.0/references/cli-utilities/crdb-cli/task/_index.md) 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/8.0/references/cli-utilities/crdb-cli/crdb/create.md b/content/operate/rs/8.0/references/cli-utilities/crdb-cli/crdb/create.md index 34d10e2692..08fa29de0a 100644 --- a/content/operate/rs/8.0/references/cli-utilities/crdb-cli/crdb/create.md +++ b/content/operate/rs/8.0/references/cli-utilities/crdb-cli/crdb/create.md @@ -44,7 +44,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/8.0/networking/port-configurations" >}}) between the participating clusters +- [Network connectivity](/content/operate/rs/8.0/networking/port-configurations.md) between the participating clusters ### Parameters @@ -55,24 +55,24 @@ Before you create an Active-Active database, you must have: | memory-size \ | size in bytes, megabytes (MB), or gigabytes (GB) | Maximum database memory (required) | | instance fqdn=\,username=\,password=\,url=https://\:9443,replication_endpoint=\:\,replication_tls_sni=\ | strings | The connection information for the participating clusters (required for each participating cluster)

**Required:**
• `fqdn` - Cluster fully qualified domain name
• `username` - Cluster username
• `password` - Cluster password

**Optional:**
• `url` - URL to access the cluster's REST API
• `replication_endpoint` - Address to access the database instance for peer replication
• `replication_tls_sni` - Cluster [Server Name Indication (SNI)](https://en.wikipedia.org/wiki/Server_Name_Indication) hostname for TLS connections | | port \ | integer | TCP port for the Active-Active database on all participating clusters | -| default-db-config \ | string | Default database configuration options. For a list of database settings, see the [CRDB database config object]({{}}) reference.| -| default-db-config-file \ | filepath | Default database configuration options from a file. For a list of database settings, see the [CRDB database config object]({{}}) reference.| +| default-db-config \ | string | Default database configuration options. For a list of database settings, see the [CRDB database config object](/content/operate/rs/8.0/references/rest-api/objects/crdb/database_config.md) reference.| +| default-db-config-file \ | filepath | Default database configuration options from a file. For a list of database settings, see the [CRDB database config object](/content/operate/rs/8.0/references/rest-api/objects/crdb/database_config.md) reference.| | wait | | Prevents `crdb-cli` from running another command before this command finishes | | no-wait | | `crdb-cli` can run 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: false) | [Causal consistency]({{< relref "/operate/rs/8.0/databases/active-active/causal-consistency.md" >}}) applies updates to all instances in the order they were received | +| causal-consistency | true
false (default: false) | [Causal consistency](/content/operate/rs/8.0/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/8.0/databases/durability-ha/replication.md" >}}) where every master shard replicates to a replica shard | +| replication | true
false (*default*) | Activates or deactivates [database replication](/content/operate/rs/8.0/databases/durability-ha/replication.md) where every master shard replicates to a replica shard | | encryption | true
false (*default*) | Activates or deactivates encryption | -| sharding | true (*default*)
false | Activates or deactivates sharding (also known as [database clustering]({{< relref "/operate/rs/8.0/databases/durability-ha/clustering.md" >}})). Cannot be updated after the database is created | +| sharding | true (*default*)
false | Activates or deactivates sharding (also known as [database clustering](/content/operate/rs/8.0/databases/durability-ha/clustering.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/8.0/clusters/optimize/oss-cluster-api" >}}) | +| oss-cluster | true
false (*default*) | Activates [OSS cluster API](/content/operate/rs/8.0/clusters/optimize/oss-cluster-api.md) | | oss-sharding | true
false | Use the OSS sharding policy instead of regex rules | -| shard-key-regex \ | string | If clustering is enabled, this defines a regex rule (also known as a [hashing policy]({{< relref "/operate/rs/8.0/databases/durability-ha/clustering#custom-hashing-policy" >}})) that determines which keys are located in each shard (defaults to `{u'regex': u'.*\\{(?.*)\\}.*'}, {u'regex': u'(?.*)'} `) | +| shard-key-regex \ | string | If clustering is enabled, this defines a regex rule (also known as a [hashing policy](/content/operate/rs/8.0/databases/durability-ha/clustering.md#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, megabytes (MB), 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/8.0/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](/content/operate/rs/8.0/databases/memory-performance/eviction-policy.md) | | proxy-policy | all-nodes
all-master-shards
single | Sets proxy policy | diff --git a/content/operate/rs/8.0/references/cli-utilities/crdb-cli/crdb/purge-instance.md b/content/operate/rs/8.0/references/cli-utilities/crdb-cli/crdb/purge-instance.md index 620f87fc0f..996ad3c459 100644 --- a/content/operate/rs/8.0/references/cli-utilities/crdb-cli/crdb/purge-instance.md +++ b/content/operate/rs/8.0/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/8.0/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`](/content/operate/rs/8.0/references/cli-utilities/crdb-cli/crdb/remove-instance.md). ### Parameters diff --git a/content/operate/rs/8.0/references/cli-utilities/crdb-cli/crdb/remove-instance.md b/content/operate/rs/8.0/references/cli-utilities/crdb-cli/crdb/remove-instance.md index 0e5b76de41..37aae3fd02 100644 --- a/content/operate/rs/8.0/references/cli-utilities/crdb-cli/crdb/remove-instance.md +++ b/content/operate/rs/8.0/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/8.0/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`](/content/operate/rs/8.0/references/cli-utilities/crdb-cli/crdb/purge-instance.md) 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/8.0/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`](/content/operate/rs/8.0/references/cli-utilities/crdb-cli/crdb/purge-instance.md) from the removed instance. | | no-wait | | Does not wait for the task to complete | ### Returns diff --git a/content/operate/rs/8.0/references/cli-utilities/crdb-cli/crdb/update.md b/content/operate/rs/8.0/references/cli-utilities/crdb-cli/crdb/update.md index 6db01ac43a..886af178bd 100644 --- a/content/operate/rs/8.0/references/cli-utilities/crdb-cli/crdb/update.md +++ b/content/operate/rs/8.0/references/cli-utilities/crdb-cli/crdb/update.md @@ -32,7 +32,7 @@ crdb-cli crdb update --crdb-guid [--update-db-config-modules { true | false } ] ``` -If you want to change the configuration of the local instance only, use [`rladmin`]({{< relref "/operate/rs/8.0/references/cli-utilities/rladmin" >}}) instead. +If you want to change the configuration of the local instance only, use [`rladmin`](/content/operate/rs/8.0/references/cli-utilities/rladmin/_index.md) instead. ### Parameters @@ -41,16 +41,16 @@ 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/8.0/databases/active-active/causal-consistency.md" >}}) applies updates to all instances in the order they were received | +| causal-consistency | true
false | [Causal consistency](/content/operate/rs/8.0/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. For a list of database settings, see the [CRDB database config object]({{}}) reference. | -| default-db-config-file \ | filepath | Default database configuration from file. For a list of database settings, see the [CRDB database config object]({{}}) reference.| +| default-db-config \ | | Default database configuration from stdin. For a list of database settings, see the [CRDB database config object](/content/operate/rs/8.0/references/rest-api/objects/crdb/database_config.md) reference. | +| default-db-config-file \ | filepath | Default database configuration from file. For a list of database settings, see the [CRDB database config object](/content/operate/rs/8.0/references/rest-api/objects/crdb/database_config.md) reference.| | encryption | true
false | Activates or deactivates encryption | | 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/8.0/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](/content/operate/rs/8.0/databases/memory-performance/eviction-policy.md) | | featureset-version | true
false | Updates to latest FeatureSet version | | update-module name=\,featureset_version=\ | strings | Update a module to the specified version | | update-db-config-modules | true
false | Updates module information in the CRDB configuration (default-db-config) based on the latest module data for the database. Use this option only after all CRDB database instances have upgraded their modules. | diff --git a/content/operate/rs/8.0/references/cli-utilities/crdb-cli/task/status.md b/content/operate/rs/8.0/references/cli-utilities/crdb-cli/task/status.md index 479daba449..ff9cd6a2c2 100644 --- a/content/operate/rs/8.0/references/cli-utilities/crdb-cli/task/status.md +++ b/content/operate/rs/8.0/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/8.0/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`](/content/operate/rs/8.0/references/cli-utilities/crdb-cli/task/list.md) command to determine available task IDs. ### Returns diff --git a/content/operate/rs/8.0/references/cli-utilities/redis-cli/_index.md b/content/operate/rs/8.0/references/cli-utilities/redis-cli/_index.md index 739edffc34..7ba40b3eb9 100644 --- a/content/operate/rs/8.0/references/cli-utilities/redis-cli/_index.md +++ b/content/operate/rs/8.0/references/cli-utilities/redis-cli/_index.md @@ -14,9 +14,9 @@ weight: $weight url: '/operate/rs/8.0/references/cli-utilities/redis-cli/' --- -The `redis-cli` command-line utility lets you interact with a Redis database. With `redis-cli`, you can run [Redis commands]({{< relref "/commands" >}}) directly from the command-line terminal or with [interactive mode](#interactive-mode). +The `redis-cli` command-line utility lets you interact with a Redis database. With `redis-cli`, you can run [Redis commands](/commands) directly from the command-line terminal or with [interactive mode](#interactive-mode). -If you want to run Redis commands without `redis-cli`, you can [connect to a database with Redis Insight]({{< relref "/develop/tools/insight" >}}) and use the built-in [CLI]({{< relref "/develop/tools/insight" >}}) prompt instead. +If you want to run Redis commands without `redis-cli`, you can [connect to a database with Redis Insight](/content/develop/tools/insight/_index.md) and use the built-in [CLI](/content/develop/tools/insight/_index.md) prompt instead. ## Install `redis-cli` @@ -24,11 +24,11 @@ When you install Redis Software or Redis Open Source, it also installs the `redi To learn how to install Redis and `redis-cli`, see the following installation guides: -- [Redis Open Source]({{< relref "/operate/oss_and_stack/install/install-stack/" >}}) +- [Redis Open Source](/content/operate/oss_and_stack/install/install-stack/_index.md) -- [Redis Software]({{< relref "/operate/rs/8.0/installing-upgrading/quickstarts/redis-enterprise-software-quickstart" >}}) +- [Redis Software](/content/operate/rs/8.0/installing-upgrading/quickstarts/redis-enterprise-software-quickstart.md) -- [Redis Software with Docker]({{< relref "/operate/rs/8.0/installing-upgrading/quickstarts/docker-quickstart" >}}) +- [Redis Software with Docker](/content/operate/rs/8.0/installing-upgrading/quickstarts/docker-quickstart.md) ## Connect to a database @@ -57,7 +57,7 @@ To connect to a Redis Software or Redis Cloud database over TLS: 1. Download or copy the Redis Software server (or proxy) certificates. - - For Redis Cloud, see [Download certificates]({{< relref "/operate/rc/security/database-security/tls-ssl#download-certificates" >}}) for detailed instructions on how to download the server certificates (`redis_ca.pem`) from the [Redis Cloud console](https://cloud.redis.io/). + - For Redis Cloud, see [Download certificates](/content/operate/rc/security/database-security/tls-ssl.md#download-certificates) for detailed instructions on how to download the server certificates (`redis_ca.pem`) from the [Redis Cloud console](https://cloud.redis.io/). - For Redis Software, copy the proxy certificate from the Cluster Manager UI (**Cluster > Security > Certificates > Server authentication**) or from a cluster node (`/etc/opt/redislabs/proxy_cert.pem`). @@ -103,15 +103,15 @@ $ redis-cli -h -p 12000 GET mykey "Hello world" ``` -For more information, see [Command line usage]({{< relref "/develop/tools/cli" >}}#command-line-usage). +For more information, see [Command line usage](/content/develop/tools/cli.md#command-line-usage). ## Interactive mode -In `redis-cli` [interactive mode]({{< relref "/develop/tools/cli" >}}#interactive-mode), you can: +In `redis-cli` [interactive mode](/content/develop/tools/cli.md#interactive-mode), you can: - Run any `redis-cli` command without prefacing it with `redis-cli`. -- Enter `?` for more information about how to use the `HELP` command and [set `redis-cli` preferences]({{< relref "/develop/tools/cli" >}}#preferences). -- Enter [`HELP`]({{< relref "/develop/tools/cli" >}}#showing-help-about-redis-commands) followed by the name of a command for more information about the command and its options. +- Enter `?` for more information about how to use the `HELP` command and [set `redis-cli` preferences](/content/develop/tools/cli.md#preferences). +- Enter [`HELP`](/content/develop/tools/cli.md#showing-help-about-redis-commands) followed by the name of a command for more information about the command and its options. - Press the `Tab` key for command completion. - Enter `exit` or `quit` or press `Control+D` to exit interactive mode and return to the terminal prompt. @@ -131,7 +131,7 @@ OK ### Check slowlog -Run [`slowlog get`]({{< relref "/commands/slowlog-get" >}}) for a list of recent slow commands: +Run [`slowlog get`](/content/commands/slowlog-get.md) for a list of recent slow commands: ```sh redis-cli -h -p slowlog get @@ -145,9 +145,9 @@ Scan the database for big keys: redis-cli -h -p --bigkeys ``` -See [Scanning for big keys]({{< relref "/develop/tools/cli" >}}#scanning-for-big-keys) for more information. +See [Scanning for big keys](/content/develop/tools/cli.md#scanning-for-big-keys) for more information. ## More info -- [Redis CLI documentation]({{< relref "/develop/tools/cli" >}}) -- [Redis commands reference]({{< relref "/commands/" >}}) +- [Redis CLI documentation](/content/develop/tools/cli.md) +- [Redis commands reference](/commands/) diff --git a/content/operate/rs/8.0/references/cli-utilities/rladmin/_index.md b/content/operate/rs/8.0/references/cli-utilities/rladmin/_index.md index 95349f334a..5931c1876c 100644 --- a/content/operate/rs/8.0/references/cli-utilities/rladmin/_index.md +++ b/content/operate/rs/8.0/references/cli-utilities/rladmin/_index.md @@ -30,15 +30,14 @@ To open the `rladmin` shell: 1. Run: `rladmin` - {{}} -If the CLI does not recognize the `rladmin` command, -run this command to load the necessary configuration first: `bash -l` - {{}} + > [!NOTE] + > If the CLI does not recognize the `rladmin` command, + > run this command to load the necessary configuration first: `bash -l` 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/8.0/references/cli-utilities/rladmin/help" >}}) followed by the name of a command for a detailed explanation of the command and its usage. +- Enter [`help`](/content/operate/rs/8.0/references/cli-utilities/rladmin/help.md) 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/8.0/references/cli-utilities/rladmin/bind.md b/content/operate/rs/8.0/references/cli-utilities/rladmin/bind.md index 1799c38f1e..8b4840e3b7 100644 --- a/content/operate/rs/8.0/references/cli-utilities/rladmin/bind.md +++ b/content/operate/rs/8.0/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/8.0/references/cli-utilities/rladmin/status#status-endpoints" >}}) to verify that the policy changed. +Use [`rladmin status endpoints`](/content/operate/rs/8.0/references/cli-utilities/rladmin/status.md#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/8.0/references/cli-utilities/rladmin/status#status-endpoints" >}}) to verify that the policy changed. +Use [`rladmin status endpoints`](/content/operate/rs/8.0/references/cli-utilities/rladmin/status.md#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/8.0/references/cli-utilities/rladmin/status#status-endpoints" >}}) to verify that the policy changed. +Use [`rladmin status endpoints`](/content/operate/rs/8.0/references/cli-utilities/rladmin/status.md#status-endpoints) to verify that the policy changed. ### Example diff --git a/content/operate/rs/8.0/references/cli-utilities/rladmin/cluster/certificate.md b/content/operate/rs/8.0/references/cli-utilities/rladmin/cluster/certificate.md index c37c34f457..86aa31dd02 100644 --- a/content/operate/rs/8.0/references/cli-utilities/rladmin/cluster/certificate.md +++ b/content/operate/rs/8.0/references/cli-utilities/rladmin/cluster/certificate.md @@ -25,13 +25,13 @@ rladmin cluster certificate set [ key_file ] ``` -To set a certificate for a specific service, use the corresponding certificate name. See the [certificates table]({{< relref "/operate/rs/8.0/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](/content/operate/rs/8.0/security/certificates/_index.md) for the list of cluster certificates and their descriptions. ### Parameters | Parameter | Type/Value | Description | |-----------|------------|-------------| -| certificate_name | 'cm'
'api'
'proxy'
'syncer'
'metrics_exporter' | Name of the certificate to update. See the [certificates table]({{< relref "/operate/rs/8.0/security/certificates" >}}) for descriptions. | +| certificate_name | 'cm'
'api'
'proxy'
'syncer'
'metrics_exporter' | Name of the certificate to update. See the [certificates table](/content/operate/rs/8.0/security/certificates/_index.md) for descriptions. | | certificate_file | filepath | Path to the certificate file | | key_file | filepath | Path to the key file (optional) | @@ -51,7 +51,7 @@ Set proxy certificate to contents of file /tmp/proxy.pem ## `cluster certificate set internal` -Sets [customer-provided internode encryption certificates]({{}}). +Sets [customer-provided internode encryption certificates](/content/operate/rs/8.0/security/encryption/internode-encryption.md#customer-provided-certificates). ```sh rladmin cluster certificate set internal @@ -76,7 +76,7 @@ Reports that the internal certificates were set to the specified files. Returns ### Example -Set up [customer-provided internode encryption certificates]({{}}): +Set up [customer-provided internode encryption certificates](/content/operate/rs/8.0/security/encryption/internode-encryption.md#customer-provided-certificates): ```sh $ rladmin cluster certificate set internal \ diff --git a/content/operate/rs/8.0/references/cli-utilities/rladmin/cluster/config.md b/content/operate/rs/8.0/references/cli-utilities/rladmin/cluster/config.md index 5b2ec615ae..36fd59fbdf 100644 --- a/content/operate/rs/8.0/references/cli-utilities/rladmin/cluster/config.md +++ b/content/operate/rs/8.0/references/cli-utilities/rladmin/cluster/config.md @@ -61,9 +61,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/8.0/security/audit-events" >}}) | -| audit_port | string | Port where a listener can capture [audit event notifications]({{< relref "/operate/rs/8.0/security/audit-events" >}}) | -| audit_protocol | `tcp`
`local` | Protocol used for [audit event notifications]({{< relref "/operate/rs/8.0/security/audit-events" >}})
For production systems, only `tcp` is supported. | +| audit_address | string | TCP/IP address where a listener can capture [audit event notifications](/content/operate/rs/8.0/security/audit-events.md) | +| audit_port | string | Port where a listener can capture [audit event notifications](/content/operate/rs/8.0/security/audit-events.md) | +| audit_protocol | `tcp`
`local` | Protocol used for [audit event notifications](/content/operate/rs/8.0/security/audit-events.md)
For production systems, only `tcp` is supported. | | availability_lag_tolerance_ms | integer | Availability lag tolerance in milliseconds | | 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 | diff --git a/content/operate/rs/8.0/references/cli-utilities/rladmin/failover.md b/content/operate/rs/8.0/references/cli-utilities/rladmin/failover.md index 06bd244e31..a7e11b95ef 100644 --- a/content/operate/rs/8.0/references/cli-utilities/rladmin/failover.md +++ b/content/operate/rs/8.0/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/8.0/references/cli-utilities/rladmin/status#status-shards" >}}) to verify that the failover completed. +Use [`rladmin status shards`](/content/operate/rs/8.0/references/cli-utilities/rladmin/status.md#status-shards) to verify that the failover completed. ### Example diff --git a/content/operate/rs/8.0/references/cli-utilities/rladmin/migrate.md b/content/operate/rs/8.0/references/cli-utilities/rladmin/migrate.md index 04468e8573..7e8491299d 100644 --- a/content/operate/rs/8.0/references/cli-utilities/rladmin/migrate.md +++ b/content/operate/rs/8.0/references/cli-utilities/rladmin/migrate.md @@ -16,7 +16,7 @@ url: '/operate/rs/8.0/references/cli-utilities/rladmin/migrate/' Moves Redis Software 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](/content/operate/rs/8.0/databases/migrate-shards.md). ## `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/8.0/references/cli-utilities/rladmin/status#status-shards" >}}) to verify the migration completed. +Use [`rladmin status shards`](/content/operate/rs/8.0/references/cli-utilities/rladmin/status.md#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/8.0/references/cli-utilities/rladmin/status#status-shards" >}}) to verify the migration completed. +Use [`rladmin status shards`](/content/operate/rs/8.0/references/cli-utilities/rladmin/status.md#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/8.0/references/cli-utilities/rladmin/status#status-shards" >}}) to verify the migration completed. +Use [`rladmin status shards`](/content/operate/rs/8.0/references/cli-utilities/rladmin/status.md#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/8.0/references/cli-utilities/rladmin/status#status-endpoints" >}}) to verify that the endpoints were moved. +Use [`rladmin status endpoints`](/content/operate/rs/8.0/references/cli-utilities/rladmin/status.md#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/8.0/references/cli-utilities/rladmin/status#status-shards" >}}) to verify the migration completed. +Use [`rladmin status shards`](/content/operate/rs/8.0/references/cli-utilities/rladmin/status.md#status-shards) to verify the migration completed. ### Example diff --git a/content/operate/rs/8.0/references/cli-utilities/rladmin/node/addr.md b/content/operate/rs/8.0/references/cli-utilities/rladmin/node/addr.md index fea399fa0b..3461bf70b3 100644 --- a/content/operate/rs/8.0/references/cli-utilities/rladmin/node/addr.md +++ b/content/operate/rs/8.0/references/cli-utilities/rladmin/node/addr.md @@ -13,7 +13,7 @@ weight: $weight url: '/operate/rs/8.0/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/8.0/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](/content/operate/rs/8.0/networking/multi-ip-ipv6.md#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/8.0/references/cli-utilities/rladmin/status#status-nodes" >}}) to verify the internal IP address was changed. +Use [`rladmin status nodes`](/content/operate/rs/8.0/references/cli-utilities/rladmin/status.md#status-nodes) to verify the internal IP address was changed. ### Example diff --git a/content/operate/rs/8.0/references/cli-utilities/rladmin/node/enslave.md b/content/operate/rs/8.0/references/cli-utilities/rladmin/node/enslave.md index 689cc3b824..303d972b54 100644 --- a/content/operate/rs/8.0/references/cli-utilities/rladmin/node/enslave.md +++ b/content/operate/rs/8.0/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/8.0/references/cli-utilities/rladmin/status#status-shards" >}}) to verify that the roles were changed. +Use [`rladmin status shards`](/content/operate/rs/8.0/references/cli-utilities/rladmin/status.md#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/8.0/references/cli-utilities/rladmin/status#status-endpoints" >}}) to verify that the roles were changed. +Use [`rladmin status endpoints`](/content/operate/rs/8.0/references/cli-utilities/rladmin/status.md#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/8.0/references/cli-utilities/rladmin/status#status-shards" >}}) to verify that the roles were changed. +Use [`rladmin status shards`](/content/operate/rs/8.0/references/cli-utilities/rladmin/status.md#status-shards) to verify that the roles were changed. ### Example diff --git a/content/operate/rs/8.0/references/cli-utilities/rladmin/node/external-addr.md b/content/operate/rs/8.0/references/cli-utilities/rladmin/node/external-addr.md index 85fb4ea603..9629fab368 100644 --- a/content/operate/rs/8.0/references/cli-utilities/rladmin/node/external-addr.md +++ b/content/operate/rs/8.0/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/8.0/references/cli-utilities/rladmin/status#status-nodes" >}}) to verify the external IP address was added. +Use [`rladmin status nodes`](/content/operate/rs/8.0/references/cli-utilities/rladmin/status.md#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/8.0/references/cli-utilities/rladmin/status#status-nodes" >}}) to verify the external IP address was set. +Use [`rladmin status nodes`](/content/operate/rs/8.0/references/cli-utilities/rladmin/status.md#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/8.0/references/cli-utilities/rladmin/status#status-nodes" >}}) to verify the external IP address was removed. +Use [`rladmin status nodes`](/content/operate/rs/8.0/references/cli-utilities/rladmin/status.md#status-nodes) to verify the external IP address was removed. ### Example diff --git a/content/operate/rs/8.0/references/cli-utilities/rladmin/node/maintenance-mode.md b/content/operate/rs/8.0/references/cli-utilities/rladmin/node/maintenance-mode.md index 537f8bbe1f..a1e8c7d174 100644 --- a/content/operate/rs/8.0/references/cli-utilities/rladmin/node/maintenance-mode.md +++ b/content/operate/rs/8.0/references/cli-utilities/rladmin/node/maintenance-mode.md @@ -13,7 +13,7 @@ weight: $weight url: '/operate/rs/8.0/references/cli-utilities/rladmin/node/maintenance-mode/' --- -Configures [quorum-only mode]({{< relref "/operate/rs/8.0/clusters/maintenance-mode#activate-maintenance-mode" >}}) on a node. +Configures [quorum-only mode](/content/operate/rs/8.0/clusters/maintenance-mode.md#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/8.0/references/cli-utilities/rladmin/status#status-nodes" >}}) to verify the node became a quorum node. +Use [`rladmin status nodes`](/content/operate/rs/8.0/references/cli-utilities/rladmin/status.md#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/8.0/references/cli-utilities/rladmin/status#status-nodes" >}}) to verify the node was restored. +Use [`rladmin status nodes`](/content/operate/rs/8.0/references/cli-utilities/rladmin/status.md#status-nodes) to verify the node was restored. ### Example diff --git a/content/operate/rs/8.0/references/cli-utilities/rladmin/node/recovery-path.md b/content/operate/rs/8.0/references/cli-utilities/rladmin/node/recovery-path.md index 52111142e6..0aa3c3e2bb 100644 --- a/content/operate/rs/8.0/references/cli-utilities/rladmin/node/recovery-path.md +++ b/content/operate/rs/8.0/references/cli-utilities/rladmin/node/recovery-path.md @@ -13,7 +13,7 @@ weight: $weight url: '/operate/rs/8.0/references/cli-utilities/rladmin/node/recovery-path/' --- -Sets the node's local recovery path, which specifies the directory where [persistence files]({{< relref "/operate/rs/8.0/databases/configure/database-persistence" >}}) are stored. You can use these persistence files to [recover a failed database]({{< relref "/operate/rs/8.0/databases/recover" >}}). +Sets the node's local recovery path, which specifies the directory where [persistence files](/content/operate/rs/8.0/databases/configure/database-persistence.md) are stored. You can use these persistence files to [recover a failed database](/content/operate/rs/8.0/databases/recover.md). ```sh rladmin node recovery_path set diff --git a/content/operate/rs/8.0/references/cli-utilities/rladmin/node/remove.md b/content/operate/rs/8.0/references/cli-utilities/rladmin/node/remove.md index 20ca56b17a..b2364dffb4 100644 --- a/content/operate/rs/8.0/references/cli-utilities/rladmin/node/remove.md +++ b/content/operate/rs/8.0/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/8.0/references/cli-utilities/rladmin/status#status-nodes" >}}) to verify that the node was removed. +Use [`rladmin status nodes`](/content/operate/rs/8.0/references/cli-utilities/rladmin/status.md#status-nodes) to verify that the node was removed. ### Example diff --git a/content/operate/rs/8.0/references/cli-utilities/rladmin/node/snapshot.md b/content/operate/rs/8.0/references/cli-utilities/rladmin/node/snapshot.md index 2e8504f078..29ff55dd14 100644 --- a/content/operate/rs/8.0/references/cli-utilities/rladmin/node/snapshot.md +++ b/content/operate/rs/8.0/references/cli-utilities/rladmin/node/snapshot.md @@ -52,9 +52,8 @@ Deletes an existing snapshot of a node. rladmin node snapshot delete ``` -{{}} -You cannot use this command to delete a snapshot created by maintenance mode. As of Redis Software version 7.4.2, only the latest maintenance mode snapshot is kept. -{{}} +> [!NOTE] +> You cannot use this command to delete a snapshot created by maintenance mode. As of Redis Software version 7.4.2, only the latest maintenance mode snapshot is kept. ### Parameters diff --git a/content/operate/rs/8.0/references/cli-utilities/rladmin/placement.md b/content/operate/rs/8.0/references/cli-utilities/rladmin/placement.md index 22769c398b..75aa005683 100644 --- a/content/operate/rs/8.0/references/cli-utilities/rladmin/placement.md +++ b/content/operate/rs/8.0/references/cli-utilities/rladmin/placement.md @@ -21,9 +21,8 @@ rladmin placement { dense | sparse } ``` -{{< note >}} -`rladmin placement db` is deprecated and will be removed in a future version. Use [`rladmin tune db`]({{< relref "/operate/rs/8.0/references/cli-utilities/rladmin/tune#tune-db" >}}) with the `shards_placement` parameter instead. -{{< /note >}} +> [!NOTE] +> `rladmin placement db` is deprecated and will be removed in a future version. Use [`rladmin tune db`](/content/operate/rs/8.0/references/cli-utilities/rladmin/tune.md#tune-db) with the `shards_placement` parameter instead. ### Parameters @@ -37,7 +36,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/8.0/references/cli-utilities/rladmin/status#status-databases" >}}) to verify that the failover completed. +Use [`rladmin status databases`](/content/operate/rs/8.0/references/cli-utilities/rladmin/status.md#status-databases) to verify that the failover completed. ### Example diff --git a/content/operate/rs/8.0/references/cli-utilities/rladmin/recover.md b/content/operate/rs/8.0/references/cli-utilities/rladmin/recover.md index 9428e280fe..e30b762d06 100644 --- a/content/operate/rs/8.0/references/cli-utilities/rladmin/recover.md +++ b/content/operate/rs/8.0/references/cli-utilities/rladmin/recover.md @@ -13,9 +13,9 @@ weight: $weight url: '/operate/rs/8.0/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/8.0/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](/content/operate/rs/8.0/databases/recover.md) 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/8.0/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 `](/content/operate/rs/8.0/references/cli-utilities/rladmin/node/recovery-path.md). ## `recover all` diff --git a/content/operate/rs/8.0/references/cli-utilities/rladmin/tune.md b/content/operate/rs/8.0/references/cli-utilities/rladmin/tune.md index 690e83ed3a..8f5839732f 100644 --- a/content/operate/rs/8.0/references/cli-utilities/rladmin/tune.md +++ b/content/operate/rs/8.0/references/cli-utilities/rladmin/tune.md @@ -64,15 +64,15 @@ 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 | | auto_recovery | `enabled`
`disabled` | Defines whether to use automatic recovery after shard failure | -| data_internode_encryption | `enabled`
`disabled` | Activates or deactivates [internode encryption]({{< relref "/operate/rs/8.0/security/encryption/internode-encryption" >}}) for new databases | -| db_conns_auditing | `enabled`
`disabled` | Activates or deactivates [connection auditing]({{< relref "/operate/rs/8.0/security/audit-events" >}}) by default for new databases of a cluster | +| data_internode_encryption | `enabled`
`disabled` | Activates or deactivates [internode encryption](/content/operate/rs/8.0/security/encryption/internode-encryption.md) for new databases | +| db_conns_auditing | `enabled`
`disabled` | Activates or deactivates [connection auditing](/content/operate/rs/8.0/security/audit-events.md) 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/8.0/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](/content/operate/rs/8.0/databases/configure/proxy-policy.md) for newly created non-sharded databases' endpoints | | default_oss_sharding | `enabled`
`disabled` | Default hashing policy to use for new databases. Set to `disabled` by default. This field is for future use only and should not be changed. | | default_recovery_wait_time | integer | The default time for new databases to wait for the persistence file to be available during automatic recovery. After the wait time expires, auto recovery completes with potential data loss. The default `-1` means to wait forever. | | 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/8.0/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/8.0/databases/memory-performance/shard-placement-policy" >}}) | +| default_sharded_proxy_policy | `single`

`all-master-shards`

`all-nodes` | Default [proxy policy](/content/operate/rs/8.0/databases/configure/proxy-policy.md) for newly created sharded databases' endpoints | +| default_shards_placement | `dense`
`sparse` | New databases place shards according to the default [shard placement policy](/content/operate/rs/8.0/databases/memory-performance/shard-placement-policy.md) | | default_tracking_table_max_keys_policy | integer (default: 1000000) | Defines the default value of the client-side caching invalidation table size for new databases. 0 makes the cache unlimited. | | 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) | @@ -92,17 +92,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/8.0/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 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/8.0/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/8.0/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/8.0/databases/configure/replica-ha" >}}) starts relocating shards to another node | +| slave_ha | `enabled`
`disabled` | Activates or deactivates [replica high availability](/content/operate/rs/8.0/databases/configure/replica-ha.md) in the cluster
(enabled by default; use [`rladmin tune db`](#tune-db) to change `slave_ha` for a specific database)

Deprecated as of Redis 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](/content/operate/rs/8.0/databases/configure/replica-ha.md) 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](/content/operate/rs/8.0/databases/configure/replica-ha.md) 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](/content/operate/rs/8.0/databases/configure/replica-ha.md) starts relocating shards to another node | | watchdog_profile | `cloud`
`local-network` | Watchdog profiles with preconfigured thresholds and timeouts (deprecated as of Redis 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/8.0/references/cli-utilities/rladmin/info#info-cluster" >}}) to verify the cluster configuration was changed. +Use [`rladmin info cluster`](/content/operate/rs/8.0/references/cli-utilities/rladmin/info.md#info-cluster) to verify the cluster configuration was changed. ### Example @@ -171,13 +171,13 @@ 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/8.0/security/encryption/internode-encryption" >}}) for the database | -| db_conns_auditing | `enabled`
`disabled` | Activates or deactivates database [connection auditing]({{< relref "/operate/rs/8.0/security/audit-events" >}}) for a database | +| data_internode_encryption | `enabled`
`disabled` | Activates or deactivates [internode encryption](/content/operate/rs/8.0/security/encryption/internode-encryption.md) for the database | +| db_conns_auditing | `enabled`
`disabled` | Activates or deactivates database [connection auditing](/content/operate/rs/8.0/security/audit-events.md) 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 | | master_persistence | `enabled`
`disabled` | If enabled, persists the primary shard in addition to replica shards in a replicated and persistent database. | -| max_aof_file_size | size in MB | Maximum size (in MB, if not specified) of [AoF]({{< relref "/glossary/_index.md#letter-a" >}}) file (minimum value is 10 GB) | +| max_aof_file_size | size in MB | Maximum size (in MB, if not specified) of [AoF](/content/glossary/_index.md#letter-a) file (minimum value is 10 GB) | | max_aof_load_time | time in seconds | Time limit in seconds to load a shard from an append-only file (AOF). If exceeded, an AOF rewrite is initiated to decrease future load time.
Minimum: 2700 seconds (45 minutes)
Default: 3600 seconds (1 hour) | | max_client_pipeline | integer | Maximum commands in the proxy's pipeline per client connection (max value is 2047, default value is 200) | | max_connections | integer | Maximum client connections to the database's endpoint (default value is 0, which is unlimited) | @@ -196,7 +196,7 @@ rladmin tune db { db: | } | repl_timeout | time in seconds | Replication timeout (in seconds) | | resp3 | `enabled`
`disabled` | Enables or deactivates RESP3 support (defaults to `enabled`) | | schedpolicy | `cmp`
`mru`
`spread`
`mnp` | Controls how server-side connections are used when forwarding traffic to shards | -| shards_placement | `dense`
`sparse` | Configures the [shard placement policy]({{< relref "/operate/rs/8.0/databases/memory-performance/shard-placement-policy" >}}) for the database | +| shards_placement | `dense`
`sparse` | Configures the [shard placement policy](/content/operate/rs/8.0/databases/memory-performance/shard-placement-policy.md) for the database | | skip_import_analyze | `enabled`
`disabled` | Skips the analyzing step when importing a database | | slave_buffer | `auto`
value in MB
hard:soft:time | Redis replica output buffer limits
• `auto`: dynamically adjusts the buffer limit based on the shard’s current used memory
• value in MB: sets the buffer limit in MB
• hard:soft:time: sets the hard limit (maximum buffer size in MB), soft limit in MB, and the time in seconds that the soft limit can be exceeded | | slave_ha | `enabled`
`disabled` | Activates or deactivates replica high availability (defaults to the cluster setting) | @@ -215,7 +215,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/8.0/references/cli-utilities/rladmin/info#info-db" >}}) to verify the database configuration was changed. +Use [`rladmin info db`](/content/operate/rs/8.0/references/cli-utilities/rladmin/info.md#info-db) to verify the database configuration was changed. ### Example @@ -250,13 +250,13 @@ tune node { | all } | max_redis_forks | integer | Maximum number of background processes forked from shards that may exist on the node at any given time | | max_redis_servers | integer | Maximum number of shards allowed to reside on the node | | max_slave_full_syncs | integer | Maximum number of simultaneous replica full-syncs that may be running at any given time (0: Unlimited, -1: Use cluster settings) | -| quorum_only | `enabled`
`disabled` | If activated, configures the node as a [quorum-only node]({{< relref "/glossary/_index.md#letter-p" >}}) | +| quorum_only | `enabled`
`disabled` | If activated, configures the node as a [quorum-only node](/content/glossary/_index.md#letter-p) | ### Returns Returns `Finished successfully` if the node configuration was changed. Otherwise, it returns an error. -Use [`rladmin info node`]({{< relref "/operate/rs/8.0/references/cli-utilities/rladmin/info#info-node" >}}) to verify the node configuration was changed. +Use [`rladmin info node`](/content/operate/rs/8.0/references/cli-utilities/rladmin/info.md#info-node) to verify the node configuration was changed. ### Example @@ -300,7 +300,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/8.0/references/cli-utilities/rladmin/info#info-proxy" >}}) to verify the proxy configuration was changed. +Use [`rladmin info proxy`](/content/operate/rs/8.0/references/cli-utilities/rladmin/info.md#info-proxy) to verify the proxy configuration was changed. ### Example diff --git a/content/operate/rs/8.0/references/cli-utilities/rladmin/upgrade.md b/content/operate/rs/8.0/references/cli-utilities/rladmin/upgrade.md index 10bc1fe165..000a5687fb 100644 --- a/content/operate/rs/8.0/references/cli-utilities/rladmin/upgrade.md +++ b/content/operate/rs/8.0/references/cli-utilities/rladmin/upgrade.md @@ -17,7 +17,7 @@ url: '/operate/rs/8.0/references/cli-utilities/rladmin/upgrade/' Schedules a restart of the primary and replica processes of a database and then upgrades the database to the latest version of Redis. -For more information, see [Upgrade an existing Redis Software Deployment]({{< relref "/operate/rs/8.0/installing-upgrading/upgrading" >}}). +For more information, see [Upgrade an existing Redis Software Deployment](/content/operate/rs/8.0/installing-upgrading/upgrading/_index.md). ```sh rladmin upgrade db { db: | } @@ -32,7 +32,7 @@ rladmin upgrade db { db: | } [ 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/8.0/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`](/content/operate/rs/8.0/references/cli-utilities/rladmin/tune.md#tune-cluster). As of Redis Software version 7.8.2, `upgrade db` will always upgrade modules. diff --git a/content/operate/rs/8.0/references/cli-utilities/rladmin/verify.md b/content/operate/rs/8.0/references/cli-utilities/rladmin/verify.md index 0a35fcc480..13f195e252 100644 --- a/content/operate/rs/8.0/references/cli-utilities/rladmin/verify.md +++ b/content/operate/rs/8.0/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/8.0/databases/configure/proxy-policy#proxy-policies" >}}) determines which nodes or endpoints to report as unbalanced. +The [proxy policy](/content/operate/rs/8.0/databases/configure/proxy-policy.md#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/8.0/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/8.0/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`](/content/operate/rs/8.0/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`](/content/operate/rs/8.0/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/8.0/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](/content/operate/rs/8.0/clusters/configure/rack-zone-awareness.md) is enabled. ```sh rladmin verify rack_aware diff --git a/content/operate/rs/8.0/references/client_references/_index.md b/content/operate/rs/8.0/references/client_references/_index.md index c2cd65aa1f..2f85572fb0 100644 --- a/content/operate/rs/8.0/references/client_references/_index.md +++ b/content/operate/rs/8.0/references/client_references/_index.md @@ -19,15 +19,15 @@ To connect to Redis instances from within your application, use a Redis client l | Language | Client name | | :---------- | :------------- | -| .Net | [StackExchange.Redis]({{< relref "/develop/clients/dotnet" >}}) | -| Go | [go-redis]({{< relref "/develop/clients/go" >}}) | -| Java | [Jedis]({{< relref "/develop/clients/jedis" >}}) (Synchronous) and [Lettuce]({{< relref "/develop/clients/lettuce" >}}) (Asynchronous) | -| Node.js | [node-redis]({{< relref "/develop/clients/nodejs" >}}) | -| Python | [redis-py]({{< relref "/develop/clients/redis-py" >}}) | +| .Net | [StackExchange.Redis](/content/develop/clients/dotnet/_index.md) | +| Go | [go-redis](/content/develop/clients/go/_index.md) | +| Java | [Jedis](/content/develop/clients/jedis/_index.md) (Synchronous) and [Lettuce](/content/develop/clients/lettuce/_index.md) (Asynchronous) | +| Node.js | [node-redis](/content/develop/clients/nodejs/_index.md) | +| Python | [redis-py](/content/develop/clients/redis-py/_index.md) | Select a client name to see its quick start. ## Other clients For a list of community-driven Redis clients, which are available for more programming languages, see -[Community-supported clients]({{< relref "/develop/clients#community-supported-clients" >}}). +[Community-supported clients](/content/develop/clients/_index.md#community-supported-clients). diff --git a/content/operate/rs/8.0/references/clustering-redis.md b/content/operate/rs/8.0/references/clustering-redis.md index c01a876c05..ae160bdd16 100644 --- a/content/operate/rs/8.0/references/clustering-redis.md +++ b/content/operate/rs/8.0/references/clustering-redis.md @@ -28,4 +28,4 @@ There are several solutions to clustering Redis, most notable of which is the [R Redis 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 Software 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 Software clusters, see [Database clustering]({{< relref "/operate/rs/8.0/databases/durability-ha/clustering/" >}}). +Redis Software 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 Software clusters, see [Database clustering](/content/operate/rs/8.0/databases/durability-ha/clustering.md). diff --git a/content/operate/rs/8.0/references/compatibility/_index.md b/content/operate/rs/8.0/references/compatibility/_index.md index 8d598923ca..4325a0bb29 100644 --- a/content/operate/rs/8.0/references/compatibility/_index.md +++ b/content/operate/rs/8.0/references/compatibility/_index.md @@ -13,18 +13,18 @@ weight: $weight tocEmbedHeaders: true url: '/operate/rs/8.0/references/compatibility/' --- -Both Redis Software and [Redis Cloud]({{< relref "/operate/rc" >}}) are compatible with Redis Open Source. +Both Redis Software and [Redis Cloud](/content/operate/rc/_index.md) are compatible with Redis Open Source. {{< embed-md "rc-rs-oss-compatibility.md" >}} ## RESP compatibility -Redis Software and Redis Cloud support RESP2 and RESP3. See [RESP compatibility with Redis Software]({{< relref "/operate/rs/8.0/references/compatibility/resp" >}}) for more information. +Redis Software and Redis Cloud support RESP2 and RESP3. See [RESP compatibility with Redis Software](/content/operate/rs/8.0/references/compatibility/resp.md) for more information. ## Client-side caching compatibility -Redis Software and Redis Cloud support [client-side caching]({{}}) for databases with Redis versions 7.4 or later. See [Client-side caching compatibility with Redis Software and Redis Cloud]({{}}) for more information about compatibility and configuration options. +Redis Software and Redis Cloud support [client-side caching](/content/develop/clients/client-side-caching.md) for databases with Redis versions 7.4 or later. See [Client-side caching compatibility with Redis Software and Redis Cloud](/content/operate/rs/8.0/references/compatibility/client-side-caching.md) for more information about compatibility and configuration options. ## Compatibility with open source Redis Cluster API -Redis Software supports [Redis OSS Cluster API]({{< relref "/operate/rs/8.0/clusters/optimize/oss-cluster-api" >}}) if it is enabled for a database. For more information, see [Enable OSS Cluster API]({{< relref "/operate/rs/8.0/databases/configure/oss-cluster-api" >}}). +Redis Software supports [Redis OSS Cluster API](/content/operate/rs/8.0/clusters/optimize/oss-cluster-api.md) if it is enabled for a database. For more information, see [Enable OSS Cluster API](/content/operate/rs/8.0/databases/configure/oss-cluster-api.md). diff --git a/content/operate/rs/8.0/references/compatibility/client-side-caching.md b/content/operate/rs/8.0/references/compatibility/client-side-caching.md index 3f0fad5666..49b02d1299 100644 --- a/content/operate/rs/8.0/references/compatibility/client-side-caching.md +++ b/content/operate/rs/8.0/references/compatibility/client-side-caching.md @@ -12,7 +12,7 @@ weight: 80 url: '/operate/rs/8.0/references/compatibility/client-side-caching/' --- -Redis Software and Redis Cloud support [client-side caching]({{}}) for databases with Redis versions 7.4 or later. +Redis Software and Redis Cloud support [client-side caching](/content/develop/clients/client-side-caching.md) for databases with Redis versions 7.4 or later. ## Required database versions @@ -28,7 +28,7 @@ The following table shows the differences in client-side caching support by prod ## Supported RESP versions -Client-side caching in Redis Software and Redis Cloud requires [RESP3]({{< relref "/develop/reference/protocol-spec#resp-versions" >}}). +Client-side caching in Redis Software and Redis Cloud requires [RESP3](/content/develop/reference/protocol-spec.md#resp-versions). The following table shows the differences in client-side caching support for RESP by product: @@ -40,7 +40,7 @@ The following table shows the differences in client-side caching support for RES ## Two connections mode with REDIRECT not supported -Unlike Redis Open Source, Redis Software and Redis Cloud do not support [two connections mode]({{}}) or the `REDIRECT` option for [`CLIENT TRACKING`]({{}}). +Unlike Redis Open Source, Redis Software and Redis Cloud do not support [two connections mode](/content/develop/reference/client-side-caching.md#two-connections-mode) or the `REDIRECT` option for [`CLIENT TRACKING`](/content/commands/client-tracking.md). ## Change tracking_table_max_keys for a database @@ -50,7 +50,7 @@ The configuration setting `tracking-table-max-keys` determines the maximum numbe To change `tracking_table_max_keys` for a database in a Redis Software cluster: -- [`rladmin tune db`]({{}}): +- [`rladmin tune db`](/content/operate/rs/8.0/references/cli-utilities/rladmin/tune.md#tune-db): ```sh rladmin tune db db: tracking_table_max_keys 2000000 @@ -58,7 +58,7 @@ To change `tracking_table_max_keys` for a database in a Redis Software cluster: You can use the database name in place of `db:` in the preceding command. -- [Update database configuration]({{}}) REST API request: +- [Update database configuration](/content/operate/rs/8.0/references/rest-api/requests/bdbs/_index.md#put-bdbs) REST API request: ```sh PUT /v1/bdbs/ @@ -71,13 +71,13 @@ The cluster-wide option `default_tracking_table_max_keys_policy` determines the To change `default_tracking_table_max_keys_policy`, use one of the following methods: -- [`rladmin tune cluster`]({{}}) +- [`rladmin tune cluster`](/content/operate/rs/8.0/references/cli-utilities/rladmin/tune.md#tune-cluster) ```sh rladmin tune cluster default_tracking_table_max_keys_policy 2000000 ``` -- [Update cluster policy]({{}}) REST API request: +- [Update cluster policy](/content/operate/rs/8.0/references/rest-api/requests/cluster/policy.md#put-cluster-policy) REST API request: ```sh PUT /v1/cluster/policy diff --git a/content/operate/rs/8.0/references/compatibility/commands/_index.md b/content/operate/rs/8.0/references/compatibility/commands/_index.md index a421d2a431..8c4996fb74 100644 --- a/content/operate/rs/8.0/references/compatibility/commands/_index.md +++ b/content/operate/rs/8.0/references/compatibility/commands/_index.md @@ -13,7 +13,7 @@ weight: 30 url: '/operate/rs/8.0/references/compatibility/commands/' --- -Learn which Redis Open Source commands are compatible with Redis Software and [Redis Cloud]({{< relref "/operate/rc" >}}). +Learn which Redis Open Source commands are compatible with Redis Software and [Redis Cloud](/content/operate/rc/_index.md). Select a command group for more details about compatibility with standard and Active-Active Redis Software. diff --git a/content/operate/rs/8.0/references/compatibility/commands/cluster.md b/content/operate/rs/8.0/references/compatibility/commands/cluster.md index 077194275a..07deb10a5c 100644 --- a/content/operate/rs/8.0/references/compatibility/commands/cluster.md +++ b/content/operate/rs/8.0/references/compatibility/commands/cluster.md @@ -12,42 +12,42 @@ weight: 10 url: '/operate/rs/8.0/references/compatibility/commands/cluster/' --- -[Clustering in Redis Software]({{< relref "/operate/rs/8.0/databases/durability-ha/clustering" >}}) and [Redis Cloud]({{< relref "/operate/rc/databases/configuration/clustering" >}}) differs from the [Redis Open Source cluster]({{}}) and works with all standard Redis clients. +[Clustering in Redis Software](/content/operate/rs/8.0/databases/durability-ha/clustering.md) and [Redis Cloud](/content/operate/rc/databases/configuration/clustering.md) differs from the [Redis Open Source cluster](/content/operate/oss_and_stack/management/scaling.md) and works with all standard Redis clients. -Redis Software blocks most [cluster commands]({{< relref "/commands" >}}?group=cluster). If you try to use a blocked cluster command, it returns an error. +Redis Software blocks most [cluster commands](/commands?group=cluster). If you try to use a blocked cluster command, it returns an error. | Command | Redis
Software | Redis
Cloud | Notes | |:--------|:----------------------|:-----------------|:------| -| [ASKING]({{< relref "/commands/asking" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [CLUSTER ADDSLOTS]({{< relref "/commands/cluster-addslots" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [CLUSTER ADDSLOTSRANGE]({{< relref "/commands/cluster-addslotsrange" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [CLUSTER BUMPEPOCH]({{< relref "/commands/cluster-bumpepoch" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [CLUSTER COUNT-FAILURE-REPORTS]({{< relref "/commands/cluster-count-failure-reports" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [CLUSTER COUNTKEYSINSLOT]({{< relref "/commands/cluster-countkeysinslot" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [CLUSTER DELSLOTS]({{< relref "/commands/cluster-delslots" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [CLUSTER DELSLOTSRANGE]({{< relref "/commands/cluster-delslotsrange" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [CLUSTER FAILOVER]({{< relref "/commands/cluster-failover" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [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/8.0/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/8.0/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/8.0/databases/configure/oss-cluster-api" >}}). | -| [CLUSTER LINKS]({{< relref "/commands/cluster-links" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [CLUSTER MIGRATION]({{< relref "/commands/cluster-migration" >}}) | ❌ 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/8.0/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 | | -| [CLUSTER SAVECONFIG]({{< relref "/commands/cluster-saveconfig" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [CLUSTER SET-CONFIG-EPOCH]({{< relref "/commands/cluster-set-config-epoch" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [CLUSTER SETSLOT]({{< relref "/commands/cluster-setslot" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [CLUSTER SHARDS]({{< relref "/commands/cluster-shards" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Only supported with the [OSS cluster API]({{< relref "/operate/rs/8.0/databases/configure/oss-cluster-api" >}}). | -| [CLUSTER SLAVES]({{< relref "/commands/cluster-slaves" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | Deprecated as of Redis v5.0.0. | -| [CLUSTER SLOT-STATS]({{< relref "/commands/cluster-slot-stats" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [CLUSTER SLOTS]({{< relref "/commands/cluster-slots" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Only supported with the [OSS cluster API]({{< relref "/operate/rs/8.0/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 | | +| [ASKING](/content/commands/asking.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [CLUSTER ADDSLOTS](/content/commands/cluster-addslots.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [CLUSTER ADDSLOTSRANGE](/content/commands/cluster-addslotsrange.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [CLUSTER BUMPEPOCH](/content/commands/cluster-bumpepoch.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [CLUSTER COUNT-FAILURE-REPORTS](/content/commands/cluster-count-failure-reports.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [CLUSTER COUNTKEYSINSLOT](/content/commands/cluster-countkeysinslot.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [CLUSTER DELSLOTS](/content/commands/cluster-delslots.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [CLUSTER DELSLOTSRANGE](/content/commands/cluster-delslotsrange.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [CLUSTER FAILOVER](/content/commands/cluster-failover.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [CLUSTER FLUSHSLOTS](/content/commands/cluster-flushslots.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [CLUSTER FORGET](/content/commands/cluster-forget.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [CLUSTER GETKEYSINSLOT](/content/commands/cluster-getkeysinslot.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [CLUSTER HELP](/content/commands/cluster-help.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Only supported with the [OSS cluster API](/content/operate/rs/8.0/databases/configure/oss-cluster-api.md). | +| [CLUSTER INFO](/content/commands/cluster-info.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Only supported with the [OSS cluster API](/content/operate/rs/8.0/databases/configure/oss-cluster-api.md). | +| [CLUSTER KEYSLOT](/content/commands/cluster-keyslot.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Only supported with the [OSS cluster API](/content/operate/rs/8.0/databases/configure/oss-cluster-api.md). | +| [CLUSTER LINKS](/content/commands/cluster-links.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [CLUSTER MIGRATION](/content/commands/cluster-migration.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [CLUSTER MEET](/content/commands/cluster-meet.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [CLUSTER MYID](/content/commands/cluster-myid.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [CLUSTER MYSHARDID](/content/commands/cluster-myshardid.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [CLUSTER NODES](/content/commands/cluster-nodes.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Only supported with the [OSS cluster API](/content/operate/rs/8.0/databases/configure/oss-cluster-api.md). | +| [CLUSTER REPLICAS](/content/commands/cluster-replicas.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [CLUSTER REPLICATE](/content/commands/cluster-replicate.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [CLUSTER RESET](/content/commands/cluster-reset.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [CLUSTER SAVECONFIG](/content/commands/cluster-saveconfig.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [CLUSTER SET-CONFIG-EPOCH](/content/commands/cluster-set-config-epoch.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [CLUSTER SETSLOT](/content/commands/cluster-setslot.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [CLUSTER SHARDS](/content/commands/cluster-shards.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Only supported with the [OSS cluster API](/content/operate/rs/8.0/databases/configure/oss-cluster-api.md). | +| [CLUSTER SLAVES](/content/commands/cluster-slaves.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | Deprecated as of Redis v5.0.0. | +| [CLUSTER SLOT-STATS](/content/commands/cluster-slot-stats.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [CLUSTER SLOTS](/content/commands/cluster-slots.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Only supported with the [OSS cluster API](/content/operate/rs/8.0/databases/configure/oss-cluster-api.md). Deprecated as of Redis v7.0.0. | +| [READONLY](/content/commands/readonly.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [READWRITE](/content/commands/readwrite.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | diff --git a/content/operate/rs/8.0/references/compatibility/commands/connection.md b/content/operate/rs/8.0/references/compatibility/commands/connection.md index 91a2a0ac8c..a59e472af1 100644 --- a/content/operate/rs/8.0/references/compatibility/commands/connection.md +++ b/content/operate/rs/8.0/references/compatibility/commands/connection.md @@ -12,32 +12,32 @@ weight: 10 url: '/operate/rs/8.0/references/compatibility/commands/connection/' --- -The following tables show which Redis Open Source [connection management commands]({{< relref "/commands" >}}?group=connection) are compatible with standard and Active-Active databases in Redis Software and Redis Cloud. +The following tables show which Redis Open Source [connection management commands](/commands?group=connection) are compatible with standard and Active-Active databases in Redis Software and Redis Cloud. | Command | Redis
Software | Redis
Cloud | Notes | |:--------|:----------------------|:-----------------|:------| -| [AUTH]({{< relref "/commands/auth" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [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 Software clustering allows [multiple active proxies]({{< relref "/operate/rs/8.0/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 | | -| [CLIENT NO-EVICT]({{< relref "/commands/client-no-evict" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [CLIENT NO-TOUCH]({{< relref "/commands/client-no-touch" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [CLIENT PAUSE]({{< relref "/commands/client-pause" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [CLIENT REPLY]({{< relref "/commands/client-reply" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [CLIENT SETINFO]({{< relref "/commands/client-setinfo" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [CLIENT SETNAME]({{< relref "/commands/client-setname" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [CLIENT TRACKING]({{< relref "/commands/client-tracking" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [CLIENT TRACKINGINFO]({{< relref "/commands/client-trackinginfo" >}}) |✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [CLIENT UNBLOCK]({{< relref "/commands/client-unblock" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [CLIENT UNPAUSE]({{< relref "/commands/client-unpause" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [ECHO]({{< relref "/commands/echo" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [HELLO]({{< relref "/commands/hello" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [PING]({{< relref "/commands/ping" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [QUIT]({{< relref "/commands/quit" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Deprecated as of Redis v7.2.0. | -| [RESET]({{< relref "/commands/reset" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [SELECT]({{< relref "/commands/select" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | Redis Software does not support shared databases due to potential negative performance impacts and blocks any related commands. The `SELECT` command is supported solely for compatibility with Redis Open Source but does not perform any operations in Redis Software. | +| [AUTH](/content/commands/auth.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [CLIENT CACHING](/content/commands/client-caching.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [CLIENT GETNAME](/content/commands/client-getname.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [CLIENT GETREDIR](/content/commands/client-getredir.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [CLIENT ID](/content/commands/client-id.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Because Redis Software clustering allows [multiple active proxies](/content/operate/rs/8.0/databases/configure/proxy-policy.md), `CLIENT ID` cannot guarantee incremental IDs between clients that connect to different nodes under multi proxy policies. | +| [CLIENT INFO](/content/commands/client-info.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [CLIENT KILL](/content/commands/client-kill.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [CLIENT LIST](/content/commands/client-list.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [CLIENT NO-EVICT](/content/commands/client-no-evict.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [CLIENT NO-TOUCH](/content/commands/client-no-touch.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [CLIENT PAUSE](/content/commands/client-pause.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [CLIENT REPLY](/content/commands/client-reply.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [CLIENT SETINFO](/content/commands/client-setinfo.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [CLIENT SETNAME](/content/commands/client-setname.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [CLIENT TRACKING](/content/commands/client-tracking.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [CLIENT TRACKINGINFO](/content/commands/client-trackinginfo.md) |✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [CLIENT UNBLOCK](/content/commands/client-unblock.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [CLIENT UNPAUSE](/content/commands/client-unpause.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [ECHO](/content/commands/echo.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [HELLO](/content/commands/hello.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [PING](/content/commands/ping.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [QUIT](/content/commands/quit.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Deprecated as of Redis v7.2.0. | +| [RESET](/content/commands/reset.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [SELECT](/content/commands/select.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | Redis Software does not support shared databases due to potential negative performance impacts and blocks any related commands. The `SELECT` command is supported solely for compatibility with Redis Open Source but does not perform any operations in Redis Software. | diff --git a/content/operate/rs/8.0/references/compatibility/commands/data-types.md b/content/operate/rs/8.0/references/compatibility/commands/data-types.md index 64ccb7dd2d..6f50154210 100644 --- a/content/operate/rs/8.0/references/compatibility/commands/data-types.md +++ b/content/operate/rs/8.0/references/compatibility/commands/data-types.md @@ -20,264 +20,264 @@ The following tables show which Redis Open Source data type commands are compati | Command | Redis
Software | Redis
Cloud | Notes | |:--------|:----------------------|:-----------------|:------| -| [ARCOUNT]({{< relref "/commands/arcount" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [ARDEL]({{< relref "/commands/ardel" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [ARDELRANGE]({{< relref "/commands/ardelrange" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [ARGET]({{< relref "/commands/arget" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [ARGETRANGE]({{< relref "/commands/argetrange" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [ARGREP]({{< relref "/commands/argrep" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [ARINFO]({{< relref "/commands/arinfo" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [ARINSERT]({{< relref "/commands/arinsert" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [ARLASTITEMS]({{< relref "/commands/arlastitems" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [ARLEN]({{< relref "/commands/arlen" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [ARMGET]({{< relref "/commands/armget" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [ARMSET]({{< relref "/commands/armset" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [ARNEXT]({{< relref "/commands/arnext" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [AROP]({{< relref "/commands/arop" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [ARRING]({{< relref "/commands/arring" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [ARSCAN]({{< relref "/commands/arscan" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [ARSEEK]({{< relref "/commands/arseek" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [ARSET]({{< relref "/commands/arset" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [ARCOUNT](/content/commands/arcount.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [ARDEL](/content/commands/ardel.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [ARDELRANGE](/content/commands/ardelrange.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [ARGET](/content/commands/arget.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [ARGETRANGE](/content/commands/argetrange.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [ARGREP](/content/commands/argrep.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [ARINFO](/content/commands/arinfo.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [ARINSERT](/content/commands/arinsert.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [ARLASTITEMS](/content/commands/arlastitems.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [ARLEN](/content/commands/arlen.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [ARMGET](/content/commands/armget.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [ARMSET](/content/commands/armset.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [ARNEXT](/content/commands/arnext.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [AROP](/content/commands/arop.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [ARRING](/content/commands/arring.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [ARSCAN](/content/commands/arscan.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [ARSEEK](/content/commands/arseek.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [ARSET](/content/commands/arset.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | ## Bitmap commands | Command | Redis
Software | Redis
Cloud | Notes | |:--------|:----------------------|:-----------------|:------| -| [BITCOUNT]({{< relref "/commands/bitcount" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [BITFIELD]({{< relref "/commands/bitfield" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [BITFIELD_RO]({{< relref "/commands/bitfield_ro" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [BITOP]({{< relref "/commands/bitop" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [BITPOS]({{< relref "/commands/bitpos" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [GETBIT]({{< relref "/commands/getbit" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [SETBIT]({{< relref "/commands/setbit" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [BITCOUNT](/content/commands/bitcount.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [BITFIELD](/content/commands/bitfield.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [BITFIELD_RO](/content/commands/bitfield_ro.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [BITOP](/content/commands/bitop.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [BITPOS](/content/commands/bitpos.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [GETBIT](/content/commands/getbit.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [SETBIT](/content/commands/setbit.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | ## Geospatial indices commands | Command | Redis
Software | Redis
Cloud | Notes | |:--------|:----------------------|:-----------------|:------| -| [GEOADD]({{< relref "/commands/geoadd" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [GEODIST]({{< relref "/commands/geodist" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [GEOHASH]({{< relref "/commands/geohash" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [GEOPOS]({{< relref "/commands/geopos" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [GEORADIUS]({{< relref "/commands/georadius" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Deprecated as of Redis v6.2.0. | -| [GEORADIUS_RO]({{< relref "/commands/georadius_ro" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Deprecated as of Redis v6.2.0. | -| [GEORADIUSBYMEMBER]({{< relref "/commands/georadiusbymember" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Deprecated as of Redis v6.2.0. | -| [GEORADIUSBYMEMBER_RO]({{< relref "/commands/georadiusbymember_ro" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Deprecated as of Redis v6.2.0. | -| [GEOSEARCH]({{< relref "/commands/geosearch" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [GEOSEARCHSTORE]({{< relref "/commands/geosearchstore" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [GEOADD](/content/commands/geoadd.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [GEODIST](/content/commands/geodist.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [GEOHASH](/content/commands/geohash.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [GEOPOS](/content/commands/geopos.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [GEORADIUS](/content/commands/georadius.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Deprecated as of Redis v6.2.0. | +| [GEORADIUS_RO](/content/commands/georadius_ro.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Deprecated as of Redis v6.2.0. | +| [GEORADIUSBYMEMBER](/content/commands/georadiusbymember.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Deprecated as of Redis v6.2.0. | +| [GEORADIUSBYMEMBER_RO](/content/commands/georadiusbymember_ro.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Deprecated as of Redis v6.2.0. | +| [GEOSEARCH](/content/commands/geosearch.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [GEOSEARCHSTORE](/content/commands/geosearchstore.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | ## Hash commands | Command | Redis
Software | Redis
Cloud | Notes | |:--------|:----------------------|:-----------------|:------| -| [HDEL]({{< relref "/commands/hdel" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [HEXISTS]({{< relref "/commands/hexists" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [HEXPIRE]({{< relref "/commands/hexpire" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [HEXPIREAT]({{< relref "/commands/hexpireat" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [HEXPIRETIME]({{< relref "/commands/hexpiretime" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [HGET]({{< relref "/commands/hget" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [HGETALL]({{< relref "/commands/hgetall" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [HGETDEL]({{< relref "/commands/hgetdel" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [HGETEX]({{< relref "/commands/hgetex" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [HINCRBY]({{< relref "/commands/hincrby" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [HINCRBYFLOAT]({{< relref "/commands/hincrbyfloat" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [HKEYS]({{< relref "/commands/hkeys" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [HLEN]({{< relref "/commands/hlen" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [HMGET]({{< relref "/commands/hmget" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [HMSET]({{< relref "/commands/hmset" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Deprecated as of Redis v4.0.0. | -| [HPERSIST]({{< relref "/commands/hpersist" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [HPEXPIRE]({{< relref "/commands/hpexpire" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [HPEXPIREAT]({{< relref "/commands/hpexpireat" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [HPEXPIRETIME]({{< relref "/commands/hpexpiretime" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [HPTTL]({{< relref "/commands/hpttl" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [HRANDFIELD]({{< relref "/commands/hrandfield" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [HSCAN]({{< relref "/commands/hscan" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [HSET]({{< relref "/commands/hset" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [HSETEX]({{< relref "/commands/hsetex" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [HSETNX]({{< relref "/commands/hsetnx" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [HSTRLEN]({{< relref "/commands/hstrlen" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [HTTL]({{< relref "/commands/httl" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [HVALS]({{< relref "/commands/hvals" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [HDEL](/content/commands/hdel.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [HEXISTS](/content/commands/hexists.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [HEXPIRE](/content/commands/hexpire.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [HEXPIREAT](/content/commands/hexpireat.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [HEXPIRETIME](/content/commands/hexpiretime.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [HGET](/content/commands/hget.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [HGETALL](/content/commands/hgetall.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [HGETDEL](/content/commands/hgetdel.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [HGETEX](/content/commands/hgetex.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [HINCRBY](/content/commands/hincrby.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [HINCRBYFLOAT](/content/commands/hincrbyfloat.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [HKEYS](/content/commands/hkeys.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [HLEN](/content/commands/hlen.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [HMGET](/content/commands/hmget.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [HMSET](/content/commands/hmset.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Deprecated as of Redis v4.0.0. | +| [HPERSIST](/content/commands/hpersist.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [HPEXPIRE](/content/commands/hpexpire.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [HPEXPIREAT](/content/commands/hpexpireat.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [HPEXPIRETIME](/content/commands/hpexpiretime.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [HPTTL](/content/commands/hpttl.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [HRANDFIELD](/content/commands/hrandfield.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [HSCAN](/content/commands/hscan.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [HSET](/content/commands/hset.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [HSETEX](/content/commands/hsetex.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [HSETNX](/content/commands/hsetnx.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [HSTRLEN](/content/commands/hstrlen.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [HTTL](/content/commands/httl.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [HVALS](/content/commands/hvals.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | ## HyperLogLog commands | Command | Redis
Software | Redis
Cloud | Notes | |:--------|:----------------------|:-----------------|:------| -| [PFADD]({{< relref "/commands/pfadd" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [PFCOUNT]({{< relref "/commands/pfcount" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [PFDEBUG]({{< relref "/commands/pfdebug" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [PFMERGE]({{< relref "/commands/pfmerge" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [PFSELFTEST]({{< relref "/commands/pfselftest" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [PFADD](/content/commands/pfadd.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [PFCOUNT](/content/commands/pfcount.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [PFDEBUG](/content/commands/pfdebug.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [PFMERGE](/content/commands/pfmerge.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [PFSELFTEST](/content/commands/pfselftest.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | ## List commands | Command | Redis
Software | Redis
Cloud | Notes | |:--------|:----------------------|:-----------------|:------| -| [BLMOVE]({{< relref "/commands/blmove" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [BLMPOP]({{< relref "/commands/blmpop" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [BLPOP]({{< relref "/commands/blpop" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [BRPOP]({{< relref "/commands/brpop" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [BRPOPLPUSH]({{< relref "/commands/brpoplpush" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Deprecated as of Redis v6.2.0. | -| [LINDEX]({{< relref "/commands/lindex" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [LINSERT]({{< relref "/commands/linsert" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [LLEN]({{< relref "/commands/llen" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [LMOVE]({{< relref "/commands/lmove" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [LMPOP]({{< relref "/commands/lmpop" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [LPOP]({{< relref "/commands/lpop" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [LPOS]({{< relref "/commands/lpos" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [LPUSH]({{< relref "/commands/lpush" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [LPUSHX]({{< relref "/commands/lpushx" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [LRANGE]({{< relref "/commands/lrange" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [LREM]({{< relref "/commands/lrem" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [LSET]({{< relref "/commands/lset" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [LTRIM]({{< relref "/commands/ltrim" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [RPOP]({{< relref "/commands/rpop" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [RPOPLPUSH]({{< relref "/commands/rpoplpush" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Deprecated as of Redis v6.2.0. | -| [RPUSH]({{< relref "/commands/rpush" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [RPUSHX]({{< relref "/commands/rpushx" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [BLMOVE](/content/commands/blmove.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [BLMPOP](/content/commands/blmpop.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [BLPOP](/content/commands/blpop.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [BRPOP](/content/commands/brpop.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [BRPOPLPUSH](/content/commands/brpoplpush.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Deprecated as of Redis v6.2.0. | +| [LINDEX](/content/commands/lindex.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [LINSERT](/content/commands/linsert.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [LLEN](/content/commands/llen.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [LMOVE](/content/commands/lmove.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [LMPOP](/content/commands/lmpop.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [LPOP](/content/commands/lpop.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [LPOS](/content/commands/lpos.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [LPUSH](/content/commands/lpush.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [LPUSHX](/content/commands/lpushx.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [LRANGE](/content/commands/lrange.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [LREM](/content/commands/lrem.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [LSET](/content/commands/lset.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [LTRIM](/content/commands/ltrim.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [RPOP](/content/commands/rpop.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [RPOPLPUSH](/content/commands/rpoplpush.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Deprecated as of Redis v6.2.0. | +| [RPUSH](/content/commands/rpush.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [RPUSHX](/content/commands/rpushx.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | ## Set commands | Command | Redis
Software | Redis
Cloud | Notes | |:--------|:----------------------|:-----------------|:------| -| [SADD]({{< relref "/commands/sadd" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [SCARD]({{< relref "/commands/scard" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [SDIFF]({{< relref "/commands/sdiff" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [SDIFFSTORE]({{< relref "/commands/sdiffstore" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [SINTER]({{< relref "/commands/sinter" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [SINTERCARD]({{< relref "/commands/sintercard" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [SINTERSTORE]({{< relref "/commands/sinterstore" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [SISMEMBER]({{< relref "/commands/sismember" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [SMEMBERS]({{< relref "/commands/smembers" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [SMISMEMBER]({{< relref "/commands/smismember" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [SMOVE]({{< relref "/commands/smove" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [SPOP]({{< relref "/commands/spop" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [SRANDMEMBER]({{< relref "/commands/srandmember" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [SREM]({{< relref "/commands/srem" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [SSCAN]({{< relref "/commands/sscan" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [SUNION]({{< relref "/commands/sunion" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [SUNIONSTORE]({{< relref "/commands/sunionstore" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [SADD](/content/commands/sadd.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [SCARD](/content/commands/scard.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [SDIFF](/content/commands/sdiff.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [SDIFFSTORE](/content/commands/sdiffstore.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [SINTER](/content/commands/sinter.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [SINTERCARD](/content/commands/sintercard.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [SINTERSTORE](/content/commands/sinterstore.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [SISMEMBER](/content/commands/sismember.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [SMEMBERS](/content/commands/smembers.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [SMISMEMBER](/content/commands/smismember.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [SMOVE](/content/commands/smove.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [SPOP](/content/commands/spop.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [SRANDMEMBER](/content/commands/srandmember.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [SREM](/content/commands/srem.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [SSCAN](/content/commands/sscan.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [SUNION](/content/commands/sunion.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [SUNIONSTORE](/content/commands/sunionstore.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | ## Sorted set commands | Command | Redis
Software | Redis
Cloud | Notes | |:--------|:----------------------|:-----------------|:------| -| [BZMPOP]({{< relref "/commands/bzmpop" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [BZPOPMAX]({{< relref "/commands/bzpopmax" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [BZPOPMIN]({{< relref "/commands/bzpopmin" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [ZADD]({{< relref "/commands/zadd" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [ZCARD]({{< relref "/commands/zcard" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [ZCOUNT]({{< relref "/commands/zcount" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [ZDIFF]({{< relref "/commands/zdiff" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [ZDIFFSTORE]({{< relref "/commands/zdiffstore" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [ZINCRBY]({{< relref "/commands/zincrby" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [ZINTER]({{< relref "/commands/zinter" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [ZINTERCARD]({{< relref "/commands/zintercard" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [ZINTERSTORE]({{< relref "/commands/zinterstore" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [ZLEXCOUNT]({{< relref "/commands/zlexcount" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [ZMPOP]({{< relref "/commands/zmpop" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [ZMSCORE]({{< relref "/commands/zmscore" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [ZPOPMAX]({{< relref "/commands/zpopmax" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [ZPOPMIN]({{< relref "/commands/zpopmin" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [ZRANDMEMBER]({{< relref "/commands/zrandmember" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [ZRANGE]({{< relref "/commands/zrange" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [ZRANGEBYLEX]({{< relref "/commands/zrangebylex" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Deprecated as of Redis v6.2.0. | -| [ZRANGEBYSCORE]({{< relref "/commands/zrangebyscore" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Deprecated as of Redis v6.2.0. | -| [ZRANGESTORE]({{< relref "/commands/zrangestore" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [ZRANK]({{< relref "/commands/zrank" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [ZREM]({{< relref "/commands/zrem" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [ZREMRANGEBYLEX]({{< relref "/commands/zremrangebylex" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [ZREMRANGEBYRANK]({{< relref "/commands/zremrangebyrank" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [ZREMRANGEBYSCORE]({{< relref "/commands/zremrangebyscore" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [ZREVRANGE]({{< relref "/commands/zrevrange" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Deprecated as of Redis v6.2.0. | -| [ZREVRANGEBYLEX]({{< relref "/commands/zrevrangebylex" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Deprecated as of Redis v6.2.0. | -| [ZREVRANGEBYSCORE]({{< relref "/commands/zrevrangebyscore" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Deprecated as of Redis v6.2.0. | -| [ZREVRANK]({{< relref "/commands/zrevrank" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [ZSCAN]({{< relref "/commands/zscan" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [ZSCORE]({{< relref "/commands/zscore" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [ZUNION]({{< relref "/commands/zunion" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [ZUNIONSTORE]({{< relref "/commands/zunionstore" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [BZMPOP](/content/commands/bzmpop.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [BZPOPMAX](/content/commands/bzpopmax.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [BZPOPMIN](/content/commands/bzpopmin.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [ZADD](/content/commands/zadd.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [ZCARD](/content/commands/zcard.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [ZCOUNT](/content/commands/zcount.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [ZDIFF](/content/commands/zdiff.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [ZDIFFSTORE](/content/commands/zdiffstore.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [ZINCRBY](/content/commands/zincrby.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [ZINTER](/content/commands/zinter.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [ZINTERCARD](/content/commands/zintercard.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [ZINTERSTORE](/content/commands/zinterstore.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [ZLEXCOUNT](/content/commands/zlexcount.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [ZMPOP](/content/commands/zmpop.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [ZMSCORE](/content/commands/zmscore.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [ZPOPMAX](/content/commands/zpopmax.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [ZPOPMIN](/content/commands/zpopmin.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [ZRANDMEMBER](/content/commands/zrandmember.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [ZRANGE](/content/commands/zrange.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [ZRANGEBYLEX](/content/commands/zrangebylex.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Deprecated as of Redis v6.2.0. | +| [ZRANGEBYSCORE](/content/commands/zrangebyscore.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Deprecated as of Redis v6.2.0. | +| [ZRANGESTORE](/content/commands/zrangestore.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [ZRANK](/content/commands/zrank.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [ZREM](/content/commands/zrem.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [ZREMRANGEBYLEX](/content/commands/zremrangebylex.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [ZREMRANGEBYRANK](/content/commands/zremrangebyrank.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [ZREMRANGEBYSCORE](/content/commands/zremrangebyscore.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [ZREVRANGE](/content/commands/zrevrange.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Deprecated as of Redis v6.2.0. | +| [ZREVRANGEBYLEX](/content/commands/zrevrangebylex.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Deprecated as of Redis v6.2.0. | +| [ZREVRANGEBYSCORE](/content/commands/zrevrangebyscore.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Deprecated as of Redis v6.2.0. | +| [ZREVRANK](/content/commands/zrevrank.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [ZSCAN](/content/commands/zscan.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [ZSCORE](/content/commands/zscore.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [ZUNION](/content/commands/zunion.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [ZUNIONSTORE](/content/commands/zunionstore.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | ## Stream commands | Command | Redis
Software | Redis
Cloud | Notes | |:--------|:----------------------|:-----------------|:------| -| [XACK]({{< relref "/commands/xack" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [XACKDEL]({{< relref "/commands/xackdel" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [XADD]({{< relref "/commands/xadd" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [XAUTOCLAIM]({{< relref "/commands/xautoclaim" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [XCLAIM]({{< relref "/commands/xclaim" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [XCFGSET]({{< relref "/commands/xcfgset" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [XDEL]({{< relref "/commands/xdel" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [XDELEX]({{< relref "/commands/xdelex" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [XGROUP]({{< relref "/commands/xgroup" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [XIDMPRECORD]({{< relref "/commands/xidmprecord" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [XINFO]({{< relref "/commands/xinfo" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [XLEN]({{< relref "/commands/xlen" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [XNACK]({{< relref "/commands/xnack" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [XPENDING]({{< relref "/commands/xpending" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [XRANGE]({{< relref "/commands/xrange" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [XREAD]({{< relref "/commands/xread" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [XREADGROUP]({{< relref "/commands/xreadgroup" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [XREVRANGE]({{< relref "/commands/xrevrange" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [XSETID]({{< relref "/commands/xsetid" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [XTRIM]({{< relref "/commands/xtrim" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [XACK](/content/commands/xack.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [XACKDEL](/content/commands/xackdel.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [XADD](/content/commands/xadd.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [XAUTOCLAIM](/content/commands/xautoclaim.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [XCLAIM](/content/commands/xclaim.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [XCFGSET](/content/commands/xcfgset.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [XDEL](/content/commands/xdel.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [XDELEX](/content/commands/xdelex.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [XGROUP](/content/commands/xgroup.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [XIDMPRECORD](/content/commands/xidmprecord.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [XINFO](/content/commands/xinfo.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [XLEN](/content/commands/xlen.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [XNACK](/content/commands/xnack.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [XPENDING](/content/commands/xpending.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [XRANGE](/content/commands/xrange.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [XREAD](/content/commands/xread.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [XREADGROUP](/content/commands/xreadgroup.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [XREVRANGE](/content/commands/xrevrange.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [XSETID](/content/commands/xsetid.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [XTRIM](/content/commands/xtrim.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | ## String commands | Command | Redis
Software | Redis
Cloud | Notes | |:--------|:----------------------|:-----------------|:------| -| [APPEND]({{< relref "/commands/append" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [DECR]({{< relref "/commands/decr" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [DECRBY]({{< relref "/commands/decrby" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [DELEX]({{< relref "/commands/delex" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [DIGEST]({{< relref "/commands/digest" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [GET]({{< relref "/commands/get" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [GETDEL]({{< relref "/commands/getdel" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [GETEX]({{< relref "/commands/getex" >}}) | ✅ Standard
✅ Active-Active\* | ✅ Standard
✅ Active-Active\* | \*Not supported for HyperLogLog. | -| [GETRANGE]({{< relref "/commands/getrange" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [GETSET]({{< relref "/commands/getset" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Deprecated as of Redis v6.2.0. | -| [INCR]({{< relref "/commands/incr" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [INCRBY]({{< relref "/commands/incrby" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [INCRBYFLOAT]({{< relref "/commands/incrbyfloat" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [INCREX]({{< relref "/commands/increx" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [LCS]({{< relref "/commands/lcs" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [MGET]({{< relref "/commands/mget" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [MSET]({{< relref "/commands/mset" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [MSETEX]({{< relref "/commands/msetex" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [MSETNX]({{< relref "/commands/msetnx" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [PSETEX]({{< relref "/commands/psetex" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [SET]({{< relref "/commands/set" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [SETEX]({{< relref "/commands/setex" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [SETNX]({{< relref "/commands/setnx" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [SETRANGE]({{< relref "/commands/setrange" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [APPEND](/content/commands/append.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [DECR](/content/commands/decr.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [DECRBY](/content/commands/decrby.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [DELEX](/content/commands/delex.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [DIGEST](/content/commands/digest.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [GET](/content/commands/get.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [GETDEL](/content/commands/getdel.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [GETEX](/content/commands/getex.md) | ✅ Standard
✅ Active-Active\* | ✅ Standard
✅ Active-Active\* | \*Not supported for HyperLogLog. | +| [GETRANGE](/content/commands/getrange.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [GETSET](/content/commands/getset.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Deprecated as of Redis v6.2.0. | +| [INCR](/content/commands/incr.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [INCRBY](/content/commands/incrby.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [INCRBYFLOAT](/content/commands/incrbyfloat.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [INCREX](/content/commands/increx.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [LCS](/content/commands/lcs.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [MGET](/content/commands/mget.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [MSET](/content/commands/mset.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [MSETEX](/content/commands/msetex.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [MSETNX](/content/commands/msetnx.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [PSETEX](/content/commands/psetex.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [SET](/content/commands/set.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [SETEX](/content/commands/setex.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [SETNX](/content/commands/setnx.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [SETRANGE](/content/commands/setrange.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | | STRALGO | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | Deprecated as of Redis v7.0.0. | -| [STRLEN]({{< relref "/commands/strlen" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [SUBSTR]({{< relref "/commands/substr" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | Deprecated as of Redis v2.0.0. | +| [STRLEN](/content/commands/strlen.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [SUBSTR](/content/commands/substr.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | Deprecated as of Redis v2.0.0. | ## Vector set commands | Command | Redis
Software | Redis
Cloud | Notes | |:--------|:----------------------|:-----------------|:------| -| [VADD]({{< relref "/commands/vadd" >}}) | ✅ Standard
❌ Active-Active | ✅ Standard
❌ Active-Active | | -| [VCARD]({{< relref "/commands/vcard" >}}) | ✅ Standard
❌ Active-Active | ✅ Standard
❌ Active-Active | | -| [VDIM]({{< relref "/commands/vdim" >}}) | ✅ Standard
❌ Active-Active | ✅ Standard
❌ Active-Active | | -| [VEMB]({{< relref "/commands/vemb" >}}) | ✅ Standard
❌ Active-Active | ✅ Standard
❌ Active-Active | | -| [VGETATTR]({{< relref "/commands/vgetattr" >}}) | ✅ Standard
❌ Active-Active | ✅ Standard
❌ Active-Active | | -| [VINFO]({{< relref "/commands/vinfo" >}}) | ✅ Standard
❌ Active-Active | ✅ Standard
❌ Active-Active | | -| [VISMEMBER]({{< relref "/commands/vismember" >}}) | ✅ Standard
❌ Active-Active | ✅ Standard
❌ Active-Active | | -| [VLINKS]({{< relref "/commands/vlinks" >}}) | ✅ Standard
❌ Active-Active | ✅ Standard
❌ Active-Active | | -| [VRANDMEMBER]({{< relref "/commands/vrandmember" >}}) | ✅ Standard
❌ Active-Active | ✅ Standard
❌ Active-Active | | -| [VRANGE]({{< relref "/commands/vrange" >}}) | ✅ Standard
❌ Active-Active | ✅ Standard
❌ Active-Active | | -| [VREM]({{< relref "/commands/vrem" >}}) | ✅ Standard
❌ Active-Active | ✅ Standard
❌ Active-Active | | -| [VSETATTR]({{< relref "/commands/vsetattr" >}}) | ✅ Standard
❌ Active-Active | ✅ Standard
❌ Active-Active | | -| [VSIM]({{< relref "/commands/vsim" >}}) | ✅ Standard
❌ Active-Active | ✅ Standard
❌ Active-Active | | +| [VADD](/content/commands/vadd.md) | ✅ Standard
❌ Active-Active | ✅ Standard
❌ Active-Active | | +| [VCARD](/content/commands/vcard.md) | ✅ Standard
❌ Active-Active | ✅ Standard
❌ Active-Active | | +| [VDIM](/content/commands/vdim.md) | ✅ Standard
❌ Active-Active | ✅ Standard
❌ Active-Active | | +| [VEMB](/content/commands/vemb.md) | ✅ Standard
❌ Active-Active | ✅ Standard
❌ Active-Active | | +| [VGETATTR](/content/commands/vgetattr.md) | ✅ Standard
❌ Active-Active | ✅ Standard
❌ Active-Active | | +| [VINFO](/content/commands/vinfo.md) | ✅ Standard
❌ Active-Active | ✅ Standard
❌ Active-Active | | +| [VISMEMBER](/content/commands/vismember.md) | ✅ Standard
❌ Active-Active | ✅ Standard
❌ Active-Active | | +| [VLINKS](/content/commands/vlinks.md) | ✅ Standard
❌ Active-Active | ✅ Standard
❌ Active-Active | | +| [VRANDMEMBER](/content/commands/vrandmember.md) | ✅ Standard
❌ Active-Active | ✅ Standard
❌ Active-Active | | +| [VRANGE](/content/commands/vrange.md) | ✅ Standard
❌ Active-Active | ✅ Standard
❌ Active-Active | | +| [VREM](/content/commands/vrem.md) | ✅ Standard
❌ Active-Active | ✅ Standard
❌ Active-Active | | +| [VSETATTR](/content/commands/vsetattr.md) | ✅ Standard
❌ Active-Active | ✅ Standard
❌ Active-Active | | +| [VSIM](/content/commands/vsim.md) | ✅ Standard
❌ Active-Active | ✅ Standard
❌ Active-Active | | diff --git a/content/operate/rs/8.0/references/compatibility/commands/generic.md b/content/operate/rs/8.0/references/compatibility/commands/generic.md index 2f9c34f781..aa6dbc580a 100644 --- a/content/operate/rs/8.0/references/compatibility/commands/generic.md +++ b/content/operate/rs/8.0/references/compatibility/commands/generic.md @@ -12,40 +12,40 @@ weight: 10 url: '/operate/rs/8.0/references/compatibility/commands/generic/' --- -The following table shows which Redis Open Source [key (generic) commands]({{< relref "/commands" >}}?group=generic) are compatible with standard and Active-Active databases in Redis Software and Redis Cloud. +The following table shows which Redis Open Source [key (generic) commands](/commands?group=generic) are compatible with standard and Active-Active databases in Redis Software and Redis Cloud. | Command | Redis
Software | Redis
Cloud | Notes | |:--------|:----------------------|:-----------------|:------| -| [COPY]({{< relref "/commands/copy" >}}) | ✅ Standard
✅ Active-Active\* | ✅ Standard
✅ Active-Active\* | For Active-Active or clustered databases, the source and destination keys must be in the same hash slot.

\*Not supported for stream consumer group info. | -| [DEL]({{< relref "/commands/del" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [DUMP]({{< relref "/commands/dump" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [EXISTS]({{< relref "/commands/exists" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [EXPIRE]({{< relref "/commands/expire" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [EXPIREAT]({{< relref "/commands/expireat" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [EXPIRETIME]({{< relref "/commands/expiretime" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [KEYS]({{< relref "/commands/keys" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [MIGRATE]({{< relref "/commands/migrate" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [MOVE]({{< relref "/commands/move" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | Redis Software does not support shared databases due to potential negative performance impacts and blocks any related commands. | -| [OBJECT ENCODING]({{< relref "/commands/object-encoding" >}}) | ✅ Standard
❌ Active-Active | ✅ Standard
❌ Active-Active | For Active-Active databases, use `CRDT.DEBUG ENCODING` instead. | -| [OBJECT FREQ]({{< relref "/commands/object-freq" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [OBJECT IDLETIME]({{< relref "/commands/object-idletime" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [OBJECT REFCOUNT]({{< relref "/commands/object-refcount" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [PERSIST]({{< relref "/commands/persist" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [PEXPIRE]({{< relref "/commands/pexpire" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [PEXPIREAT]({{< relref "/commands/pexpireat" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [PEXPIRETIME]({{< relref "/commands/pexpiretime" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [PTTL]({{< relref "/commands/pttl" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [RANDOMKEY]({{< relref "/commands/randomkey" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [RENAME]({{< relref "/commands/rename" >}}) | ✅ Standard
✅ Active-Active\* | ✅ Standard
✅ Active-Active\* | For Active-Active or clustered databases, the original key and new key must be in the same hash slot.

\*Not supported for stream consumer group info. | -| [RENAMENX]({{< relref "/commands/renamenx" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | For Active-Active or clustered databases, the original key and new key must be in the same hash slot. | -| [RESTORE]({{< relref "/commands/restore" >}}) | ✅ Standard
❌ Active-Active\* | ✅ Standard
❌ Active-Active\* | \*Only supported for module keys. | -| [SCAN]({{< relref "/commands/scan" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [SORT]({{< relref "/commands/sort" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [SORT_RO]({{< relref "/commands/sort_ro" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [TOUCH]({{< relref "/commands/touch" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [TTL]({{< relref "/commands/ttl" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [TYPE]({{< relref "/commands/type" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [UNLINK]({{< relref "/commands/unlink" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [WAIT]({{< relref "/commands/wait" >}}) | ✅ Standard
❌ Active-Active\* | ❌ Standard**
❌ Active-Active | \*For Active-Active databases, `WAIT` commands are supported for primary and replica shard replication. You can contact support to enable `WAIT` for local replicas only. `WAIT` is not supported for cross-instance replication.

\*\*`WAIT` commands are supported on Redis Cloud Flexible subscriptions. | -| [WAITAOF]({{< relref "/commands/waitaof" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [COPY](/content/commands/copy.md) | ✅ Standard
✅ Active-Active\* | ✅ Standard
✅ Active-Active\* | For Active-Active or clustered databases, the source and destination keys must be in the same hash slot.

\*Not supported for stream consumer group info. | +| [DEL](/content/commands/del.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [DUMP](/content/commands/dump.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [EXISTS](/content/commands/exists.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [EXPIRE](/content/commands/expire.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [EXPIREAT](/content/commands/expireat.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [EXPIRETIME](/content/commands/expiretime.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [KEYS](/content/commands/keys.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [MIGRATE](/content/commands/migrate.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [MOVE](/content/commands/move.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | Redis Software does not support shared databases due to potential negative performance impacts and blocks any related commands. | +| [OBJECT ENCODING](/content/commands/object-encoding.md) | ✅ Standard
❌ Active-Active | ✅ Standard
❌ Active-Active | For Active-Active databases, use `CRDT.DEBUG ENCODING` instead. | +| [OBJECT FREQ](/content/commands/object-freq.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [OBJECT IDLETIME](/content/commands/object-idletime.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [OBJECT REFCOUNT](/content/commands/object-refcount.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [PERSIST](/content/commands/persist.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [PEXPIRE](/content/commands/pexpire.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [PEXPIREAT](/content/commands/pexpireat.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [PEXPIRETIME](/content/commands/pexpiretime.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [PTTL](/content/commands/pttl.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [RANDOMKEY](/content/commands/randomkey.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [RENAME](/content/commands/rename.md) | ✅ Standard
✅ Active-Active\* | ✅ Standard
✅ Active-Active\* | For Active-Active or clustered databases, the original key and new key must be in the same hash slot.

\*Not supported for stream consumer group info. | +| [RENAMENX](/content/commands/renamenx.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | For Active-Active or clustered databases, the original key and new key must be in the same hash slot. | +| [RESTORE](/content/commands/restore.md) | ✅ Standard
❌ Active-Active\* | ✅ Standard
❌ Active-Active\* | \*Only supported for module keys. | +| [SCAN](/content/commands/scan.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [SORT](/content/commands/sort.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [SORT_RO](/content/commands/sort_ro.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [TOUCH](/content/commands/touch.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [TTL](/content/commands/ttl.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [TYPE](/content/commands/type.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [UNLINK](/content/commands/unlink.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [WAIT](/content/commands/wait.md) | ✅ Standard
❌ Active-Active\* | ❌ Standard**
❌ Active-Active | \*For Active-Active databases, `WAIT` commands are supported for primary and replica shard replication. You can contact support to enable `WAIT` for local replicas only. `WAIT` is not supported for cross-instance replication.

\*\*`WAIT` commands are supported on Redis Cloud Flexible subscriptions. | +| [WAITAOF](/content/commands/waitaof.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | diff --git a/content/operate/rs/8.0/references/compatibility/commands/pub-sub.md b/content/operate/rs/8.0/references/compatibility/commands/pub-sub.md index 44b16de790..45b979a0f2 100644 --- a/content/operate/rs/8.0/references/compatibility/commands/pub-sub.md +++ b/content/operate/rs/8.0/references/compatibility/commands/pub-sub.md @@ -12,20 +12,20 @@ weight: 10 url: '/operate/rs/8.0/references/compatibility/commands/pub-sub/' --- -The following table shows which Redis Open Source [pub/sub commands]({{< relref "/commands" >}}?group=pubsub) are compatible with standard and Active-Active databases in Redis Software and Redis Cloud. +The following table shows which Redis Open Source [pub/sub commands](/commands?group=pubsub) are compatible with standard and Active-Active databases in Redis Software and Redis Cloud. | Command | Redis
Software | Redis
Cloud | Notes | |:--------|:----------------------|:-----------------|:------| -| [PSUBSCRIBE]({{< relref "/commands/psubscribe" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [PUBLISH]({{< relref "/commands/publish" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [PUBSUB CHANNELS]({{< relref "/commands/pubsub-channels" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [PUBSUB NUMPAT]({{< relref "/commands/pubsub-numpat" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [PUBSUB NUMSUB]({{< relref "/commands/pubsub-numsub" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [PUBSUB SHARDCHANNELS]({{< relref "/commands/pubsub-shardchannels" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [PUBSUB SHARDNUMSUB]({{< relref "/commands/pubsub-shardnumsub" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [PUNSUBSCRIBE]({{< relref "/commands/punsubscribe" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [SPUBLISH]({{< relref "/commands/spublish" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [SSUBSCRIBE]({{< relref "/commands/ssubscribe" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [SUBSCRIBE]({{< relref "/commands/subscribe" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [SUNSUBSCRIBE]({{< relref "/commands/sunsubscribe" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [UNSUBSCRIBE]({{< relref "/commands/unsubscribe" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [PSUBSCRIBE](/content/commands/psubscribe.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [PUBLISH](/content/commands/publish.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [PUBSUB CHANNELS](/content/commands/pubsub-channels.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [PUBSUB NUMPAT](/content/commands/pubsub-numpat.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [PUBSUB NUMSUB](/content/commands/pubsub-numsub.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [PUBSUB SHARDCHANNELS](/content/commands/pubsub-shardchannels.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [PUBSUB SHARDNUMSUB](/content/commands/pubsub-shardnumsub.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [PUNSUBSCRIBE](/content/commands/punsubscribe.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [SPUBLISH](/content/commands/spublish.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [SSUBSCRIBE](/content/commands/ssubscribe.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [SUBSCRIBE](/content/commands/subscribe.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [SUNSUBSCRIBE](/content/commands/sunsubscribe.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [UNSUBSCRIBE](/content/commands/unsubscribe.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | diff --git a/content/operate/rs/8.0/references/compatibility/commands/scripting.md b/content/operate/rs/8.0/references/compatibility/commands/scripting.md index f8cbfed8a6..3228015c71 100644 --- a/content/operate/rs/8.0/references/compatibility/commands/scripting.md +++ b/content/operate/rs/8.0/references/compatibility/commands/scripting.md @@ -12,34 +12,34 @@ weight: 10 url: '/operate/rs/8.0/references/compatibility/commands/scripting/' --- -The following table shows which Redis Open Source [scripting and function commands]({{< relref "/commands" >}}?group=scripting) are compatible with standard and Active-Active databases in Redis Software and Redis Cloud. +The following table shows which Redis Open Source [scripting and function commands](/commands?group=scripting) are compatible with standard and Active-Active databases in Redis Software and Redis Cloud. ## Function commands | Command | Redis
Software | Redis
Cloud | Notes | |:--------|:----------------------|:-----------------|:------| -| [FCALL]({{< relref "/commands/fcall" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [FCALL_RO]({{< relref "/commands/fcall_ro" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [FUNCTION DELETE]({{< relref "/commands/function-delete" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [FUNCTION DUMP]({{< relref "/commands/function-dump" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [FUNCTION FLUSH]({{< relref "/commands/function-flush" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [FUNCTION HELP]({{< relref "/commands/function-help" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [FUNCTION KILL]({{< relref "/commands/function-kill" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [FUNCTION LIST]({{< relref "/commands/function-list" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [FUNCTION LOAD]({{< relref "/commands/function-load" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [FUNCTION RESTORE]({{< relref "/commands/function-restore" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [FUNCTION STATS]({{< relref "/commands/function-stats" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [FCALL](/content/commands/fcall.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [FCALL_RO](/content/commands/fcall_ro.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [FUNCTION DELETE](/content/commands/function-delete.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [FUNCTION DUMP](/content/commands/function-dump.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [FUNCTION FLUSH](/content/commands/function-flush.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [FUNCTION HELP](/content/commands/function-help.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [FUNCTION KILL](/content/commands/function-kill.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [FUNCTION LIST](/content/commands/function-list.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [FUNCTION LOAD](/content/commands/function-load.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [FUNCTION RESTORE](/content/commands/function-restore.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [FUNCTION STATS](/content/commands/function-stats.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | ## Scripting commands | Command | Redis
Software | Redis
Cloud | Notes | |:--------|:----------------------|:-----------------|:------| -| [EVAL]({{< relref "/commands/eval" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [EVAL_RO]({{< relref "/commands/eval_ro" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [EVALSHA]({{< relref "/commands/evalsha" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [EVALSHA_RO]({{< relref "/commands/evalsha_ro" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [SCRIPT DEBUG]({{< relref "/commands/script-debug" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [SCRIPT EXISTS]({{< relref "/commands/script-exists" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [SCRIPT FLUSH]({{< relref "/commands/script-flush" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [SCRIPT KILL]({{< relref "/commands/script-kill" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [SCRIPT LOAD]({{< relref "/commands/script-load" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [EVAL](/content/commands/eval.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [EVAL_RO](/content/commands/eval_ro.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [EVALSHA](/content/commands/evalsha.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [EVALSHA_RO](/content/commands/evalsha_ro.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [SCRIPT DEBUG](/content/commands/script-debug.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [SCRIPT EXISTS](/content/commands/script-exists.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [SCRIPT FLUSH](/content/commands/script-flush.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [SCRIPT KILL](/content/commands/script-kill.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [SCRIPT LOAD](/content/commands/script-load.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | diff --git a/content/operate/rs/8.0/references/compatibility/commands/server.md b/content/operate/rs/8.0/references/compatibility/commands/server.md index 8d359507ef..9d54b671b5 100644 --- a/content/operate/rs/8.0/references/compatibility/commands/server.md +++ b/content/operate/rs/8.0/references/compatibility/commands/server.md @@ -13,131 +13,131 @@ weight: 10 url: '/operate/rs/8.0/references/compatibility/commands/server/' --- -The following tables show which Redis Open Source [server management commands]({{< relref "/commands" >}}?group=server) are compatible with standard and Active-Active databases in Redis Software and Redis Cloud. +The following tables show which Redis Open Source [server management commands](/commands?group=server) are compatible with standard and Active-Active databases in Redis Software and Redis Cloud. ## Access control commands -Several access control list (ACL) commands are not available in Redis Software. Instead, you can manage access controls from the [Redis Software Cluster Manager UI]({{< relref "/operate/rs/8.0/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 Software. Instead, you can manage access controls from the [Redis Software Cluster Manager UI](/content/operate/rs/8.0/security/access-control/_index.md) and the [Redis Cloud console](/content/operate/rc/security/access-control/data-access-control/role-based-access-control.md). | Command | Redis
Software | Redis
Cloud | Notes | |:--------|:----------------------|:-----------------|:------| -| [ACL CAT]({{< relref "/commands/acl-cat" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Not supported for [scripts]({{}}). | -| [ACL DELUSER]({{< relref "/commands/acl-deluser" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [ACL DRYRUN]({{< relref "/commands/acl-dryrun" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Might reply with "unknown user" for LDAP users even if `AUTH` succeeds. | -| [ACL GENPASS]({{< relref "/commands/acl-genpass" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [ACL GETUSER]({{< relref "/commands/acl-getuser" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Not supported for [scripts]({{}}). | -| [ACL HELP]({{< relref "/commands/acl-help" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Not supported for [scripts]({{}}). | -| [ACL LIST]({{< relref "/commands/acl-list" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Not supported for [scripts]({{}}). | -| [ACL LOAD]({{< relref "/commands/acl-load" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [ACL LOG]({{< relref "/commands/acl-log" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [ACL SAVE]({{< relref "/commands/acl-save" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [ACL SETUSER]({{< relref "/commands/acl-setuser" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [ACL USERS]({{< relref "/commands/acl-users" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Not supported for [scripts]({{}}). | -| [ACL WHOAMI]({{< relref "/commands/acl-whoami" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Not supported for [scripts]({{}}). | +| [ACL CAT](/content/commands/acl-cat.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Not supported for [scripts](/content/develop/programmability/_index.md). | +| [ACL DELUSER](/content/commands/acl-deluser.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [ACL DRYRUN](/content/commands/acl-dryrun.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Might reply with "unknown user" for LDAP users even if `AUTH` succeeds. | +| [ACL GENPASS](/content/commands/acl-genpass.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [ACL GETUSER](/content/commands/acl-getuser.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Not supported for [scripts](/content/develop/programmability/_index.md). | +| [ACL HELP](/content/commands/acl-help.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Not supported for [scripts](/content/develop/programmability/_index.md). | +| [ACL LIST](/content/commands/acl-list.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Not supported for [scripts](/content/develop/programmability/_index.md). | +| [ACL LOAD](/content/commands/acl-load.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [ACL LOG](/content/commands/acl-log.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [ACL SAVE](/content/commands/acl-save.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [ACL SETUSER](/content/commands/acl-setuser.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [ACL USERS](/content/commands/acl-users.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Not supported for [scripts](/content/develop/programmability/_index.md). | +| [ACL WHOAMI](/content/commands/acl-whoami.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Not supported for [scripts](/content/develop/programmability/_index.md). | ## Configuration commands | Command | Redis
Software | 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/8.0/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/8.0/references/compatibility/config-settings" >}}) | +| [CONFIG GET](/content/commands/config-get.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | [Only supports a subset of configuration settings.](/content/operate/rs/8.0/references/compatibility/config-settings.md) | +| [CONFIG RESETSTAT](/content/commands/config-resetstat.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [CONFIG REWRITE](/content/commands/config-rewrite.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [CONFIG SET](/content/commands/config-set.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | [Only supports a subset of configuration settings.](/content/operate/rs/8.0/references/compatibility/config-settings.md) | ## General server commands | Command | Redis
Software | Redis
Cloud | Notes | |:--------|:----------------------|:-----------------|:------| -| [COMMAND]({{< relref "/commands/command" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [COMMAND COUNT]({{< relref "/commands/command-count" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [COMMAND DOCS]({{< relref "/commands/command-docs" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [COMMAND GETKEYS]({{< relref "/commands/command-getkeys" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [COMMAND GETKEYSANDFLAGS]({{< relref "/commands/command-getkeysandflags" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [COMMAND HELP]({{< relref "/commands/command-help" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [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/8.0/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/8.0/references/rest-api/requests/crdbs/flush" >}}). | -| [HOTKEYS GET]({{< relref "/commands/hotkeys-get" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [HOTKEYS HELP]({{< relref "/commands/hotkeys-help" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [HOTKEYS RESET]({{< relref "/commands/hotkeys-reset" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [HOTKEYS START]({{< relref "/commands/hotkeys-start" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [HOTKEYS STOP]({{< relref "/commands/hotkeys-stop" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [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 | | -| [TIME]({{< relref "/commands/time" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [COMMAND](/content/commands/command.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [COMMAND COUNT](/content/commands/command-count.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [COMMAND DOCS](/content/commands/command-docs.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [COMMAND GETKEYS](/content/commands/command-getkeys.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [COMMAND GETKEYSANDFLAGS](/content/commands/command-getkeysandflags.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [COMMAND HELP](/content/commands/command-help.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [COMMAND INFO](/content/commands/command-info.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [COMMAND LIST](/content/commands/command-list.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [DEBUG](/content/commands/debug.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [FLUSHALL](/content/commands/flushall.md) | ✅ Standard
❌ Active-Active\* | ✅ Standard
❌ Active-Active | \*Can use the [Active-Active flush API request](/content/operate/rs/8.0/references/rest-api/requests/crdbs/flush.md). | +| [FLUSHDB](/content/commands/flushdb.md) | ✅ Standard
❌ Active-Active\* | ✅ Standard
❌ Active-Active | \*Can use the [Active-Active flush API request](/content/operate/rs/8.0/references/rest-api/requests/crdbs/flush.md). | +| [HOTKEYS GET](/content/commands/hotkeys-get.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [HOTKEYS HELP](/content/commands/hotkeys-help.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [HOTKEYS RESET](/content/commands/hotkeys-reset.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [HOTKEYS START](/content/commands/hotkeys-start.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [HOTKEYS STOP](/content/commands/hotkeys-stop.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [LOLWUT](/content/commands/lolwut.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [SHUTDOWN](/content/commands/shutdown.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [SWAPDB](/content/commands/swapdb.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [TIME](/content/commands/time.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | ## Module commands -For Redis 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/8.0/references/rest-api/requests/modules" >}}). +For Redis Software, you can [manage Redis modules](/content/operate/oss_and_stack/stack-with-enterprise/install/_index.md) from the Cluster Manager UI or with [REST API requests](/content/operate/rs/8.0/references/rest-api/requests/modules/_index.md). -Redis Cloud manages modules for you and lets you [enable modules]({{< relref "/operate/rc/databases/create-database#modules" >}}) when you create a database. +Redis Cloud manages modules for you and lets you [enable modules](/content/operate/rc/databases/create-database/_index.md#modules) when you create a database. | Command | Redis
Software | Redis
Cloud | Notes | |:--------|:----------------------|:-----------------|:------| -| [MODULE HELP]({{< relref "/commands/module-help" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [MODULE LIST]({{< relref "/commands/module-list" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [MODULE LOAD]({{< relref "/commands/module-load" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [MODULE LOADEX]({{< relref "/commands/module-loadex" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [MODULE UNLOAD]({{< relref "/commands/module-unload" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [MODULE HELP](/content/commands/module-help.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [MODULE LIST](/content/commands/module-list.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [MODULE LOAD](/content/commands/module-load.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [MODULE LOADEX](/content/commands/module-loadex.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [MODULE UNLOAD](/content/commands/module-unload.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | ## Monitoring commands -Although Redis Software does not support certain monitoring commands, you can use the Cluster Manager UI to view Redis Software [metrics]({{< relref "/operate/rs/8.0/monitoring" >}}) and [logs]({{< relref "/operate/rs/8.0/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 Software does not support certain monitoring commands, you can use the Cluster Manager UI to view Redis Software [metrics](/content/operate/rs/8.0/monitoring/_index.md) and [logs](/content/operate/rs/8.0/clusters/logging/_index.md) or the Redis Cloud console to view Redis Cloud [metrics](/content/operate/rc/databases/monitor-performance.md) and [logs](/content/operate/rc/logs-reports/system-logs.md). | Command | Redis
Software | Redis
Cloud | Notes | |:--------|:----------------------|:-----------------|:------| -| [DBSIZE]({{< relref "/commands/dbsize" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [INFO]({{< relref "/commands/info" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | In Redis Software, `INFO` returns a different set of fields than Redis Open Source.
Not supported for [scripts]({{}}). | -| [LATENCY DOCTOR]({{< relref "/commands/latency-doctor" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [LATENCY GRAPH]({{< relref "/commands/latency-graph" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [LATENCY HELP]({{< relref "/commands/latency-help" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [LATENCY HISTOGRAM]({{< relref "/commands/latency-histogram" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [LATENCY HISTORY]({{< relref "/commands/latency-history" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [LATENCY LATEST]({{< relref "/commands/latency-latest" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [LATENCY RESET]({{< relref "/commands/latency-reset" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [MEMORY DOCTOR]({{< relref "/commands/memory-doctor" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [MEMORY HELP]({{< relref "/commands/memory-help" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Not supported for [scripts]({{}}) in Redis versions earlier than 7. | -| [MEMORY MALLOC-STATS]({{< relref "/commands/memory-malloc-stats" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [MEMORY PURGE]({{< relref "/commands/memory-purge" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [MEMORY STATS]({{< relref "/commands/memory-stats" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [MEMORY USAGE]({{< relref "/commands/memory-usage" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Not supported for [scripts]({{}}) in Redis versions earlier than 7. | -| [MONITOR]({{< relref "/commands/monitor" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [SLOWLOG GET]({{< relref "/commands/slowlog-get" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Not supported for [scripts]({{}}). | -| [SLOWLOG LEN]({{< relref "/commands/slowlog-len" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Not supported for [scripts]({{}}). | -| [SLOWLOG RESET]({{< relref "/commands/slowlog-reset" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Not supported for [scripts]({{}}). | +| [DBSIZE](/content/commands/dbsize.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [INFO](/content/commands/info.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | In Redis Software, `INFO` returns a different set of fields than Redis Open Source.
Not supported for [scripts](/content/develop/programmability/_index.md). | +| [LATENCY DOCTOR](/content/commands/latency-doctor.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [LATENCY GRAPH](/content/commands/latency-graph.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [LATENCY HELP](/content/commands/latency-help.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [LATENCY HISTOGRAM](/content/commands/latency-histogram.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [LATENCY HISTORY](/content/commands/latency-history.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [LATENCY LATEST](/content/commands/latency-latest.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [LATENCY RESET](/content/commands/latency-reset.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [MEMORY DOCTOR](/content/commands/memory-doctor.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [MEMORY HELP](/content/commands/memory-help.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Not supported for [scripts](/content/develop/programmability/_index.md) in Redis versions earlier than 7. | +| [MEMORY MALLOC-STATS](/content/commands/memory-malloc-stats.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [MEMORY PURGE](/content/commands/memory-purge.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [MEMORY STATS](/content/commands/memory-stats.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [MEMORY USAGE](/content/commands/memory-usage.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Not supported for [scripts](/content/develop/programmability/_index.md) in Redis versions earlier than 7. | +| [MONITOR](/content/commands/monitor.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [SLOWLOG GET](/content/commands/slowlog-get.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Not supported for [scripts](/content/develop/programmability/_index.md). | +| [SLOWLOG LEN](/content/commands/slowlog-len.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Not supported for [scripts](/content/develop/programmability/_index.md). | +| [SLOWLOG RESET](/content/commands/slowlog-reset.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Not supported for [scripts](/content/develop/programmability/_index.md). | ## Persistence commands -Data persistence and backup commands are not available in Redis Software. Instead, you can [manage data persistence]({{< relref "/operate/rs/8.0/databases/configure/database-persistence" >}}) and [backups]({{< relref "/operate/rs/8.0/databases/import-export/schedule-backups" >}}) from the Redis 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 Software. Instead, you can [manage data persistence](/content/operate/rs/8.0/databases/configure/database-persistence.md) and [backups](/content/operate/rs/8.0/databases/import-export/schedule-backups.md) from the Redis Software Cluster Manager UI and the [Redis Cloud console](/content/operate/rc/databases/view-edit-database.md#durability-section). | Command | Redis
Software | Redis
Cloud | Notes | |:--------|:----------------------|:-----------------|:------| -| [BGREWRITEAOF]({{< relref "/commands/bgrewriteaof" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [BGSAVE]({{< relref "/commands/bgsave" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [LASTSAVE]({{< relref "/commands/lastsave" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [SAVE]({{< relref "/commands/save" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [BGREWRITEAOF](/content/commands/bgrewriteaof.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [BGSAVE](/content/commands/bgsave.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [LASTSAVE](/content/commands/lastsave.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [SAVE](/content/commands/save.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | ## Replication commands -Redis Software automatically manages [replication]({{< relref "/operate/rs/8.0/databases/durability-ha/replication" >}}). +Redis Software automatically manages [replication](/content/operate/rs/8.0/databases/durability-ha/replication.md). | Command | Redis
Software | Redis
Cloud | Notes | |:--------|:----------------------|:-----------------|:------| -| [FAILOVER]({{< relref "/commands/failover" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [MIGRATE]({{< relref "/commands/migrate" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [PSYNC]({{< relref "/commands/psync" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [REPLCONF]({{< relref "/commands/replconf" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [REPLICAOF]({{< relref "/commands/replicaof" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [RESTORE-ASKING]({{< relref "/commands/restore-asking" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [ROLE]({{< relref "/commands/role" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | -| [SLAVEOF]({{< relref "/commands/slaveof" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | Deprecated as of Redis v5.0.0. | -| [SYNC]({{< relref "/commands/sync" >}}) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [FAILOVER](/content/commands/failover.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [MIGRATE](/content/commands/migrate.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [PSYNC](/content/commands/psync.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [REPLCONF](/content/commands/replconf.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [REPLICAOF](/content/commands/replicaof.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [RESTORE-ASKING](/content/commands/restore-asking.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [ROLE](/content/commands/role.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | +| [SLAVEOF](/content/commands/slaveof.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | Deprecated as of Redis v5.0.0. | +| [SYNC](/content/commands/sync.md) | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | | diff --git a/content/operate/rs/8.0/references/compatibility/commands/transactions.md b/content/operate/rs/8.0/references/compatibility/commands/transactions.md index 898b90fb9b..f35ed5f145 100644 --- a/content/operate/rs/8.0/references/compatibility/commands/transactions.md +++ b/content/operate/rs/8.0/references/compatibility/commands/transactions.md @@ -12,12 +12,12 @@ weight: 10 url: '/operate/rs/8.0/references/compatibility/commands/transactions/' --- -The following table shows which Redis Open Source [transaction commands]({{< relref "/commands" >}}?group=transactions) are compatible with standard and Active-Active databases in Redis Software and Redis Cloud. +The following table shows which Redis Open Source [transaction commands](/commands?group=transactions) are compatible with standard and Active-Active databases in Redis Software and Redis Cloud. | Command | Redis
Software | Redis
Cloud | Notes | |:--------|:----------------------|:-----------------|:------| -| [DISCARD]({{< relref "/commands/discard" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [EXEC]({{< relref "/commands/exec" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [MULTI]({{< relref "/commands/multi" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [UNWATCH]({{< relref "/commands/unwatch" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| [WATCH]({{< relref "/commands/watch" >}}) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [DISCARD](/content/commands/discard.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [EXEC](/content/commands/exec.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [MULTI](/content/commands/multi.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [UNWATCH](/content/commands/unwatch.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | +| [WATCH](/content/commands/watch.md) | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | diff --git a/content/operate/rs/8.0/references/compatibility/config-settings.md b/content/operate/rs/8.0/references/compatibility/config-settings.md index 064bde85ff..3e68efb538 100644 --- a/content/operate/rs/8.0/references/compatibility/config-settings.md +++ b/content/operate/rs/8.0/references/compatibility/config-settings.md @@ -12,7 +12,7 @@ weight: 50 url: '/operate/rs/8.0/references/compatibility/config-settings/' --- -Redis Software and [Redis Cloud]({{< relref "/operate/rc" >}}) only support a subset of [Redis Open Source configuration settings]({{}}). Using [`CONFIG GET`]({{< relref "/commands/config-get" >}}) or [`CONFIG SET`]({{< relref "/commands/config-set" >}}) with unsupported configuration settings returns an error. +Redis Software and [Redis Cloud](/content/operate/rc/_index.md) only support a subset of [Redis Open Source configuration settings](/content/operate/oss_and_stack/management/config.md). Using [`CONFIG GET`](/content/commands/config-get.md) or [`CONFIG SET`](/content/commands/config-set.md) with unsupported configuration settings returns an error. | Setting | Redis
Software | Redis
Cloud | Notes | |:--------|:----------------------|:-----------------|:------| @@ -34,7 +34,7 @@ Redis Software and [Redis Cloud]({{< relref "/operate/rc" >}}) only support a su | slowlog-max-len | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | Value must be between 128 and 1024. | | stream-node-max-bytes | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | | stream-node-max-entries | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | -| tracking-table-max-keys | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | For Redis Software, use an [update database configuration]({{}}) REST API request or [`rladmin tune db`]({{}}) to set `tracking_table_max_keys` instead. | +| tracking-table-max-keys | ❌ Standard
❌ Active-Active | ❌ Standard
❌ Active-Active | For Redis Software, use an [update database configuration](/content/operate/rs/references/rest-api/requests/bdbs/_index.md#put-bdbs) REST API request or [`rladmin tune db`](/content/operate/rs/8.0/references/cli-utilities/rladmin/tune.md#tune-db) to set `tracking_table_max_keys` instead. | | zset-max-listpack-entries | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | | zset-max-listpack-value | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | | zset-max-ziplist-entries | ✅ Standard
✅ Active-Active | ✅ Standard
✅ Active-Active | | diff --git a/content/operate/rs/8.0/references/compatibility/resp.md b/content/operate/rs/8.0/references/compatibility/resp.md index 4ccb1f05d0..4223a411ae 100644 --- a/content/operate/rs/8.0/references/compatibility/resp.md +++ b/content/operate/rs/8.0/references/compatibility/resp.md @@ -12,7 +12,7 @@ weight: 80 url: '/operate/rs/8.0/references/compatibility/resp/' --- -RESP (Redis Serialization Protocol) is the protocol that clients use to communicate with Redis databases. See the [RESP protocol specification]({{< relref "/develop/reference/protocol-spec" >}}) for more information. +RESP (Redis Serialization Protocol) is the protocol that clients use to communicate with Redis databases. See the [RESP protocol specification](/content/develop/reference/protocol-spec.md) for more information. ## Supported RESP versions @@ -20,9 +20,8 @@ RESP (Redis Serialization Protocol) is the protocol that clients use to communic - RESP3 is supported by Redis Software 7.2 and later. -{{}} -Redis Software versions that support RESP3 continue to support RESP2. -{{}} +> [!NOTE] +> Redis Software versions that support RESP3 continue to support RESP2. ## Enable RESP3 for a database {#enable-resp3} @@ -39,7 +38,7 @@ To use RESP3 with a Redis Software database: 1. Enable RESP3 support for your database (`enabled` by default): - - [`rladmin tune db`]({{< relref "/operate/rs/8.0/references/cli-utilities/rladmin/tune#tune-db" >}}): + - [`rladmin tune db`](/content/operate/rs/8.0/references/cli-utilities/rladmin/tune.md#tune-db): ```sh rladmin tune db db: resp3 enabled @@ -47,7 +46,7 @@ To use RESP3 with a Redis Software database: You can use the database name in place of `db:` in the preceding command. - - [Update database configuration]({{< relref "/operate/rs/8.0/references/rest-api/requests/bdbs#put-bdbs" >}}) REST API request: + - [Update database configuration](/content/operate/rs/8.0/references/rest-api/requests/bdbs/_index.md#put-bdbs) REST API request: ```sh PUT /v1/bdbs/ @@ -58,7 +57,7 @@ To use RESP3 with a Redis Software database: To deactivate RESP3 support for a database: -- [`rladmin tune db`]({{< relref "/operate/rs/8.0/references/cli-utilities/rladmin/tune#tune-db" >}}): +- [`rladmin tune db`](/content/operate/rs/8.0/references/cli-utilities/rladmin/tune.md#tune-db): ```sh rladmin tune db db: resp3 disabled @@ -66,7 +65,7 @@ To use RESP3 with a Redis Software database: You can use the database name in place of `db:` in the preceding command. -- [Update database configuration]({{< relref "/operate/rs/8.0/references/rest-api/requests/bdbs#put-bdbs" >}}) REST API request: +- [Update database configuration](/content/operate/rs/8.0/references/rest-api/requests/bdbs/_index.md#put-bdbs) REST API request: ```sh PUT /v1/bdbs/ @@ -75,9 +74,8 @@ To use RESP3 with a Redis Software database: When RESP3 is deactivated, connected clients that use RESP3 are disconnected from the database. -{{}} -You cannot use sharded pub/sub if you deactivate RESP3 support. When RESP3 is enabled, you can use sharded pub/sub with either RESP2 or RESP3. -{{}} +> [!NOTE] +> You cannot use sharded pub/sub if you deactivate RESP3 support. When RESP3 is enabled, you can use sharded pub/sub with either RESP2 or RESP3. ## Change default RESP3 option @@ -95,13 +93,13 @@ To change `resp3_default` to `disabled`, use one of the following methods: 1. Click **Save**. -- [`rladmin tune cluster`]({{< relref "/operate/rs/8.0/references/cli-utilities/rladmin/tune#tune-cluster" >}}) +- [`rladmin tune cluster`](/content/operate/rs/8.0/references/cli-utilities/rladmin/tune.md#tune-cluster) ```sh rladmin tune cluster resp3_default disabled ``` -- [Update cluster policy]({{< relref "/operate/rs/8.0/references/rest-api/requests/cluster/policy#put-cluster-policy" >}}) REST API request: +- [Update cluster policy](/content/operate/rs/8.0/references/rest-api/requests/cluster/policy.md#put-cluster-policy) REST API request: ```sh PUT /v1/cluster/policy diff --git a/content/operate/rs/8.0/references/memtier-benchmark.md b/content/operate/rs/8.0/references/memtier-benchmark.md index 9e99c27d8f..c615b812ad 100644 --- a/content/operate/rs/8.0/references/memtier-benchmark.md +++ b/content/operate/rs/8.0/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 Software and set up a cluster, see: -- [Redis Software quickstart]({{< relref "/operate/rs/8.0/installing-upgrading/quickstarts/redis-enterprise-software-quickstart" >}}) for a test installation -- [Install and upgrade]({{< relref "/operate/rs/8.0/installing-upgrading" >}}) for a production installation +- [Redis Software quickstart](/content/operate/rs/8.0/installing-upgrading/quickstarts/redis-enterprise-software-quickstart.md) for a test installation +- [Install and upgrade](/content/operate/rs/8.0/installing-upgrading/_index.md) 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/8.0/references/metrics/_index.md b/content/operate/rs/8.0/references/metrics/_index.md index 4a97dbd2e4..eeddcc68ab 100644 --- a/content/operate/rs/8.0/references/metrics/_index.md +++ b/content/operate/rs/8.0/references/metrics/_index.md @@ -15,21 +15,21 @@ url: '/operate/rs/8.0/references/metrics/' ## Cluster manager metrics -In the Redis Software 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/8.0/monitoring" >}}). +In the Redis Software 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](/content/operate/rs/8.0/monitoring/_index.md). {{The database metrics page.}} See the following topics for metrics definitions: -- [Database operations]({{< relref "/operate/rs/8.0/references/metrics/database-operations" >}}) for database metrics -- [Resource usage]({{< relref "/operate/rs/8.0/references/metrics/resource-usage" >}}) for resource and database usage metrics -- [Auto Tiering]({{< relref "/operate/rs/8.0/references/metrics/auto-tiering" >}}) for additional metrics for [Auto Tiering ]({{< relref "/operate/rs/8.0/databases/flash" >}}) databases +- [Database operations](/content/operate/rs/8.0/references/metrics/database-operations.md) for database metrics +- [Resource usage](/content/operate/rs/8.0/references/metrics/resource-usage.md) for resource and database usage metrics +- [Auto Tiering](/content/operate/rs/8.0/references/metrics/auto-tiering.md) for additional metrics for [Auto Tiering ](/content/operate/rs/8.0/databases/flash/_index.md) databases ## Prometheus metrics To collect and display metrics data from your databases and other cluster components, you can connect your [Prometheus](https://prometheus.io/) and [Grafana](https://grafana.com/) server to your Redis Software cluster. We recommend you use Prometheus and Grafana to view metrics history and trends. -See [Prometheus integration]({{< relref "/operate/rs/8.0/monitoring/get-started" >}}) to learn how to connect Prometheus and Grafana to your Redis Software database. +See [Prometheus integration](/content/operate/rs/8.0/monitoring/get-started.md) to learn how to connect Prometheus and Grafana to your Redis Software database. The new metrics stream engine that exposes the v2 Prometheus scraping endpoint at `https://:8070/v2` is generally available as of Redis Software version 8.0. This new engine exports all time-series metrics to external monitoring tools such as Grafana, DataDog, NewRelic, and Dynatrace using Prometheus. @@ -38,29 +38,29 @@ The new engine enables real-time monitoring, including full monitoring during ma For a list of available metrics, see the following references: -- [Prometheus metrics v1]({{}}) +- [Prometheus metrics v1](/content/operate/rs/references/metrics/prometheus-metrics-v1.md) -- [Prometheus metrics v2]({{}}) +- [Prometheus metrics v2](/content/operate/rs/8.0/references/metrics/prometheus-metrics-v2.md) -If you are already using the existing scraping endpoint for integration, follow [this guide]({{}}) to transition and try the new engine. It is possible to scrape both existing and new endpoints simultaneously, allowing advanced dashboard preparation and a smooth transition. +If you are already using the existing scraping endpoint for integration, follow [this guide](/content/operate/rs/8.0/references/metrics/prometheus-metrics-v1-to-v2.md) to transition and try the new engine. It is possible to scrape both existing and new endpoints simultaneously, allowing advanced dashboard preparation and a smooth transition. ## Limitations ### Shard limit -Metrics information is not shown for clusters with more than 128 shards. For large clusters, we recommend you use [Prometheus and Grafana]({{< relref "/operate/rs/8.0/monitoring/get-started" >}}) to view metrics. +Metrics information is not shown for clusters with more than 128 shards. For large clusters, we recommend you use [Prometheus and Grafana](/content/operate/rs/8.0/monitoring/get-started.md) to view metrics. ### Metrics not shown during shard migration -The following metrics are not measured during [shard migration]({{< relref "/operate/rs/8.0/databases/configure/replica-ha" >}}) when using the [internal monitoring systems]({{}}). If you view these metrics while resharding, the graph will be blank. +The following metrics are not measured during [shard migration](/content/operate/rs/8.0/databases/configure/replica-ha.md) when using the [internal monitoring systems](/content/operate/rs/8.0/monitoring/v1_monitoring.md). If you view these metrics while resharding, the graph will be blank. -- [Evicted objects/sec]({{< relref "/operate/rs/8.0/references/metrics/database-operations#evicted-objectssec" >}}) -- [Expired objects/sec]({{< relref "/operate/rs/8.0/references/metrics/database-operations#expired-objectssec" >}}) -- [Read misses/sec]({{< relref "/operate/rs/8.0/references/metrics/database-operations#read-missessec" >}}) -- [Write misses/sec]({{< relref "/operate/rs/8.0/references/metrics/database-operations#write-missessec" >}}) -- [Total keys]({{< relref "/operate/rs/8.0/references/metrics/database-operations#total-keys" >}}) -- [Incoming traffic]({{< relref "/operate/rs/8.0/references/metrics/resource-usage#incoming-traffic" >}}) -- [Outgoing traffic]({{< relref "/operate/rs/8.0/references/metrics/resource-usage#outgoing-traffic" >}}) -- [Used memory]({{< relref "/operate/rs/8.0/references/metrics/resource-usage#used-memory" >}}) +- [Evicted objects/sec](/content/operate/rs/8.0/references/metrics/database-operations.md#evicted-objectssec) +- [Expired objects/sec](/content/operate/rs/8.0/references/metrics/database-operations.md#expired-objectssec) +- [Read misses/sec](/content/operate/rs/8.0/references/metrics/database-operations.md#read-missessec) +- [Write misses/sec](/content/operate/rs/8.0/references/metrics/database-operations.md#write-missessec) +- [Total keys](/content/operate/rs/8.0/references/metrics/database-operations.md#total-keys) +- [Incoming traffic](/content/operate/rs/8.0/references/metrics/resource-usage.md#incoming-traffic) +- [Outgoing traffic](/content/operate/rs/8.0/references/metrics/resource-usage.md#outgoing-traffic) +- [Used memory](/content/operate/rs/8.0/references/metrics/resource-usage.md#used-memory) -This limitation does not apply to the new [metrics stream engine]({{}}). +This limitation does not apply to the new [metrics stream engine](/content/operate/rs/8.0/monitoring/metrics_stream_engine/_index.md). diff --git a/content/operate/rs/8.0/references/metrics/auto-tiering.md b/content/operate/rs/8.0/references/metrics/auto-tiering.md index a6590d6b5c..8ce5035423 100644 --- a/content/operate/rs/8.0/references/metrics/auto-tiering.md +++ b/content/operate/rs/8.0/references/metrics/auto-tiering.md @@ -11,7 +11,7 @@ weight: $weight url: '/operate/rs/8.0/references/metrics/auto-tiering/' --- -The following additional metrics for [Redis Flex and Auto Tiering ]({{< relref "/operate/rs/8.0/databases/flash" >}}) databases are available in the Redis Software Cluster Manager UI. +The following additional metrics for [Redis Flex and Auto Tiering ](/content/operate/rs/8.0/databases/flash/_index.md) databases are available in the Redis Software Cluster Manager UI. {{The database metrics page.}} @@ -27,13 +27,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/8.0/databases/durability-ha/replication" >}}). +Number of keys with values stored in flash, not including [replication](/content/operate/rs/8.0/databases/durability-ha/replication.md). **Components measured**: Database and Shard #### Values in RAM -Number of keys with values stored in RAM, not including [replication]({{< relref "/operate/rs/8.0/databases/durability-ha/replication" >}}). +Number of keys with values stored in RAM, not including [replication](/content/operate/rs/8.0/databases/durability-ha/replication.md). **Components measured**: Database and Shard @@ -87,7 +87,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/8.0/databases/durability-ha/replication" >}}) (if enabled). +Total size of data stored in RAM, including keys, values, overheads, and [replication](/content/operate/rs/8.0/databases/durability-ha/replication.md) (if enabled). **Components measured**: Database and Shard @@ -124,7 +124,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/8.0/references/metrics/database-operations#total-keys" >}}) * 2) + / ([total_keys](/content/operate/rs/8.0/references/metrics/database-operations.md#total-keys) * 2) - RoF average value size in RAM diff --git a/content/operate/rs/8.0/references/metrics/database-operations.md b/content/operate/rs/8.0/references/metrics/database-operations.md index 71ece0f8ab..a728831774 100644 --- a/content/operate/rs/8.0/references/metrics/database-operations.md +++ b/content/operate/rs/8.0/references/metrics/database-operations.md @@ -20,9 +20,9 @@ The following metrics are available in the Redis Software Cluster Manager UI. Number of objects evicted from the database per second. -Objects are evicted from the database according to the [eviction policy]({{< relref "/operate/rs/8.0/databases/memory-performance/eviction-policy" >}}). +Objects are evicted from the database according to the [eviction policy](/content/operate/rs/8.0/databases/memory-performance/eviction-policy.md). -Object information is not measured during [shard migration]({{< relref "/operate/rs/8.0/databases/configure/replica-ha" >}}). +Object information is not measured during [shard migration](/content/operate/rs/8.0/databases/configure/replica-ha.md). **Components measured**: Database and Shard @@ -30,7 +30,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/8.0/databases/configure/replica-ha" >}}). +Object information is not measured during [shard migration](/content/operate/rs/8.0/databases/configure/replica-ha.md). **Components measured**: Database and Shard @@ -44,7 +44,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/8.0/databases/configure/replica-ha" >}}). +Read misses are not measured during [shard migration](/content/operate/rs/8.0/databases/configure/replica-ha.md). **Components measured**: Database @@ -52,7 +52,7 @@ Read misses are not measured during [shard migration]({{< relref "/operate/rs/8. Number of [write operations](#writessec) per second on keys that do not exist. -Write misses are not measured during [shard migration]({{< relref "/operate/rs/8.0/databases/configure/replica-ha" >}}). +Write misses are not measured during [shard migration](/content/operate/rs/8.0/databases/configure/replica-ha.md). **Components measured**: Database and Shard @@ -92,7 +92,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/8.0/references/cli-utilities/redis-cli" >}}): +To find out which commands are read operations, run the following command with [`redis-cli`](/content/operate/rs/8.0/references/cli-utilities/redis-cli/_index.md): ```sh ACL CAT read @@ -104,7 +104,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/8.0/references/cli-utilities/redis-cli" >}}): +To find out which commands are write operations, run the following command with [`redis-cli`](/content/operate/rs/8.0/references/cli-utilities/redis-cli/_index.md): ```sh ACL CAT write @@ -114,17 +114,17 @@ ACL CAT write #### Pending writes min -Minimum number of write operations queued per [Active-Active]({{< relref "/operate/rs/8.0/databases/active-active" >}}) replica database. +Minimum number of write operations queued per [Active-Active](/content/operate/rs/8.0/databases/active-active/_index.md) replica database. #### Pending writes max -Maximum number of write operations queued per [Active-Active]({{< relref "/operate/rs/8.0/databases/active-active" >}}) replica database. +Maximum number of write operations queued per [Active-Active](/content/operate/rs/8.0/databases/active-active/_index.md) replica database. ### Other commands/sec Number of operations per second that are not [read operations](#readssec) or [write operations](#writessec). -Examples of other operations include [PING]({{< relref "/commands/ping" >}}), [AUTH]({{< relref "/commands/auth" >}}), and [INFO]({{< relref "/commands/info" >}}). +Examples of other operations include [PING](/content/commands/ping.md), [AUTH](/content/commands/auth.md), and [INFO](/content/commands/info.md). **Components measured**: Database @@ -132,9 +132,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/8.0/databases/durability-ha/replication" >}}) is enabled. +Does not include replicated keys, even if [replication](/content/operate/rs/8.0/databases/durability-ha/replication.md) is enabled. -Total keys is not measured during [shard migration]({{< relref "/operate/rs/8.0/databases/configure/replica-ha" >}}). +Total keys is not measured during [shard migration](/content/operate/rs/8.0/databases/configure/replica-ha.md). **Components measured**: Database diff --git a/content/operate/rs/8.0/references/metrics/prometheus-metrics-v1-to-v2.md b/content/operate/rs/8.0/references/metrics/prometheus-metrics-v1-to-v2.md index fb3385ce19..efe630adf8 100644 --- a/content/operate/rs/8.0/references/metrics/prometheus-metrics-v1-to-v2.md +++ b/content/operate/rs/8.0/references/metrics/prometheus-metrics-v1-to-v2.md @@ -15,7 +15,7 @@ tocEmbedHeaders: true url: '/operate/rs/8.0/references/metrics/prometheus-metrics-v1-to-v2/' --- -You can integrate Redis Software with Prometheus and tools such as [Grafana]({{}}), [Datadog]({{}}), [Dynatrace]({{}}), or [New Relic]({{}}) to create dashboards for important metrics. +You can integrate Redis Software with Prometheus and tools such as [Grafana](/content/integrate/prometheus-with-redis-enterprise/_index.md), [Datadog](/content/integrate/datadog-with-redis-enterprise/_index.md), [Dynatrace](/content/integrate/dynatrace-with-redis-enterprise/_index.md), or [New Relic](/content/integrate/new-relic-with-redis-enterprise/_index.md) to create dashboards for important metrics. As of Redis Software version 7.8.2, [PromQL (Prometheus Query Language)](https://prometheus.io/docs/prometheus/latest/querying/basics/) metrics are available. V1 metrics are deprecated but still available. @@ -39,6 +39,6 @@ scrape_configs: It is possible to scrape both v1 and v2 endpoints simultaneously during the transition period to prepare dashboards and ensure a smooth transition. -You can use the following tables to transition from v1 metrics to equivalent v2 PromQL. For a list of all available v2 metrics, see [Prometheus metrics v2]({{}}). +You can use the following tables to transition from v1 metrics to equivalent v2 PromQL. For a list of all available v2 metrics, see [Prometheus metrics v2](/content/operate/rs/8.0/references/metrics/prometheus-metrics-v2.md). {{}} diff --git a/content/operate/rs/8.0/references/metrics/prometheus-metrics-v1.md b/content/operate/rs/8.0/references/metrics/prometheus-metrics-v1.md index a372db77cf..aaca658d6e 100644 --- a/content/operate/rs/8.0/references/metrics/prometheus-metrics-v1.md +++ b/content/operate/rs/8.0/references/metrics/prometheus-metrics-v1.md @@ -15,8 +15,8 @@ tocEmbedHeaders: true url: '/operate/rs/8.0/references/metrics/prometheus-metrics-v1/' --- -You can integrate Redis Software with Prometheus and tools such as [Grafana]({{}}), [Datadog]({{}}), [Dynatrace]({{}}), or [New Relic]({{}}) to create dashboards for important metrics. +You can integrate Redis Software with Prometheus and tools such as [Grafana](/content/integrate/prometheus-with-redis-enterprise/_index.md), [Datadog](/content/integrate/datadog-with-redis-enterprise/_index.md), [Dynatrace](/content/integrate/dynatrace-with-redis-enterprise/_index.md), or [New Relic](/content/integrate/new-relic-with-redis-enterprise/_index.md) to create dashboards for important metrics. -As of Redis Software version 7.8.2, v1 metrics are deprecated but still available. For help transitioning from v1 metrics to v2 PromQL, see [Prometheus v1 metrics and equivalent v2 PromQL]({{}}). +As of Redis Software version 7.8.2, v1 metrics are deprecated but still available. For help transitioning from v1 metrics to v2 PromQL, see [Prometheus v1 metrics and equivalent v2 PromQL](/content/operate/rs/8.0/references/metrics/prometheus-metrics-v1-to-v2.md). {{}} diff --git a/content/operate/rs/8.0/references/metrics/prometheus-metrics-v2.md b/content/operate/rs/8.0/references/metrics/prometheus-metrics-v2.md index 482a38f99f..4c2ae91620 100644 --- a/content/operate/rs/8.0/references/metrics/prometheus-metrics-v2.md +++ b/content/operate/rs/8.0/references/metrics/prometheus-metrics-v2.md @@ -15,9 +15,9 @@ tocEmbedHeaders: true url: '/operate/rs/8.0/references/metrics/prometheus-metrics-v2/' --- -You can integrate Redis Software with Prometheus and tools such as [Grafana]({{}}), [Datadog]({{}}), [Dynatrace]({{}}), or [New Relic]({{}}) to create dashboards for important metrics. +You can integrate Redis Software with Prometheus and tools such as [Grafana](/content/integrate/prometheus-with-redis-enterprise/_index.md), [Datadog](/content/integrate/datadog-with-redis-enterprise/_index.md), [Dynatrace](/content/integrate/dynatrace-with-redis-enterprise/_index.md), or [New Relic](/content/integrate/new-relic-with-redis-enterprise/_index.md) to create dashboards for important metrics. -The v2 metrics in the following tables are available as of Redis Software version 7.8.0. For help transitioning from v1 metrics to v2 PromQL, see [Prometheus v1 metrics and equivalent v2 PromQL]({{}}). +The v2 metrics in the following tables are available as of Redis Software version 7.8.0. For help transitioning from v1 metrics to v2 PromQL, see [Prometheus v1 metrics and equivalent v2 PromQL](/content/operate/rs/8.0/references/metrics/prometheus-metrics-v1-to-v2.md). The v2 scraping endpoint also exposes metrics for `node_exporter`. For more information, see the [Prometheus node_exporter GitHub repository](https://github.com/prometheus/node_exporter). diff --git a/content/operate/rs/8.0/references/metrics/resource-usage.md b/content/operate/rs/8.0/references/metrics/resource-usage.md index 03b7ea1c55..b8e345c1e9 100644 --- a/content/operate/rs/8.0/references/metrics/resource-usage.md +++ b/content/operate/rs/8.0/references/metrics/resource-usage.md @@ -52,7 +52,7 @@ Remaining unused disk space. ## Memory ### Used memory -Total memory used by the database, including RAM, [Flash]({{< relref "/operate/rs/8.0/databases/flash" >}}) (if enabled), and [replication]({{< relref "/operate/rs/8.0/databases/durability-ha/replication" >}}) (if enabled). +Total memory used by the database, including RAM, [Flash](/content/operate/rs/8.0/databases/flash/_index.md) (if enabled), and [replication](/content/operate/rs/8.0/databases/durability-ha/replication.md) (if enabled). Used memory does not include: @@ -64,11 +64,11 @@ Used memory does not include: - A database snapshot process - AOF rewrite process -Used memory is not measured during [shard migration]({{< relref "/operate/rs/8.0/databases/configure/replica-ha" >}}). +Used memory is not measured during [shard migration](/content/operate/rs/8.0/databases/configure/replica-ha.md). -Additional factors for [Active-Active databases]({{}}): +Additional factors for [Active-Active databases](/content/operate/rs/8.0/databases/active-active/_index.md): -- By default, the [Active-Active replication backlog]({{}}), used for synchronization between clusters or regions, is set to 1% of the database size. +- By default, the [Active-Active replication backlog](/content/operate/rs/8.0/databases/active-active/manage.md#replication-backlog), used for synchronization between clusters or regions, 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. @@ -97,23 +97,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/8.0/databases/configure/replica-ha" >}}). +All incoming traffic is not measured during [shard migration](/content/operate/rs/8.0/databases/configure/replica-ha.md). **Components measured**: Cluster, Node and Database #### Incoming traffic compressed -Total incoming compressed traffic (in bytes/sec) per [Active-Active]({{< relref "/operate/rs/8.0/databases/active-active" >}}) replica database. +Total incoming compressed traffic (in bytes/sec) per [Active-Active](/content/operate/rs/8.0/databases/active-active/_index.md) replica database. #### Incoming traffic uncompressed -Total incoming uncompressed traffic (in bytes/sec) per [Active-Active]({{< relref "/operate/rs/8.0/databases/active-active" >}}) replica database. +Total incoming uncompressed traffic (in bytes/sec) per [Active-Active](/content/operate/rs/8.0/databases/active-active/_index.md) 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/8.0/databases/configure/replica-ha" >}}). +Outgoing traffic is not measured during [shard migration](/content/operate/rs/8.0/databases/configure/replica-ha.md). **Components measured**: Cluster, Node and Database diff --git a/content/operate/rs/8.0/references/rest-api/_index.md b/content/operate/rs/8.0/references/rest-api/_index.md index 18ef3e4a0e..2b9caed31f 100644 --- a/content/operate/rs/8.0/references/rest-api/_index.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/requests" >}}), organized by path -- Supported [objects]({{< relref "/operate/rs/8.0/references/rest-api/objects" >}}), both request and response -- Built-in roles and associated [permissions]({{< relref "/operate/rs/8.0/references/rest-api/permissions" >}}) -- [Redis Software REST API quick start]({{< relref "/operate/rs/8.0/references/rest-api/quick-start" >}}) with examples +- Supported [request endpoints](/content/operate/rs/8.0/references/rest-api/requests/_index.md), organized by path +- Supported [objects](/content/operate/rs/8.0/references/rest-api/objects/_index.md), both request and response +- Built-in roles and associated [permissions](/content/operate/rs/8.0/references/rest-api/permissions.md) +- [Redis Software REST API quick start](/content/operate/rs/8.0/references/rest-api/quick-start.md) with examples ## Authentication @@ -34,23 +34,23 @@ curl -u "demo@redislabs.com:password" \ https://localhost:9443/v1/bdbs ``` -For more examples, see the [Redis Software REST API quick start]({{< relref "/operate/rs/8.0/references/rest-api/quick-start" >}}). +For more examples, see the [Redis Software REST API quick start](/content/operate/rs/8.0/references/rest-api/quick-start.md). ### Permissions -By default, the admin user is authorized for access to all endpoints. Use [role-based access controls]({{< relref "/operate/rs/8.0/security/access-control" >}}) and [role permissions]({{< relref "/operate/rs/8.0/references/rest-api/permissions" >}}) to manage access. +By default, the admin user is authorized for access to all endpoints. Use [role-based access controls](/content/operate/rs/8.0/security/access-control/_index.md) and [role permissions](/content/operate/rs/8.0/references/rest-api/permissions.md) 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/8.0/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](/content/operate/rs/8.0/references/rest-api/permissions.md). ### Certificates -The Redis Software REST API uses [Self-signed certificates]({{< relref "/operate/rs/8.0/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 Software REST API uses [Self-signed certificates](/content/operate/rs/8.0/security/certificates/_index.md) 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 Software Docker image]({{< relref "/operate/rs/8.0/installing-upgrading/quickstarts/docker-quickstart" >}}), run the following command to start the Docker image with port 9443 exposed: +If you are using a [Redis Software Docker image](/content/operate/rs/8.0/installing-upgrading/quickstarts/docker-quickstart.md), 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/8.0/references/rest-api/requests/bdbs/" >}}) page documents POST requests for [version 1]({{< relref "/operate/rs/8.0/references/rest-api/requests/bdbs/#post-bdbs-v1" >}}) and [version 2]({{< relref "/operate/rs/8.0/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](/content/operate/rs/8.0/references/rest-api/requests/bdbs/_index.md) page documents POST requests for [version 1](/content/operate/rs/8.0/references/rest-api/requests/bdbs/_index.md#post-bdbs-v1) and [version 2](/content/operate/rs/8.0/references/rest-api/requests/bdbs/_index.md#post-bdbs-v2). ## Headers diff --git a/content/operate/rs/8.0/references/rest-api/objects/_index.md b/content/operate/rs/8.0/references/rest-api/objects/_index.md index 102bfeab9e..bd7ae10b15 100644 --- a/content/operate/rs/8.0/references/rest-api/objects/_index.md +++ b/content/operate/rs/8.0/references/rest-api/objects/_index.md @@ -12,7 +12,7 @@ weight: 40 url: '/operate/rs/8.0/references/rest-api/objects/' --- -Certain [REST API requests]({{< relref "/operate/rs/8.0/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](/content/operate/rs/8.0/references/rest-api/requests/_index.md) 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/8.0/references/rest-api/objects/alert.md b/content/operate/rs/8.0/references/rest-api/objects/alert.md index 9cbe720d21..17ee90a12e 100644 --- a/content/operate/rs/8.0/references/rest-api/objects/alert.md +++ b/content/operate/rs/8.0/references/rest-api/objects/alert.md @@ -13,7 +13,7 @@ url: '/operate/rs/8.0/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/8.0/references/rest-api/objects/bdb" >}}) or [node]({{< relref "/operate/rs/8.0/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](/content/operate/rs/8.0/references/rest-api/objects/bdb/_index.md) or [node](/content/operate/rs/8.0/references/rest-api/objects/node.md)), and the cluster's state determines whether the alerts turn on or off. Name | Type/Value | Description | Writable |-------|------------|-------------|----------| diff --git a/content/operate/rs/8.0/references/rest-api/objects/bdb/_index.md b/content/operate/rs/8.0/references/rest-api/objects/bdb/_index.md index e8646816c8..b62f2d8c91 100644 --- a/content/operate/rs/8.0/references/rest-api/objects/bdb/_index.md +++ b/content/operate/rs/8.0/references/rest-api/objects/bdb/_index.md @@ -39,13 +39,13 @@ An API object that represents a managed database in the cluster. | auto_shards_balancing_grace_period | integer (default: 120); Time to wait before auto sharding is initiated. This field is for future use and should not be changed. | | auto_upgrade | boolean (default: false); Upgrade the database automatically after a cluster upgrade | | avoid_nodes | array of strings; Cluster node UIDs to avoid when placing the database's shards and binding its endpoints | -| background_op | Deprecated as of Redis Software v7.8.2. Use [`GET /v1/actions/bdb/`]({{}}) instead.
{{}}[{
"status": string,
"name": string,
"error": object,
"progress": number
}, ...]{{}} (read-only); **progress**: Percent of completed steps in current operation | +| background_op | Deprecated as of Redis Software v7.8.2. Use [`GET /v1/actions/bdb/`](/content/operate/rs/8.0/references/rest-api/requests/actions/bdb.md) instead.
{{}}[{
"status": string,
"name": string,
"error": object,
"progress": number
}, ...]{{}} (read-only); **progress**: Percent of completed steps in current operation | | backup | boolean (default: false); Policy for periodic database backup | | backup_failure_reason | Reason of last failed backup process (read-only)
Values:
'no-permission'
'wrong-file-path'
'general-error' | | 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/8.0/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](/content/operate/rs/8.0/references/rest-api/objects/bdb/backup_location.md); 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 | @@ -68,17 +68,17 @@ 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/8.0/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/8.0/references/rest-api/objects/bdb/replica_sync" >}}) for more details.
Values:
'enabled'
**'disabled'**
'paused'
'stopped' | +| crdt_sources | array of [syncer_sources](/content/operate/rs/8.0/references/rest-api/objects/bdb/syncer_sources.md) 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](/content/operate/rs/8.0/references/rest-api/objects/bdb/replica_sync.md) for more details.
Values:
'enabled'
**'disabled'**
'paused'
'stopped' | | crdt_sync_connection_alarm_timeout_seconds | integer (default: 0); If the syncer takes longer than the specified number of seconds to connect to an Active-Active database, raise a connection alarm | | 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/8.0/references/rest-api/objects/bdb/snapshot_policy" >}}) must be provided
Values:
**'disabled'**
'snapshot'
'aof' | -| dataset_import_sources | [complex object]({{< relref "/operate/rs/8.0/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/8.0/security/audit-events" >}}) | +| data_persistence | Database on-disk persistence policy. For snapshot persistence, a [snapshot_policy](/content/operate/rs/8.0/references/rest-api/objects/bdb/snapshot_policy.md) must be provided
Values:
**'disabled'**
'snapshot'
'aof' | +| dataset_import_sources | [complex object](/content/operate/rs/8.0/references/rest-api/objects/bdb/dataset_import_sources.md); 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](/content/operate/rs/8.0/security/audit-events.md) | | default_user | boolean (default: true); Allow/disallow a default user to connect | | disabled_commands | string (default: ); Redis commands which are disabled in db | | disconnect_clients_on_password_removal | boolean (default: false); Controls whether client connections using removed, revoked, or rotated passwords are actively disconnected | @@ -118,10 +118,10 @@ An API object that represents a managed database in the cluster. | memory_size | integer (default: 0); Database memory limit (0 is unlimited), expressed in bytes. | | metrics_export_all | boolean; Enable/disable exposing all shard metrics through the metrics exporter | | mkms | boolean (default: true); Are MKMS (Multi Key Multi Slots) commands supported? | -| module_list | {{}}[{
"module_id": string,
"module_args": [
u'string',
u'null'],
"module_name": string,
"semantic_version": string
}, ...]{{}} List of modules associated with the database

**module_id**: Module UID (deprecated; use `module_name` instead)
**module_args**: Module command-line arguments (deprecated; use the module objects for [search]({{}}), [timeseries]({{}}), and [probabilistic]({{}}) instead)
**module_name**: Module's name
**semantic_version**: Module's semantic version (deprecated; use `module_args` instead)

**module_id** and **semantic_version** are optional as of Redis Software v7.4.2 and deprecated as of v7.8.2.
**module_args** is deprecated as of Redis Software v8.0. | +| module_list | {{}}[{
"module_id": string,
"module_args": [
u'string',
u'null'],
"module_name": string,
"semantic_version": string
}, ...]{{}} List of modules associated with the database

**module_id**: Module UID (deprecated; use `module_name` instead)
**module_args**: Module command-line arguments (deprecated; use the module objects for [search](/content/operate/rs/8.0/references/rest-api/objects/bdb/search.md), [timeseries](/content/operate/rs/8.0/references/rest-api/objects/bdb/timeseries.md), and [probabilistic](/content/operate/rs/8.0/references/rest-api/objects/bdb/probabilistic.md) instead)
**module_name**: Module's name
**semantic_version**: Module's semantic version (deprecated; use `module_args` instead)

**module_id** and **semantic_version** are optional as of Redis Software v7.4.2 and deprecated as of v7.8.2.
**module_args** is deprecated as of Redis Software v8.0. | | mtls_allow_outdated_certs | boolean; An optional mTLS relaxation flag for certs verification | | mtls_allow_weak_hashing | boolean; An optional mTLS relaxation flag for certs verification | -| multi_commands_opt | If set to `batch`, it reduces the overhead of transaction management by batching multiple commands into a single transaction.
Values:
**disabled**: Turns off the optimization.
**batch**: Enables the optimization.
**auto**: Uses the [cluster's `multi_commands_opt` setting]({{}}). | +| multi_commands_opt | If set to `batch`, it reduces the overhead of transaction management by batching multiple commands into a single transaction.
Values:
**disabled**: Turns off the optimization.
**batch**: Enables the optimization.
**auto**: Uses the [cluster's `multi_commands_opt` setting](/content/operate/rs/8.0/references/rest-api/objects/cluster/_index.md). | | name | string; Database name. Only letters, numbers, or hyphens are valid characters. The name must start and end with a letter or number. | | oss_cluster | boolean (default: false); OSS Cluster mode option. Cannot be enabled with `'hash_slots_policy': 'legacy'` | | oss_cluster_api_preferred_endpoint_type | Endpoint type in the OSS cluster API
Values:
**‘ip’**
‘hostname’ | @@ -130,17 +130,17 @@ An API object that represents a managed database in the cluster. | partial_request_timeout_seconds | integer (default: 3); When a client connection sends a command, takes a server connection, and stops writing before the command is complete, it causes head-of-line blocking on this server connection. Such commands will time out after this many seconds and the client connection will be closed. | | port | integer; TCP port on which the database is available. Generated automatically if omitted and returned as 0 | | preemptive_drain_timeout_seconds | integer (default: 2); Timeout in seconds for preemptive drain of client connections before a shard is taken down | -| probabilistic | [complex object]({{< relref "/operate/rs/8.0/references/rest-api/objects/bdb/probabilistic" >}}); Configuration fields for probabilistic data structures. | +| probabilistic | [complex object](/content/operate/rs/8.0/references/rest-api/objects/bdb/probabilistic.md); Configuration fields for probabilistic data structures. | | proxy_policy | The default policy used for proxy binding to endpoints
Values:
'single'
'all-master-shards'
'all-nodes' | -| query_performance_factor | [complex object]({{< relref "/operate/rs/8.0/references/rest-api/objects/bdb/query_performance_factor" >}}); Configures query performance factor and related fields | +| query_performance_factor | [complex object](/content/operate/rs/8.0/references/rest-api/objects/bdb/query_performance_factor.md); Configures query performance factor and related fields | | rack_aware | boolean (default: false); Require the database to always replicate across multiple racks | | 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_read_only | boolean (default: false); If `true`, enables an Active-Passive setup where Replica Of databases only allow read operations. Only configurable during database creation and cannot be changed later. | | replica_sconns_on_demand | Reduces DMC internode connections by at least 50%, conserving sockets, file descriptors, and KEEPALIVE traffic.
Values:
**'enabled'**
'disabled' | -| replica_sources | array of [syncer_sources]({{< relref "/operate/rs/8.0/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/8.0/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](/content/operate/rs/8.0/references/rest-api/objects/bdb/syncer_sources.md) objects; Remote endpoints of database to sync from. See the 'bdb -\> replica_sources' section | +| [replica_sync](/content/operate/rs/8.0/references/rest-api/objects/bdb/replica_sync.md) | Enable, disable, or pause syncing from specified replica_sources
Values:
'enabled'
**'disabled'**
'paused'
'stopped' | | replica_sync_connection_alarm_timeout_seconds | integer (default: 0); If the syncer takes longer than the specified number of seconds to connect to a replica, raise a connection alarm | | replica_sync_dist | boolean; Enable/disable distributed syncer in replica-of | | replication | boolean (default: false); In-memory database replication mode | @@ -148,7 +148,7 @@ An API object that represents a managed database in the cluster. | resp3 | boolean (default: true); Enables or deactivates RESP3 support | | roles_permissions | {{}}[{
"role_uid": integer,
"redis_acl_uid": integer
}, ...]{{}} | | sched_policy | Controls how server-side connections are used when forwarding traffic to shards.
Values:
**cmp**: Closest to max_pipelined policy. Pick the connection with the most pipelined commands that has not reached the max_pipelined limit.
**mru**: Try to use most recently used connections.
**spread**: Try to use all connections.
**mnp**: Minimal pipeline policy. Pick the connection with the least pipelined commands. | -| search | [complex object]({{< relref "/operate/rs/8.0/references/rest-api/objects/bdb/search" >}}); Configuration fields for Redis Search. | +| search | [complex object](/content/operate/rs/8.0/references/rest-api/objects/bdb/search.md); Configuration fields for Redis Search. | | search_on_bigstore | boolean (default: false); Include search module in Redis on flash v2 (Flex databases) | | shard_block_crossslot_keys | boolean (default: false); In Lua scripts, prevent use of keys from different hash slots within the range owned by the current shard | | shard_block_foreign_keys | boolean (default: true); In Lua scripts, `foreign_keys` prevent use of keys which could reside in a different shard (foreign keys) | @@ -163,17 +163,17 @@ 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/8.0/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](/content/operate/rs/8.0/references/rest-api/objects/bdb/snapshot_policy.md) 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 Software v5.0.1) | -| [status]({{< relref "/operate/rs/8.0/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](/content/operate/rs/8.0/references/rest-api/objects/bdb/status.md) | 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 Software v5.0.1, use [replica_sync]({{< relref "/operate/rs/8.0/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 Software v5.0.1, use [replica_sync](/content/operate/rs/8.0/references/rest-api/objects/bdb/replica_sync.md) 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 Software 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’ | | syncer_mode | The syncer for replication between database instances is either on a single node (centralized) or on each node that has a proxy according to the proxy policy (distributed). (read-only)
Values:
'distributed'
'centralized' | | tags | {{}}[{
"key": string,
"value": string
}, ...]{{}} Optional list of tag objects attached to the database. Each tag requires a key-value pair.
**key**: Represents the tag's meaning and must be unique among tags (pattern does not allow special characters &,\<,>,")
**value**: The tag's value.| -| timeseries | [complex object]({{< relref "/operate/rs/8.0/references/rest-api/objects/bdb/timeseries" >}}); Configuration fields for timeseries. | +| timeseries | [complex object](/content/operate/rs/8.0/references/rest-api/objects/bdb/timeseries.md); Configuration fields for timeseries. | | tls_mode | Require TLS-authenticated and encrypted connections to the database
Values:
'enabled'
**'disabled'**
'replica_ssl' | | tracking_table_max_keys | integer; The client-side caching invalidation table size. 0 makes the cache unlimited. | | traffic_manually_disabled | boolean; Whether traffic was manually turned off using the stop_traffic API (read-only) | diff --git a/content/operate/rs/8.0/references/rest-api/objects/bdb/backup_location.md b/content/operate/rs/8.0/references/rest-api/objects/bdb/backup_location.md index 3eaaf36915..f573ef3410 100644 --- a/content/operate/rs/8.0/references/rest-api/objects/bdb/backup_location.md +++ b/content/operate/rs/8.0/references/rest-api/objects/bdb/backup_location.md @@ -66,7 +66,7 @@ You can also connect to a storage service that uses the S3 protocol but is not h To connect to an S3-compatible storage location: -1. Configure the S3 URL with [`rladmin cluster config`]({{}}): +1. Configure the S3 URL with [`rladmin cluster config`](/content/operate/rs/8.0/references/cli-utilities/rladmin/cluster/config.md): ```sh rladmin cluster config s3_url @@ -103,9 +103,8 @@ To connect to an S3-compatible storage location: | sas_token | string | Token to authenticate with shared access signature | | subdir | string | Path to the backup directory in the Blob Storage container (optional) | -{{}} -`account_key` and `sas_token` are mutually exclusive -{{}} +> [!NOTE] +> `account_key` and `sas_token` are mutually exclusive ### NAS/Local Storage diff --git a/content/operate/rs/8.0/references/rest-api/objects/bdb/dataset_import_sources.md b/content/operate/rs/8.0/references/rest-api/objects/bdb/dataset_import_sources.md index 0795b11733..e6ba80713f 100644 --- a/content/operate/rs/8.0/references/rest-api/objects/bdb/dataset_import_sources.md +++ b/content/operate/rs/8.0/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/8.0/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](/content/operate/rs/8.0/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. @@ -71,7 +71,7 @@ You can also connect to a storage service that uses the S3 protocol but is not h To connect to an S3-compatible storage location: -1. Configure the S3 URL with [`rladmin cluster config`]({{}}): +1. Configure the S3 URL with [`rladmin cluster config`](/content/operate/rs/8.0/references/cli-utilities/rladmin/cluster/config.md): ```sh rladmin cluster config s3_url @@ -110,9 +110,8 @@ To connect to an S3-compatible storage location: | sas_token | string | Token to authenticate with shared access signature | | subdir | string | Path to the backup directory in the Blob Storage container (optional) | -{{}} -`account_key` and `sas_token` are mutually exclusive -{{}} +> [!NOTE] +> `account_key` and `sas_token` are mutually exclusive ### NAS/Local Storage diff --git a/content/operate/rs/8.0/references/rest-api/objects/bdb/query_performance_factor.md b/content/operate/rs/8.0/references/rest-api/objects/bdb/query_performance_factor.md index 67bb2babc9..36d0e917b2 100644 --- a/content/operate/rs/8.0/references/rest-api/objects/bdb/query_performance_factor.md +++ b/content/operate/rs/8.0/references/rest-api/objects/bdb/query_performance_factor.md @@ -11,7 +11,7 @@ weight: $weight url: '/operate/rs/8.0/references/rest-api/objects/bdb/query_performance_factor/' --- -Configures [query performance factor]({{}}) and related fields. +Configures [query performance factor](/content/operate/oss_and_stack/stack-with-enterprise/search/query-performance-factor.md) and related fields. | Field | Type/Value | Description | |-------|------------|-------------| diff --git a/content/operate/rs/8.0/references/rest-api/objects/bdb/replica_sources_status.md b/content/operate/rs/8.0/references/rest-api/objects/bdb/replica_sources_status.md index 012e0a1ac7..9787851936 100644 --- a/content/operate/rs/8.0/references/rest-api/objects/bdb/replica_sources_status.md +++ b/content/operate/rs/8.0/references/rest-api/objects/bdb/replica_sources_status.md @@ -11,7 +11,7 @@ weight: $weight url: '/operate/rs/8.0/references/rest-api/objects/bdb/replica_sources_status/' --- -The `replica_sources` status field relates to the [Replica Of]({{< relref "/operate/rs/8.0/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](/content/operate/rs/8.0/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/8.0/references/rest-api/objects/bdb/replica_sync.md b/content/operate/rs/8.0/references/rest-api/objects/bdb/replica_sync.md index cee32e2fa7..453ea0fe86 100644 --- a/content/operate/rs/8.0/references/rest-api/objects/bdb/replica_sync.md +++ b/content/operate/rs/8.0/references/rest-api/objects/bdb/replica_sync.md @@ -12,9 +12,9 @@ weight: $weight url: '/operate/rs/8.0/references/rest-api/objects/bdb/replica_sync/' --- -The BDB `replica_sync` field relates to the [Replica Of]({{< relref "/operate/rs/8.0/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](/content/operate/rs/8.0/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/8.0/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](/content/operate/rs/8.0/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/8.0/references/rest-api/objects/bootstrap/_index.md b/content/operate/rs/8.0/references/rest-api/objects/bootstrap/_index.md index 6cd0dc5ca6..09146b95da 100644 --- a/content/operate/rs/8.0/references/rest-api/objects/bootstrap/_index.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/objects/bootstrap/cluster_identity" >}}) object | Cluster to join or create | +| cluster | [cluster_identity](/content/operate/rs/8.0/references/rest-api/objects/bootstrap/cluster_identity.md) 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/8.0/references/rest-api/objects/bootstrap/credentials" >}}) object | Cluster admin credentials | +| credentials | [credentials](/content/operate/rs/8.0/references/rest-api/objects/bootstrap/credentials.md) object | Cluster admin credentials | | dns_suffixes | object | Explicit configuration of DNS suffixes
{{}} [{ "name": string, @@ -35,12 +35,12 @@ A bootstrap configuration object. | gossip_envoy_admin_port | integer, (range: 1024-65535) | Gossip envoy admin port (deprecated; this port is no longer used because gossip functionality is handled by the main envoy process on `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/8.0/references/rest-api/objects/bootstrap/node_identity" >}}) object | Node description | -| policy | [policy]({{< relref "/operate/rs/8.0/references/rest-api/objects/bootstrap/policy" >}}) object | Policy object (deprecated; use [`PUT /v1/cluster/policy`]({{< relref "/operate/rs/8.0/references/rest-api/requests/cluster/policy#put-cluster-policy" >}}) after cluster creation instead) | +| node | [node_identity](/content/operate/rs/8.0/references/rest-api/objects/bootstrap/node_identity.md) object | Node description | +| policy | [policy](/content/operate/rs/8.0/references/rest-api/objects/bootstrap/policy.md) object | Policy object (deprecated; use [`PUT /v1/cluster/policy`](/content/operate/rs/8.0/references/rest-api/requests/cluster/policy.md#put-cluster-policy) after cluster creation instead) | | 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 (deprecated as of Redis Software v7.8.6) | | retry_time | integer | Max waiting time between retries (in seconds) | -| user_defined_modules | array of [user_defined_module]({{< relref "/operate/rs/8.0/references/rest-api/objects/bootstrap/user_defined_module" >}}) objects | List of custom modules to download and install during bootstrap. Each node downloads and installs the modules independently. | +| user_defined_modules | array of [user_defined_module](/content/operate/rs/8.0/references/rest-api/objects/bootstrap/user_defined_module.md) objects | List of custom modules to download and install during bootstrap. Each node downloads and installs the modules independently. | | witness_disk | object | An API object that represents the Witness Disk bootstrap configuration | diff --git a/content/operate/rs/8.0/references/rest-api/objects/bootstrap/node_identity.md b/content/operate/rs/8.0/references/rest-api/objects/bootstrap/node_identity.md index 98eb335497..44f475fca2 100644 --- a/content/operate/rs/8.0/references/rest-api/objects/bootstrap/node_identity.md +++ b/content/operate/rs/8.0/references/rest-api/objects/bootstrap/node_identity.md @@ -14,8 +14,8 @@ url: '/operate/rs/8.0/references/rest-api/objects/bootstrap/node_identity/' | Name | Type/Value | Description | |------|------------|-------------| -| bigstore_driver | 'rocksdb' | Bigstore driver name or none (deprecated, use the [cluster object]({{< relref "/operate/rs/8.0/references/rest-api/objects/cluster" >}})'s `bigstore_driver` instead) | -| bigstore_enabled | boolean (default: false) | If `true`, then flash storage is enabled on this node for [Redis Flex and Auto Tiering]({{}}) databases. Configurable during [bootstrapping]({{}}). After bootstrapping, it is read-only. | -| identity | [identity]({{< relref "/operate/rs/8.0/references/rest-api/objects/bootstrap/identity" >}}) object | Node identity | -| limits | [limits]({{< relref "/operate/rs/8.0/references/rest-api/objects/bootstrap/limits" >}}) object | Node limits | -| paths | [paths]({{< relref "/operate/rs/8.0/references/rest-api/objects/bootstrap/paths" >}}) object | Storage paths object | +| bigstore_driver | 'rocksdb' | Bigstore driver name or none (deprecated, use the [cluster object](/content/operate/rs/8.0/references/rest-api/objects/cluster/_index.md)'s `bigstore_driver` instead) | +| bigstore_enabled | boolean (default: false) | If `true`, then flash storage is enabled on this node for [Redis Flex and Auto Tiering](/content/operate/rs/8.0/databases/flash/_index.md) databases. Configurable during [bootstrapping](/content/operate/rs/8.0/references/rest-api/requests/bootstrap/_index.md#post-bootstrap). After bootstrapping, it is read-only. | +| identity | [identity](/content/operate/rs/8.0/references/rest-api/objects/bootstrap/identity.md) object | Node identity | +| limits | [limits](/content/operate/rs/8.0/references/rest-api/objects/bootstrap/limits.md) object | Node limits | +| paths | [paths](/content/operate/rs/8.0/references/rest-api/objects/bootstrap/paths.md) object | Storage paths object | diff --git a/content/operate/rs/8.0/references/rest-api/objects/certificates.md b/content/operate/rs/8.0/references/rest-api/objects/certificates.md index 0a010c6a2a..db4f3f89c6 100644 --- a/content/operate/rs/8.0/references/rest-api/objects/certificates.md +++ b/content/operate/rs/8.0/references/rest-api/objects/certificates.md @@ -15,6 +15,6 @@ An API object that represents a certificate used by a Redis Software cluster. | Name | Type/Value | Description | |------|------------|-------------| -| name | "cm"
"api"
"mtls_trusted_ca"
"proxy"
"metrics_exporter"
"syncer"
"ldap_client"
"ccs_internode_encryption"
"data_internode_encryption"
"sso_service"
"sso_issuer" | Certificate type.
See the [certificates table]({{< relref "/operate/rs/8.0/security/certificates" >}}) for the list of cluster certificates and their descriptions. | +| name | "cm"
"api"
"mtls_trusted_ca"
"proxy"
"metrics_exporter"
"syncer"
"ldap_client"
"ccs_internode_encryption"
"data_internode_encryption"
"sso_service"
"sso_issuer" | Certificate type.
See the [certificates table](/content/operate/rs/8.0/security/certificates/_index.md) for the list of cluster certificates and their descriptions. | | certificate | string | The certificate in PEM format | | key | string | The private key in PEM format | diff --git a/content/operate/rs/8.0/references/rest-api/objects/cluster/_index.md b/content/operate/rs/8.0/references/rest-api/objects/cluster/_index.md index 89b67ce72c..09a4360c52 100644 --- a/content/operate/rs/8.0/references/rest-api/objects/cluster/_index.md +++ b/content/operate/rs/8.0/references/rest-api/objects/cluster/_index.md @@ -16,9 +16,9 @@ An API object that represents the cluster. | Name | Type/Value | Description | |------|------------|-------------| -| alert_settings | [alert_settings]({{< relref "/operate/rs/8.0/references/rest-api/objects/cluster/alert_settings" >}}) object | Cluster and node alert settings | -| availability_lag_tolerance_ms | integer (default: 100) | The maximum replication lag in milliseconds tolerated between source and replicas during [lag-aware database availability checks]({{}}). | -| bigstore_driver | "speedb"
"rocksdb" | Storage engine for [Redis Flex or Auto Tiering]({{}}) | +| alert_settings | [alert_settings](/content/operate/rs/8.0/references/rest-api/objects/cluster/alert_settings.md) object | Cluster and node alert settings | +| availability_lag_tolerance_ms | integer (default: 100) | The maximum replication lag in milliseconds tolerated between source and replicas during [lag-aware database availability checks](/content/operate/rs/8.0/monitoring/db-availability.md#lag-aware). | +| bigstore_driver | "speedb"
"rocksdb" | Storage engine for [Redis Flex or Auto Tiering](/content/operate/rs/8.0/databases/flash/_index.md) | | cluster_ssh_public_key | string | Cluster's autogenerated SSH public key | | client_maint_notifications | boolean (default: false) | Toggles sending client maintenance notifications about shard movements | | cm_port | integer, (range: 1024-65535) | UI HTTPS listening port | @@ -57,7 +57,7 @@ An API object that represents the cluster. | gossip_envoy_admin_port | integer, (range: 1024-65535) | Gossip envoy admin port (deprecated; this port is no longer used because gossip functionality is handled by the main envoy process on `envoy_admin_port`) | | handle_redirects | boolean (default: false) | Handle API HTTPS requests and redirect to the master node internally | | http_support | boolean (default: false) | Enable or turn off HTTP support | -| logrotate_settings | [logrotate_settings]({{}}) object | Settings for logrotate configuration | +| logrotate_settings | [logrotate_settings](/content/operate/rs/8.0/references/rest-api/objects/cluster/logrotate_settings.md) object | Settings for logrotate configuration | | mask_bdb_credentials | boolean (default: false) | If set to true, the BDB credentials will be masked in the BDB API responses | | metrics_auth | boolean (default: false) | If true, requires authentication for requests to the metrics exporter | | min_control_TLS_version | "1.2"
"1.3" | The minimum version of TLS protocol which is supported at the control path | @@ -66,7 +66,7 @@ An API object that represents the cluster. | mtls_authorized_subjects | array | {{}}[{
"CN": string,
"O": string,
"OU": [array of strings],
"L": string,
"ST": string,
"C": string
}, ...]{{}} A list of valid subjects used for additional certificate validations during TLS client authentication. All subject attributes are case-sensitive.
**Required subject fields**:
"CN" for Common Name
**Optional subject fields:**
"O" for Organization
"OU" for Organizational Unit (array of strings)
"L" for Locality (city)
"ST" for State/Province
"C" for 2-letter country code | | mtls_certificate_authentication | boolean | Require authentication of client certificates for mTLS connections to the cluster. The API_CA certificate should be configured as a prerequisite. | | mtls_client_cert_subject_validation_type | "disabled"
"san_cn"
"full_subject" | Enables additional certificate validations that further limit connections to clients with valid certificates during TLS client authentication.
Values:
**disabled**: Authenticates clients with valid certificates. No additional validations are enforced.
**san_cn**: A client certificate is valid only if its Common Name (CN) matches an entry in the list of valid subjects. Ignores other Subject attributes.
**full_subject**: A client certificate is valid only if its Subject attributes match an entry in the list of valid subjects. | -| multi_commands_opt | **"disabled"**
"batch"
"force_disabled" | Determines the default `multi_commands_opt` setting for databases in the cluster. If set to `batch`, it reduces the overhead of transaction management by batching multiple commands into a single transaction.
Values:
**disabled**: Turns off the optimization for all databases except those that override it on the [bdb level]({{}}). Default value.
**batch**: Enables the optimization on all databases except those that override it on the [bdb level]({{}}).
**force_disabled**: Disables the optimization for all databases, even those that override it on the [bdb level]({{}}). | +| multi_commands_opt | **"disabled"**
"batch"
"force_disabled" | Determines the default `multi_commands_opt` setting for databases in the cluster. If set to `batch`, it reduces the overhead of transaction management by batching multiple commands into a single transaction.
Values:
**disabled**: Turns off the optimization for all databases except those that override it on the [bdb level](/content/operate/rs/8.0/references/rest-api/objects/bdb/_index.md). Default value.
**batch**: Enables the optimization on all databases except those that override it on the [bdb level](/content/operate/rs/8.0/references/rest-api/objects/bdb/_index.md).
**force_disabled**: Disables the optimization for all databases, even those that override it on the [bdb level](/content/operate/rs/8.0/references/rest-api/objects/bdb/_index.md). | | name | string | Cluster's fully qualified domain name (read-only) | | options_method_forbidden | boolean (default: false) | Make OPTIONS http method forbidden over CNM HTTPS port. | | password_complexity | boolean (default: false) | Enforce password complexity policy | diff --git a/content/operate/rs/8.0/references/rest-api/objects/cluster/alert_settings.md b/content/operate/rs/8.0/references/rest-api/objects/cluster/alert_settings.md index e43f1b6bed..b635de7961 100644 --- a/content/operate/rs/8.0/references/rest-api/objects/cluster/alert_settings.md +++ b/content/operate/rs/8.0/references/rest-api/objects/cluster/alert_settings.md @@ -14,12 +14,12 @@ url: '/operate/rs/8.0/references/rest-api/objects/cluster/alert_settings/' | Name | Type/Value | Description | |------|------------|-------------| -| cluster_certs_about_to_expire | [cluster_alert_settings_with_threshold]({{< relref "/operate/rs/8.0/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](/content/operate/rs/8.0/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold.md) 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_rl_sw | boolean (default: false) | Some nodes in the cluster are running different versions of Redis Software | | cluster_internal_bdb | boolean (default: false) | Issues with internal cluster databases | -| cluster_license_about_to_expire | [cluster_alert_settings_with_threshold]({{}}) object | Cluster license will expire in x days. This alert is enabled by default. Its default threshold is 7 days before license expiration. | +| cluster_license_about_to_expire | [cluster_alert_settings_with_threshold](/content/operate/rs/8.0/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold.md) object | Cluster license will expire in x days. This alert is enabled by default. Its default threshold is 7 days before license expiration. | | cluster_multiple_nodes_down | boolean (default: false) | Multiple cluster nodes are down (this might cause data loss) | | cluster_node_joined | boolean (default: false) | New node joined the cluster | | cluster_node_remove_abort_completed | boolean (default: false) | Cancel node remove operation completed | @@ -30,15 +30,15 @@ url: '/operate/rs/8.0/references/rest-api/objects/cluster/alert_settings/' | cluster_ocsp_status_revoked | boolean (default: false) | OCSP certificate status is REVOKED | | cluster_ram_overcommit | boolean (default: false) | RAM committed to databases is larger than cluster total RAM | | cluster_too_few_nodes_for_replication | boolean (default: false) | Replication requires at least 2 nodes in the cluster | -| cluster_users_count_approaches_limit | [cluster_alert_settings_with_threshold]({{< relref "/operate/rs/8.0/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold" >}}) object | Number of users approaches the maximum limit of 32,000 users. This alert is enabled with a 90% threshold by default on new clusters. | +| cluster_users_count_approaches_limit | [cluster_alert_settings_with_threshold](/content/operate/rs/8.0/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold.md) object | Number of users approaches the maximum limit of 32,000 users. This alert is enabled with a 90% threshold by default on new clusters. | | 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/8.0/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/8.0/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](/content/operate/rs/8.0/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold.md) object | Node CPU utilization has reached the threshold value (% of the utilization limit) | +| node_ephemeral_storage | [cluster_alert_settings_with_threshold](/content/operate/rs/8.0/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold.md) 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/8.0/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](/content/operate/rs/8.0/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold.md) 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/8.0/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/8.0/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/8.0/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/8.0/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](/content/operate/rs/8.0/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold.md) object| Internal certificate on node will expire in x days | +| node_memory | [cluster_alert_settings_with_threshold](/content/operate/rs/8.0/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold.md) object | Node memory has reached the threshold value (% of the memory limit) | +| node_net_throughput | [cluster_alert_settings_with_threshold](/content/operate/rs/8.0/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold.md) object | Node network throughput has reached the threshold value (bytes/s) | +| node_persistent_storage | [cluster_alert_settings_with_threshold](/content/operate/rs/8.0/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold.md) object | Node persistent storage has reached the threshold value (% of the storage limit) | diff --git a/content/operate/rs/8.0/references/rest-api/objects/cluster_settings.md b/content/operate/rs/8.0/references/rest-api/objects/cluster_settings.md index ec789b85c1..9931e20946 100644 --- a/content/operate/rs/8.0/references/rest-api/objects/cluster_settings.md +++ b/content/operate/rs/8.0/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/8.0/security/audit-events" >}}) for new databases by default if set to true. | +| db_conns_auditing | boolean | [Audit connections](/content/operate/rs/8.0/security/audit-events.md) for new databases by default if set to true. | | default_bigstore_version | **`1`**
`2` | Determines the default value of `bigstore_version` for new databases with Redis version 7.4:
• `1` for Auto Tiering (Redis on Flash version 1). Default version.
• `2` for Redis Flex (Redis on Flash version 2) on databases that support it. Can only be used with the `speedb` driver. | | 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 | diff --git a/content/operate/rs/8.0/references/rest-api/objects/crdb/_index.md b/content/operate/rs/8.0/references/rest-api/objects/crdb/_index.md index bd8dfb53e8..fc424b4494 100644 --- a/content/operate/rs/8.0/references/rest-api/objects/crdb/_index.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/objects/crdb/database_config" >}}) object | Default database configuration applied to all instances in the CRDB object. In most cases, instances should use the same configuration. If you need to override `default_db_config` or add configuration values for specific instances, you can use `db_config` in individual [instance objects]({{< relref "/operate/rs/8.0/references/rest-api/objects/crdb/instance_info" >}}). For a list of which settings must be identical across all instances and which to set per instance, see the [CRDB database config object]({{}}) reference. | +| default_db_config| [CRDB database_config](/content/operate/rs/8.0/references/rest-api/objects/crdb/database_config.md) object | Default database configuration applied to all instances in the CRDB object. In most cases, instances should use the same configuration. If you need to override `default_db_config` or add configuration values for specific instances, you can use `db_config` in individual [instance objects](/content/operate/rs/8.0/references/rest-api/objects/crdb/instance_info.md). For a list of which settings must be identical across all instances and which to set per instance, see the [CRDB database config object](/content/operate/rs/8.0/references/rest-api/objects/crdb/database_config.md) reference. | | encryption | boolean | Encrypt communication | | featureset_version | integer | Active-Active database active FeatureSet version -| instances | array of [CRDB instance_info]({{< relref "/operate/rs/8.0/references/rest-api/objects/crdb/instance_info" >}}) objects | | +| instances | array of [CRDB instance_info](/content/operate/rs/8.0/references/rest-api/objects/crdb/instance_info.md) objects | | | local_databases | object | Mapping of instance IDs for local databases to local BDB IDs
{{}}[{ "bdb_uid": string, "id": integer diff --git a/content/operate/rs/8.0/references/rest-api/objects/crdb/database_config.md b/content/operate/rs/8.0/references/rest-api/objects/crdb/database_config.md index 26c7b5385b..3e3bde443e 100644 --- a/content/operate/rs/8.0/references/rest-api/objects/crdb/database_config.md +++ b/content/operate/rs/8.0/references/rest-api/objects/crdb/database_config.md @@ -13,9 +13,9 @@ url: '/operate/rs/8.0/references/rest-api/objects/crdb/database_config/' An object that represents the database configuration. This configuration object is used in two contexts within CRDB objects: -- As `default_db_config` in the main [CRDB object]({{< relref "/operate/rs/8.0/references/rest-api/objects/crdb" >}}) for settings that apply to all instances. In most cases, instances should use the same configuration. +- As `default_db_config` in the main [CRDB object](/content/operate/rs/8.0/references/rest-api/objects/crdb/_index.md) for settings that apply to all instances. In most cases, instances should use the same configuration. -- As `db_config` in individual [instance objects]({{< relref "/operate/rs/8.0/references/rest-api/objects/crdb/instance_info" >}}) to override `default_db_config` or add configuration values for specific instances. Use `db_config` only when an instance needs different settings than the default configuration. +- As `db_config` in individual [instance objects](/content/operate/rs/8.0/references/rest-api/objects/crdb/instance_info.md) to override `default_db_config` or add configuration values for specific instances. Use `db_config` only when an instance needs different settings than the default configuration. ## `default_db_config` settings @@ -38,7 +38,7 @@ The following fields don't break replication if they differ between instances, b | Name | Type/Value | Description | |------|------------|-------------| -| eviction_policy | **'noeviction'**
'allkeys-lru'
'allkeys-lfu'
'allkeys-random'
'volatile-lru'
'volatile-lfu'
'volatile-random'
'volatile-ttl' | Database memory eviction policy. See [eviction policy]({{< relref "/operate/rs/8.0/databases/memory-performance/eviction-policy" >}}) for more information. | +| eviction_policy | **'noeviction'**
'allkeys-lru'
'allkeys-lfu'
'allkeys-random'
'volatile-lru'
'volatile-lfu'
'volatile-random'
'volatile-ttl' | Database memory eviction policy. See [eviction policy](/content/operate/rs/8.0/databases/memory-performance/eviction-policy.md) for more information. | | memory_size | integer (default: 0) | Database memory size limit in bytes. 0 is unlimited. | | oss_cluster | boolean (default: false) | Enables OSS Cluster mode | | oss_cluster_api_preferred_ip_type | 'internal'
'external' | Indicates preferred IP type in OSS cluster API | @@ -55,16 +55,16 @@ The following fields don't break replication or cause future issues if they diff |------|------------|-------------| | aof_policy | **'appendfsync-every-sec'**
'appendfsync-always' | Policy for Append-Only File data persistence | | authentication_redis_pass | string | Redis AUTH password (deprecated as of Redis Software v7.2, replaced with multiple passwords feature in version 6.0.X) | -| data_persistence | 'disabled'
'snapshot'
**'aof'** | Database on-disk persistence policy. For snapshot persistence, a [snapshot_policy]({{< relref "/operate/rs/8.0/references/rest-api/objects/bdb/snapshot_policy" >}}) must be provided | +| data_persistence | 'disabled'
'snapshot'
**'aof'** | Database on-disk persistence policy. For snapshot persistence, a [snapshot_policy](/content/operate/rs/8.0/references/rest-api/objects/bdb/snapshot_policy.md) must be provided | | max_aof_file_size | integer | Maximum AOF file size in bytes | | max_aof_load_time | integer (default: 3600) | Maximum AOF reload time in seconds | | replication | boolean (default: true) | Database replication | -| replication_oom_threshold_percent | integer (range: 0-20) (default: 5) | Reserved memory buffer percentage below `maxmemory` that blocks client writes while allowing Active-Active replication. Requires Redis database version 8.4 or later. See [Replication OOM protection]({{}}) for more information. | -| snapshot_policy | array of [snapshot_policy]({{< relref "/operate/rs/8.0/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. | +| replication_oom_threshold_percent | integer (range: 0-20) (default: 5) | Reserved memory buffer percentage below `maxmemory` that blocks client writes while allowing Active-Active replication. Requires Redis database version 8.4 or later. See [Replication OOM protection](/content/operate/rs/8.0/databases/active-active/planning.md#replication-oom-protection) for more information. | +| snapshot_policy | array of [snapshot_policy](/content/operate/rs/8.0/references/rest-api/objects/bdb/snapshot_policy.md) 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. | ## Per-instance `db_config` settings -Set the following fields in an individual [instance]({{}})'s `db_config` because they are specific to that cluster's environment. +Set the following fields in an individual [instance](/content/operate/rs/8.0/references/rest-api/objects/crdb/instance_info.md)'s `db_config` because they are specific to that cluster's environment. | Name | Type/Value | Description | |------|------------|-------------| diff --git a/content/operate/rs/8.0/references/rest-api/objects/crdb/health_report/_index.md b/content/operate/rs/8.0/references/rest-api/objects/crdb/health_report/_index.md index c2a2b37d08..f801ff12d8 100644 --- a/content/operate/rs/8.0/references/rest-api/objects/crdb/health_report/_index.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/objects/crdb/health_report/health_report_configuration" >}}) objects | Stored database configurations | +| configurations | array of [health_report_configuration](/content/operate/rs/8.0/references/rest-api/objects/crdb/health_report/health_report_configuration.md) 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/8.0/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](/content/operate/rs/8.0/references/rest-api/objects/bdb/_index.md)) 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/8.0/references/rest-api/objects/crdb/instance_info.md b/content/operate/rs/8.0/references/rest-api/objects/crdb/instance_info.md index acc07dfe13..5c200d3ba3 100644 --- a/content/operate/rs/8.0/references/rest-api/objects/crdb/instance_info.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/objects/crdb/cluster_info" >}}) object | | +| cluster | [CRDB cluster_info](/content/operate/rs/8.0/references/rest-api/objects/crdb/cluster_info.md) object | | | compression | integer | Compression level when syncing from this source | -| db_config | [CRDB database_config]({{< relref "/operate/rs/8.0/references/rest-api/objects/crdb/database_config" >}}) object | Database configuration for this specific instance. Use `db_config` only when you need to override or add configuration values that differ from the `default_db_config` in the main [CRDB object]({{< relref "/operate/rs/8.0/references/rest-api/objects/crdb" >}}). For a list of which settings must be identical across all instances and which to set per instance, see the [CRDB database config object]({{}}) reference. | +| db_config | [CRDB database_config](/content/operate/rs/8.0/references/rest-api/objects/crdb/database_config.md) object | Database configuration for this specific instance. Use `db_config` only when you need to override or add configuration values that differ from the `default_db_config` in the main [CRDB object](/content/operate/rs/8.0/references/rest-api/objects/crdb/_index.md). For a list of which settings must be identical across all instances and which to set per instance, see the [CRDB database config object](/content/operate/rs/8.0/references/rest-api/objects/crdb/database_config.md) reference. | | 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/8.0/references/rest-api/objects/crdb/modify_request.md b/content/operate/rs/8.0/references/rest-api/objects/crdb/modify_request.md index 81c1193882..b095dcd585 100644 --- a/content/operate/rs/8.0/references/rest-api/objects/crdb/modify_request.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/objects/crdb/instance_info" >}}) objects | List of new CRDB instances | -| crdb | [CRDB]({{< relref "/operate/rs/8.0/references/rest-api/objects/crdb" >}}) object | An object that represents an Active-Active database | +| add_instances | array of [CRDB instance_info](/content/operate/rs/8.0/references/rest-api/objects/crdb/instance_info.md) objects | List of new CRDB instances | +| crdb | [CRDB](/content/operate/rs/8.0/references/rest-api/objects/crdb/_index.md) 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/8.0/references/rest-api/objects/db_alerts_settings/_index.md b/content/operate/rs/8.0/references/rest-api/objects/db_alerts_settings/_index.md index 110353467f..f229723f97 100644 --- a/content/operate/rs/8.0/references/rest-api/objects/db_alerts_settings/_index.md +++ b/content/operate/rs/8.0/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/8.0/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/8.0/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/8.0/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/8.0/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/8.0/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/8.0/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 Software v5.0.1) | -| bdb_high_throughput | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/8.0/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/8.0/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/8.0/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/8.0/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/8.0/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/8.0/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/8.0/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/8.0/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/8.0/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/8.0/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/8.0/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 Software v5.0.1) | -| bdb_syncer_general_error | [bdb_alert_settings_with_threshold]({{< relref "/operate/rs/8.0/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold" >}}) object | Replica of sync encountered in general error (deprecated as of Redis Software v5.0.1) | +| bdb_backup_delayed | [bdb_alert_settings_with_threshold](/content/operate/rs/8.0/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold.md) object | Periodic backup has been delayed for longer than specified threshold value (minutes) | +| bdb_crdt_src_high_syncer_lag | [bdb_alert_settings_with_threshold](/content/operate/rs/8.0/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold.md) object | CRDB source sync lag is higher than specified threshold value (seconds) | +| bdb_crdt_src_syncer_connection_error | [bdb_alert_settings_with_threshold](/content/operate/rs/8.0/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold.md) 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](/content/operate/rs/8.0/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold.md) object | CRDB sync encountered in general error | +| bdb_high_latency | [bdb_alert_settings_with_threshold](/content/operate/rs/8.0/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold.md) object | Latency is higher than specified threshold value (microsec) | +| bdb_high_syncer_lag | [bdb_alert_settings_with_threshold](/content/operate/rs/8.0/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold.md) object | Replica of sync lag is higher than specified threshold value (seconds) (deprecated as of Redis Software v5.0.1) | +| bdb_high_throughput | [bdb_alert_settings_with_threshold](/content/operate/rs/8.0/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold.md) object | Throughput is higher than specified threshold value (requests / sec) | +| bdb_long_running_action | [bdb_alert_settings_with_threshold](/content/operate/rs/8.0/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold.md) object | An alert for state machines that are running for too long | +| bdb_low_throughput | [bdb_alert_settings_with_threshold](/content/operate/rs/8.0/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold.md) object | Throughput is lower than specified threshold value (requests / sec) | +| bdb_ram_dataset_overhead | [bdb_alert_settings_with_threshold](/content/operate/rs/8.0/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold.md) object | Dataset RAM overhead of a shard has reached the threshold value (% of its RAM limit) | +| bdb_ram_values | [bdb_alert_settings_with_threshold](/content/operate/rs/8.0/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold.md) 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](/content/operate/rs/8.0/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold.md) object | Replica of source sync lag is higher than specified threshold value (seconds) | +| bdb_replica_src_syncer_connection_error | [bdb_alert_settings_with_threshold](/content/operate/rs/8.0/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold.md) 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](/content/operate/rs/8.0/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold.md) object | Replica of sync encountered in general error | +| bdb_shard_num_ram_values | [bdb_alert_settings_with_threshold](/content/operate/rs/8.0/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold.md) object | Number of values kept in a shard's RAM is lower than (values) | +| bdb_size | [bdb_alert_settings_with_threshold](/content/operate/rs/8.0/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold.md) object | Dataset size has reached the threshold value \(% of the memory limit) | +| bdb_syncer_connection_error | [bdb_alert_settings_with_threshold](/content/operate/rs/8.0/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold.md) object | Replica of sync has connection error while trying to connect replica source (deprecated as of Redis Software v5.0.1) | +| bdb_syncer_general_error | [bdb_alert_settings_with_threshold](/content/operate/rs/8.0/references/rest-api/objects/db_alerts_settings/bdb_alert_settings_with_threshold.md) object | Replica of sync encountered in general error (deprecated as of Redis Software v5.0.1) | diff --git a/content/operate/rs/8.0/references/rest-api/objects/job_scheduler/_index.md b/content/operate/rs/8.0/references/rest-api/objects/job_scheduler/_index.md index 393cacce32..4c36c3f2a9 100644 --- a/content/operate/rs/8.0/references/rest-api/objects/job_scheduler/_index.md +++ b/content/operate/rs/8.0/references/rest-api/objects/job_scheduler/_index.md @@ -16,10 +16,10 @@ 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/8.0/references/rest-api/objects/job_scheduler/backup_job_settings" >}}) object | Backup job settings | -| bdb_usage_report_job_settings | [bdb_usage_report_job_settings]({{< relref "/operate/rs/8.0/references/rest-api/objects/job_scheduler/bdb_usage_report_job_settings" >}}) object | Job settings for database usage reports | -| cert_rotation_job_settings | [cert_rotation_job_settings]({{< relref "/operate/rs/8.0/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/8.0/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/8.0/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/8.0/references/rest-api/objects/job_scheduler/redis_cleanup_job_settings" >}}) object | Redis cleanup job settings (deprecated as of Redis Software v6.4.2, replaced with persistence_cleanup_scan_interval) | -| rotate_ccs_job_settings | [rotate_ccs_job_settings]({{< relref "/operate/rs/8.0/references/rest-api/objects/job_scheduler/rotate_ccs_job_settings" >}}) object | Rotate CCS job settings | +| backup_job_settings | [backup_job_settings](/content/operate/rs/8.0/references/rest-api/objects/job_scheduler/backup_job_settings.md) object | Backup job settings | +| bdb_usage_report_job_settings | [bdb_usage_report_job_settings](/content/operate/rs/8.0/references/rest-api/objects/job_scheduler/bdb_usage_report_job_settings.md) object | Job settings for database usage reports | +| cert_rotation_job_settings | [cert_rotation_job_settings](/content/operate/rs/8.0/references/rest-api/objects/job_scheduler/cert_rotation_job_settings.md) object | Job settings for internal certificate rotation | +| log_rotation_job_settings | [log_rotation_job_settings](/content/operate/rs/8.0/references/rest-api/objects/job_scheduler/log_rotation_job_settings.md) object | Log rotation job settings | +| node_checks_job_settings | [node_checks_job_settings](/content/operate/rs/8.0/references/rest-api/objects/job_scheduler/node_checks_job_settings.md) object | Node checks job settings | +| redis_cleanup_job_settings | [redis_cleanup_job_settings](/content/operate/rs/8.0/references/rest-api/objects/job_scheduler/redis_cleanup_job_settings.md) object | Redis cleanup job settings (deprecated as of Redis Software v6.4.2, replaced with persistence_cleanup_scan_interval) | +| rotate_ccs_job_settings | [rotate_ccs_job_settings](/content/operate/rs/8.0/references/rest-api/objects/job_scheduler/rotate_ccs_job_settings.md) object | Rotate CCS job settings | diff --git a/content/operate/rs/8.0/references/rest-api/objects/ldap.md b/content/operate/rs/8.0/references/rest-api/objects/ldap.md index 7d79f0004f..2d85ec08a3 100644 --- a/content/operate/rs/8.0/references/rest-api/objects/ldap.md +++ b/content/operate/rs/8.0/references/rest-api/objects/ldap.md @@ -11,7 +11,7 @@ weight: $weight url: '/operate/rs/8.0/references/rest-api/objects/ldap/' --- -An API object that represents the cluster's [LDAP]({{< relref "/operate/rs/8.0/security/access-control/ldap" >}}) configuration. +An API object that represents the cluster's [LDAP](/content/operate/rs/8.0/security/access-control/ldap/_index.md) configuration. | Name | Type/Value | Description | |------|------------|-------------| @@ -26,7 +26,7 @@ An API object that represents the cluster's [LDAP]({{< relref "/operate/rs/8.0/s | data_plane | boolean (default: false) | Use LDAP for user authentication/authorization in the data plane | | directory_timeout_s | integer (range: 5-60) (default: 5) | The connection timeout to the LDAP server when authenticating a user, in seconds | | dn_group_attr | string | The name of an attribute of the LDAP user entity that contains a list of the groups that user belongs to. `dn_group_attr` is mutually exclusive with `dn_group_query`. | -| dn_group_query | complex object | An LDAP search query used to find a user’s groups, which determine the user’s level of access to the cluster and database as defined by Redis ACLs when [mapped to roles]({{}}). `dn_group_query` is mutually exclusive with `dn_group_attr`.

Contains the following fields:
**base**: Defines the starting point DN (unique identifier Distinguished Name) in the directory information tree for the search. Example value: `"DC=example,DC=com"`
**filter**: An [RFC-4515](https://www.rfc-editor.org/info/rfc4515) string representation of the search filter to apply. Defines the conditions required for an entry to appear in the search results. Example value: `"member=%D"` where `%D` is replaced with the user's DN.
**scope**: Defines the scope of the LDAP search according to the following values:
**"base"**: Search the base entry.
**"one"**: Search the base entry's immediate children.
**"subtree"**: Search the base entry and all its descendants. | +| dn_group_query | complex object | An LDAP search query used to find a user’s groups, which determine the user’s level of access to the cluster and database as defined by Redis ACLs when [mapped to roles](/content/operate/rs/8.0/references/rest-api/requests/ldap_mappings/_index.md). `dn_group_query` is mutually exclusive with `dn_group_attr`.

Contains the following fields:
**base**: Defines the starting point DN (unique identifier Distinguished Name) in the directory information tree for the search. Example value: `"DC=example,DC=com"`
**filter**: An [RFC-4515](https://www.rfc-editor.org/info/rfc4515) string representation of the search filter to apply. Defines the conditions required for an entry to appear in the search results. Example value: `"member=%D"` where `%D` is replaced with the user's DN.
**scope**: Defines the scope of the LDAP search according to the following values:
**"base"**: Search the base entry.
**"one"**: Search the base entry's immediate children.
**"subtree"**: Search the base entry and all its descendants. | | starttls | boolean (default: false) | Use StartTLS negotiation for the LDAP connection | | uris | array of strings | URIs of LDAP servers that only contain the schema, host, and port | | user_dn_query | complex object | An LDAP search query used to find and authenticate LDAP users. `user_dn_query` is mutually exclusive with `user_dn_template`.

Contains the following fields:
**base**: Defines the starting point DN (unique identifier Distinguished Name) in the directory information tree for the search. Example value: `"DC=example,DC=com"`
**filter**: An [RFC-4515](https://www.rfc-editor.org/info/rfc4515) string representation of the search filter to apply. Defines the conditions required for an entry to appear in the search results. Example value: `"(&(objectClass=Person)(cn=%u))"` where `%u` is replaced with the username.
**scope**: Defines the scope of the LDAP search according to the following values:
**"base"**: Search the base entry.
**"one"**: Search the base entry's immediate children.
**"subtree"**: Search the base entry and all its descendants. | diff --git a/content/operate/rs/8.0/references/rest-api/objects/ldap_mapping.md b/content/operate/rs/8.0/references/rest-api/objects/ldap_mapping.md index 044e592f24..6920f4c230 100644 --- a/content/operate/rs/8.0/references/rest-api/objects/ldap_mapping.md +++ b/content/operate/rs/8.0/references/rest-api/objects/ldap_mapping.md @@ -11,7 +11,7 @@ weight: $weight url: '/operate/rs/8.0/references/rest-api/objects/ldap_mapping/' --- -An API object that represents an [LDAP mapping]({{< relref "/operate/rs/8.0/security/access-control/ldap/map-ldap-groups-to-roles" >}}) between an LDAP group and [roles]({{< relref "/operate/rs/8.0/references/rest-api/objects/role" >}}). +An API object that represents an [LDAP mapping](/content/operate/rs/8.0/security/access-control/ldap/map-ldap-groups-to-roles.md) between an LDAP group and [roles](/content/operate/rs/8.0/references/rest-api/objects/role.md). | Name | Type/Value | Description | |------|------------|-------------| diff --git a/content/operate/rs/8.0/references/rest-api/objects/module.md b/content/operate/rs/8.0/references/rest-api/objects/module.md index dc12a25b52..88d861bad3 100644 --- a/content/operate/rs/8.0/references/rest-api/objects/module.md +++ b/content/operate/rs/8.0/references/rest-api/objects/module.md @@ -11,7 +11,7 @@ weight: $weight url: '/operate/rs/8.0/references/rest-api/objects/module/' --- -Represents a [Redis module]({{< relref "/operate/oss_and_stack/stack-with-enterprise" >}}). +Represents a [Redis module](/content/operate/oss_and_stack/stack-with-enterprise/_index.md). | Name | Type/Value | Description | |------|------------|-------------| diff --git a/content/operate/rs/8.0/references/rest-api/objects/module_metadata.md b/content/operate/rs/8.0/references/rest-api/objects/module_metadata.md index 9aff250e90..55324d2398 100644 --- a/content/operate/rs/8.0/references/rest-api/objects/module_metadata.md +++ b/content/operate/rs/8.0/references/rest-api/objects/module_metadata.md @@ -11,7 +11,7 @@ weight: $weight url: '/operate/rs/8.0/references/rest-api/objects/module_metadata/' --- -Represents a [Redis module]({{< relref "/operate/oss_and_stack/stack-with-enterprise" >}}). +Represents a [Redis module](/content/operate/oss_and_stack/stack-with-enterprise/_index.md). | Name | Type/Value | Description | |------|------------|-------------| diff --git a/content/operate/rs/8.0/references/rest-api/objects/node.md b/content/operate/rs/8.0/references/rest-api/objects/node.md index 99d836bedd..e615afdf8b 100644 --- a/content/operate/rs/8.0/references/rest-api/objects/node.md +++ b/content/operate/rs/8.0/references/rest-api/objects/node.md @@ -20,8 +20,8 @@ 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 Software v7.2, use the [cluster object]({{< relref "/operate/rs/8.0/references/rest-api/objects/cluster" >}})'s `bigstore_driver` instead) | -| bigstore_enabled | boolean | If `true`, then flash storage is enabled on this node for [Redis Flex and Auto Tiering]({{}}) databases. Configurable during [bootstrapping]({{}}). After bootstrapping, it is read-only. | +| bigstore_driver | 'ibm-capi-ga1'
'ibm-capi-ga2'
'ibm-capi-ga4'
'speedb'
'rocksdb' | Bigstore driver name or none (deprecated as of Redis Software v7.2, use the [cluster object](/content/operate/rs/8.0/references/rest-api/objects/cluster/_index.md)'s `bigstore_driver` instead) | +| bigstore_enabled | boolean | If `true`, then flash storage is enabled on this node for [Redis Flex and Auto Tiering](/content/operate/rs/8.0/databases/flash/_index.md) databases. Configurable during [bootstrapping](/content/operate/rs/8.0/references/rest-api/requests/bootstrap/_index.md#post-bootstrap). After bootstrapping, it is read-only. | | 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/8.0/references/rest-api/objects/redis_acl.md b/content/operate/rs/8.0/references/rest-api/objects/redis_acl.md index 85c461758c..1ce2bbb58d 100644 --- a/content/operate/rs/8.0/references/rest-api/objects/redis_acl.md +++ b/content/operate/rs/8.0/references/rest-api/objects/redis_acl.md @@ -11,7 +11,7 @@ weight: $weight url: '/operate/rs/8.0/references/rest-api/objects/redis_acl/' --- -An API object that represents a Redis [access control list (ACL)]({{< relref "/operate/rs/8.0/security/access-control/create-db-roles" >}}) +An API object that represents a Redis [access control list (ACL)](/content/operate/rs/8.0/security/access-control/create-db-roles.md) | Name | Type/Value | Description | |------|------------|-------------| diff --git a/content/operate/rs/8.0/references/rest-api/objects/role.md b/content/operate/rs/8.0/references/rest-api/objects/role.md index 77490e873c..644fd06a76 100644 --- a/content/operate/rs/8.0/references/rest-api/objects/role.md +++ b/content/operate/rs/8.0/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'
'user_manager'
'none' | [Management role]({{< relref "/operate/rs/8.0/references/rest-api/permissions#roles" >}}) | +| management | 'admin'
'db_member'
'db_viewer'
'cluster_member'
'cluster_viewer'
'user_manager'
'none' | [Management role](/content/operate/rs/8.0/references/rest-api/permissions.md#roles) | | name | string | Role's name | diff --git a/content/operate/rs/8.0/references/rest-api/objects/services_configuration/_index.md b/content/operate/rs/8.0/references/rest-api/objects/services_configuration/_index.md index 513f87715b..703d108082 100644 --- a/content/operate/rs/8.0/references/rest-api/objects/services_configuration/_index.md +++ b/content/operate/rs/8.0/references/rest-api/objects/services_configuration/_index.md @@ -16,14 +16,14 @@ Optional cluster services settings | Name | Type/Value | Description | |------|------------|-------------| -| alert_mgr | [alert_mgr]({{< relref "/operate/rs/8.0/references/rest-api/objects/services_configuration/alert_mgr" >}}) object | Whether to enable/disable the alert manager processes | -| call_home_agent | [call_home_agent]({{< relref "/operate/rs/8.0/references/rest-api/objects/services_configuration/call_home_agent" >}}) object | Whether to enable/disable the call_home_agent process, which sends daily usage statistics to Redis | -| cm_server | [cm_server]({{< relref "/operate/rs/8.0/references/rest-api/objects/services_configuration/cm_server" >}}) object | Whether to enable/disable the CM server | -| crdb_coordinator | [crdb_coordinator]({{< relref "/operate/rs/8.0/references/rest-api/objects/services_configuration/crdb_coordinator" >}}) object | Whether to enable/disable the CRDB coordinator process | -| crdb_worker | [crdb_worker]({{< relref "/operate/rs/8.0/references/rest-api/objects/services_configuration/crdb_worker" >}}) object | Whether to enable/disable the CRDB worker processes | -| entraid_agent_mgr | [entraid_agent_mgr]({{< relref "/operate/rs/8.0/references/rest-api/objects/services_configuration/entraid_agent_mgr" >}}) object | Whether to enable/disable the Entra ID agent manager process | -| ldap_agent_mgr | [ldap_agent_mgr]({{< relref "/operate/rs/8.0/references/rest-api/objects/services_configuration/ldap_agent_mgr" >}}) object | Whether to enable/disable the LDAP agent manager processes | -| mdns_server | [mdns_server]({{< relref "/operate/rs/8.0/references/rest-api/objects/services_configuration/mdns_server" >}}) object | Whether to enable/disable the multicast DNS server | -| pdns_server | [pdns_server]({{< relref "/operate/rs/8.0/references/rest-api/objects/services_configuration/pdns_server" >}}) object | Whether to enable/disable the PDNS server | -| sentinel_service | [sentinel_service]({{< relref "/operate/rs/8.0/references/rest-api/objects/services_configuration/sentinel_service" >}}) object | Whether to enable/disable the Sentinel service process | -| stats_archiver | [stats_archiver]({{< relref "/operate/rs/8.0/references/rest-api/objects/services_configuration/stats_archiver" >}}) object | Whether to enable/disable the stats archiver service | +| alert_mgr | [alert_mgr](/content/operate/rs/8.0/references/rest-api/objects/services_configuration/alert_mgr.md) object | Whether to enable/disable the alert manager processes | +| call_home_agent | [call_home_agent](/content/operate/rs/8.0/references/rest-api/objects/services_configuration/call_home_agent.md) object | Whether to enable/disable the call_home_agent process, which sends daily usage statistics to Redis | +| cm_server | [cm_server](/content/operate/rs/8.0/references/rest-api/objects/services_configuration/cm_server.md) object | Whether to enable/disable the CM server | +| crdb_coordinator | [crdb_coordinator](/content/operate/rs/8.0/references/rest-api/objects/services_configuration/crdb_coordinator.md) object | Whether to enable/disable the CRDB coordinator process | +| crdb_worker | [crdb_worker](/content/operate/rs/8.0/references/rest-api/objects/services_configuration/crdb_worker.md) object | Whether to enable/disable the CRDB worker processes | +| entraid_agent_mgr | [entraid_agent_mgr](/content/operate/rs/8.0/references/rest-api/objects/services_configuration/entraid_agent_mgr.md) object | Whether to enable/disable the Entra ID agent manager process | +| ldap_agent_mgr | [ldap_agent_mgr](/content/operate/rs/8.0/references/rest-api/objects/services_configuration/ldap_agent_mgr.md) object | Whether to enable/disable the LDAP agent manager processes | +| mdns_server | [mdns_server](/content/operate/rs/8.0/references/rest-api/objects/services_configuration/mdns_server.md) object | Whether to enable/disable the multicast DNS server | +| pdns_server | [pdns_server](/content/operate/rs/8.0/references/rest-api/objects/services_configuration/pdns_server.md) object | Whether to enable/disable the PDNS server | +| sentinel_service | [sentinel_service](/content/operate/rs/8.0/references/rest-api/objects/services_configuration/sentinel_service.md) object | Whether to enable/disable the Sentinel service process | +| stats_archiver | [stats_archiver](/content/operate/rs/8.0/references/rest-api/objects/services_configuration/stats_archiver.md) object | Whether to enable/disable the stats archiver service | diff --git a/content/operate/rs/8.0/references/rest-api/objects/shard/_index.md b/content/operate/rs/8.0/references/rest-api/objects/shard/_index.md index d829be719a..8b4cd499dc 100644 --- a/content/operate/rs/8.0/references/rest-api/objects/shard/_index.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/objects/shard/backup" >}}) object | Current status of scheduled periodic backup process | +| backup | [backup](/content/operate/rs/8.0/references/rest-api/objects/shard/backup.md) 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/8.0/references/rest-api/objects/shard/loading" >}}) object | Current status of dump file loading | +| loading | [loading](/content/operate/rs/8.0/references/rest-api/objects/shard/loading.md) 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" >}}) | +| redis_info | redis_info object | A sub-dictionary of the [Redis INFO command](/content/commands/info.md) | | 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/8.0/references/rest-api/objects/shard/sync.md" >}}) object | Shard's current sync status and progress | +| sync | [sync](/content/operate/rs/8.0/references/rest-api/objects/shard/sync.md) object | Shard's current sync status and progress | diff --git a/content/operate/rs/8.0/references/rest-api/objects/statistics/_index.md b/content/operate/rs/8.0/references/rest-api/objects/statistics/_index.md index c1722b7043..9cf52c414c 100644 --- a/content/operate/rs/8.0/references/rest-api/objects/statistics/_index.md +++ b/content/operate/rs/8.0/references/rest-api/objects/statistics/_index.md @@ -13,19 +13,19 @@ url: '/operate/rs/8.0/references/rest-api/objects/statistics/' --- {{}} -The v1 statistics REST API endpoints are deprecated as of Redis Software version 7.22. Use the [metrics stream engine for monitoring v2]({{< relref "/operate/rs/8.0/monitoring/metrics_stream_engine" >}}) instead for real-time monitoring and metrics collection. +The v1 statistics REST API endpoints are deprecated as of Redis Software version 7.22. Use the [metrics stream engine for monitoring v2](/content/operate/rs/8.0/monitoring/metrics_stream_engine/_index.md) instead for real-time monitoring and metrics collection. {{}} ## 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/8.0/references/rest-api/requests/cluster/stats" >}}) -- [Database stats]({{< relref "/operate/rs/8.0/references/rest-api/requests/bdbs/stats" >}}) -- [Node stats]({{< relref "/operate/rs/8.0/references/rest-api/requests/nodes/stats" >}}) -- [Shard stats]({{< relref "/operate/rs/8.0/references/rest-api/requests/shards/stats" >}}) +- [Cluster stats](/content/operate/rs/8.0/references/rest-api/requests/cluster/stats/_index.md) +- [Database stats](/content/operate/rs/8.0/references/rest-api/requests/bdbs/stats/_index.md) +- [Node stats](/content/operate/rs/8.0/references/rest-api/requests/nodes/stats/_index.md) +- [Shard stats](/content/operate/rs/8.0/references/rest-api/requests/shards/stats/_index.md) View endpoint stats using `GET` requests, see: -- [Endpoint stats]({{< relref "/operate/rs/8.0/references/rest-api/requests/endpoints-stats" >}}) +- [Endpoint stats](/content/operate/rs/8.0/references/rest-api/requests/endpoints-stats/_index.md) ### Response object @@ -44,14 +44,13 @@ 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/8.0/references/rest-api/objects/statistics/cluster-metrics" >}}) -- [DB metrics]({{< relref "/operate/rs/8.0/references/rest-api/objects/statistics/db-metrics" >}}) -- [Node metrics]({{< relref "/operate/rs/8.0/references/rest-api/objects/statistics/node-metrics" >}}) -- [Shard metrics]({{< relref "/operate/rs/8.0/references/rest-api/objects/statistics/shard-metrics" >}}) +- [Cluster metrics](/content/operate/rs/8.0/references/rest-api/objects/statistics/cluster-metrics.md) +- [DB metrics](/content/operate/rs/8.0/references/rest-api/objects/statistics/db-metrics.md) +- [Node metrics](/content/operate/rs/8.0/references/rest-api/objects/statistics/node-metrics.md) +- [Shard metrics](/content/operate/rs/8.0/references/rest-api/objects/statistics/shard-metrics.md) -{{}} -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. -{{}} +> [!NOTE] +> 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. ### Optional URL parameters @@ -77,6 +76,5 @@ The system retains a maximum number of most recent samples for each interval. The actual number of samples returned by a `GET stats` request depends on how many samples are available and any filters applied by the optional URL parameters. For example, newly created objects (clusters, nodes, databases, or shards) or a narrow time filter range will return fewer samples. -{{}} -To reduce load generated by stats collection, relatively inactive databases or shards (less than 5 ops/sec) do not collect 1sec stats at one second intervals. Instead, they collect 1sec stats every 2-5 seconds but still retain the same maximum number of samples. -{{}} +> [!NOTE] +> To reduce load generated by stats collection, relatively inactive databases or shards (less than 5 ops/sec) do not collect 1sec stats at one second intervals. Instead, they collect 1sec stats every 2-5 seconds but still retain the same maximum number of samples. diff --git a/content/operate/rs/8.0/references/rest-api/objects/statistics/cluster-metrics.md b/content/operate/rs/8.0/references/rest-api/objects/statistics/cluster-metrics.md index d54b144eb5..935ad51b57 100644 --- a/content/operate/rs/8.0/references/rest-api/objects/statistics/cluster-metrics.md +++ b/content/operate/rs/8.0/references/rest-api/objects/statistics/cluster-metrics.md @@ -13,7 +13,7 @@ url: '/operate/rs/8.0/references/rest-api/objects/statistics/cluster-metrics/' --- {{}} -The v1 statistics REST API endpoints are deprecated as of Redis Software version 7.22. Use the [metrics stream engine for monitoring v2]({{< relref "/operate/rs/8.0/monitoring/metrics_stream_engine" >}}) instead for real-time monitoring and metrics collection. +The v1 statistics REST API endpoints are deprecated as of Redis Software version 7.22. Use the [metrics stream engine for monitoring v2](/content/operate/rs/8.0/monitoring/metrics_stream_engine/_index.md) instead for real-time monitoring and metrics collection. {{}} | Metric name | Type | Description | diff --git a/content/operate/rs/8.0/references/rest-api/objects/statistics/db-metrics.md b/content/operate/rs/8.0/references/rest-api/objects/statistics/db-metrics.md index c72cae20d7..6215aca11c 100644 --- a/content/operate/rs/8.0/references/rest-api/objects/statistics/db-metrics.md +++ b/content/operate/rs/8.0/references/rest-api/objects/statistics/db-metrics.md @@ -13,7 +13,7 @@ url: '/operate/rs/8.0/references/rest-api/objects/statistics/db-metrics/' --- {{}} -The v1 statistics REST API endpoints are deprecated as of Redis Software version 7.22. Use the [metrics stream engine for monitoring v2]({{< relref "/operate/rs/8.0/monitoring/metrics_stream_engine" >}}) instead for real-time monitoring and metrics collection. +The v1 statistics REST API endpoints are deprecated as of Redis Software version 7.22. Use the [metrics stream engine for monitoring v2](/content/operate/rs/8.0/monitoring/metrics_stream_engine/_index.md) instead for real-time monitoring and metrics collection. {{}} | Metric name | Type | Description | diff --git a/content/operate/rs/8.0/references/rest-api/objects/statistics/node-metrics.md b/content/operate/rs/8.0/references/rest-api/objects/statistics/node-metrics.md index ddc11f19ac..589fc4142a 100644 --- a/content/operate/rs/8.0/references/rest-api/objects/statistics/node-metrics.md +++ b/content/operate/rs/8.0/references/rest-api/objects/statistics/node-metrics.md @@ -13,7 +13,7 @@ url: '/operate/rs/8.0/references/rest-api/objects/statistics/node-metrics/' --- {{}} -The v1 statistics REST API endpoints are deprecated as of Redis Software version 7.22. Use the [metrics stream engine for monitoring v2]({{< relref "/operate/rs/8.0/monitoring/metrics_stream_engine" >}}) instead for real-time monitoring and metrics collection. +The v1 statistics REST API endpoints are deprecated as of Redis Software version 7.22. Use the [metrics stream engine for monitoring v2](/content/operate/rs/8.0/monitoring/metrics_stream_engine/_index.md) instead for real-time monitoring and metrics collection. {{}} | Metric name | Type | Description | diff --git a/content/operate/rs/8.0/references/rest-api/objects/statistics/shard-metrics.md b/content/operate/rs/8.0/references/rest-api/objects/statistics/shard-metrics.md index 3707b831bf..1cd0d589bf 100644 --- a/content/operate/rs/8.0/references/rest-api/objects/statistics/shard-metrics.md +++ b/content/operate/rs/8.0/references/rest-api/objects/statistics/shard-metrics.md @@ -13,7 +13,7 @@ url: '/operate/rs/8.0/references/rest-api/objects/statistics/shard-metrics/' --- {{}} -The v1 statistics REST API endpoints are deprecated as of Redis Software version 7.22. Use the [metrics stream engine for monitoring v2]({{< relref "/operate/rs/8.0/monitoring/metrics_stream_engine" >}}) instead for real-time monitoring and metrics collection. +The v1 statistics REST API endpoints are deprecated as of Redis Software version 7.22. Use the [metrics stream engine for monitoring v2](/content/operate/rs/8.0/monitoring/metrics_stream_engine/_index.md) instead for real-time monitoring and metrics collection. {{}} | Metric name | Type | Description | diff --git a/content/operate/rs/8.0/references/rest-api/objects/user.md b/content/operate/rs/8.0/references/rest-api/objects/user.md index 251ab45309..e152e1bd3e 100644 --- a/content/operate/rs/8.0/references/rest-api/objects/user.md +++ b/content/operate/rs/8.0/references/rest-api/objects/user.md @@ -27,6 +27,6 @@ url: '/operate/rs/8.0/references/rest-api/objects/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'**
'user_manager'
'none' | User's [role]({{< relref "/operate/rs/8.0/references/rest-api/permissions#roles" >}}) | +| role | 'admin'
'cluster_member'
'cluster_viewer'
'db_member'
**'db_viewer'**
'user_manager'
'none' | User's [role](/content/operate/rs/8.0/references/rest-api/permissions.md#roles) | | role_uids | array of integers | UIDs of user's roles for role-based access control | | status | 'active'
'locked'
'password_expired' | User sign-in status (read-only)
**active**: able to sign in
**locked**: unable to sign in
**password_expired**: unable to sign in because the password expired | diff --git a/content/operate/rs/8.0/references/rest-api/permissions.md b/content/operate/rs/8.0/references/rest-api/permissions.md index 36dd8410ab..4c3d407849 100644 --- a/content/operate/rs/8.0/references/rest-api/permissions.md +++ b/content/operate/rs/8.0/references/rest-api/permissions.md @@ -12,9 +12,9 @@ weight: 60 url: '/operate/rs/8.0/references/rest-api/permissions/' --- -Some Redis Software [REST API requests]({{< relref "/operate/rs/8.0/references/rest-api/requests" >}}) may require the user to have specific permissions. +Some Redis Software [REST API requests](/content/operate/rs/8.0/references/rest-api/requests/_index.md) 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/8.0/security/access-control/create-users" >}}) or a [`PUT /v1/users/{uid}` API request]({{< relref "/operate/rs/8.0/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](/content/operate/rs/8.0/security/access-control/create-users.md) or a [`PUT /v1/users/{uid}` API request](/content/operate/rs/8.0/references/rest-api/requests/users/_index.md#put-user) to grant necessary permissions to them. ## Roles diff --git a/content/operate/rs/8.0/references/rest-api/quick-start.md b/content/operate/rs/8.0/references/rest-api/quick-start.md index 2883a58c3e..c05ba7866b 100644 --- a/content/operate/rs/8.0/references/rest-api/quick-start.md +++ b/content/operate/rs/8.0/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/8.0/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/8.0/references/rest-api#ports" >}}) | All calls are made to port 9443 by default | -| [Versions]({{< relref "/operate/rs/8.0/references/rest-api#versions" >}}) | Specify the version in the request [URI](https://en.wikipedia.org/wiki/Uniform_Resource_Identifier) | -| [Headers]({{< relref "/operate/rs/8.0/references/rest-api#headers" >}}) | `Accept` and `Content-Type` should be `application/json` | -| [Response types and error codes]({{< relref "/operate/rs/8.0/references/rest-api#response-types-and-error-codes" >}}) | A response of `200 OK` means success; otherwise, the request failed due to an error | +| [Authentication](/content/operate/rs/8.0/references/rest-api/_index.md#authentication) | Use [Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication) with your cluster username (email) and password | +| [Ports](/content/operate/rs/8.0/references/rest-api/_index.md#ports) | All calls are made to port 9443 by default | +| [Versions](/content/operate/rs/8.0/references/rest-api/_index.md#versions) | Specify the version in the request [URI](https://en.wikipedia.org/wiki/Uniform_Resource_Identifier) | +| [Headers](/content/operate/rs/8.0/references/rest-api/_index.md#headers) | `Accept` and `Content-Type` should be `application/json` | +| [Response types and error codes](/content/operate/rs/8.0/references/rest-api/_index.md#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 Software REST API]({{< relref "/operate/rs/8.0/references/rest-api/" >}}). +For more information, see [Redis Software REST API](/content/operate/rs/8.0/references/rest-api/_index.md). ## 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/8.0/references/rest-api/requests/modules/#post-module" >}}) or [`POST /v2/modules`]({{< relref "/operate/rs/8.0/references/rest-api/requests/modules/#post-module-v2" >}}) endpoint | +| -F | Form data for PUT or POST requests, such as for the [`POST /v1/modules`](/content/operate/rs/8.0/references/rest-api/requests/modules/_index.md#post-module) or [`POST /v2/modules`](/content/operate/rs/8.0/references/rest-api/requests/modules/_index.md#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/8.0/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/`](/content/operate/rs/8.0/references/rest-api/requests/bdbs/_index.md#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/8.0/references/rest-api/requests/bdbs/#get-all-bdbs" >}}), see the [`bdbs` object]({{< relref "/operate/rs/8.0/references/rest-api/objects/bdb/" >}}). +For more information about the fields returned by [GET `/v1/bdbs/`](/content/operate/rs/8.0/references/rest-api/requests/bdbs/_index.md#get-all-bdbs), see the [`bdbs` object](/content/operate/rs/8.0/references/rest-api/objects/bdb/_index.md). ### PUT request -Once you have the database ID, you can use [PUT `/v1/bdbs/`]({{< relref "/operate/rs/8.0/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/`](/content/operate/rs/8.0/references/rest-api/requests/bdbs/_index.md#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/8.0/references/rest-api/requests/bdbs/#put-bdbs" >}}), see the [`bdbs` object]({{< relref "/operate/rs/8.0/references/rest-api/objects/bdb/" >}}). +For more information about the fields you can update with [PUT `/v1/bdbs/`](/content/operate/rs/8.0/references/rest-api/requests/bdbs/_index.md#put-bdbs), see the [`bdbs` object](/content/operate/rs/8.0/references/rest-api/objects/bdb/_index.md). ## 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 Software]({{< relref "/operate/rs/8.0/installing-upgrading/quickstarts/redis-enterprise-software-quickstart" >}}) node +- A [Redis Software](/content/operate/rs/8.0/installing-upgrading/quickstarts/redis-enterprise-software-quickstart.md) 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 Software REST API]({{< relref "/operate/rs/8.0/references/rest-api/" >}}) -- [Redis Software REST API requests]({{< relref "/operate/rs/8.0/references/rest-api/requests/" >}}) +- [Redis Software REST API](/content/operate/rs/8.0/references/rest-api/_index.md) +- [Redis Software REST API requests](/content/operate/rs/8.0/references/rest-api/requests/_index.md) diff --git a/content/operate/rs/8.0/references/rest-api/requests/_index.md b/content/operate/rs/8.0/references/rest-api/requests/_index.md index f7e5b0ef0b..1c9679810d 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/_index.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/permissions" >}}) +- [Permissions](/content/operate/rs/8.0/references/rest-api/permissions.md) {{< table-children columnNames="Request,Description" columnSources="LinkTitle,Description" enableLinks="LinkTitle" >}} diff --git a/content/operate/rs/8.0/references/rest-api/requests/actions/_index.md b/content/operate/rs/8.0/references/rest-api/requests/actions/_index.md index 4a0136bd8c..ad66129439 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/actions/_index.md +++ b/content/operate/rs/8.0/references/rest-api/requests/actions/_index.md @@ -34,7 +34,7 @@ This API does not return any information about other actions, such as import, ex | Permission name | |-----------------| -| [view_status_of_cluster_action]({{< relref "/operate/rs/8.0/references/rest-api/permissions#view_status_of_cluster_action" >}}) | +| [view_status_of_cluster_action](/content/operate/rs/8.0/references/rest-api/permissions.md#view_status_of_cluster_action) | ### Request {#get-all-request} @@ -46,7 +46,7 @@ GET /v1/actions ### Response {#get-all-response} -Returns a JSON array of [action objects]({{< relref "/operate/rs/8.0/references/rest-api/objects/action" >}}), which represent tasks, and an array of [state-machine objects]({{< relref "/operate/rs/8.0/references/rest-api/objects/state-machine" >}}). +Returns a JSON array of [action objects](/content/operate/rs/8.0/references/rest-api/objects/action.md), which represent tasks, and an array of [state-machine objects](/content/operate/rs/8.0/references/rest-api/objects/state-machine.md). | Field | Type/Value | Description | |-------|------------|-------------| @@ -115,7 +115,7 @@ Get the status of all currently running, pending, or completed actions from task | Permission name | |-----------------| -| [view_status_of_cluster_action]({{< relref "/operate/rs/8.0/references/rest-api/permissions#view_status_of_cluster_action" >}}) | +| [view_status_of_cluster_action](/content/operate/rs/8.0/references/rest-api/permissions.md#view_status_of_cluster_action) | ### Request {#get-all-request-v2} @@ -127,7 +127,7 @@ GET /v2/actions ### Response {#get-all-response-v2} -Returns a JSON array of v2 [action objects]({{< relref "/operate/rs/8.0/references/rest-api/objects/action" >}}). +Returns a JSON array of v2 [action objects](/content/operate/rs/8.0/references/rest-api/objects/action.md). The v2 action object includes the following fields: @@ -193,7 +193,7 @@ This API does not return any information about other actions, such as import, ex | Permission name | |-----------------| -| [view_status_of_cluster_action]({{< relref "/operate/rs/8.0/references/rest-api/permissions#view_status_of_cluster_action" >}}) | +| [view_status_of_cluster_action](/content/operate/rs/8.0/references/rest-api/permissions.md#view_status_of_cluster_action) | ### Request {#get-request} @@ -211,7 +211,7 @@ GET /v1/actions/{uid} ### Response {#get-response} -Returns an [action object]({{< relref "/operate/rs/8.0/references/rest-api/objects/action" >}}). +Returns an [action object](/content/operate/rs/8.0/references/rest-api/objects/action.md). | Field | Type/Value | Description | |-------|------------|-------------| @@ -258,7 +258,7 @@ Get the status of a specific action. This API can also return information about | Permission name | |-----------------| -| [view_status_of_cluster_action]({{< relref "/operate/rs/8.0/references/rest-api/permissions#view_status_of_cluster_action" >}}) | +| [view_status_of_cluster_action](/content/operate/rs/8.0/references/rest-api/permissions.md#view_status_of_cluster_action) | ### Request {#get-request-v2} @@ -276,7 +276,7 @@ GET /v2/actions/{uid} ### Response {#get-response-v2} -Returns a v2 [action object]({{}}). +Returns a v2 [action object](/content/operate/rs/8.0/references/rest-api/objects/action.md). The v2 action object includes the following fields: diff --git a/content/operate/rs/8.0/references/rest-api/requests/actions/bdb.md b/content/operate/rs/8.0/references/rest-api/requests/actions/bdb.md index 211c80f8d4..a567c34ad9 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/actions/bdb.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/permissions#view_status_of_cluster_action" >}}) | +| [view_status_of_cluster_action](/content/operate/rs/8.0/references/rest-api/permissions.md#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/8.0/references/rest-api/objects/action" >}}) and [state machines]({{< relref "/operate/rs/8.0/references/rest-api/objects/state-machine" >}}). +Returns an array of JSON objects with attributes from [actions](/content/operate/rs/8.0/references/rest-api/objects/action.md) and [state machines](/content/operate/rs/8.0/references/rest-api/objects/state-machine.md). Each action contains the following attributes: `name`, `action_uid`, `status`, and `progress`. diff --git a/content/operate/rs/8.0/references/rest-api/requests/bdbs/_index.md b/content/operate/rs/8.0/references/rest-api/requests/bdbs/_index.md index da662d1d9c..16bd4ff850 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/bdbs/_index.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/permissions#view_all_bdbs_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | +| [view_all_bdbs_info](/content/operate/rs/8.0/references/rest-api/permissions.md#view_all_bdbs_info) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | ### Request {#get-all-request} @@ -69,7 +69,7 @@ GET /v1/bdbs?extended=true ### Response {#get-all-response} -The response body contains a JSON array with all databases, represented as [BDB objects]({{< relref "/operate/rs/8.0/references/rest-api/objects/bdb" >}}). +The response body contains a JSON array with all databases, represented as [BDB objects](/content/operate/rs/8.0/references/rest-api/objects/bdb/_index.md). #### Body @@ -134,7 +134,7 @@ Get a single database. | Permission name | Roles | |-----------------|-------| -| [view_bdb_info]({{< relref "/operate/rs/8.0/references/rest-api/permissions#view_bdb_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | +| [view_bdb_info](/content/operate/rs/8.0/references/rest-api/permissions.md#view_bdb_info) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | ### Request {#get-request} @@ -176,7 +176,7 @@ GET /v1/bdbs/1?extended=true ### Response {#get-response} -Returns a [BDB object]({{< relref "/operate/rs/8.0/references/rest-api/objects/bdb" >}}). +Returns a [BDB object](/content/operate/rs/8.0/references/rest-api/objects/bdb/_index.md). #### Example JSON body @@ -202,17 +202,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/8.0/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](/content/operate/rs/8.0/references/rest-api/objects/bdb/_index.md) 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/8.0/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](/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/_index.md) with the action_uid returned in the response body. ### Permissions | Permission name | Roles | |-----------------|-------| -| [update_bdb]({{< relref "/operate/rs/8.0/references/rest-api/permissions#update_bdb" >}}) | admin
cluster_member
db_member | +| [update_bdb](/content/operate/rs/8.0/references/rest-api/permissions.md#update_bdb) | admin
cluster_member
db_member | ### Request {#put-request} @@ -234,7 +234,7 @@ PUT /v1/bdbs/1 | Field | Type | Description | |---------|------|---------------| -| dry_run | | Validate the new [BDB object]({{< relref "/operate/rs/8.0/references/rest-api/objects/bdb" >}}) but don't apply the update. | +| dry_run | | Validate the new [BDB object](/content/operate/rs/8.0/references/rest-api/objects/bdb/_index.md) but don't apply the update. | #### URL parameters @@ -244,7 +244,7 @@ PUT /v1/bdbs/1 #### Body -Include a [BDB object]({{< relref "/operate/rs/8.0/references/rest-api/objects/bdb" >}}) with updated fields in the request body. +Include a [BDB object](/content/operate/rs/8.0/references/rest-api/objects/bdb/_index.md) with updated fields in the request body. ##### Example JSON body @@ -259,7 +259,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/8.0/references/rest-api/objects/bdb" >}}). +Returns the updated [BDB object](/content/operate/rs/8.0/references/rest-api/objects/bdb/_index.md). #### Example JSON body @@ -314,13 +314,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/8.0/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](/content/operate/rs/8.0/references/rest-api/objects/bdb/_index.md) 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/8.0/references/rest-api/permissions#update_bdb_with_action" >}}) | admin
cluster_member
db_member | +| [update_bdb_with_action](/content/operate/rs/8.0/references/rest-api/permissions.md#update_bdb_with_action) | admin
cluster_member
db_member | ### Request {#put-request-action} @@ -350,11 +350,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/8.0/references/rest-api/objects/bdb" >}}) but don't apply the update. | +| dry_run | | Validate the new [BDB object](/content/operate/rs/8.0/references/rest-api/objects/bdb/_index.md) but don't apply the update. | #### Body -Include a [BDB object]({{< relref "/operate/rs/8.0/references/rest-api/objects/bdb" >}}) with updated fields in the request body. +Include a [BDB object](/content/operate/rs/8.0/references/rest-api/objects/bdb/_index.md) with updated fields in the request body. ##### Example JSON body @@ -367,13 +367,12 @@ Include a [BDB object]({{< relref "/operate/rs/8.0/references/rest-api/objects/b The above request attempts to modify a database configuration to enable in-memory data replication and append-only file data persistence. -{{}} -To change the shard hashing policy, you must flush all keys from the database. -{{}} +> [!NOTE] +> 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/8.0/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](/content/operate/rs/8.0/references/rest-api/objects/bdb/_index.md). If an error occurs, the response body may include an error code and message with more details. #### Status codes {#put-status-codes-action} @@ -418,7 +417,7 @@ POST /v1/bdbs ``` Create a new database in the cluster. -The request must contain a single JSON [BDB object]({{< relref "/operate/rs/8.0/references/rest-api/objects/bdb" >}}) with the configuration parameters for the new database. +The request must contain a single JSON [BDB object](/content/operate/rs/8.0/references/rest-api/objects/bdb/_index.md) with the configuration parameters for the new database. The following parameters are required to create the database: @@ -427,9 +426,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/8.0/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](/content/operate/rs/8.0/references/rest-api/objects/bdb/_index.md), but will not invoke the state machine that will create it. -To track this request's progress, poll the [`/actions/` endpoint]({{< relref "/operate/rs/8.0/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](/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/_index.md) 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. @@ -437,7 +436,7 @@ The cluster will use default configuration for any missing database field. The c | Permission name | Roles | |-----------------|-------| -| [create_bdb]({{< relref "/operate/rs/8.0/references/rest-api/permissions#create_bdb" >}}) | admin
cluster_member
db_member | +| [create_bdb](/content/operate/rs/8.0/references/rest-api/permissions.md#create_bdb) | admin
cluster_member
db_member | ### Request {#post-request-v1} @@ -459,11 +458,11 @@ POST /v1/bdbs | Field | Type | Description | |-------|------|-------------| -| dry_run | | Validate the new [BDB object]({{< relref "/operate/rs/8.0/references/rest-api/objects/bdb" >}}) but don't create the database. | +| dry_run | | Validate the new [BDB object](/content/operate/rs/8.0/references/rest-api/objects/bdb/_index.md) but don't create the database. | #### Body -Include a [BDB object]({{< relref "/operate/rs/8.0/references/rest-api/objects/bdb" >}}) in the request body. +Include a [BDB object](/content/operate/rs/8.0/references/rest-api/objects/bdb/_index.md) in the request body. The following parameters are required to create the database: @@ -490,7 +489,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/8.0/references/rest-api/objects/bdb" >}}). +The response includes the newly created [BDB object](/content/operate/rs/8.0/references/rest-api/objects/bdb/_index.md). #### Example JSON body @@ -553,7 +552,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/8.0/references/rest-api/requests/bdbs#post-bdbs-v1" >}}) for more information. +Create a new database in the cluster. See [`POST /v1/bdbs`](/content/operate/rs/8.0/references/rest-api/requests/bdbs/_index.md#post-bdbs-v1) for more information. The database's configuration should be under the "bdb" field. @@ -583,11 +582,11 @@ POST /v2/bdbs | Field | Type | Description | |-------|------|-------------| -| dry_run | | Validate the new [BDB object]({{< relref "/operate/rs/8.0/references/rest-api/objects/bdb" >}}) but don't create the database. | +| dry_run | | Validate the new [BDB object](/content/operate/rs/8.0/references/rest-api/objects/bdb/_index.md) but don't create the database. | #### Body -Include a JSON object that contains a [BDB object]({{< relref "/operate/rs/8.0/references/rest-api/objects/bdb" >}}) and an optional `recovery_plan` object in the request body. +Include a JSON object that contains a [BDB object](/content/operate/rs/8.0/references/rest-api/objects/bdb/_index.md) and an optional `recovery_plan` object in the request body. ##### Example JSON body @@ -614,7 +613,7 @@ Include a JSON object that contains a [BDB object]({{< relref "/operate/rs/8.0/r ### Response {#post-response-v2} -The response includes the newly created [BDB object]({{< relref "/operate/rs/8.0/references/rest-api/objects/bdb" >}}). +The response includes the newly created [BDB object](/content/operate/rs/8.0/references/rest-api/objects/bdb/_index.md). #### Example JSON body @@ -640,7 +639,7 @@ Delete an active database. | Permission name | Roles | |-----------------|-------| -| [delete_bdb]({{< relref "/operate/rs/8.0/references/rest-api/permissions#delete_bdb" >}}) | admin
cluster_member
db_member | +| [delete_bdb](/content/operate/rs/8.0/references/rest-api/permissions.md#delete_bdb) | admin
cluster_member
db_member | ### Request {#delete-request} diff --git a/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/_index.md b/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/_index.md index bfaf7b6bd4..453b5793c5 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/_index.md +++ b/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/_index.md @@ -17,47 +17,47 @@ url: '/operate/rs/8.0/references/rest-api/requests/bdbs/actions/' | Method | Path | Description | |--------|------|-------------| -| [PUT]({{< relref "./backup_reset_status#put-bdbs-actions-backup-reset-status" >}}) | `/v1/bdbs/{uid}/actions/backup_reset_status` | Reset database backup status | +| [PUT](./backup_reset_status#put-bdbs-actions-backup-reset-status) | `/v1/bdbs/{uid}/actions/backup_reset_status` | Reset database backup status | ## Export | Method | Path | Description | |--------|------|-------------| -| [PUT]({{< relref "./export_reset_status#put-bdbs-actions-export-reset-status" >}}) | `/v1/bdbs/{uid}/actions/export_reset_status` | Reset database export status | -| [POST]({{< relref "./export#post-bdbs-actions-export" >}}) | `/v1/bdbs/{uid}/actions/export` | Initiate database export | +| [PUT](./export_reset_status#put-bdbs-actions-export-reset-status) | `/v1/bdbs/{uid}/actions/export_reset_status` | Reset database export status | +| [POST](./export#post-bdbs-actions-export) | `/v1/bdbs/{uid}/actions/export` | Initiate database export | ## Import | Method | Path | Description | |--------|------|-------------| -| [PUT]({{< relref "./import_reset_status#put-bdbs-actions-import-reset-status" >}}) | `/v1/bdbs/{uid}/actions/import_reset_status` | Reset database import status | -| [POST]({{< relref "./import#post-bdbs-actions-import" >}}) | `/v1/bdbs/{uid}/actions/import` | Initiate manual dataset import | +| [PUT](./import_reset_status#put-bdbs-actions-import-reset-status) | `/v1/bdbs/{uid}/actions/import_reset_status` | Reset database import status | +| [POST](./import#post-bdbs-actions-import) | `/v1/bdbs/{uid}/actions/import` | Initiate manual dataset import | ## Optimize shards placement | Method | Path | Description | |--------|------|-------------| -| [GET]({{< relref "./optimize_shards_placement#get-bdbs-actions-optimize-shards-placement" >}}) | `/v1/bdbs/{uid}/actions/optimize_shards_placement` | Get optimized shards placement for a database | +| [GET](./optimize_shards_placement#get-bdbs-actions-optimize-shards-placement) | `/v1/bdbs/{uid}/actions/optimize_shards_placement` | Get optimized shards placement for a database | ## Rebalance | Method | Path | Description | |--------|------|-------------| -| [PUT]({{}}) | `/v1/bdbs/{uid}/actions/rebalance` | Rebalance database shards | +| [PUT](/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/rebalance.md#put-bdbs-actions-rebalance) | `/v1/bdbs/{uid}/actions/rebalance` | Rebalance database shards | ## Recover | Method | Path | Description | |--------|------|-------------| -| [GET]({{}}) | `/v1/bdbs/{uid}/actions/recover` | Get database recovery plan | -| [POST]({{}}) | `/v1/bdbs/{uid}/actions/recover` | Recover database | +| [GET](/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/recover.md#get-bdbs-actions-recover) | `/v1/bdbs/{uid}/actions/recover` | Get database recovery plan | +| [POST](/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/recover.md#post-bdbs-actions-recover) | `/v1/bdbs/{uid}/actions/recover` | Recover database | ## Resume traffic | Method | Path | Description | |--------|------|-------------| -| [POST]({{}}) | `/v1/bdbs/{uid}/actions/resume_traffic` | Resume database traffic | +| [POST](/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/resume_traffic.md#post-bdbs-actions-resume-traffic) | `/v1/bdbs/{uid}/actions/resume_traffic` | Resume database traffic | ## Stop traffic | Method | Path | Description | |--------|------|-------------| -| [POST]({{}}) | `/v1/bdbs/{uid}/actions/stop_traffic` | Stop database traffic | +| [POST](/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/stop_traffic.md#post-bdbs-actions-stop-traffic) | `/v1/bdbs/{uid}/actions/stop_traffic` | Stop database traffic | diff --git a/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/backup_reset_status.md b/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/backup_reset_status.md index 84565c95c6..e37dddd258 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/backup_reset_status.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/permissions#reset_bdb_current_backup_status" >}}) | admin
cluster_member
db_member | +| [reset_bdb_current_backup_status](/content/operate/rs/8.0/references/rest-api/permissions.md#reset_bdb_current_backup_status) | admin
cluster_member
db_member | ### Request {#put-request} diff --git a/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/export.md b/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/export.md index f2af143498..fddd29f4c3 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/export.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/permissions#start_bdb_export" >}}) | admin
cluster_member
db_member | +| [start_bdb_export](/content/operate/rs/8.0/references/rest-api/permissions.md#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/8.0/references/rest-api/objects/bdb/backup_location" >}}) object | Details for the export destination. Call [`GET /v1/jsonschema`]({{< relref "/operate/rs/8.0/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](/content/operate/rs/8.0/references/rest-api/objects/bdb/backup_location.md) object | Details for the export destination. Call [`GET /v1/jsonschema`](/content/operate/rs/8.0/references/rest-api/requests/jsonschema/_index.md#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/8.0/references/rest-api/requests/bdbs/actions/export_reset_status.md b/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/export_reset_status.md index 96adf41d9f..2bcc219d25 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/export_reset_status.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/permissions#reset_bdb_current_export_status" >}}) | admin
cluster_member
db_member | +| [reset_bdb_current_export_status](/content/operate/rs/8.0/references/rest-api/permissions.md#reset_bdb_current_export_status) | admin
cluster_member
db_member | ### Request {#put-request} diff --git a/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/import.md b/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/import.md index 6e68cc510e..3ccee5edd9 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/import.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/permissions#start_bdb_import" >}}) | admin
cluster_member
db_member | +| [start_bdb_import](/content/operate/rs/8.0/references/rest-api/permissions.md#start_bdb_import) | admin
cluster_member
db_member | ### Request {#post-request} @@ -54,16 +54,15 @@ POST /v1/bdbs/1/actions/import #### Body -The request _may_ contain a subset of the [BDB JSON object]({{< relref "/operate/rs/8.0/references/rest-api/objects/bdb" >}}), which includes the following import-related attributes: +The request _may_ contain a subset of the [BDB JSON object](/content/operate/rs/8.0/references/rest-api/objects/bdb/_index.md), which includes the following import-related attributes: | Field | Type | Description | |-------|------|-------------| -| dataset_import_sources | array of [dataset_import_sources]({{< relref "/operate/rs/8.0/references/rest-api/objects/bdb/dataset_import_sources" >}}) objects | Details for the import sources. Call [`GET /v1/jsonschema`]({{< relref "/operate/rs/8.0/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](/content/operate/rs/8.0/references/rest-api/objects/bdb/dataset_import_sources.md) objects | Details for the import sources. Call [`GET /v1/jsonschema`](/content/operate/rs/8.0/references/rest-api/requests/jsonschema/_index.md#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) | -{{}} -Other attributes are not allowed and will cause the request to fail. -{{}} +> [!NOTE] +> Other attributes are not allowed and will cause the request to fail. ##### Example JSON body diff --git a/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/import_reset_status.md b/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/import_reset_status.md index 33dc2b0bc5..ee735a4a1d 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/import_reset_status.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/permissions#reset_bdb_current_import_status" >}}) | admin
cluster_member
db_member | +| [reset_bdb_current_import_status](/content/operate/rs/8.0/references/rest-api/permissions.md#reset_bdb_current_import_status) | admin
cluster_member
db_member | ### Request {#put-request} diff --git a/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/optimize_shards_placement.md b/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/optimize_shards_placement.md index c51df87dd4..d13de2b132 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/optimize_shards_placement.md +++ b/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/optimize_shards_placement.md @@ -13,7 +13,7 @@ url: '/operate/rs/8.0/references/rest-api/requests/bdbs/actions/optimize_shards_ --- {{}} -This REST API path is deprecated as of Redis Software version 7.22. Use [`PUT /v1/bdbs//actions/revamp?dry_run=true`]({{}}) instead. +This REST API path is deprecated as of Redis Software version 7.22. Use [`PUT /v1/bdbs//actions/revamp?dry_run=true`](/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/revamp.md#put-bdbs-actions-revamp) instead. {{}} | Method | Path | Description | @@ -33,7 +33,7 @@ Get optimized shards placement for the given database. | Permission name | Roles | |-----------------|-------| -| [view_bdb_info]({{< relref "/operate/rs/8.0/references/rest-api/permissions#view_bdb_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | +| [view_bdb_info](/content/operate/rs/8.0/references/rest-api/permissions.md#view_bdb_info) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | ### Request {#get-request} @@ -129,9 +129,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/8.0/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`](/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/optimize_shards_placement.md#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/8.0/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}`](/content/operate/rs/8.0/references/rest-api/requests/bdbs/_index.md#put-bdbs) request headers. The cluster will reject the update if its state was changed since the optimal shards placement was obtained. @@ -170,6 +170,5 @@ PUT /v1/bdbs/1 } ``` -{{}} -If you submit such an optimized blueprint, it may cause strain on the cluster and its resources. Use with caution. -{{}} +> [!WARNING] +> If you submit such an optimized blueprint, it may cause strain on the cluster and its resources. Use with caution. diff --git a/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/rebalance.md b/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/rebalance.md index d8f8b7eae2..3011f8ccc8 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/rebalance.md +++ b/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/rebalance.md @@ -22,13 +22,13 @@ url: '/operate/rs/8.0/references/rest-api/requests/bdbs/actions/rebalance/' PUT /v1/bdbs/{int: uid}/actions/rebalance ``` -Distributes the database's shards across nodes based on the database's shard placement policy. See [Shard placement policy]({{}}) for more information about shard placement and available policies. +Distributes the database's shards across nodes based on the database's shard placement policy. See [Shard placement policy](/content/operate/rs/8.0/databases/memory-performance/shard-placement-policy.md) for more information about shard placement and available policies. #### Required permissions | Permission name | Roles | |-----------------|-------| -| [view_bdb_info]({{< relref "/operate/rs/8.0/references/rest-api/permissions#view_bdb_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | +| [view_bdb_info](/content/operate/rs/8.0/references/rest-api/permissions.md#view_bdb_info) | admin
cluster_member
cluster_viewer
db_member
db_viewer | ### Request {#put-request} @@ -60,11 +60,11 @@ PUT /v1/bdbs/1/actions/rebalance?only_failovers=true&dry_run=true ### Response {#put-response} -- If `dry_run` is `false`, returns an `action_uid`. You can track the action's progress with a [`GET /v1/actions/`]({{}}) request. +- If `dry_run` is `false`, returns an `action_uid`. You can track the action's progress with a [`GET /v1/actions/`](/content/operate/rs/8.0/references/rest-api/requests/actions/_index.md#get-action) request. - If `dry_run` is `true`, returns the balanced shards' blueprint. - You can rearrange shards according to this blueprint if you use it in the `shards_blueprint` field of a [rearrange database shards]({{}}) request. + You can rearrange shards according to this blueprint if you use it in the `shards_blueprint` field of a [rearrange database shards](/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/optimize_shards_placement.md#put-bdbs-rearrange-shards) request. You should also pass the rebalance shards' `cluster-state-id` response header as a request header of the rearrange database shards request to make sure the optimized shard placement is relevant for the current cluster state. The cluster will reject the update if its state changed since the optimal shards placement blueprint was generated. diff --git a/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/recover.md b/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/recover.md index 5fcc7b6514..d8d598b359 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/recover.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/permissions#view_bdb_recovery_plan" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer | +| [view_bdb_recovery_plan](/content/operate/rs/8.0/references/rest-api/permissions.md#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](/content/operate/rs/databases/recover.md) in a recoverable state where all the database's files are available after [cluster recovery](/content/operate/rs/8.0/clusters/cluster-recovery.md). #### Required permissions | Permission name | Roles | |-----------------|-------| -| [start_bdb_recovery]({{< relref "/operate/rs/8.0/references/rest-api/permissions#start_bdb_recovery" >}}) | admin
cluster_member
db_member | +| [start_bdb_recovery](/content/operate/rs/8.0/references/rest-api/permissions.md#start_bdb_recovery) | admin
cluster_member
db_member | ### Request {#post-request} diff --git a/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/resume_traffic.md b/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/resume_traffic.md index 12c1fe1fb8..be73ce6886 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/resume_traffic.md +++ b/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/resume_traffic.md @@ -24,13 +24,13 @@ POST /v1/bdbs/{int: uid}/actions/resume_traffic Resume traffic handling for the database. -Use this action to resume read and write traffic on a database, where traffic was previously paused using the [`stop_traffic`]({{}}) action. +Use this action to resume read and write traffic on a database, where traffic was previously paused using the [`stop_traffic`](/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/stop_traffic.md) action. #### Required permissions | Permission name | Roles | |-----------------|-------| -| [update_bdb_with_action]({{< relref "/operate/rs/8.0/references/rest-api/permissions#update_bdb_with_action" >}}) | admin
cluster_member
db_member | +| [update_bdb_with_action](/content/operate/rs/8.0/references/rest-api/permissions.md#update_bdb_with_action) | admin
cluster_member
db_member | ### Request {#post-request} @@ -48,7 +48,7 @@ POST /v1/bdbs/1/actions/resume_traffic ### 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/`](/content/operate/rs/8.0/references/rest-api/requests/actions/_index.md#get-action) request. #### Status codes {#post-status-codes} diff --git a/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/revamp.md b/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/revamp.md index add2ec60c6..1edc378e0e 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/revamp.md +++ b/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/revamp.md @@ -28,7 +28,7 @@ Updates the topology-related configurations of an active database and optimizes | Permission name | Roles | |-----------------|-------| -| [update_bdb_with_action]({{< relref "/operate/rs/8.0/references/rest-api/permissions#update_bdb_with_action" >}}) | admin
cluster_member
db_member | +| [update_bdb_with_action](/content/operate/rs/8.0/references/rest-api/permissions.md#update_bdb_with_action) | admin
cluster_member
db_member | ### Request {#put-request} @@ -78,7 +78,7 @@ PUT /v1/bdbs/1/actions/revamp?dry_run=true ### Response {#put-response} -- If `dry_run` is `false`, returns an `action_uid`. You can track the action's progress with a [`GET /v1/actions/`]({{}}) request. +- If `dry_run` is `false`, returns an `action_uid`. You can track the action's progress with a [`GET /v1/actions/`](/content/operate/rs/8.0/references/rest-api/requests/actions/_index.md#get-action) request. - If `dry_run` is `true`, returns a blueprint of the database update. diff --git a/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/stop_traffic.md b/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/stop_traffic.md index ac5f8acf05..c6b191f4d2 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/stop_traffic.md +++ b/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/stop_traffic.md @@ -24,13 +24,13 @@ POST /v1/bdbs/{int: uid}/actions/stop_traffic Stop handling traffic for the database. -Use this action to stop read and write traffic on a database. To resume traffic afterward, use the [`resume_traffic`]({{}}) action. +Use this action to stop read and write traffic on a database. To resume traffic afterward, use the [`resume_traffic`](/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/resume_traffic.md) action. #### Required permissions | Permission name | Roles | |-----------------|-------| -| [update_bdb_with_action]({{< relref "/operate/rs/8.0/references/rest-api/permissions#update_bdb_with_action" >}}) | admin
cluster_member
db_member | +| [update_bdb_with_action](/content/operate/rs/8.0/references/rest-api/permissions.md#update_bdb_with_action) | admin
cluster_member
db_member | ### Request {#post-request} @@ -48,7 +48,7 @@ POST /v1/bdbs/1/actions/stop_traffic ### 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/`](/content/operate/rs/8.0/references/rest-api/requests/actions/_index.md#get-action) request. #### Status codes {#post-status-codes} diff --git a/content/operate/rs/8.0/references/rest-api/requests/bdbs/alerts.md b/content/operate/rs/8.0/references/rest-api/requests/bdbs/alerts.md index f50fe459ec..d8ee2890bb 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/bdbs/alerts.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/permissions#view_all_bdbs_alerts" >}}) | +| [view_all_bdbs_alerts](/content/operate/rs/8.0/references/rest-api/permissions.md#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/8.0/references/rest-api/objects/alert" >}}) states for each database. +Returns a hash of alert UIDs and the [alerts](/content/operate/rs/8.0/references/rest-api/objects/alert.md) 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/8.0/references/rest-api/permissions#view_bdb_alerts" >}}) | +| [view_bdb_alerts](/content/operate/rs/8.0/references/rest-api/permissions.md#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/8.0/references/rest-api/objects/alert" >}}) and their states. +Returns a hash of [alert objects](/content/operate/rs/8.0/references/rest-api/objects/alert.md) and their states. #### Example JSON body @@ -143,7 +143,7 @@ Get a database alert state. | Permission name | |-----------------| -| [view_bdb_alerts]({{< relref "/operate/rs/8.0/references/rest-api/permissions#view_bdb_alerts" >}}) | +| [view_bdb_alerts](/content/operate/rs/8.0/references/rest-api/permissions.md#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/8.0/references/rest-api/objects/alert" >}}). +Returns an [alert object](/content/operate/rs/8.0/references/rest-api/objects/alert.md). #### Example JSON body @@ -206,7 +206,7 @@ Updates a database's alerts configuration. | Permission name | |-----------------| -| [update_bdb_alerts]({{< relref "/operate/rs/8.0/references/rest-api/permissions#update_bdb_alerts" >}}) | +| [update_bdb_alerts](/content/operate/rs/8.0/references/rest-api/permissions.md#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/8.0/references/rest-api/objects/alert" >}}). +The request must contain a single JSON object with one or many database [alert objects](/content/operate/rs/8.0/references/rest-api/objects/alert.md). ### Response {#post-response} -The response includes the updated database [alerts]({{< relref "/operate/rs/8.0/references/rest-api/objects/alert" >}}). +The response includes the updated database [alerts](/content/operate/rs/8.0/references/rest-api/objects/alert.md). ### Status codes {#post-status-codes} diff --git a/content/operate/rs/8.0/references/rest-api/requests/bdbs/availability.md b/content/operate/rs/8.0/references/rest-api/requests/bdbs/availability.md index 88a828bcc1..2c24427c86 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/bdbs/availability.md +++ b/content/operate/rs/8.0/references/rest-api/requests/bdbs/availability.md @@ -29,7 +29,7 @@ Verifies the local database endpoint is available. This request does not redirec | Permission name | Roles | |-----------------|-------| -| [view_bdb_info]({{< relref "/operate/rs/8.0/references/rest-api/permissions#view_bdb_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | +| [view_bdb_info](/content/operate/rs/8.0/references/rest-api/permissions.md#view_bdb_info) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | ### Request {#get-endpoint-request} @@ -117,7 +117,7 @@ Gets the availability status of a database. | Permission name | Roles | |-----------------|-------| -| [view_bdb_info]({{< relref "/operate/rs/8.0/references/rest-api/permissions#view_bdb_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | +| [view_bdb_info](/content/operate/rs/8.0/references/rest-api/permissions.md#view_bdb_info) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | ### Request {#get-db-request} diff --git a/content/operate/rs/8.0/references/rest-api/requests/bdbs/crdt_sources-alerts.md b/content/operate/rs/8.0/references/rest-api/requests/bdbs/crdt_sources-alerts.md index ec333dc6f9..9dc8a3a165 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/bdbs/crdt_sources-alerts.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/permissions#view_all_bdbs_alerts" >}}) | +| [view_all_bdbs_alerts](/content/operate/rs/8.0/references/rest-api/permissions.md#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/8.0/references/rest-api/objects/alert" >}}) for each local BDB of CRDB. +Returns a hash of alert UIDs and the [alerts states](/content/operate/rs/8.0/references/rest-api/objects/alert.md) 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/8.0/references/rest-api/permissions#view_bdb_alerts" >}}) | +| [view_bdb_alerts](/content/operate/rs/8.0/references/rest-api/permissions.md#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/8.0/references/rest-api/objects/alert" >}}) and their states. +Returns a hash of [alert objects](/content/operate/rs/8.0/references/rest-api/objects/alert.md) and their states. #### Example JSON body @@ -150,7 +150,7 @@ of a CRDB. | Permission name | |-----------------| -| [view_bdb_alerts]({{< relref "/operate/rs/8.0/references/rest-api/permissions#view_bdb_alerts" >}}) | +| [view_bdb_alerts](/content/operate/rs/8.0/references/rest-api/permissions.md#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/8.0/references/rest-api/objects/alert" >}}) and their states. +Returns a hash of [alert objects](/content/operate/rs/8.0/references/rest-api/objects/alert.md) and their states. #### Example JSON body @@ -213,7 +213,7 @@ Get a BDB alert state. | Permission name | |-----------------| -| [view_bdb_alerts]({{< relref "/operate/rs/8.0/references/rest-api/permissions#view_bdb_alerts" >}}) | +| [view_bdb_alerts](/content/operate/rs/8.0/references/rest-api/permissions.md#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/8.0/references/rest-api/objects/alert" >}}). +Returns an [alert object](/content/operate/rs/8.0/references/rest-api/objects/alert.md). #### Example JSON body diff --git a/content/operate/rs/8.0/references/rest-api/requests/bdbs/debuginfo.md b/content/operate/rs/8.0/references/rest-api/requests/bdbs/debuginfo.md index 434ea5126d..3687cc1b1d 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/bdbs/debuginfo.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/permissions#view_debugging_info" >}}) | +| [view_debugging_info](/content/operate/rs/8.0/references/rest-api/permissions.md#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/8.0/references/rest-api/permissions#view_debugging_info" >}}) | +| [view_debugging_info](/content/operate/rs/8.0/references/rest-api/permissions.md#view_debugging_info) | ### Request {#get-request} diff --git a/content/operate/rs/8.0/references/rest-api/requests/bdbs/modules/_index.md b/content/operate/rs/8.0/references/rest-api/requests/bdbs/modules/_index.md index 2e250fd8e0..2793a782fb 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/bdbs/modules/_index.md +++ b/content/operate/rs/8.0/references/rest-api/requests/bdbs/modules/_index.md @@ -16,9 +16,9 @@ url: '/operate/rs/8.0/references/rest-api/requests/bdbs/modules/' ## Configure module | Method | Path | Description | |--------|------|-------------| -| [POST]({{< relref "/operate/rs/8.0/references/rest-api/requests/bdbs/modules/config#post-bdb-modules-config" >}}) | `/v1/bdbs/{uid}/modules/config` | Configure module | +| [POST](/content/operate/rs/8.0/references/rest-api/requests/bdbs/modules/config.md#post-bdb-modules-config) | `/v1/bdbs/{uid}/modules/config` | Configure module | ## Upgrade module | Method | Path | Description | |--------|------|-------------| -| [POST]({{< relref "/operate/rs/8.0/references/rest-api/requests/bdbs/modules/upgrade#post-bdb-modules-upgrade" >}}) | `/v1/bdbs/{uid}/modules/upgrade` | Upgrade module | \ No newline at end of file +| [POST](/content/operate/rs/8.0/references/rest-api/requests/bdbs/modules/upgrade.md#post-bdb-modules-upgrade) | `/v1/bdbs/{uid}/modules/upgrade` | Upgrade module | \ No newline at end of file diff --git a/content/operate/rs/8.0/references/rest-api/requests/bdbs/modules/config.md b/content/operate/rs/8.0/references/rest-api/requests/bdbs/modules/config.md index 9dfc04f40d..94d9361d39 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/bdbs/modules/config.md +++ b/content/operate/rs/8.0/references/rest-api/requests/bdbs/modules/config.md @@ -13,7 +13,7 @@ url: '/operate/rs/8.0/references/rest-api/requests/bdbs/modules/config/' --- {{}} -This REST API path is deprecated as of Redis Software version 7.4. Use [`PUT /v2/bdbs/`]({{}}) instead. +This REST API path is deprecated as of Redis Software version 7.4. Use [`PUT /v2/bdbs/`](/content/operate/rs/8.0/references/rest-api/requests/bdbs/_index.md#put-bdbs-action) instead. {{}} | Method | Path | Description | @@ -30,7 +30,7 @@ Use the module runtime configuration command (if defined) to configure new argum | Permission name | |-----------------| -| [edit_bdb_module]({{< relref "/operate/rs/8.0/references/rest-api/permissions#edit_bdb_module" >}}) | +| [edit_bdb_module](/content/operate/rs/8.0/references/rest-api/permissions.md#edit_bdb_module) | ### Request {#post-request} diff --git a/content/operate/rs/8.0/references/rest-api/requests/bdbs/modules/upgrade.md b/content/operate/rs/8.0/references/rest-api/requests/bdbs/modules/upgrade.md index 1420e9ff63..d15df0d097 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/bdbs/modules/upgrade.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/permissions#edit_bdb_module" >}}) | +| [edit_bdb_module](/content/operate/rs/8.0/references/rest-api/permissions.md#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/8.0/references/rest-api/objects/module" >}}). +Returns the upgraded [module object](/content/operate/rs/8.0/references/rest-api/objects/module.md). #### Example JSON body diff --git a/content/operate/rs/8.0/references/rest-api/requests/bdbs/passwords.md b/content/operate/rs/8.0/references/rest-api/requests/bdbs/passwords.md index 59f91822dc..612258a762 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/bdbs/passwords.md +++ b/content/operate/rs/8.0/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](/content/operate/rs/8.0/references/rest-api/permissions.md#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/8.0/references/rest-api/permissions#update_bdb" >}}) | +| [update_bdb](/content/operate/rs/8.0/references/rest-api/permissions.md#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/8.0/references/rest-api/permissions#update_bdb" >}}) | +| [update_bdb](/content/operate/rs/8.0/references/rest-api/permissions.md#update_bdb) | ### Request {#delete-request} diff --git a/content/operate/rs/8.0/references/rest-api/requests/bdbs/peer_stats.md b/content/operate/rs/8.0/references/rest-api/requests/bdbs/peer_stats.md index 68a498f4d8..3a095d8a2e 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/bdbs/peer_stats.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/permissions#view_bdb_stats" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | +| [view_bdb_stats](/content/operate/rs/8.0/references/rest-api/permissions.md#view_bdb_stats) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | ### 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/8.0/references/rest-api/objects/statistics" >}}) for all CRDB peer instances. +Returns [statistics](/content/operate/rs/8.0/references/rest-api/objects/statistics/_index.md) 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/8.0/references/rest-api/permissions#view_bdb_stats" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | +| [view_bdb_stats](/content/operate/rs/8.0/references/rest-api/permissions.md#view_bdb_stats) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | ### Request {#get-request} @@ -155,7 +155,7 @@ GET /v1/bdbs/1/peer_stats/3?interval=5min ### Response {#get-response} -Returns [statistics]({{< relref "/operate/rs/8.0/references/rest-api/objects/statistics" >}}) for a specific CRDB peer instance. +Returns [statistics](/content/operate/rs/8.0/references/rest-api/objects/statistics/_index.md) for a specific CRDB peer instance. #### Example JSON body diff --git a/content/operate/rs/8.0/references/rest-api/requests/bdbs/replica_sources-alerts.md b/content/operate/rs/8.0/references/rest-api/requests/bdbs/replica_sources-alerts.md index 26342b3b25..4ac1fe65d7 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/bdbs/replica_sources-alerts.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/permissions#view_all_bdbs_alerts" >}}) | +| [view_all_bdbs_alerts](/content/operate/rs/8.0/references/rest-api/permissions.md#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/8.0/references/rest-api/objects/alert" >}}) for a description of the alert state object. +See [REST API alerts overview](/content/operate/rs/8.0/references/rest-api/objects/alert.md) 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/8.0/references/rest-api/permissions#view_bdb_alerts" >}}) | +| [view_bdb_alerts](/content/operate/rs/8.0/references/rest-api/permissions.md#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/8.0/references/rest-api/objects/alert" >}}) and their states. +Returns a hash of [alert objects](/content/operate/rs/8.0/references/rest-api/objects/alert.md) 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/8.0/references/rest-api/permissions#view_bdb_alerts" >}}) | +| [view_bdb_alerts](/content/operate/rs/8.0/references/rest-api/permissions.md#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/8.0/references/rest-api/objects/alert" >}}) and their states. +Returns a hash of [alert objects](/content/operate/rs/8.0/references/rest-api/objects/alert.md) 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/8.0/references/rest-api/permissions#view_bdb_alerts" >}}) | +| [view_bdb_alerts](/content/operate/rs/8.0/references/rest-api/permissions.md#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/8.0/references/rest-api/objects/alert" >}}). +Returns an [alert state object](/content/operate/rs/8.0/references/rest-api/objects/alert.md). #### Example JSON body diff --git a/content/operate/rs/8.0/references/rest-api/requests/bdbs/shards.md b/content/operate/rs/8.0/references/rest-api/requests/bdbs/shards.md index 8c8e58a7c4..58db3f0c2b 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/bdbs/shards.md +++ b/content/operate/rs/8.0/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](/content/operate/rs/8.0/references/rest-api/objects/shard/_index.md). #### Example JSON body diff --git a/content/operate/rs/8.0/references/rest-api/requests/bdbs/stats/_index.md b/content/operate/rs/8.0/references/rest-api/requests/bdbs/stats/_index.md index 9dde897751..e74c414205 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/bdbs/stats/_index.md +++ b/content/operate/rs/8.0/references/rest-api/requests/bdbs/stats/_index.md @@ -14,7 +14,7 @@ url: '/operate/rs/8.0/references/rest-api/requests/bdbs/stats/' --- {{}} -The v1 statistics REST API endpoints are deprecated as of Redis Software version 7.22. Use the [metrics stream engine for monitoring v2]({{< relref "/operate/rs/8.0/monitoring/metrics_stream_engine" >}}) instead for real-time monitoring and metrics collection. +The v1 statistics REST API endpoints are deprecated as of Redis Software version 7.22. Use the [metrics stream engine for monitoring v2](/content/operate/rs/8.0/monitoring/metrics_stream_engine/_index.md) instead for real-time monitoring and metrics collection. {{}} | Method | Path | Description | @@ -34,7 +34,7 @@ Get statistics for all databases. | Permission name | Roles | |-----------------|-------| -| [view_all_bdb_stats]({{< relref "/operate/rs/8.0/references/rest-api/permissions#view_all_bdb_stats" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | +| [view_all_bdb_stats](/content/operate/rs/8.0/references/rest-api/permissions.md#view_all_bdb_stats) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | ### Request {#get-all-request} @@ -61,7 +61,7 @@ GET /v1/bdbs/stats?interval=1hour&stime=2014-08-28T10:00:00Z ### Response {#get-all-response} -Returns [statistics]({{< relref "/operate/rs/8.0/references/rest-api/objects/statistics" >}}) for all databases. +Returns [statistics](/content/operate/rs/8.0/references/rest-api/objects/statistics/_index.md) for all databases. #### Example JSON body @@ -175,7 +175,7 @@ Get statistics for a specific database. | Permission name | Roles | |-----------------|-------| -| [view_bdb_stats]({{< relref "/operate/rs/8.0/references/rest-api/permissions#view_bdb_stats" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | +| [view_bdb_stats](/content/operate/rs/8.0/references/rest-api/permissions.md#view_bdb_stats) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | ### Request {#get-request} @@ -208,7 +208,7 @@ GET /v1/bdbs/stats/1?interval=1hour&stime=2014-08-28T10:00:00Z ### Response {#get-response} -Returns [statistics]({{< relref "/operate/rs/8.0/references/rest-api/objects/statistics" >}}) for a specific database. +Returns [statistics](/content/operate/rs/8.0/references/rest-api/objects/statistics/_index.md) for a specific database. #### Example JSON body diff --git a/content/operate/rs/8.0/references/rest-api/requests/bdbs/stats/last.md b/content/operate/rs/8.0/references/rest-api/requests/bdbs/stats/last.md index 885b6483c8..0a267a358b 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/bdbs/stats/last.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/permissions#view_all_bdb_stats" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | +| [view_all_bdb_stats](/content/operate/rs/8.0/references/rest-api/permissions.md#view_all_bdb_stats) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | ### 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/8.0/references/rest-api/objects/statistics" >}}) for all databases. +Returns [statistics](/content/operate/rs/8.0/references/rest-api/objects/statistics/_index.md) 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/8.0/references/rest-api/permissions#view_bdb_stats" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | +| [view_bdb_stats](/content/operate/rs/8.0/references/rest-api/permissions.md#view_bdb_stats) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | ### 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/8.0/references/rest-api/objects/statistics" >}}) for a specific database. +Returns the most recent [statistics](/content/operate/rs/8.0/references/rest-api/objects/statistics/_index.md) for a specific database. #### Example JSON body diff --git a/content/operate/rs/8.0/references/rest-api/requests/bdbs/sync_source_stats.md b/content/operate/rs/8.0/references/rest-api/requests/bdbs/sync_source_stats.md index 70a4994ad8..9ff65893de 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/bdbs/sync_source_stats.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/permissions#view_bdb_stats" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | +| [view_bdb_stats](/content/operate/rs/8.0/references/rest-api/permissions.md#view_bdb_stats) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | ### 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/8.0/references/rest-api/objects/statistics" >}}) for all syncer sources. +Returns [statistics](/content/operate/rs/8.0/references/rest-api/objects/statistics/_index.md) 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/8.0/references/rest-api/permissions#view_bdb_stats" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | +| [view_bdb_stats](/content/operate/rs/8.0/references/rest-api/permissions.md#view_bdb_stats) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | ### 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/8.0/references/rest-api/objects/statistics" >}}) for a specific syncer instance. +Returns [statistics](/content/operate/rs/8.0/references/rest-api/objects/statistics/_index.md) for a specific syncer instance. #### Example JSON body diff --git a/content/operate/rs/8.0/references/rest-api/requests/bdbs/syncer_state/_index.md b/content/operate/rs/8.0/references/rest-api/requests/bdbs/syncer_state/_index.md index 32382e5772..ba90050e29 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/bdbs/syncer_state/_index.md +++ b/content/operate/rs/8.0/references/rest-api/requests/bdbs/syncer_state/_index.md @@ -25,15 +25,14 @@ GET /v1/bdbs/{int: uid}/syncer_state Get a CRDB's syncer state as JSON. -{{}} -This endpoint is deprecated as of Redis Software version 7.2.4 and will be removed in a future release. Use [`/v1/bdbs//syncer_state/crdt`]({{< relref "/operate/rs/8.0/references/rest-api/requests/bdbs/syncer_state/crdt" >}}) instead. -{{}} +> [!WARNING] +> This endpoint is deprecated as of Redis Software version 7.2.4 and will be removed in a future release. Use [`/v1/bdbs//syncer_state/crdt`](/content/operate/rs/8.0/references/rest-api/requests/bdbs/syncer_state/crdt.md) instead. ### Permissions | Permission name | Roles | |-----------------|---------| -| [view_bdb_info]({{< relref "/operate/rs/8.0/references/rest-api/permissions#view_bdb_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | +| [view_bdb_info](/content/operate/rs/8.0/references/rest-api/permissions.md#view_bdb_info) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | ### Request {#get-request} diff --git a/content/operate/rs/8.0/references/rest-api/requests/bdbs/syncer_state/crdt.md b/content/operate/rs/8.0/references/rest-api/requests/bdbs/syncer_state/crdt.md index 0e7ff63463..127b409c33 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/bdbs/syncer_state/crdt.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/permissions#view_bdb_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager| +| [view_bdb_info](/content/operate/rs/8.0/references/rest-api/permissions.md#view_bdb_info) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager| ### Request {#get-request} diff --git a/content/operate/rs/8.0/references/rest-api/requests/bdbs/syncer_state/replica.md b/content/operate/rs/8.0/references/rest-api/requests/bdbs/syncer_state/replica.md index d3f09eaab1..ffccc63c67 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/bdbs/syncer_state/replica.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/permissions#view_bdb_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | +| [view_bdb_info](/content/operate/rs/8.0/references/rest-api/permissions.md#view_bdb_info) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | ### Request {#get-request} diff --git a/content/operate/rs/8.0/references/rest-api/requests/bdbs/upgrade.md b/content/operate/rs/8.0/references/rest-api/requests/bdbs/upgrade.md index cca5af41e5..56963ac7c8 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/bdbs/upgrade.md +++ b/content/operate/rs/8.0/references/rest-api/requests/bdbs/upgrade.md @@ -27,7 +27,7 @@ Upgrade a database. | Permission name | |-----------------| -| [update_bdb_with_action]({{< relref "/operate/rs/8.0/references/rest-api/permissions#update_bdb_with_action" >}}) | +| [update_bdb_with_action](/content/operate/rs/8.0/references/rest-api/permissions.md#update_bdb_with_action) | ### Request {#post-request} @@ -68,7 +68,7 @@ Upgrade a database. ### Response {#post-response} -Returns the upgraded [BDB object]({{< relref "/operate/rs/8.0/references/rest-api/objects/bdb" >}}). +Returns the upgraded [BDB object](/content/operate/rs/8.0/references/rest-api/objects/bdb/_index.md). #### Example JSON body diff --git a/content/operate/rs/8.0/references/rest-api/requests/bootstrap/_index.md b/content/operate/rs/8.0/references/rest-api/requests/bootstrap/_index.md index 2a0f79d952..2519399e20 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/bootstrap/_index.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/objects/node" >}}) that provides information about the node configuration. +The `local_node_info` object is a subset of a [node object](/content/operate/rs/8.0/references/rest-api/objects/node.md) 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/8.0/references/rest-api/objects/bootstrap" >}}) or a minimal subset. +described in [Object attributes](/content/operate/rs/8.0/references/rest-api/objects/bootstrap/_index.md) 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/8.0/references/rest-api/objects/bootstrap" >}}) in the request body. +Include a [bootstrap object](/content/operate/rs/8.0/references/rest-api/objects/bootstrap/_index.md) in the request body. ### Response {#post-response} diff --git a/content/operate/rs/8.0/references/rest-api/requests/bootstrap/validate.md b/content/operate/rs/8.0/references/rest-api/requests/bootstrap/validate.md index dcdf30711e..329479862d 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/bootstrap/validate.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/objects/bootstrap" >}}), similar to the one used for actual bootstrapping. +The request must contain a [bootstrap configuration object](/content/operate/rs/8.0/references/rest-api/objects/bootstrap/_index.md), similar to the one used for actual bootstrapping. ### Response {#post-response} diff --git a/content/operate/rs/8.0/references/rest-api/requests/cluster/_index.md b/content/operate/rs/8.0/references/rest-api/requests/cluster/_index.md index 015b0448fc..bf190e814b 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/cluster/_index.md +++ b/content/operate/rs/8.0/references/rest-api/requests/cluster/_index.md @@ -28,7 +28,7 @@ Get cluster info. | Permission name | |-----------------| -| [view_cluster_info]({{< relref "/operate/rs/8.0/references/rest-api/permissions#view_cluster_info" >}}) | +| [view_cluster_info](/content/operate/rs/8.0/references/rest-api/permissions.md#view_cluster_info) | ### Request {#get-request} @@ -45,7 +45,7 @@ Get cluster info. ### Response {#get-response} -Returns a [cluster object]({{< relref "/operate/rs/8.0/references/rest-api/objects/cluster" >}}). +Returns a [cluster object](/content/operate/rs/8.0/references/rest-api/objects/cluster/_index.md). #### Example JSON body @@ -78,14 +78,14 @@ Returns a [cluster object]({{< relref "/operate/rs/8.0/references/rest-api/objec Update cluster settings. If called with the `dry_run` URL query string, the function will -validate the [cluster object]({{< relref "/operate/rs/8.0/references/rest-api/objects/cluster" >}}), but will not apply the requested +validate the [cluster object](/content/operate/rs/8.0/references/rest-api/objects/cluster/_index.md), but will not apply the requested changes. #### Required permissions | Permission name | |-----------------| -| [update_cluster]({{< relref "/operate/rs/8.0/references/rest-api/permissions#update_cluster" >}}) | +| [update_cluster](/content/operate/rs/8.0/references/rest-api/permissions.md#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/8.0/references/rest-api/objects/cluster" >}}) with updated fields in the request body. +Include a [cluster object](/content/operate/rs/8.0/references/rest-api/objects/cluster/_index.md) with updated fields in the request body. ### Response {#put-response} diff --git a/content/operate/rs/8.0/references/rest-api/requests/cluster/actions.md b/content/operate/rs/8.0/references/rest-api/requests/cluster/actions.md index 6f65784b27..0faa8081ee 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/cluster/actions.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/permissions#view_status_of_cluster_action" >}}) | +| [view_status_of_cluster_action](/content/operate/rs/8.0/references/rest-api/permissions.md#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/8.0/references/rest-api/objects/action" >}}). +Returns a JSON array of [action objects](/content/operate/rs/8.0/references/rest-api/objects/action.md). #### 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/8.0/references/rest-api/permissions#view_status_of_cluster_action" >}}) | +| [view_status_of_cluster_action](/content/operate/rs/8.0/references/rest-api/permissions.md#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/8.0/references/rest-api/objects/action" >}}). +Returns an [action object](/content/operate/rs/8.0/references/rest-api/objects/action.md). #### Example JSON body @@ -125,7 +125,7 @@ removed as soon as the new one is submitted. | Permission name | |-----------------| -| [start_cluster_action]({{< relref "/operate/rs/8.0/references/rest-api/permissions#start_cluster_action" >}}) | +| [start_cluster_action](/content/operate/rs/8.0/references/rest-api/permissions.md#start_cluster_action) | ### Request {#post-request} @@ -175,7 +175,7 @@ a previously executed and completed action. | Permission name | |-----------------| -| [cancel_cluster_action]({{< relref "/operate/rs/8.0/references/rest-api/permissions#cancel_cluster_action" >}}) | +| [cancel_cluster_action](/content/operate/rs/8.0/references/rest-api/permissions.md#cancel_cluster_action) | ### Request {#delete-request} diff --git a/content/operate/rs/8.0/references/rest-api/requests/cluster/alerts.md b/content/operate/rs/8.0/references/rest-api/requests/cluster/alerts.md index c19ebdce8a..f30ca13f40 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/cluster/alerts.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/permissions#view_cluster_alerts" >}}) | +| [view_cluster_alerts](/content/operate/rs/8.0/references/rest-api/permissions.md#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/8.0/references/rest-api/objects/alert" >}}) and their states. +Returns a hash of [alert objects](/content/operate/rs/8.0/references/rest-api/objects/alert.md) and their states. #### Example JSON body @@ -85,7 +85,7 @@ Get a cluster alert state. | Permission name | |-----------------| -| [view_cluster_alerts]({{< relref "/operate/rs/8.0/references/rest-api/permissions#view_cluster_alerts" >}}) | +| [view_cluster_alerts](/content/operate/rs/8.0/references/rest-api/permissions.md#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/8.0/references/rest-api/objects/alert" >}}). +Returns an [alert object](/content/operate/rs/8.0/references/rest-api/objects/alert.md). #### Example JSON body diff --git a/content/operate/rs/8.0/references/rest-api/requests/cluster/auditing-db-conns.md b/content/operate/rs/8.0/references/rest-api/requests/cluster/auditing-db-conns.md index 1428fa3fd7..c3ec592d03 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/cluster/auditing-db-conns.md +++ b/content/operate/rs/8.0/references/rest-api/requests/cluster/auditing-db-conns.md @@ -22,13 +22,13 @@ url: '/operate/rs/8.0/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/8.0/security/audit-events" >}}). +Gets the configuration settings for [auditing database connections](/content/operate/rs/8.0/security/audit-events.md). #### Required permissions | Permission name | |-----------------| -| [view_cluster_info]({{< relref "/operate/rs/8.0/references/rest-api/permissions#view_cluster_info" >}}) | +| [view_cluster_info](/content/operate/rs/8.0/references/rest-api/permissions.md#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/8.0/references/rest-api/objects/db-conns-auditing-config" >}}). +Returns a [database connection auditing configuration object](/content/operate/rs/8.0/references/rest-api/objects/db-conns-auditing-config.md). #### 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/8.0/security/audit-events" >}}). +Updates the configuration settings for [auditing database connections](/content/operate/rs/8.0/security/audit-events.md). #### Required permissions | Permission name | |-----------------| -| [update_cluster]({{< relref "/operate/rs/8.0/references/rest-api/permissions#update_cluster" >}}) | +| [update_cluster](/content/operate/rs/8.0/references/rest-api/permissions.md#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/8.0/references/rest-api/objects/db-conns-auditing-config" >}}) with updated fields in the request body. +Include a [database connection auditing configuration object](/content/operate/rs/8.0/references/rest-api/objects/db-conns-auditing-config.md) with updated fields in the request body. ### Response {#put-response} -Returns the updated [database connection auditing configuration object]({{< relref "/operate/rs/8.0/references/rest-api/objects/db-conns-auditing-config" >}}). +Returns the updated [database connection auditing configuration object](/content/operate/rs/8.0/references/rest-api/objects/db-conns-auditing-config.md). #### 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/8.0/security/audit-events" >}}). +Resets the configuration settings for [auditing database connections](/content/operate/rs/8.0/security/audit-events.md). #### Required permissions | Permission name | |-----------------| -| [update_cluster]({{< relref "/operate/rs/8.0/references/rest-api/permissions#update_cluster" >}}) | +| [update_cluster](/content/operate/rs/8.0/references/rest-api/permissions.md#update_cluster) | ### Request {#delete-request} diff --git a/content/operate/rs/8.0/references/rest-api/requests/cluster/certificates/_index.md b/content/operate/rs/8.0/references/rest-api/requests/cluster/certificates/_index.md index fc16ed74fb..ad24982337 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/cluster/certificates/_index.md +++ b/content/operate/rs/8.0/references/rest-api/requests/cluster/certificates/_index.md @@ -30,7 +30,7 @@ Get the cluster's certificates. | Permission name | |-----------------| -| [view_cluster_info]({{< relref "/operate/rs/8.0/references/rest-api/permissions#view_cluster_info" >}}) | +| [view_cluster_info](/content/operate/rs/8.0/references/rest-api/permissions.md#view_cluster_info) | ### Request {#get-request} @@ -75,7 +75,7 @@ PUT /v1/cluster/certificates Replaces multiple cluster certificates with the provided certificates on all nodes within the cluster. This endpoint validates all provided certificates before actually updating the cluster. -See the [certificates table]({{< relref "/operate/rs/8.0/security/certificates" >}}) for the list of cluster certificates and their descriptions. +See the [certificates table](/content/operate/rs/8.0/security/certificates/_index.md) for the list of cluster certificates and their descriptions. ### Request {#put-certificates-request} @@ -113,7 +113,7 @@ PUT /v1/cluster/certificates #### Request body -Include an array of [certificate objects]({{}}) in the request body. +Include an array of [certificate objects](/content/operate/rs/8.0/references/rest-api/objects/certificates.md) in the request body. ### Response {#put-certificates-response} @@ -137,13 +137,12 @@ If the response returns a failed status code, you should retry updating the cert PUT /v1/cluster/update_cert ``` -{{}} -This REST API path is deprecated as of Redis Software 7.22.2 and will be removed in a future version. Use [`PUT /v1/cluster/certificates`](#put-cluster-certificates) instead. -{{}} +> [!NOTE] +> This REST API path is deprecated as of Redis Software 7.22.2 and will be removed in a future version. Use [`PUT /v1/cluster/certificates`](#put-cluster-certificates) instead. 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/8.0/security/certificates" >}}) for the list of cluster certificates and their descriptions. +See the [certificates table](/content/operate/rs/8.0/security/certificates/_index.md) for the list of cluster certificates and their descriptions. ### Request {#put-request} @@ -189,7 +188,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/8.0/security/certificates" >}}) for the list of cluster certificates and their descriptions. +this endpoint. See the [certificates table](/content/operate/rs/8.0/security/certificates/_index.md) for the list of cluster certificates and their descriptions. ### Request {#delete-request} diff --git a/content/operate/rs/8.0/references/rest-api/requests/cluster/change_password_hashing_algorithm.md b/content/operate/rs/8.0/references/rest-api/requests/cluster/change_password_hashing_algorithm.md index cd91dd1cd5..f736afcd39 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/cluster/change_password_hashing_algorithm.md +++ b/content/operate/rs/8.0/references/rest-api/requests/cluster/change_password_hashing_algorithm.md @@ -28,7 +28,7 @@ The hashing algorithm options are `SHA-256` or `PBKDF2`. The default hashing alg | Permission name | |-----------------| -| [update_cluster]({{< relref "/operate/rs/8.0/references/rest-api/permissions#update_cluster" >}}) | +| [update_cluster](/content/operate/rs/8.0/references/rest-api/permissions.md#update_cluster) | ### Request {#patch-request} diff --git a/content/operate/rs/8.0/references/rest-api/requests/cluster/check.md b/content/operate/rs/8.0/references/rest-api/requests/cluster/check.md index 53213bae56..9b633e8693 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/cluster/check.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/permissions#view_all_nodes_checks" >}}) | +| [view_all_nodes_checks](/content/operate/rs/8.0/references/rest-api/permissions.md#view_all_nodes_checks) | ### Request {#get-request} diff --git a/content/operate/rs/8.0/references/rest-api/requests/cluster/debuginfo.md b/content/operate/rs/8.0/references/rest-api/requests/cluster/debuginfo.md index 1bf00c9e2f..41ad17584a 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/cluster/debuginfo.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/permissions#view_debugging_info" >}}) | +| [view_debugging_info](/content/operate/rs/8.0/references/rest-api/permissions.md#view_debugging_info) | ### Request {#get-request} diff --git a/content/operate/rs/8.0/references/rest-api/requests/cluster/ldap.md b/content/operate/rs/8.0/references/rest-api/requests/cluster/ldap.md index fde91b31ac..34f2c55baa 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/cluster/ldap.md +++ b/content/operate/rs/8.0/references/rest-api/requests/cluster/ldap.md @@ -28,7 +28,7 @@ Get the LDAP configuration. | Permission name | |-----------------| -| [view_ldap_config]({{< relref "/operate/rs/8.0/references/rest-api/permissions#view_ldap_config" >}}) | +| [view_ldap_config](/content/operate/rs/8.0/references/rest-api/permissions.md#view_ldap_config) | ### Request {#get-request} @@ -45,7 +45,7 @@ Get the LDAP configuration. ### Response {#get-response} -Returns an [LDAP object]({{< relref "/operate/rs/8.0/references/rest-api/objects/ldap" >}}). +Returns an [LDAP object](/content/operate/rs/8.0/references/rest-api/objects/ldap.md). #### Example JSON body @@ -89,7 +89,7 @@ Set or update the cluster LDAP configuration. | Permission name | |-----------------| -| [config_ldap]({{< relref "/operate/rs/8.0/references/rest-api/permissions#config_ldap" >}}) | +| [config_ldap](/content/operate/rs/8.0/references/rest-api/permissions.md#config_ldap) | ### Request {#put-request} @@ -122,7 +122,7 @@ Set or update the cluster LDAP configuration. #### Request body -Include an [LDAP object]({{< relref "/operate/rs/8.0/references/rest-api/objects/ldap" >}}) with updated fields in the request body. +Include an [LDAP object](/content/operate/rs/8.0/references/rest-api/objects/ldap.md) with updated fields in the request body. ### Response {#put-response} @@ -153,7 +153,7 @@ Clear the LDAP configuration. | Permission name | |-----------------| -| [config_ldap]({{< relref "/operate/rs/8.0/references/rest-api/permissions#config_ldap" >}}) | +| [config_ldap](/content/operate/rs/8.0/references/rest-api/permissions.md#config_ldap) | ### Request {#delete-request} diff --git a/content/operate/rs/8.0/references/rest-api/requests/cluster/module-capabilities.md b/content/operate/rs/8.0/references/rest-api/requests/cluster/module-capabilities.md index 53e56cd96f..7e904a22a0 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/cluster/module-capabilities.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/permissions#view_cluster_modules" >}}) | +| [view_cluster_modules](/content/operate/rs/8.0/references/rest-api/permissions.md#view_cluster_modules) | ### Request {#get-request} diff --git a/content/operate/rs/8.0/references/rest-api/requests/cluster/policy.md b/content/operate/rs/8.0/references/rest-api/requests/cluster/policy.md index 568adf5df6..10d0cb0978 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/cluster/policy.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/permissions#view_cluster_info" >}}) | +| [view_cluster_info](/content/operate/rs/8.0/references/rest-api/permissions.md#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/8.0/references/rest-api/objects/cluster_settings" >}}). +Returns a [cluster settings object](/content/operate/rs/8.0/references/rest-api/objects/cluster_settings.md). #### Example JSON body @@ -77,7 +77,7 @@ Update cluster policy settings. | Permission name | |-----------------| -| [update_cluster]({{< relref "/operate/rs/8.0/references/rest-api/permissions#update_cluster" >}}) | +| [update_cluster](/content/operate/rs/8.0/references/rest-api/permissions.md#update_cluster) | ### Request {#put-request} @@ -103,7 +103,7 @@ Update cluster policy settings. #### Request body -Include a [cluster settings object]({{< relref "/operate/rs/8.0/references/rest-api/objects/cluster_settings" >}}) with updated fields in the request body. +Include a [cluster settings object](/content/operate/rs/8.0/references/rest-api/objects/cluster_settings.md) with updated fields in the request body. ### Response {#put-response} diff --git a/content/operate/rs/8.0/references/rest-api/requests/cluster/services_configuration.md b/content/operate/rs/8.0/references/rest-api/requests/cluster/services_configuration.md index 47a8defea0..d8a068e47c 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/cluster/services_configuration.md +++ b/content/operate/rs/8.0/references/rest-api/requests/cluster/services_configuration.md @@ -27,7 +27,7 @@ Get cluster services settings. | Permission name | |-----------------| -| [view_cluster_info]({{< relref "/operate/rs/8.0/references/rest-api/permissions#view_cluster_info" >}}) | +| [view_cluster_info](/content/operate/rs/8.0/references/rest-api/permissions.md#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/8.0/references/rest-api/objects/services_configuration" >}}). +Returns a [services configuration object](/content/operate/rs/8.0/references/rest-api/objects/services_configuration/_index.md). #### Example JSON body @@ -76,7 +76,7 @@ Update the cluster services settings. | Permission name | |-----------------| -| [update_cluster]({{< relref "/operate/rs/8.0/references/rest-api/permissions#update_cluster" >}}) | +| [update_cluster](/content/operate/rs/8.0/references/rest-api/permissions.md#update_cluster) | ### Request {#put-request} @@ -104,11 +104,11 @@ Update the cluster services settings. #### Request body -Include a [services configuration object]({{< relref "/operate/rs/8.0/references/rest-api/objects/services_configuration" >}}) with updated fields in the request body. +Include a [services configuration object](/content/operate/rs/8.0/references/rest-api/objects/services_configuration/_index.md) with updated fields in the request body. ### Response {#put-response} -Returns the updated [services configuration object]({{< relref "/operate/rs/8.0/references/rest-api/objects/services_configuration" >}}). +Returns the updated [services configuration object](/content/operate/rs/8.0/references/rest-api/objects/services_configuration/_index.md). #### Example JSON body diff --git a/content/operate/rs/8.0/references/rest-api/requests/cluster/sso.md b/content/operate/rs/8.0/references/rest-api/requests/cluster/sso.md index 7a5a89c592..07b5caf8f1 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/cluster/sso.md +++ b/content/operate/rs/8.0/references/rest-api/requests/cluster/sso.md @@ -31,7 +31,7 @@ Get the single sign-on configuration as JSON. | Permission name | Roles | |-----------------|-------| -| [view_sso]({{< relref "/operate/rs/8.0/references/rest-api/permissions#view_sso" >}}) | admin
user_manager | +| [view_sso](/content/operate/rs/8.0/references/rest-api/permissions.md#view_sso) | admin
user_manager | ### Request {#get-request} @@ -48,7 +48,7 @@ Get the single sign-on configuration as JSON. ### Response {#get-response} -Returns an [SSO object]({{< relref "/operate/rs/8.0/references/rest-api/objects/sso" >}}). +Returns an [SSO object](/content/operate/rs/8.0/references/rest-api/objects/sso.md). #### Example JSON body @@ -90,7 +90,7 @@ Set or update the cluster single sign-on configuration. | Permission name | Roles | |-----------------|-------| -| [config_sso]({{< relref "/operate/rs/8.0/references/rest-api/permissions#config_sso" >}}) | admin
user_manager | +| [config_sso](/content/operate/rs/8.0/references/rest-api/permissions.md#config_sso) | admin
user_manager | ### Request {#put-request} @@ -125,7 +125,7 @@ Set or update the cluster single sign-on configuration. #### Request body -Include an [SSO object]({{< relref "/operate/rs/8.0/references/rest-api/objects/sso" >}}) with updated fields in the request body. +Include an [SSO object](/content/operate/rs/8.0/references/rest-api/objects/sso.md) with updated fields in the request body. ### Response {#put-response} @@ -158,7 +158,7 @@ Clear the single sign-on configuration. | Permission name | Roles | |-----------------|-------| -| [config_sso]({{< relref "/operate/rs/8.0/references/rest-api/permissions#config_sso" >}}) | admin
user_manager | +| [config_sso](/content/operate/rs/8.0/references/rest-api/permissions.md#config_sso) | admin
user_manager | ### Request {#delete-request} @@ -202,7 +202,7 @@ Generates and returns the SAML2 service provider metadata XML. | Permission name | Roles | |-----------------|-------| -| [view_sso]({{< relref "/operate/rs/8.0/references/rest-api/permissions#view_sso" >}}) | admin
user_manager | +| [view_sso](/content/operate/rs/8.0/references/rest-api/permissions.md#view_sso) | admin
user_manager | ### Request {#get-metadata-request} @@ -258,7 +258,7 @@ Uploads and validates the SAML2 identity provider metadata XML. | Permission name | Roles | |-----------------|-------| -| [config_sso]({{< relref "/operate/rs/8.0/references/rest-api/permissions#config_sso" >}}) | admin
user_manager | +| [config_sso](/content/operate/rs/8.0/references/rest-api/permissions.md#config_sso) | admin
user_manager | ### Request {#post-metadata-request} @@ -289,7 +289,7 @@ Uploads and validates the SAML2 identity provider metadata XML. ### Response {#post-metadata-response} -Returns an [SSO object]({{< relref "/operate/rs/8.0/references/rest-api/objects/sso" >}}) with the updated configuration. +Returns an [SSO object](/content/operate/rs/8.0/references/rest-api/objects/sso.md) with the updated configuration. #### Example JSON body diff --git a/content/operate/rs/8.0/references/rest-api/requests/cluster/stats/_index.md b/content/operate/rs/8.0/references/rest-api/requests/cluster/stats/_index.md index 37ca0340f4..57a3a19e41 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/cluster/stats/_index.md +++ b/content/operate/rs/8.0/references/rest-api/requests/cluster/stats/_index.md @@ -14,7 +14,7 @@ url: '/operate/rs/8.0/references/rest-api/requests/cluster/stats/' --- {{}} -The v1 statistics REST API endpoints are deprecated as of Redis Software version 7.22. Use the [metrics stream engine for monitoring v2]({{< relref "/operate/rs/8.0/monitoring/metrics_stream_engine" >}}) instead for real-time monitoring and metrics collection. +The v1 statistics REST API endpoints are deprecated as of Redis Software version 7.22. Use the [metrics stream engine for monitoring v2](/content/operate/rs/8.0/monitoring/metrics_stream_engine/_index.md) instead for real-time monitoring and metrics collection. {{}} | Method | Path | Description | @@ -33,7 +33,7 @@ Get cluster statistics. | Permission name | Roles | |-----------------|-------| -| [view_cluster_stats]({{< relref "/operate/rs/8.0/references/rest-api/permissions#view_cluster_stats" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | +| [view_cluster_stats](/content/operate/rs/8.0/references/rest-api/permissions.md#view_cluster_stats) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | ### Request {#get-request} @@ -60,7 +60,7 @@ GET /v1/cluster/stats/1?interval=1hour&stime=2014-08-28T10:00:00Z ### Response {#get-response} -Returns [statistics]({{< relref "/operate/rs/8.0/references/rest-api/objects/statistics" >}}) for the cluster. +Returns [statistics](/content/operate/rs/8.0/references/rest-api/objects/statistics/_index.md) for the cluster. #### Example JSON body diff --git a/content/operate/rs/8.0/references/rest-api/requests/cluster/stats/last.md b/content/operate/rs/8.0/references/rest-api/requests/cluster/stats/last.md index 907e973705..887a210c3b 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/cluster/stats/last.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/permissions#view_cluster_stats" >}}) | +| [view_cluster_stats](/content/operate/rs/8.0/references/rest-api/permissions.md#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/8.0/references/rest-api/objects/statistics" >}}) for the cluster. +Returns the most recent [statistics](/content/operate/rs/8.0/references/rest-api/objects/statistics/_index.md) for the cluster. #### Example JSON body diff --git a/content/operate/rs/8.0/references/rest-api/requests/cm_settings/_index.md b/content/operate/rs/8.0/references/rest-api/requests/cm_settings/_index.md index b345d2ee73..a0bb77615e 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/cm_settings/_index.md +++ b/content/operate/rs/8.0/references/rest-api/requests/cm_settings/_index.md @@ -30,7 +30,7 @@ Get Cluster Manager UI settings. | Permission name | Roles | |-----------------|-------| -| [view_cluster_info]({{< relref "/operate/rs/8.0/references/rest-api/permissions#view_cluster_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | +| [view_cluster_info](/content/operate/rs/8.0/references/rest-api/permissions.md#view_cluster_info) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | ### Request {#get-request} @@ -49,7 +49,7 @@ GET /v1/cm_settings ### Response {#get-response} -Returns a [cm_settings object]({{}}). +Returns a [cm_settings object](/content/operate/rs/8.0/references/rest-api/objects/cm_settings.md). #### Example JSON body @@ -77,7 +77,7 @@ Update Cluster Manager UI settings. | Permission name | Roles | |-----------------|-------| -| [update_cluster]({{< relref "/operate/rs/8.0/references/rest-api/permissions#update_cluster" >}}) | admin | +| [update_cluster](/content/operate/rs/8.0/references/rest-api/permissions.md#update_cluster) | admin | ### Request {#put-request} @@ -105,11 +105,11 @@ PUT /v1/cm_settings #### Body -Include a [cm_settings object]({{}}) with updated fields in the request body. +Include a [cm_settings object](/content/operate/rs/8.0/references/rest-api/objects/cm_settings.md) with updated fields in the request body. ### Response {#put-response} -Returns a [cm_settings object]({{}}) with the updated fields. +Returns a [cm_settings object](/content/operate/rs/8.0/references/rest-api/objects/cm_settings.md) with the updated fields. #### Example JSON body diff --git a/content/operate/rs/8.0/references/rest-api/requests/crdb_tasks/_index.md b/content/operate/rs/8.0/references/rest-api/requests/crdb_tasks/_index.md index e49e20717c..ab54f9c45f 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/crdb_tasks/_index.md +++ b/content/operate/rs/8.0/references/rest-api/requests/crdb_tasks/_index.md @@ -37,7 +37,7 @@ GET /v1/crdb_tasks ### Response {#get-all-response} -Returns a JSON array of [CRDB task objects]({{< relref "/operate/rs/8.0/references/rest-api/objects/crdb_task" >}}). +Returns a JSON array of [CRDB task objects](/content/operate/rs/8.0/references/rest-api/objects/crdb_task.md). #### Status codes {#get-all-status-codes} @@ -80,7 +80,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/8.0/references/rest-api/objects/crdb_task" >}}). +Returns a [CRDB task object](/content/operate/rs/8.0/references/rest-api/objects/crdb_task.md). ### Status codes {#get-status-codes} diff --git a/content/operate/rs/8.0/references/rest-api/requests/crdbs/_index.md b/content/operate/rs/8.0/references/rest-api/requests/crdbs/_index.md index dc247ba1c9..3cb1b6cd56 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/crdbs/_index.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/objects/crdb" >}}). +Returns a JSON array of [CRDB objects](/content/operate/rs/8.0/references/rest-api/objects/crdb/_index.md). ##### 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/8.0/references/rest-api/objects/crdb" >}}). +Returns a [CRDB object](/content/operate/rs/8.0/references/rest-api/objects/crdb/_index.md). #### Status codes {#get-status-codes} @@ -114,9 +114,9 @@ Updating `default_db_config` affects both existing and new instances. When you update `db_config`, it changes the configuration of the specified database instance. This field overrides any corresponding fields in `default_db_config`. -For a list of which settings must be identical across all instances and which to set per instance, see the [CRDB database config object]({{}}) reference. +For a list of which settings must be identical across all instances and which to set per instance, see the [CRDB database config object](/content/operate/rs/8.0/references/rest-api/objects/crdb/database_config.md) reference. -To add or remove instances, use [`POST crdbs/{crdb_guid}/updates`]({{< relref "/operate/rs/8.0/references/rest-api/requests/crdbs/updates#post-crdbs-updates" >}}) instead. +To add or remove instances, use [`POST crdbs/{crdb_guid}/updates`](/content/operate/rs/8.0/references/rest-api/requests/crdbs/updates.md#post-crdbs-updates) instead. ### Request {#patch-request} @@ -141,11 +141,11 @@ To add or remove instances, use [`POST crdbs/{crdb_guid}/updates`]( #### Request body -Include a [CRDB object]({{< relref "/operate/rs/8.0/references/rest-api/objects/crdb" >}}) with updated fields in the request body. +Include a [CRDB object](/content/operate/rs/8.0/references/rest-api/objects/crdb/_index.md) with updated fields in the request body. ### Response {#patch-response} -Returns a [CRDB task object]({{< relref "/operate/rs/8.0/references/rest-api/objects/crdb_task" >}}). +Returns a [CRDB task object](/content/operate/rs/8.0/references/rest-api/objects/crdb_task.md). #### Status codes {#patch-status-codes} @@ -165,7 +165,7 @@ POST /v1/crdbs Create a new Active-Active database. -For a list of which settings must be identical across all instances and which to set per instance, see the [CRDB database config object]({{}}) reference. +For a list of which settings must be identical across all instances and which to set per instance, see the [CRDB database config object](/content/operate/rs/8.0/references/rest-api/objects/crdb/database_config.md) reference. ### Request {#post-request} @@ -190,7 +190,7 @@ For a list of which settings must be identical across all instances and which to #### Request body -Include a [CRDB object]({{< relref "/operate/rs/8.0/references/rest-api/objects/crdb" >}}), which defines the Active-Active database, in the request body. +Include a [CRDB object](/content/operate/rs/8.0/references/rest-api/objects/crdb/_index.md), which defines the Active-Active database, in the request body. ##### Example body @@ -238,7 +238,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/8.0/references/rest-api/objects/crdb_task" >}}). +Returns a [CRDB task object](/content/operate/rs/8.0/references/rest-api/objects/crdb_task.md). #### Status codes {#post-status-codes} @@ -280,7 +280,7 @@ Delete an Active-Active database. ### Response {#delete-response} -Returns a [CRDB task object]({{< relref "/operate/rs/8.0/references/rest-api/objects/crdb_task" >}}). +Returns a [CRDB task object](/content/operate/rs/8.0/references/rest-api/objects/crdb_task.md). #### Status codes {#delete-status-codes} diff --git a/content/operate/rs/8.0/references/rest-api/requests/crdbs/flush.md b/content/operate/rs/8.0/references/rest-api/requests/crdbs/flush.md index 3f9c3e75bd..12b65ee987 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/crdbs/flush.md +++ b/content/operate/rs/8.0/references/rest-api/requests/crdbs/flush.md @@ -55,7 +55,7 @@ PUT /v1/crdbs/552bbccb-99f3-4142-bd17-93d245f0bc79/flush ### Response {#put-response} -Returns a [CRDB task object]({{< relref "/operate/rs/8.0/references/rest-api/objects/crdb_task" >}}). +Returns a [CRDB task object](/content/operate/rs/8.0/references/rest-api/objects/crdb_task.md). #### Status codes {#put-status-codes} diff --git a/content/operate/rs/8.0/references/rest-api/requests/crdbs/health_report.md b/content/operate/rs/8.0/references/rest-api/requests/crdbs/health_report.md index 25a98de465..6216333fda 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/crdbs/health_report.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/objects/crdb/health_report" >}}). +Returns a JSON array of [CRDB health report objects](/content/operate/rs/8.0/references/rest-api/objects/crdb/health_report/_index.md). ### Status codes {#get-status-codes} diff --git a/content/operate/rs/8.0/references/rest-api/requests/crdbs/purge.md b/content/operate/rs/8.0/references/rest-api/requests/crdbs/purge.md index 0cdb2d6f8f..78a6efe915 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/crdbs/purge.md +++ b/content/operate/rs/8.0/references/rest-api/requests/crdbs/purge.md @@ -51,7 +51,7 @@ removed instance). ### Response {#put-response} -Returns a [CRDB task object]({{< relref "/operate/rs/8.0/references/rest-api/objects/crdb_task" >}}). +Returns a [CRDB task object](/content/operate/rs/8.0/references/rest-api/objects/crdb_task.md). ### Status codes {#put-status-codes} diff --git a/content/operate/rs/8.0/references/rest-api/requests/crdbs/updates.md b/content/operate/rs/8.0/references/rest-api/requests/crdbs/updates.md index fb466cf089..9f42a5332b 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/crdbs/updates.md +++ b/content/operate/rs/8.0/references/rest-api/requests/crdbs/updates.md @@ -22,17 +22,16 @@ url: '/operate/rs/8.0/references/rest-api/requests/crdbs/updates/' Modify Active-Active configuration. -{{}} -This is a very powerful API request and can cause damage if used incorrectly. -{{}} +> [!WARNING] +> This is a very powerful API request and can cause damage if used incorrectly. -To add or remove instances, you must use this API. For simple configuration updates, use [`PATCH /crdbs/{crdb_guid}`]({{}}) instead. +To add or remove instances, you must use this API. For simple configuration updates, use [`PATCH /crdbs/{crdb_guid}`](/content/operate/rs/8.0/references/rest-api/requests/crdbs/_index.md#patch-crdbs) instead. Updating `default_db_config` affects both existing and new instances. When you update `db_config`, it changes the configuration of the specified database instance. This field overrides any corresponding fields in `default_db_config`. -For a list of which settings must be identical across all instances and which to set per instance, see the [CRDB database config object]({{}}) reference. +For a list of which settings must be identical across all instances and which to set per instance, see the [CRDB database config object](/content/operate/rs/8.0/references/rest-api/objects/crdb/database_config.md) reference. ### Request {#post-request} @@ -61,11 +60,11 @@ For a list of which settings must be identical across all instances and which to #### Request body -Include a [CRDB modify_request object]({{< relref "/operate/rs/8.0/references/rest-api/objects/crdb/modify_request" >}}) with updated fields in the request body. +Include a [CRDB modify_request object](/content/operate/rs/8.0/references/rest-api/objects/crdb/modify_request.md) with updated fields in the request body. ### Response {#post-response} -Returns a [CRDB task object]({{< relref "/operate/rs/8.0/references/rest-api/objects/crdb_task" >}}). +Returns a [CRDB task object](/content/operate/rs/8.0/references/rest-api/objects/crdb_task.md). ### Status codes {#post-status-codes} diff --git a/content/operate/rs/8.0/references/rest-api/requests/crdbs/upgrade.md b/content/operate/rs/8.0/references/rest-api/requests/crdbs/upgrade.md index 25abcce59d..9aa78acb91 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/crdbs/upgrade.md +++ b/content/operate/rs/8.0/references/rest-api/requests/crdbs/upgrade.md @@ -70,7 +70,7 @@ POST /v1/crdbs/1/upgrade ### Response {#post-response} -Returns a [CRDB task object]({{< relref "/operate/rs/8.0/references/rest-api/objects/crdb_task" >}}). +Returns a [CRDB task object](/content/operate/rs/8.0/references/rest-api/objects/crdb_task.md). #### Status codes {#post-status-codes} diff --git a/content/operate/rs/8.0/references/rest-api/requests/debuginfo/_index.md b/content/operate/rs/8.0/references/rest-api/requests/debuginfo/_index.md index 333cb65575..aa81215186 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/debuginfo/_index.md +++ b/content/operate/rs/8.0/references/rest-api/requests/debuginfo/_index.md @@ -13,7 +13,7 @@ url: '/operate/rs/8.0/references/rest-api/requests/debuginfo/' --- {{}} -These REST API paths are deprecated as of Redis Software version 7.4.2. Use the new paths [`/v1/cluster/debuginfo`]({{< relref "/operate/rs/8.0/references/rest-api/requests/cluster/debuginfo" >}}), [`/v1/nodes/debuginfo`]({{< relref "/operate/rs/8.0/references/rest-api/requests/nodes/debuginfo" >}}), and [`/v1/bdbs/debuginfo`]({{< relref "/operate/rs/8.0/references/rest-api/requests/bdbs/debuginfo" >}}) instead. +These REST API paths are deprecated as of Redis Software version 7.4.2. Use the new paths [`/v1/cluster/debuginfo`](/content/operate/rs/8.0/references/rest-api/requests/cluster/debuginfo.md), [`/v1/nodes/debuginfo`](/content/operate/rs/8.0/references/rest-api/requests/nodes/debuginfo.md), and [`/v1/bdbs/debuginfo`](/content/operate/rs/8.0/references/rest-api/requests/bdbs/debuginfo.md) 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. @@ -22,12 +22,12 @@ Downloads a support package, which includes logs and information about the clust | Method | Path | Description | |--------|------|-------------| -| [GET]({{< relref "./all#get-all-debuginfo" >}}) | `/v1/debuginfo/all` | Gets debug info for all nodes | -| [GET]({{< relref "./all/bdb#get-all-debuginfo-bdb" >}}) | `/v1/debuginfo/all/bdb/{bdb_uid}` | Gets debug info for a database from all nodes | +| [GET](./all#get-all-debuginfo) | `/v1/debuginfo/all` | Gets debug info for all nodes | +| [GET](./all/bdb#get-all-debuginfo-bdb) | `/v1/debuginfo/all/bdb/{bdb_uid}` | Gets debug info for a database from all nodes | ## Get debug info for the current node | Method | Path | Description | |--------|------|-------------| -| [GET]({{< relref "./node#get-debuginfo-node" >}}) | `/v1/debuginfo/node` | Gets debug info for the current node | -| [GET]({{< relref "./node/bdb#get-debuginfo-node-bdb" >}}) | `/v1/debuginfo/node/bdb/{bdb_uid}` | Gets debug info for a database from the current node | +| [GET](./node#get-debuginfo-node) | `/v1/debuginfo/node` | Gets debug info for the current node | +| [GET](./node/bdb#get-debuginfo-node-bdb) | `/v1/debuginfo/node/bdb/{bdb_uid}` | Gets debug info for a database from the current node | diff --git a/content/operate/rs/8.0/references/rest-api/requests/debuginfo/all/_index.md b/content/operate/rs/8.0/references/rest-api/requests/debuginfo/all/_index.md index 5511027a3b..c4e53a0fee 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/debuginfo/all/_index.md +++ b/content/operate/rs/8.0/references/rest-api/requests/debuginfo/all/_index.md @@ -14,7 +14,7 @@ url: '/operate/rs/8.0/references/rest-api/requests/debuginfo/all/' --- {{}} -This REST API path is deprecated as of Redis Software version 7.4.2. Use the new path [`/v1/cluster/debuginfo`]({{< relref "/operate/rs/8.0/references/rest-api/requests/cluster/debuginfo" >}}) instead. +This REST API path is deprecated as of Redis Software version 7.4.2. Use the new path [`/v1/cluster/debuginfo`](/content/operate/rs/8.0/references/rest-api/requests/cluster/debuginfo.md) 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/8.0/references/rest-api/permissions#view_debugging_info" >}}) | +| [view_debugging_info](/content/operate/rs/8.0/references/rest-api/permissions.md#view_debugging_info) | ### Request {#get-all-request} diff --git a/content/operate/rs/8.0/references/rest-api/requests/debuginfo/all/bdb.md b/content/operate/rs/8.0/references/rest-api/requests/debuginfo/all/bdb.md index 8ea5d78557..e54a038e60 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/debuginfo/all/bdb.md +++ b/content/operate/rs/8.0/references/rest-api/requests/debuginfo/all/bdb.md @@ -13,7 +13,7 @@ url: '/operate/rs/8.0/references/rest-api/requests/debuginfo/all/bdb/' --- {{}} -This REST API path is deprecated as of Redis Software version 7.4.2. Use the new path [`/v1/bdbs/debuginfo`]({{< relref "/operate/rs/8.0/references/rest-api/requests/bdbs/debuginfo" >}}) instead. +This REST API path is deprecated as of Redis Software version 7.4.2. Use the new path [`/v1/bdbs/debuginfo`](/content/operate/rs/8.0/references/rest-api/requests/bdbs/debuginfo.md) 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/8.0/references/rest-api/permissions#view_debugging_info" >}}) | +| [view_debugging_info](/content/operate/rs/8.0/references/rest-api/permissions.md#view_debugging_info) | ### Request {#get-all-request} diff --git a/content/operate/rs/8.0/references/rest-api/requests/debuginfo/node/_index.md b/content/operate/rs/8.0/references/rest-api/requests/debuginfo/node/_index.md index f7ef06beb3..2e448ce1c7 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/debuginfo/node/_index.md +++ b/content/operate/rs/8.0/references/rest-api/requests/debuginfo/node/_index.md @@ -14,7 +14,7 @@ url: '/operate/rs/8.0/references/rest-api/requests/debuginfo/node/' --- {{}} -This REST API path is deprecated as of Redis Software version 7.4.2. Use the new path [`/v1/nodes/debuginfo`]({{< relref "/operate/rs/8.0/references/rest-api/requests/nodes/debuginfo" >}}) instead. +This REST API path is deprecated as of Redis Software version 7.4.2. Use the new path [`/v1/nodes/debuginfo`](/content/operate/rs/8.0/references/rest-api/requests/nodes/debuginfo.md) 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/8.0/references/rest-api/permissions#view_debugging_info" >}}) | +| [view_debugging_info](/content/operate/rs/8.0/references/rest-api/permissions.md#view_debugging_info) | ### Request {#get-request} diff --git a/content/operate/rs/8.0/references/rest-api/requests/debuginfo/node/bdb.md b/content/operate/rs/8.0/references/rest-api/requests/debuginfo/node/bdb.md index 84a5610e95..6ec417cfa9 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/debuginfo/node/bdb.md +++ b/content/operate/rs/8.0/references/rest-api/requests/debuginfo/node/bdb.md @@ -13,7 +13,7 @@ url: '/operate/rs/8.0/references/rest-api/requests/debuginfo/node/bdb/' --- {{}} -This REST API path is deprecated as of Redis Software version 7.4.2. Use the new path [`/v1/bdbs/debuginfo`]({{< relref "/operate/rs/8.0/references/rest-api/requests/bdbs/debuginfo" >}}) instead. +This REST API path is deprecated as of Redis Software version 7.4.2. Use the new path [`/v1/bdbs/debuginfo`](/content/operate/rs/8.0/references/rest-api/requests/bdbs/debuginfo.md) 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/8.0/references/rest-api/permissions#view_debugging_info" >}}) | +| [view_debugging_info](/content/operate/rs/8.0/references/rest-api/permissions.md#view_debugging_info) | ### Request {#get-request} diff --git a/content/operate/rs/8.0/references/rest-api/requests/diagnostics/_index.md b/content/operate/rs/8.0/references/rest-api/requests/diagnostics/_index.md index edfaf78161..03147fc38e 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/diagnostics/_index.md +++ b/content/operate/rs/8.0/references/rest-api/requests/diagnostics/_index.md @@ -30,7 +30,7 @@ Gets the diagnostic logging service configuration as JSON. | Permission name | Roles | |-----------------|-------| -| [view_cluster_info]({{< relref "/operate/rs/8.0/references/rest-api/permissions#view_cluster_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | +| [view_cluster_info](/content/operate/rs/8.0/references/rest-api/permissions.md#view_cluster_info) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | ### Request {#get-request} @@ -116,7 +116,7 @@ Updates the diagnostic logging service configuration. | Permission name | Roles | |-----------------|-------| -| [update_cluster]({{< relref "/operate/rs/8.0/references/rest-api/permissions#update_cluster" >}}) | admin | +| [update_cluster](/content/operate/rs/8.0/references/rest-api/permissions.md#update_cluster) | admin | ### Request {#put-request} diff --git a/content/operate/rs/8.0/references/rest-api/requests/endpoints-stats/_index.md b/content/operate/rs/8.0/references/rest-api/requests/endpoints-stats/_index.md index 071dfefa27..ad8d447faf 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/endpoints-stats/_index.md +++ b/content/operate/rs/8.0/references/rest-api/requests/endpoints-stats/_index.md @@ -14,7 +14,7 @@ url: '/operate/rs/8.0/references/rest-api/requests/endpoints-stats/' --- {{}} -The v1 statistics REST API endpoints are deprecated as of Redis Software version 7.22. Use the [metrics stream engine for monitoring v2]({{< relref "/operate/rs/8.0/monitoring/metrics_stream_engine" >}}) instead for real-time monitoring and metrics collection. +The v1 statistics REST API endpoints are deprecated as of Redis Software version 7.22. Use the [metrics stream engine for monitoring v2](/content/operate/rs/8.0/monitoring/metrics_stream_engine/_index.md) instead for real-time monitoring and metrics collection. {{}} | Method | Path | Description | @@ -27,16 +27,15 @@ The v1 statistics REST API endpoints are deprecated as of Redis Software version Get statistics for all endpoint-proxy links. -{{}} -This method will return both endpoints and listeners stats for backwards -compatability. -{{}} +> [!NOTE] +> This method will return both endpoints and listeners stats for backwards +> compatability. #### Required permissions | Permission name | |-----------------| -| [view_endpoint_stats]({{< relref "/operate/rs/8.0/references/rest-api/permissions#view_endpoint_stats" >}}) | +| [view_endpoint_stats](/content/operate/rs/8.0/references/rest-api/permissions.md#view_endpoint_stats) | ### Request {#get-request} diff --git a/content/operate/rs/8.0/references/rest-api/requests/job_scheduler/_index.md b/content/operate/rs/8.0/references/rest-api/requests/job_scheduler/_index.md index d3a182add3..76f0b87596 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/job_scheduler/_index.md +++ b/content/operate/rs/8.0/references/rest-api/requests/job_scheduler/_index.md @@ -30,7 +30,7 @@ Get job scheduler information. | Permission name | Roles | |-----------------|-------| -| [view_cluster_info]({{< relref "/operate/rs/8.0/references/rest-api/permissions#view_cluster_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | +| [view_cluster_info](/content/operate/rs/8.0/references/rest-api/permissions.md#view_cluster_info) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | ### Request {#get-request} @@ -49,7 +49,7 @@ GET /v1/job_scheduler ### Response {#get-response} -Returns a [job_scheduler object]({{}}). +Returns a [job_scheduler object](/content/operate/rs/8.0/references/rest-api/objects/job_scheduler/_index.md). #### Example JSON body @@ -107,7 +107,7 @@ Update job scheduler settings. | Permission name | Roles | |-----------------|-------| -| [update_cluster]({{< relref "/operate/rs/8.0/references/rest-api/permissions#update_cluster" >}}) | admin | +| [update_cluster](/content/operate/rs/8.0/references/rest-api/permissions.md#update_cluster) | admin | ### Request {#put-request} @@ -137,11 +137,11 @@ PUT /v1/job_scheduler #### Body -Include a [job_scheduler object]({{}}) with updated fields in the request body. +Include a [job_scheduler object](/content/operate/rs/8.0/references/rest-api/objects/job_scheduler/_index.md) with updated fields in the request body. ### Response {#put-response} -Returns a [job_scheduler object]({{}}) with the updated fields. +Returns a [job_scheduler object](/content/operate/rs/8.0/references/rest-api/objects/job_scheduler/_index.md) with the updated fields. #### Example JSON body diff --git a/content/operate/rs/8.0/references/rest-api/requests/jsonschema/_index.md b/content/operate/rs/8.0/references/rest-api/requests/jsonschema/_index.md index 72aaf30037..5c85e50957 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/jsonschema/_index.md +++ b/content/operate/rs/8.0/references/rest-api/requests/jsonschema/_index.md @@ -21,7 +21,7 @@ url: '/operate/rs/8.0/references/rest-api/requests/jsonschema/' GET /v1/jsonschema -Get the JSON schema of various [Redis Software REST API objects]({{< relref "/operate/rs/8.0/references/rest-api/objects" >}}). +Get the JSON schema of various [Redis Software REST API objects](/content/operate/rs/8.0/references/rest-api/objects/_index.md). ### Request {#get-request} diff --git a/content/operate/rs/8.0/references/rest-api/requests/ldap_mappings/_index.md b/content/operate/rs/8.0/references/rest-api/requests/ldap_mappings/_index.md index 8986687dc1..db63d54c38 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/ldap_mappings/_index.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/permissions#view_all_ldap_mappings_info" >}}) | +| [view_all_ldap_mappings_info](/content/operate/rs/8.0/references/rest-api/permissions.md#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/8.0/references/rest-api/objects/ldap_mapping" >}}). +Returns a JSON array of [LDAP mapping objects](/content/operate/rs/8.0/references/rest-api/objects/ldap_mapping.md). #### Example JSON body @@ -83,7 +83,7 @@ Get a specific LDAP mapping. | Permission name | |-----------------| -| [view_ldap_mapping_info]({{< relref "/operate/rs/8.0/references/rest-api/permissions#view_ldap_mapping_info" >}}) | +| [view_ldap_mapping_info](/content/operate/rs/8.0/references/rest-api/permissions.md#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/8.0/references/rest-api/objects/ldap_mapping" >}}). +Returns an [LDAP mapping object](/content/operate/rs/8.0/references/rest-api/objects/ldap_mapping.md). #### Example JSON body @@ -151,7 +151,7 @@ Update an existing ldap_mapping object. | Permission name | |-----------------| -| [update_ldap_mapping]({{< relref "/operate/rs/8.0/references/rest-api/permissions#update_ldap_mapping" >}}) | +| [update_ldap_mapping](/content/operate/rs/8.0/references/rest-api/permissions.md#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/8.0/references/rest-api/objects/ldap_mapping" >}}) with updated fields in the request body. +Include an [LDAP mapping object](/content/operate/rs/8.0/references/rest-api/objects/ldap_mapping.md) 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/8.0/references/rest-api/permissions#create_ldap_mapping" >}}) | +| [create_ldap_mapping](/content/operate/rs/8.0/references/rest-api/permissions.md#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/8.0/references/rest-api/objects/ldap_mapping" >}}) in the request body. +Include an [LDAP mapping object](/content/operate/rs/8.0/references/rest-api/objects/ldap_mapping.md) in the request body. ### Response {#post-response} @@ -309,7 +309,7 @@ Delete an LDAP mapping object. | Permission name | |-----------------| -| [delete_ldap_mapping]({{< relref "/operate/rs/8.0/references/rest-api/permissions#delete_ldap_mapping" >}}) | +| [delete_ldap_mapping](/content/operate/rs/8.0/references/rest-api/permissions.md#delete_ldap_mapping) | ### Request {#delete-request} diff --git a/content/operate/rs/8.0/references/rest-api/requests/license/_index.md b/content/operate/rs/8.0/references/rest-api/requests/license/_index.md index 5837e5084c..50aa2e22da 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/license/_index.md +++ b/content/operate/rs/8.0/references/rest-api/requests/license/_index.md @@ -29,7 +29,7 @@ and supported features. | Permission name | |-----------------| -| [view_license]({{< relref "/operate/rs/8.0/references/rest-api/permissions#view_license" >}}) | +| [view_license](/content/operate/rs/8.0/references/rest-api/permissions.md#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/8.0/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](/content/operate/rs/8.0/clusters/configure/license-keys.md#expired-cluster-license) for a list of available actions and restrictions. #### Required permissions | Permission name | |-----------------| -| [install_new_license]({{< relref "/operate/rs/8.0/references/rest-api/permissions#install_new_license" >}}) | +| [install_new_license](/content/operate/rs/8.0/references/rest-api/permissions.md#install_new_license) | ### Request {#put-request} diff --git a/content/operate/rs/8.0/references/rest-api/requests/logs/_index.md b/content/operate/rs/8.0/references/rest-api/requests/logs/_index.md index 3dd77f0c76..b44a7d6db2 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/logs/_index.md +++ b/content/operate/rs/8.0/references/rest-api/requests/logs/_index.md @@ -27,7 +27,7 @@ Get cluster events log. | Permission name | |-----------------| -| [view_logged_events]({{< relref "/operate/rs/8.0/references/rest-api/permissions#view_logged_events" >}}) | +| [view_logged_events](/content/operate/rs/8.0/references/rest-api/permissions.md#view_logged_events) | ### Request {#get-request} diff --git a/content/operate/rs/8.0/references/rest-api/requests/migrations/_index.md b/content/operate/rs/8.0/references/rest-api/requests/migrations/_index.md index 72223c0fb2..2533972dac 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/migrations/_index.md +++ b/content/operate/rs/8.0/references/rest-api/requests/migrations/_index.md @@ -29,7 +29,7 @@ Gets the migration status of a database in the cluster when using Replica Of. | Permission name | Roles | |-----------------|-------| -| [view_bdb_info]({{< relref "/operate/rs/8.0/references/rest-api/permissions#view_bdb_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | +| [view_bdb_info](/content/operate/rs/8.0/references/rest-api/permissions.md#view_bdb_info) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | ### Request {#get-request} diff --git a/content/operate/rs/8.0/references/rest-api/requests/modules/_index.md b/content/operate/rs/8.0/references/rest-api/requests/modules/_index.md index b4d474f849..2323cd7f18 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/modules/_index.md +++ b/content/operate/rs/8.0/references/rest-api/requests/modules/_index.md @@ -30,7 +30,7 @@ List available modules, i.e. modules stored within the CCS. | Permission name | Roles | |-----------------|-------| -| [view_cluster_modules]({{< relref "/operate/rs/8.0/references/rest-api/permissions#view_cluster_modules" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | +| [view_cluster_modules](/content/operate/rs/8.0/references/rest-api/permissions.md#view_cluster_modules) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | ### Request {#list-request} @@ -49,7 +49,7 @@ GET /v1/modules ### Response {#list-response} -Returns a JSON array of [module objects]({{< relref "/operate/rs/8.0/references/rest-api/objects/module" >}}). +Returns a JSON array of [module objects](/content/operate/rs/8.0/references/rest-api/objects/module.md). #### Status codes {#list-status-codes} @@ -69,7 +69,7 @@ Get specific available modules, i.e. modules stored within the CCS. | Permission name | Roles | |-----------------|-------| -| [view_cluster_modules]({{< relref "/operate/rs/8.0/references/rest-api/permissions#view_cluster_modules" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | +| [view_cluster_modules](/content/operate/rs/8.0/references/rest-api/permissions.md#view_cluster_modules) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | ### Request {#get-request} @@ -94,7 +94,7 @@ GET /v1/modules/1 ### Response {#get-response} -Returns a [module object]({{< relref "/operate/rs/8.0/references/rest-api/objects/module" >}}). +Returns a [module object](/content/operate/rs/8.0/references/rest-api/objects/module.md). ### Status codes {#get-status-codes} diff --git a/content/operate/rs/8.0/references/rest-api/requests/modules/config.md b/content/operate/rs/8.0/references/rest-api/requests/modules/config.md index 9e10ec482e..e42eb09cb5 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/modules/config.md +++ b/content/operate/rs/8.0/references/rest-api/requests/modules/config.md @@ -13,7 +13,7 @@ url: '/operate/rs/8.0/references/rest-api/requests/modules/config/' --- {{}} -This REST API path is deprecated as of Redis Software version 7.4. Use [`PUT /v2/bdbs/`]({{}}) instead. +This REST API path is deprecated as of Redis Software version 7.4. Use [`PUT /v2/bdbs/`](/content/operate/rs/8.0/references/rest-api/requests/bdbs/_index.md#put-bdbs-action) instead. {{}} | Method | Path | Description | @@ -30,7 +30,7 @@ Use the module runtime configuration command (if defined) to configure new argum | Permission name | |-----------------| -| [edit_bdb_module]({{< relref "/operate/rs/8.0/references/rest-api/permissions#edit_bdb_module" >}}) | +| [edit_bdb_module](/content/operate/rs/8.0/references/rest-api/permissions.md#edit_bdb_module) | ### Request {#post-request} diff --git a/content/operate/rs/8.0/references/rest-api/requests/modules/user-defined.md b/content/operate/rs/8.0/references/rest-api/requests/modules/user-defined.md index 6bc92865e6..6236277587 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/modules/user-defined.md +++ b/content/operate/rs/8.0/references/rest-api/requests/modules/user-defined.md @@ -32,7 +32,7 @@ Returns a list of all custom module artifacts on the local node. | Permission name | Roles | |-----------------|-------| -| [view_cluster_modules]({{< relref "/operate/rs/8.0/references/rest-api/permissions#view_cluster_modules" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | +| [view_cluster_modules](/content/operate/rs/8.0/references/rest-api/permissions.md#view_cluster_modules) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | ### Request {#get-local-artifacts-request} @@ -86,7 +86,7 @@ Creates a module object in the cluster configuration store (CCS). After calling | Permission name | Roles | |-----------------|-------| -| [manage_cluster_modules]({{< relref "/operate/rs/8.0/references/rest-api/permissions#manage_cluster_modules" >}}) | admin | +| [manage_cluster_modules](/content/operate/rs/8.0/references/rest-api/permissions.md#manage_cluster_modules) | admin | ### Request {#post-user-defined-request} @@ -144,7 +144,7 @@ The request body is a JSON object that must contain the following fields: ### Response {#post-user-defined-response} -Returns a [module object]({{< relref "/operate/rs/8.0/references/rest-api/objects/module" >}}). +Returns a [module object](/content/operate/rs/8.0/references/rest-api/objects/module.md). #### Example JSON body @@ -187,7 +187,7 @@ The module must be packaged as a `.zip` file containing: | Permission name | Roles | |-----------------|-------| -| [manage_cluster_modules]({{< relref "/operate/rs/8.0/references/rest-api/permissions#manage_cluster_modules" >}}) | admin | +| [manage_cluster_modules](/content/operate/rs/8.0/references/rest-api/permissions.md#manage_cluster_modules) | admin | ### Request {#post-local-artifacts-request} @@ -231,7 +231,7 @@ Delete a module object from the cluster configuration store (CCS). This REST API | Permission name | Roles | |-----------------|-------| -| [manage_cluster_modules]({{< relref "/operate/rs/8.0/references/rest-api/permissions#manage_cluster_modules" >}}) | admin | +| [manage_cluster_modules](/content/operate/rs/8.0/references/rest-api/permissions.md#manage_cluster_modules) | admin | ### Request {#delete-user-defined-request} @@ -279,7 +279,7 @@ A local API to delete a custom module's artifact from the current node. You must | Permission name | Roles | |-----------------|-------| -| [manage_cluster_modules]({{< relref "/operate/rs/8.0/references/rest-api/permissions#manage_cluster_modules" >}}) | admin | +| [manage_cluster_modules](/content/operate/rs/8.0/references/rest-api/permissions.md#manage_cluster_modules) | admin | ### Request {#delete-local-artifacts-request} diff --git a/content/operate/rs/8.0/references/rest-api/requests/node_master_healthcheck/_index.md b/content/operate/rs/8.0/references/rest-api/requests/node_master_healthcheck/_index.md index 60c37eb1bc..1ad7d334da 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/node_master_healthcheck/_index.md +++ b/content/operate/rs/8.0/references/rest-api/requests/node_master_healthcheck/_index.md @@ -29,7 +29,7 @@ Checks whether the current node has a valid connection to the cluster's primary | Permission name | Roles | |-----------------|-------| -| [view_cluster_info]({{< relref "/operate/rs/8.0/references/rest-api/permissions#view_cluster_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | +| [view_cluster_info](/content/operate/rs/8.0/references/rest-api/permissions.md#view_cluster_info) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | ### Request {#get-request} diff --git a/content/operate/rs/8.0/references/rest-api/requests/nodes/_index.md b/content/operate/rs/8.0/references/rest-api/requests/nodes/_index.md index d361cf0333..7a89ea2e22 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/nodes/_index.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/permissions#view_all_nodes_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | +| [view_all_nodes_info](/content/operate/rs/8.0/references/rest-api/permissions.md#view_all_nodes_info) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | ### 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/8.0/references/rest-api/objects/node" >}}). +Returns a JSON array of [node objects](/content/operate/rs/8.0/references/rest-api/objects/node.md). #### Example JSON body @@ -115,7 +115,7 @@ Get a single cluster node. | Permission name | Roles | |-----------------|-------| -| [view_node_info]({{< relref "/operate/rs/8.0/references/rest-api/permissions#view_node_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | +| [view_node_info](/content/operate/rs/8.0/references/rest-api/permissions.md#view_node_info) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | ### Request {#get-request} @@ -140,7 +140,7 @@ GET /v1/nodes/1 ### Response {#get-response} -Returns a [node object]({{< relref "/operate/rs/8.0/references/rest-api/objects/node" >}}). +Returns a [node object](/content/operate/rs/8.0/references/rest-api/objects/node.md). #### Example JSON body @@ -165,7 +165,7 @@ Returns a [node object]({{< relref "/operate/rs/8.0/references/rest-api/objects/ PUT /v1/nodes/{int: uid} ``` -Update a [node object]({{< relref "/operate/rs/8.0/references/rest-api/objects/node" >}}). +Update a [node object](/content/operate/rs/8.0/references/rest-api/objects/node.md). Currently, you can edit the following attributes: @@ -182,15 +182,14 @@ Currently, you can edit the following attributes: | recovery_path | string | Recovery files path | | second_rack_id | string | Second rack ID where node is installed | -{{}} -You can only update the `addr` attribute for offline nodes. Otherwise, the request returns an error. -{{}} +> [!NOTE] +> You can only update the `addr` attribute for offline nodes. Otherwise, the request returns an error. ### Permissions | Permission name | Roles | |-----------------|-------| -| [update_node]({{< relref "/operate/rs/8.0/references/rest-api/permissions#update_node" >}}) | admin | +| [update_node](/content/operate/rs/8.0/references/rest-api/permissions.md#update_node) | admin | ### Request {#put-request} diff --git a/content/operate/rs/8.0/references/rest-api/requests/nodes/actions.md b/content/operate/rs/8.0/references/rest-api/requests/nodes/actions.md index 20dc4c4e50..5f3e708a40 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/nodes/actions.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/permissions#view_status_of_all_node_actions" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | +| [view_status_of_all_node_actions](/content/operate/rs/8.0/references/rest-api/permissions.md#view_status_of_all_node_actions) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | ### 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/8.0/references/rest-api/objects/action" >}}). +Returns a list of [action objects](/content/operate/rs/8.0/references/rest-api/objects/action.md). ### 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/8.0/references/rest-api/permissions#view_status_of_node_action" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | +| [view_status_of_node_action](/content/operate/rs/8.0/references/rest-api/permissions.md#view_status_of_node_action) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | ### 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/8.0/references/rest-api/objects/action" >}}) for the specified node. +Returns a JSON object that includes a list of [action objects](/content/operate/rs/8.0/references/rest-api/objects/action.md) 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/8.0/references/rest-api/objects/action" >}}) for the specified node. +Returns an [action object](/content/operate/rs/8.0/references/rest-api/objects/action.md) 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/8.0/references/rest-api/permissions#start_node_action" >}}) | admin | +| [start_node_action](/content/operate/rs/8.0/references/rest-api/permissions.md#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](/content/operate/rs/8.0/references/rest-api/requests/cluster/policy.md#put-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/8.0/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](/content/operate/rs/8.0/clusters/maintenance-mode.md) for more information. - As of Redis 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/8.0/clusters/maintenance-mode" >}}) for more information. +- `maintenance_off`: Restores node to its previous state before maintenance started. See [maintenance mode](/content/operate/rs/8.0/clusters/maintenance-mode.md) 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/8.0/references/rest-api/permissions#cancel_node_action" >}}) | +| [cancel_node_action](/content/operate/rs/8.0/references/rest-api/permissions.md#cancel_node_action) | ### Request {#delete-request} diff --git a/content/operate/rs/8.0/references/rest-api/requests/nodes/alerts.md b/content/operate/rs/8.0/references/rest-api/requests/nodes/alerts.md index 92cec47ec0..4f3a536532 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/nodes/alerts.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/permissions#view_all_nodes_alerts" >}}) | +| [view_all_nodes_alerts](/content/operate/rs/8.0/references/rest-api/permissions.md#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/8.0/references/rest-api/objects/alert" >}}) for each node. +Returns a hash of node UIDs and the [alert states](/content/operate/rs/8.0/references/rest-api/objects/alert.md) 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/8.0/references/rest-api/permissions#view_node_alerts" >}}) | +| [view_node_alerts](/content/operate/rs/8.0/references/rest-api/permissions.md#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/8.0/references/rest-api/objects/alert" >}}) and their states for a specific node. +Returns a hash of [alert objects](/content/operate/rs/8.0/references/rest-api/objects/alert.md) 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/8.0/references/rest-api/permissions#view_node_alerts" >}}) | +| [view_node_alerts](/content/operate/rs/8.0/references/rest-api/permissions.md#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/8.0/references/rest-api/objects/alert" >}}). +Returns an [alert object](/content/operate/rs/8.0/references/rest-api/objects/alert.md). #### Example JSON body diff --git a/content/operate/rs/8.0/references/rest-api/requests/nodes/check.md b/content/operate/rs/8.0/references/rest-api/requests/nodes/check.md index d56713eaaf..f115a28e91 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/nodes/check.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/permissions#view_node_check" >}}) | +| [view_node_check](/content/operate/rs/8.0/references/rest-api/permissions.md#view_node_check) | ### Request {#get-request} diff --git a/content/operate/rs/8.0/references/rest-api/requests/nodes/debuginfo.md b/content/operate/rs/8.0/references/rest-api/requests/nodes/debuginfo.md index b919c491fa..0688fda177 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/nodes/debuginfo.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/permissions#view_debugging_info" >}}) | +| [view_debugging_info](/content/operate/rs/8.0/references/rest-api/permissions.md#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/8.0/references/rest-api/permissions#view_debugging_info" >}}) | +| [view_debugging_info](/content/operate/rs/8.0/references/rest-api/permissions.md#view_debugging_info) | ### Request {#get-request} diff --git a/content/operate/rs/8.0/references/rest-api/requests/nodes/snapshots.md b/content/operate/rs/8.0/references/rest-api/requests/nodes/snapshots.md index bc688db967..917951da8b 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/nodes/snapshots.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/permissions#view_node_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | +| [view_node_info](/content/operate/rs/8.0/references/rest-api/permissions.md#view_node_info) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | ### 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/8.0/references/rest-api/permissions#update_node" >}}) | admin | +| [update_node](/content/operate/rs/8.0/references/rest-api/permissions.md#update_node) | admin | ### Request {#delete-request} diff --git a/content/operate/rs/8.0/references/rest-api/requests/nodes/stats/_index.md b/content/operate/rs/8.0/references/rest-api/requests/nodes/stats/_index.md index e284e74367..f8f78008d7 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/nodes/stats/_index.md +++ b/content/operate/rs/8.0/references/rest-api/requests/nodes/stats/_index.md @@ -14,7 +14,7 @@ url: '/operate/rs/8.0/references/rest-api/requests/nodes/stats/' --- {{}} -The v1 statistics REST API endpoints are deprecated as of Redis Software version 7.22. Use the [metrics stream engine for monitoring v2]({{< relref "/operate/rs/8.0/monitoring/metrics_stream_engine" >}}) instead for real-time monitoring and metrics collection. +The v1 statistics REST API endpoints are deprecated as of Redis Software version 7.22. Use the [metrics stream engine for monitoring v2](/content/operate/rs/8.0/monitoring/metrics_stream_engine/_index.md) instead for real-time monitoring and metrics collection. {{}} | Method | Path | Description | @@ -34,7 +34,7 @@ Get statistics for all nodes. | Permission name | |-----------------| -| [view_all_nodes_stats]({{< relref "/operate/rs/8.0/references/rest-api/permissions#view_all_nodes_stats" >}}) | +| [view_all_nodes_stats](/content/operate/rs/8.0/references/rest-api/permissions.md#view_all_nodes_stats) | ### Request {#get-all-request} @@ -61,7 +61,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/8.0/references/rest-api/objects/statistics" >}}) for all nodes. +Returns a JSON array of [statistics](/content/operate/rs/8.0/references/rest-api/objects/statistics/_index.md) for all nodes. #### Example JSON body @@ -147,7 +147,7 @@ Get statistics for a node. | Permission name | |-----------------| -| [view_node_stats]({{< relref "/operate/rs/8.0/references/rest-api/permissions#view_node_stats" >}}) | +| [view_node_stats](/content/operate/rs/8.0/references/rest-api/permissions.md#view_node_stats) | ### Request {#get-request} @@ -180,7 +180,7 @@ GET /v1/nodes/stats/1?interval=1hour&stime=2014-08-28T10:00:00Z ### Response {#get-response} -Returns [statistics]({{< relref "/operate/rs/8.0/references/rest-api/objects/statistics" >}}) for the specified node. +Returns [statistics](/content/operate/rs/8.0/references/rest-api/objects/statistics/_index.md) for the specified node. #### Example JSON body diff --git a/content/operate/rs/8.0/references/rest-api/requests/nodes/stats/last.md b/content/operate/rs/8.0/references/rest-api/requests/nodes/stats/last.md index cbf8457bd5..54725d0394 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/nodes/stats/last.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/permissions#view_all_nodes_stats" >}}) | +| [view_all_nodes_stats](/content/operate/rs/8.0/references/rest-api/permissions.md#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/8.0/references/rest-api/objects/statistics" >}}) for all nodes. +Returns most recent [statistics](/content/operate/rs/8.0/references/rest-api/objects/statistics/_index.md) 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/8.0/references/rest-api/permissions#view_node_stats" >}}) | +| [view_node_stats](/content/operate/rs/8.0/references/rest-api/permissions.md#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/8.0/references/rest-api/objects/statistics" >}}) for the specified node. +Returns the most recent [statistics](/content/operate/rs/8.0/references/rest-api/objects/statistics/_index.md) for the specified node. #### Example JSON body diff --git a/content/operate/rs/8.0/references/rest-api/requests/nodes/status.md b/content/operate/rs/8.0/references/rest-api/requests/nodes/status.md index b1475e748b..56922ded7e 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/nodes/status.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/permissions#view_node_info" >}}) | +| [view_node_info](/content/operate/rs/8.0/references/rest-api/permissions.md#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](/content/operate/rs/8.0/clusters/maintenance-mode.md) 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/8.0/references/rest-api/permissions#view_node_info" >}}) | +| [view_node_info](/content/operate/rs/8.0/references/rest-api/permissions.md#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](/content/operate/rs/8.0/clusters/maintenance-mode.md) process, the response includes a `maintenance_snapshot` field. #### Example JSON body diff --git a/content/operate/rs/8.0/references/rest-api/requests/ocsp/_index.md b/content/operate/rs/8.0/references/rest-api/requests/ocsp/_index.md index 4d711651e6..6b4712c32a 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/ocsp/_index.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/permissions#view_ocsp_config" >}}) | +| [view_ocsp_config](/content/operate/rs/8.0/references/rest-api/permissions.md#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/8.0/references/rest-api/objects/ocsp" >}}). +Returns an [OCSP configuration object](/content/operate/rs/8.0/references/rest-api/objects/ocsp.md). #### Example JSON body @@ -86,7 +86,7 @@ Updates the cluster's OCSP configuration. | Permission name | |-----------------| -| [config_ocsp]({{< relref "/operate/rs/8.0/references/rest-api/permissions#config_ocsp" >}}) | +| [config_ocsp](/content/operate/rs/8.0/references/rest-api/permissions.md#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/8.0/references/rest-api/objects/ocsp" >}}) with updated fields in the request body. +Include an [OCSP configuration object](/content/operate/rs/8.0/references/rest-api/objects/ocsp.md) with updated fields in the request body. ### Response {#put-response} -Returns the updated [OCSP configuration object]({{< relref "/operate/rs/8.0/references/rest-api/objects/ocsp" >}}). +Returns the updated [OCSP configuration object](/content/operate/rs/8.0/references/rest-api/objects/ocsp.md). ### Error codes {#put-error-codes} diff --git a/content/operate/rs/8.0/references/rest-api/requests/ocsp/status.md b/content/operate/rs/8.0/references/rest-api/requests/ocsp/status.md index 8f861441e8..c43267c8bb 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/ocsp/status.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/permissions#view_ocsp_status" >}}) | +| [view_ocsp_status](/content/operate/rs/8.0/references/rest-api/permissions.md#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/8.0/references/rest-api/objects/ocsp_status" >}}). +Returns an [OCSP status object](/content/operate/rs/8.0/references/rest-api/objects/ocsp_status.md). #### Example JSON body diff --git a/content/operate/rs/8.0/references/rest-api/requests/ocsp/test.md b/content/operate/rs/8.0/references/rest-api/requests/ocsp/test.md index ed24164ce6..d3de51c516 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/ocsp/test.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/permissions#test_ocsp_status" >}}) | +| [test_ocsp_status](/content/operate/rs/8.0/references/rest-api/permissions.md#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/8.0/references/rest-api/objects/ocsp_status" >}}). +Returns an [OCSP status object](/content/operate/rs/8.0/references/rest-api/objects/ocsp_status.md). #### Example JSON body diff --git a/content/operate/rs/8.0/references/rest-api/requests/proxies/_index.md b/content/operate/rs/8.0/references/rest-api/requests/proxies/_index.md index 75b2a8b5d6..bef44c1194 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/proxies/_index.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/permissions#view_all_proxies_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | +| [view_all_proxies_info](/content/operate/rs/8.0/references/rest-api/permissions.md#view_all_proxies_info) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | ### 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/8.0/references/rest-api/objects/proxy" >}}). +Returns a JSON array of [proxy objects](/content/operate/rs/8.0/references/rest-api/objects/proxy.md). #### Example JSON body @@ -103,7 +103,7 @@ Get a single proxy's info. | Permission name | Roles | |-----------------|-------| -| [view_proxy_info]({{< relref "/operate/rs/8.0/references/rest-api/permissions#view_proxy_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | +| [view_proxy_info](/content/operate/rs/8.0/references/rest-api/permissions.md#view_proxy_info) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | ### Request {#get-request} @@ -128,7 +128,7 @@ GET /v1/proxies/1 ### Response {#get-response} -Returns a [proxy object]({{< relref "/operate/rs/8.0/references/rest-api/objects/proxy" >}}). +Returns a [proxy object](/content/operate/rs/8.0/references/rest-api/objects/proxy.md). #### 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/8.0/references/rest-api/permissions#update_proxy" >}}) | admin
user_manager | +| [update_proxy](/content/operate/rs/8.0/references/rest-api/permissions.md#update_proxy) | admin
user_manager | ### 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/8.0/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](/content/operate/rs/8.0/references/rest-api/objects/proxy.md) 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/8.0/references/rest-api/permissions#update_proxy" >}}) | admin
user_manager | +| [update_proxy](/content/operate/rs/8.0/references/rest-api/permissions.md#update_proxy) | admin
user_manager | ### 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/8.0/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](/content/operate/rs/8.0/references/rest-api/objects/proxy.md) with updated fields. ### Response {#put-all-response} diff --git a/content/operate/rs/8.0/references/rest-api/requests/redis_acls/_index.md b/content/operate/rs/8.0/references/rest-api/requests/redis_acls/_index.md index ee5d6439c3..f78b52281b 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/redis_acls/_index.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/permissions#view_all_redis_acls_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | +| [view_all_redis_acls_info](/content/operate/rs/8.0/references/rest-api/permissions.md#view_all_redis_acls_info) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | ### 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/8.0/references/rest-api/objects/redis_acl" >}}). +Returns a JSON array of [Redis ACL objects](/content/operate/rs/8.0/references/rest-api/objects/redis_acl.md). #### Example JSON body @@ -100,7 +100,7 @@ Get a single Redis ACL object. | Permission name | Roles | |-----------------|-------| -| [view_redis_acl_info]({{< relref "/operate/rs/8.0/references/rest-api/permissions#view_redis_acl_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | +| [view_redis_acl_info](/content/operate/rs/8.0/references/rest-api/permissions.md#view_redis_acl_info) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | ### Request {#get-request} @@ -126,7 +126,7 @@ GET /v1/redis_acls/1 ### Response {#get-response} -Returns a [Redis ACL object]({{< relref "/operate/rs/8.0/references/rest-api/objects/redis_acl" >}}). +Returns a [Redis ACL object](/content/operate/rs/8.0/references/rest-api/objects/redis_acl.md). #### Example JSON body @@ -159,7 +159,7 @@ Update an existing Redis ACL object. | Permission name | Roles | |-----------------|-------| -| [update_redis_acl]({{< relref "/operate/rs/8.0/references/rest-api/permissions#update_redis_acl" >}}) | admin
user_manager | +| [update_redis_acl](/content/operate/rs/8.0/references/rest-api/permissions.md#update_redis_acl) | admin
user_manager | ### Request {#put-request} @@ -188,7 +188,7 @@ PUT /v1/redis_acls/17 | Field | Type | Description | |---------|------|---------------| -| dry_run | | Validate the updated [Redis ACL object]({{< relref "/operate/rs/8.0/references/rest-api/objects/redis_acl" >}}) but don't apply the update. | +| dry_run | | Validate the updated [Redis ACL object](/content/operate/rs/8.0/references/rest-api/objects/redis_acl.md) but don't apply the update. | #### URL parameters @@ -198,11 +198,11 @@ PUT /v1/redis_acls/17 #### Request body -Include a [Redis ACL object]({{< relref "/operate/rs/8.0/references/rest-api/objects/redis_acl" >}}) with updated fields in the request body. +Include a [Redis ACL object](/content/operate/rs/8.0/references/rest-api/objects/redis_acl.md) with updated fields in the request body. ### Response {#put-response} -Returns the updated [Redis ACL object]({{< relref "/operate/rs/8.0/references/rest-api/objects/redis_acl" >}}). +Returns the updated [Redis ACL object](/content/operate/rs/8.0/references/rest-api/objects/redis_acl.md). #### Example JSON body @@ -244,7 +244,7 @@ Create a new Redis ACL object. | Permission name | Roles | |-----------------|-------| -| [create_redis_acl]({{< relref "/operate/rs/8.0/references/rest-api/permissions#create_redis_acl" >}}) | admin
user_manager | +| [create_redis_acl](/content/operate/rs/8.0/references/rest-api/permissions.md#create_redis_acl) | admin
user_manager | ### Request {#post-request} @@ -274,15 +274,15 @@ POST /v1/redis_acls | Field | Type | Description | |---------|------|---------------| -| dry_run | | Validate the new [Redis ACL object]({{< relref "/operate/rs/8.0/references/rest-api/objects/redis_acl" >}}) but don't apply the update. | +| dry_run | | Validate the new [Redis ACL object](/content/operate/rs/8.0/references/rest-api/objects/redis_acl.md) but don't apply the update. | #### Request body -Include a [Redis ACL object]({{< relref "/operate/rs/8.0/references/rest-api/objects/redis_acl" >}}) in the request body. +Include a [Redis ACL object](/content/operate/rs/8.0/references/rest-api/objects/redis_acl.md) in the request body. ### Response {#post-response} -Returns the newly created [Redis ACL object]({{< relref "/operate/rs/8.0/references/rest-api/objects/redis_acl" >}}). +Returns the newly created [Redis ACL object](/content/operate/rs/8.0/references/rest-api/objects/redis_acl.md). #### Example JSON body @@ -360,7 +360,7 @@ Delete a Redis ACL object. | Permission name | Roles | |-----------------|-------| -| [delete_redis_acl]({{< relref "/operate/rs/8.0/references/rest-api/permissions#delete_redis_acl" >}}) | admin
user_manager | +| [delete_redis_acl](/content/operate/rs/8.0/references/rest-api/permissions.md#delete_redis_acl) | admin
user_manager | ### Request {#delete-request} diff --git a/content/operate/rs/8.0/references/rest-api/requests/roles/_index.md b/content/operate/rs/8.0/references/rest-api/requests/roles/_index.md index 0b291e7e54..788b553193 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/roles/_index.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/permissions#view_all_roles_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | +| [view_all_roles_info](/content/operate/rs/8.0/references/rest-api/permissions.md#view_all_roles_info) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | ### 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/8.0/references/rest-api/objects/role" >}}). +Returns a JSON array of [role objects](/content/operate/rs/8.0/references/rest-api/objects/role.md). #### Example JSON body @@ -115,7 +115,7 @@ Get the details of a single role. | Permission name | Roles | |-----------------|-------| -| [view_role_info]({{< relref "/operate/rs/8.0/references/rest-api/permissions#view_role_info" >}}) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | +| [view_role_info](/content/operate/rs/8.0/references/rest-api/permissions.md#view_role_info) | admin
cluster_member
cluster_viewer
db_member
db_viewer
user_manager | ### Request {#get-request} @@ -142,7 +142,7 @@ GET /v1/roles/1 ### Response {#get-response} -Returns a [role object]({{< relref "/operate/rs/8.0/references/rest-api/objects/role" >}}). +Returns a [role object](/content/operate/rs/8.0/references/rest-api/objects/role.md). #### Example JSON body @@ -175,7 +175,7 @@ Update an existing role's details. | Permission name | Roles | |-----------------|-------| -| [update_role]({{< relref "/operate/rs/8.0/references/rest-api/permissions#update_role" >}}) | admin
user_manager | +| [update_role](/content/operate/rs/8.0/references/rest-api/permissions.md#update_role) | admin
user_manager | ### Request {#put-request} @@ -204,7 +204,7 @@ PUT /v1/roles/17 | Field | Type | Description | |---------|------|---------------| -| dry_run | | Validate the updated [role object]({{< relref "/operate/rs/8.0/references/rest-api/objects/role" >}}) but don't apply the update. | +| dry_run | | Validate the updated [role object](/content/operate/rs/8.0/references/rest-api/objects/role.md) but don't apply the update. | #### URL parameters @@ -214,11 +214,11 @@ PUT /v1/roles/17 #### Body -Include a [role object]({{< relref "/operate/rs/8.0/references/rest-api/objects/role" >}}) with updated fields in the request body. +Include a [role object](/content/operate/rs/8.0/references/rest-api/objects/role.md) with updated fields in the request body. ### Response {#put-response} -Returns a [role object]({{< relref "/operate/rs/8.0/references/rest-api/objects/role" >}}) with the updated fields. +Returns a [role object](/content/operate/rs/8.0/references/rest-api/objects/role.md) with the updated fields. #### Example JSON body @@ -261,7 +261,7 @@ Create a new role. | Permission name | Roles | |-----------------|-------| -| [create_role]({{< relref "/operate/rs/8.0/references/rest-api/permissions#create_role" >}}) | admin
user_manager | +| [create_role](/content/operate/rs/8.0/references/rest-api/permissions.md#create_role) | admin
user_manager | ### Request {#post-request} @@ -291,15 +291,15 @@ POST /v1/roles | Field | Type | Description | |---------|------|---------------| -| dry_run | | Validate the new [role object]({{< relref "/operate/rs/8.0/references/rest-api/objects/role" >}}) but don't apply the update. | +| dry_run | | Validate the new [role object](/content/operate/rs/8.0/references/rest-api/objects/role.md) but don't apply the update. | #### Body -Include a [role object]({{< relref "/operate/rs/8.0/references/rest-api/objects/role" >}}) in the request body. +Include a [role object](/content/operate/rs/8.0/references/rest-api/objects/role.md) in the request body. ### Response {#post-response} -Returns the newly created [role object]({{< relref "/operate/rs/8.0/references/rest-api/objects/role" >}}). +Returns the newly created [role object](/content/operate/rs/8.0/references/rest-api/objects/role.md). #### Example JSON body @@ -376,7 +376,7 @@ Delete a role object. | Permission name | Roles | |-----------------|-------| -| [delete_role]({{< relref "/operate/rs/8.0/references/rest-api/permissions#delete_role" >}}) | admin
user_manager | +| [delete_role](/content/operate/rs/8.0/references/rest-api/permissions.md#delete_role) | admin
user_manager | ### Request {#delete-request} diff --git a/content/operate/rs/8.0/references/rest-api/requests/services/_index.md b/content/operate/rs/8.0/references/rest-api/requests/services/_index.md index 7d9b3e2152..8a1c47aaa3 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/services/_index.md +++ b/content/operate/rs/8.0/references/rest-api/requests/services/_index.md @@ -19,13 +19,12 @@ url: '/operate/rs/8.0/references/rest-api/requests/services/' | [POST](#post-local-services) | `/v1/local/services` | Modify or perform operations on local processes | | [POST](#post-services) | `/v1/services` | Modify or perform operations on primary node processes | -{{}} -This API is dangerous and should only be run with guidance from [Redis support](https://redis.io/support/). - -Stop, start, or restart optional services only. Changing the status of required services can negatively affect cluster behavior and cause a complete loss of the cluster and its data. - -For a list of optional services, see the [services configuration object reference]({{}}) or use a [`GET /v1/cluster/services_configuration`]({{}}) request. -{{}} +> [!WARNING] +> This API is dangerous and should only be run with guidance from [Redis support](https://redis.io/support/). +> +> Stop, start, or restart optional services only. Changing the status of required services can negatively affect cluster behavior and cause a complete loss of the cluster and its data. +> +> For a list of optional services, see the [services configuration object reference](/content/operate/rs/8.0/references/rest-api/objects/services_configuration/_index.md) or use a [`GET /v1/cluster/services_configuration`](/content/operate/rs/8.0/references/rest-api/requests/cluster/services_configuration.md#get-cluster-services_config) request. ## Get local services {#get-local-services} @@ -100,13 +99,12 @@ Supported `operation_type` values: - start - restart -{{}} -This API is dangerous and should only be run with guidance from [Redis support](https://redis.io/support/). - -Stop, start, or restart optional services only. Changing the status of required services can negatively affect cluster behavior and cause a complete loss of the cluster and its data. - -For a list of optional services, see the [services configuration object reference]({{}}) or use a [`GET /v1/cluster/services_configuration`]({{}}) request. -{{}} +> [!WARNING] +> This API is dangerous and should only be run with guidance from [Redis support](https://redis.io/support/). +> +> Stop, start, or restart optional services only. Changing the status of required services can negatively affect cluster behavior and cause a complete loss of the cluster and its data. +> +> For a list of optional services, see the [services configuration object reference](/content/operate/rs/8.0/references/rest-api/objects/services_configuration/_index.md) or use a [`GET /v1/cluster/services_configuration`](/content/operate/rs/8.0/references/rest-api/requests/cluster/services_configuration.md#get-cluster-services_config) request. ### Request {#post-local-request} @@ -169,13 +167,12 @@ Supported `operation_type` values: - start - restart -{{}} -This API is dangerous and should only be run with guidance from [Redis support](https://redis.io/support/). - -Stop, start, or restart optional services only. Changing the status of required services can negatively affect cluster behavior and cause a complete loss of the cluster and its data. - -For a list of optional services, see the [services configuration object reference]({{}}) or use a [`GET /v1/cluster/services_configuration`]({{}}) request. -{{}} +> [!WARNING] +> This API is dangerous and should only be run with guidance from [Redis support](https://redis.io/support/). +> +> Stop, start, or restart optional services only. Changing the status of required services can negatively affect cluster behavior and cause a complete loss of the cluster and its data. +> +> For a list of optional services, see the [services configuration object reference](/content/operate/rs/8.0/references/rest-api/objects/services_configuration/_index.md) or use a [`GET /v1/cluster/services_configuration`](/content/operate/rs/8.0/references/rest-api/requests/cluster/services_configuration.md#get-cluster-services_config) request. ### Request {#post-request} diff --git a/content/operate/rs/8.0/references/rest-api/requests/shards/_index.md b/content/operate/rs/8.0/references/rest-api/requests/shards/_index.md index e71fcdb47a..e7d727aa70 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/shards/_index.md +++ b/content/operate/rs/8.0/references/rest-api/requests/shards/_index.md @@ -41,11 +41,11 @@ Get information about all shards in the cluster. | Field | Type | Description | |-------|------|-------------| -| extra_info_keys | list of strings | An optional list of extra keys to be fetched from the Redis [`INFO`]({{< relref "/commands/info" >}}) command. See [extra_info_keys](#extra_info_keys) for common keys to include. | +| extra_info_keys | list of strings | An optional list of extra keys to be fetched from the Redis [`INFO`](/content/commands/info.md) command. See [extra_info_keys](#extra_info_keys) for common keys to include. | ### Response {#get-all-response} -Returns a JSON array of [shard objects]({{}}). +Returns a JSON array of [shard objects](/content/operate/rs/8.0/references/rest-api/objects/shard/_index.md). #### Example JSON body @@ -111,11 +111,11 @@ Gets information about a single shard. | Field | Type | Description | |-------|------|-------------| -| extra_info_keys | list of strings | An optional list of extra keys to be fetched from the Redis [`INFO`]({{< relref "/commands/info" >}}) command. See [extra_info_keys](#extra_info_keys) for common keys to include. | +| extra_info_keys | list of strings | An optional list of extra keys to be fetched from the Redis [`INFO`](/content/commands/info.md) command. See [extra_info_keys](#extra_info_keys) for common keys to include. | ### Response {#get-response} -Returns a [shard object]({{}}). +Returns a [shard object](/content/operate/rs/8.0/references/rest-api/objects/shard/_index.md). #### Example JSON body @@ -148,7 +148,7 @@ Returns a [shard object]({{}}) command key for shard requests using the `extra_info_keys` query parameter. The requested keys are returned in the `redis_info` object of the response. +You can include any Redis [`INFO`](/content/commands/info.md) command key for shard requests using the `extra_info_keys` query parameter. The requested keys are returned in the `redis_info` object of the response. See the following tables for common keys to include. diff --git a/content/operate/rs/8.0/references/rest-api/requests/shards/actions/_index.md b/content/operate/rs/8.0/references/rest-api/requests/shards/actions/_index.md index 9730e14c85..a529516b25 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/shards/actions/_index.md +++ b/content/operate/rs/8.0/references/rest-api/requests/shards/actions/_index.md @@ -17,5 +17,5 @@ url: '/operate/rs/8.0/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](/content/operate/rs/8.0/references/rest-api/requests/shards/actions/migrate.md#post-multi-shards) | `/v1/shards/actions/migrate` | Migrate multiple shards | +| [POST](/content/operate/rs/8.0/references/rest-api/requests/shards/actions/migrate.md#post-shard) | `/v1/shards/{uid}/actions/migrate` | Migrate a specific shard | diff --git a/content/operate/rs/8.0/references/rest-api/requests/shards/actions/failover.md b/content/operate/rs/8.0/references/rest-api/requests/shards/actions/failover.md index 74afc1c406..397c7b212c 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/shards/actions/failover.md +++ b/content/operate/rs/8.0/references/rest-api/requests/shards/actions/failover.md @@ -29,7 +29,7 @@ The cluster automatically manages failover to ensure high availability. Use this | Permission name | Roles | |-----------------|-------| -| [failover_shard]({{< relref "/operate/rs/8.0/references/rest-api/permissions#failover_shard" >}}) | admin
cluster_member
db_member | +| [failover_shard](/content/operate/rs/8.0/references/rest-api/permissions.md#failover_shard) | admin
cluster_member
db_member | ### Request {#post-multi-request} @@ -67,7 +67,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/`](/content/operate/rs/8.0/references/rest-api/requests/actions/_index.md#get-action) request. #### Example JSON body @@ -111,7 +111,7 @@ The cluster automatically manages failover to ensure high availability. Use this | Permission name | Roles | |-----------------|-------| -| [failover_shard]({{< relref "/operate/rs/8.0/references/rest-api/permissions#failover_shard" >}}) | admin
cluster_member
db_member | +| [failover_shard](/content/operate/rs/8.0/references/rest-api/permissions.md#failover_shard) | admin
cluster_member
db_member | ### Request {#post-request} @@ -156,7 +156,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/`](/content/operate/rs/8.0/references/rest-api/requests/actions/_index.md#get-action) request. #### Example JSON body diff --git a/content/operate/rs/8.0/references/rest-api/requests/shards/actions/migrate.md b/content/operate/rs/8.0/references/rest-api/requests/shards/actions/migrate.md index ceb150fff0..b1b4222e5e 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/shards/actions/migrate.md +++ b/content/operate/rs/8.0/references/rest-api/requests/shards/actions/migrate.md @@ -23,13 +23,13 @@ url: '/operate/rs/8.0/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](/content/operate/rs/8.0/databases/migrate-shards.md). #### Required permissions | Permission name | Roles | |-----------------|-------| -| [migrate_shard]({{< relref "/operate/rs/8.0/references/rest-api/permissions#migrate_shard" >}}) | admin
cluster_member
db_member | +| [migrate_shard](/content/operate/rs/8.0/references/rest-api/permissions.md#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/`](/content/operate/rs/8.0/references/rest-api/requests/actions/_index.md#get-action) 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](/content/operate/rs/8.0/databases/migrate-shards.md). #### Required permissions | Permission name | Roles | |-----------------|-------| -| [migrate_shard]({{< relref "/operate/rs/8.0/references/rest-api/permissions#migrate_shard" >}}) | admin
cluster_member
db_member | +| [migrate_shard](/content/operate/rs/8.0/references/rest-api/permissions.md#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/`](/content/operate/rs/8.0/references/rest-api/requests/actions/_index.md#get-action) request. #### Example JSON body diff --git a/content/operate/rs/8.0/references/rest-api/requests/shards/stats/_index.md b/content/operate/rs/8.0/references/rest-api/requests/shards/stats/_index.md index aef51afb48..fcb7c21f8a 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/shards/stats/_index.md +++ b/content/operate/rs/8.0/references/rest-api/requests/shards/stats/_index.md @@ -14,7 +14,7 @@ url: '/operate/rs/8.0/references/rest-api/requests/shards/stats/' --- {{}} -The v1 statistics REST API endpoints are deprecated as of Redis Software version 7.22. Use the [metrics stream engine for monitoring v2]({{< relref "/operate/rs/8.0/monitoring/metrics_stream_engine" >}}) instead for real-time monitoring and metrics collection. +The v1 statistics REST API endpoints are deprecated as of Redis Software version 7.22. Use the [metrics stream engine for monitoring v2](/content/operate/rs/8.0/monitoring/metrics_stream_engine/_index.md) instead for real-time monitoring and metrics collection. {{}} | Method | Path | Description | @@ -32,7 +32,7 @@ Get statistics for all shards. | Permission name | |-----------------| -| [view_all_shard_stats]({{< relref "/operate/rs/8.0/references/rest-api/permissions#view_all_shard_stats" >}}) | +| [view_all_shard_stats](/content/operate/rs/8.0/references/rest-api/permissions.md#view_all_shard_stats) | ### Request {#get-all-request} @@ -57,11 +57,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/8.0/references/rest-api/objects/statistics/shard-metrics" >}}) for which we want statistics (default is all) (optional) | +| metrics | list | Comma-separated list of [metric names](/content/operate/rs/8.0/references/rest-api/objects/statistics/shard-metrics.md) for which we want statistics (default is all) (optional) | ### Response {#get-all-response} -Returns a JSON array of [statistics]({{< relref "/operate/rs/8.0/references/rest-api/objects/statistics" >}}) for all shards. +Returns a JSON array of [statistics](/content/operate/rs/8.0/references/rest-api/objects/statistics/_index.md) for all shards. #### Example JSON body @@ -150,7 +150,7 @@ Get statistics for a specific shard. | Permission name | |-----------------| -| [view_shard_stats]({{< relref "/operate/rs/8.0/references/rest-api/permissions#view_shard_stats" >}}) | +| [view_shard_stats](/content/operate/rs/8.0/references/rest-api/permissions.md#view_shard_stats) | ### Request {#get-request} @@ -184,7 +184,7 @@ Get statistics for a specific shard. ### Response {#get-response} -Returns [statistics]({{< relref "/operate/rs/8.0/references/rest-api/objects/statistics" >}}) for the specified shard. +Returns [statistics](/content/operate/rs/8.0/references/rest-api/objects/statistics/_index.md) for the specified shard. #### Example JSON body diff --git a/content/operate/rs/8.0/references/rest-api/requests/shards/stats/last.md b/content/operate/rs/8.0/references/rest-api/requests/shards/stats/last.md index 17fd7b84e0..bdf1c69f3a 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/shards/stats/last.md +++ b/content/operate/rs/8.0/references/rest-api/requests/shards/stats/last.md @@ -27,7 +27,7 @@ Get most recent statistics for all shards. | Permission name | |-----------------| -| [view_all_shard_stats]({{< relref "/operate/rs/8.0/references/rest-api/permissions#view_all_shard_stats" >}}) | +| [view_all_shard_stats](/content/operate/rs/8.0/references/rest-api/permissions.md#view_all_shard_stats) | ### Request {#get-all-request} @@ -54,7 +54,7 @@ Get most recent statistics for all shards. ### Response {#get-all-response} -Returns most recent [statistics]({{< relref "/operate/rs/8.0/references/rest-api/objects/statistics" >}}) for all shards. +Returns most recent [statistics](/content/operate/rs/8.0/references/rest-api/objects/statistics/_index.md) for all shards. #### Example JSON body @@ -115,7 +115,7 @@ Get most recent statistics for a specific shard. | Permission name | |-----------------| -| [view_shard_stats]({{< relref "/operate/rs/8.0/references/rest-api/permissions#view_shard_stats" >}}) | +| [view_shard_stats](/content/operate/rs/8.0/references/rest-api/permissions.md#view_shard_stats) | ### Request {#get-request} @@ -149,7 +149,7 @@ Get most recent statistics for a specific shard. ### Response {#get-response} -Returns the most recent [statistics]({{< relref "/operate/rs/8.0/references/rest-api/objects/statistics" >}}) for the specified shard. +Returns the most recent [statistics](/content/operate/rs/8.0/references/rest-api/objects/statistics/_index.md) for the specified shard. #### Example JSON body diff --git a/content/operate/rs/8.0/references/rest-api/requests/suffix/_index.md b/content/operate/rs/8.0/references/rest-api/requests/suffix/_index.md index 8c9de24366..c1a1b12507 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/suffix/_index.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/objects/suffix" >}}). +Returns a [suffix object](/content/operate/rs/8.0/references/rest-api/objects/suffix.md). #### Example JSON body diff --git a/content/operate/rs/8.0/references/rest-api/requests/suffixes/_index.md b/content/operate/rs/8.0/references/rest-api/requests/suffixes/_index.md index f39ceb42bc..f4656216c1 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/suffixes/_index.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/objects/suffix" >}}). +The response body contains a JSON array with all suffixes, represented as [suffix objects](/content/operate/rs/8.0/references/rest-api/objects/suffix.md). #### Example JSON body diff --git a/content/operate/rs/8.0/references/rest-api/requests/users/_index.md b/content/operate/rs/8.0/references/rest-api/requests/users/_index.md index f3eebb842a..07006526c2 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/users/_index.md +++ b/content/operate/rs/8.0/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/8.0/references/rest-api/permissions#view_all_users_info" >}}) | admin
user_manager | +| [view_all_users_info](/content/operate/rs/8.0/references/rest-api/permissions.md#view_all_users_info) | admin
user_manager | ### 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/8.0/references/rest-api/objects/user" >}}). +Returns a JSON array of [user objects](/content/operate/rs/8.0/references/rest-api/objects/user.md). #### Example JSON body @@ -100,7 +100,7 @@ Get a single user's details. | Permission name | Roles | |-----------------|-------| -| [view_user_info]({{< relref "/operate/rs/8.0/references/rest-api/permissions#view_user_info" >}}) | admin
user_manager | +| [view_user_info](/content/operate/rs/8.0/references/rest-api/permissions.md#view_user_info) | admin
user_manager | ### Request {#get-request} @@ -125,7 +125,7 @@ GET /v1/users/1 ### Response {#get-response} -Returns a [user object]({{< relref "/operate/rs/8.0/references/rest-api/objects/user" >}}) that contains the details for the specified user ID. +Returns a [user object](/content/operate/rs/8.0/references/rest-api/objects/user.md) 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/8.0/references/rest-api/permissions#update_user" >}}) | admin
user_manager | +| [update_user](/content/operate/rs/8.0/references/rest-api/permissions.md#update_user) | admin
user_manager | Any user can change their own name, password, or alert preferences. @@ -195,7 +195,7 @@ PUT /v1/users/1 | Field | Type | Description | |---------|------|---------------| -| dry_run | | Validate the updated [user object]({{< relref "/operate/rs/8.0/references/rest-api/objects/user" >}}) but don't apply the update. | +| dry_run | | Validate the updated [user object](/content/operate/rs/8.0/references/rest-api/objects/user.md) but don't apply the update. | #### URL parameters @@ -206,11 +206,11 @@ PUT /v1/users/1 #### Request body -Include a [user object]({{< relref "/operate/rs/8.0/references/rest-api/objects/user" >}}) with updated fields in the request body. +Include a [user object](/content/operate/rs/8.0/references/rest-api/objects/user.md) with updated fields in the request body. ### Response {#put-response} -Returns the updated [user object]({{< relref "/operate/rs/8.0/references/rest-api/objects/user" >}}). +Returns the updated [user object](/content/operate/rs/8.0/references/rest-api/objects/user.md). #### Example JSON body @@ -227,9 +227,8 @@ Returns the updated [user object]({{< relref "/operate/rs/8.0/references/rest-ap } ``` -{{}} -For [RBAC-enabled clusters]({{< relref "/operate/rs/8.0/security/access-control" >}}), the returned user details include `role_uids` instead of `role`. -{{}} +> [!NOTE] +> For [RBAC-enabled clusters](/content/operate/rs/8.0/security/access-control/_index.md), the returned user details include `role_uids` instead of `role`. ### Error codes {#put-error-codes} @@ -263,7 +262,7 @@ Create a new user. | Permission name | Roles | |-----------------|-------| -| [create_new_user]({{< relref "/operate/rs/8.0/references/rest-api/permissions#create_new_user" >}}) | admin
user_manager | +| [create_new_user](/content/operate/rs/8.0/references/rest-api/permissions.md#create_new_user) | admin
user_manager | ### Request {#post-request} @@ -284,15 +283,14 @@ POST /v1/users | Field | Type | Description | |---------|------|---------------| -| dry_run | | Validate the new [user object]({{< relref "/operate/rs/8.0/references/rest-api/objects/user" >}}) but don't apply the update. | +| dry_run | | Validate the new [user object](/content/operate/rs/8.0/references/rest-api/objects/user.md) but don't apply the update. | #### Body -Include a single [user object]({{< relref "/operate/rs/8.0/references/rest-api/objects/user" >}}) in the request body. The user object must have an email, password, and role. +Include a single [user object](/content/operate/rs/8.0/references/rest-api/objects/user.md) in the request body. The user object must have an email, password, and role. -{{}} -For [RBAC-enabled clusters]({{< relref "/operate/rs/8.0/security/access-control" >}}), use `role_uids` instead of `role` in the request body. -{{}} +> [!NOTE] +> For [RBAC-enabled clusters](/content/operate/rs/8.0/security/access-control/_index.md), use `role_uids` instead of `role` in the request body. `email_alerts` can be configured either as: @@ -316,7 +314,7 @@ For [RBAC-enabled clusters]({{< relref "/operate/rs/8.0/security/access-control" ### Response {#post-response} -Returns the newly created [user object]({{< relref "/operate/rs/8.0/references/rest-api/objects/user" >}}). +Returns the newly created [user object](/content/operate/rs/8.0/references/rest-api/objects/user.md). #### Example JSON body @@ -417,7 +415,7 @@ Delete a user. | Permission name | Roles | |-----------------|-------| -| [delete_user]({{< relref "/operate/rs/8.0/references/rest-api/permissions#delete_user" >}}) | admin
user_manager | +| [delete_user](/content/operate/rs/8.0/references/rest-api/permissions.md#delete_user) | admin
user_manager | ### Request {#delete-request} diff --git a/content/operate/rs/8.0/references/terminology.md b/content/operate/rs/8.0/references/terminology.md index f6251cd459..dd0eb3f3a2 100644 --- a/content/operate/rs/8.0/references/terminology.md +++ b/content/operate/rs/8.0/references/terminology.md @@ -16,7 +16,7 @@ Here are explanations of some of the terms used in Redis Software. A _node_ is a physical machine, virtual machine, container or cloud instance on which the RS installation package was installed and the -[setup process]({{< relref "/operate/rs/8.0/clusters/new-cluster-setup" >}}) was run in order to make the machine part of the cluster. +[setup process](/content/operate/rs/8.0/clusters/new-cluster-setup.md) was run in order to make the machine part of the cluster. Each node is a container for running multiple Redis instances, referred to as "shards". @@ -28,7 +28,7 @@ if a cluster has only one node you cannot enable database replication, which helps to achieve high availability. A node is made up of several components, as detailed below, and works -together with the other cluster nodes. You can [add nodes]({{< relref "/operate/rs/8.0/clusters/add-node" >}}), [remove nodes]({{< relref "/operate/rs/8.0/clusters/remove-node" >}}), or [replace nodes]({{< relref "/operate/rs/8.0/clusters/replace-node" >}}) as needed. +together with the other cluster nodes. You can [add nodes](/content/operate/rs/8.0/clusters/add-node.md), [remove nodes](/content/operate/rs/8.0/clusters/remove-node.md), or [replace nodes](/content/operate/rs/8.0/clusters/replace-node.md) as needed. ## Redis instance (shard) @@ -39,20 +39,20 @@ Redis Software supports various database configurations: - **Standard Redis database** - A single Redis shard with no replication or clustering. -- [**Highly available Redis database**]({{< relref "/operate/rs/8.0/databases/durability-ha/replication" >}}) - Every database master shard +- [**Highly available Redis database**](/content/operate/rs/8.0/databases/durability-ha/replication.md) - Every database master shard has a replica shard, so that if the master shard fails the cluster can automatically fail over to the replica with minimal impact. Master and replica shards are always placed on separate nodes to ensure high availability. -- [**Clustered Redis database**]({{< relref "/operate/rs/8.0/databases/durability-ha/clustering" >}}) - The data stored in the database is +- [**Clustered Redis database**](/content/operate/rs/8.0/databases/durability-ha/clustering.md) - The data stored in the database is split across several shards. The number of shards can be defined by the user. Various performance optimization algorithms define where shards are placed within the cluster. During the lifetime of the - cluster, these algorithms might [migrate a shard]({{< relref "/operate/rs/8.0/databases/migrate-shards" >}}) between nodes. + cluster, these algorithms might [migrate a shard](/content/operate/rs/8.0/databases/migrate-shards.md) between nodes. - **Clustered and highly available Redis database** - Each master shard in the clustered database has a replica shard, enabling failover if the master shard fails. -You can configure [shard placement]({{< relref "/operate/rs/8.0/databases/configure/shard-placement" >}}) to optimize performance and availability. +You can configure [shard placement](/content/operate/rs/8.0/databases/configure/shard-placement.md) to optimize performance and availability. ## Proxy @@ -68,11 +68,11 @@ and employs various optimization methods. For example, to help ensure high-throughput and low-latency performance, the proxy might use instruction pipelining even if not instructed to do so by the client. -You can configure [proxy policies]({{< relref "/operate/rs/8.0/databases/configure/proxy-policy" >}}) to determine which nodes' proxies are active and bound to databases. +You can configure [proxy policies](/content/operate/rs/8.0/databases/configure/proxy-policy.md) to determine which nodes' proxies are active and bound to databases. ## Database endpoint -Each database is served by a [database endpoint]({{< relref "/operate/rs/8.0/databases/connect/test-client-connectivity" >}}) that is part of and +Each database is served by a [database endpoint](/content/operate/rs/8.0/databases/connect/test-client-connectivity.md) that is part of and managed by the proxies. The endpoint oversees forwarding Redis operations to specific database shards. @@ -93,7 +93,7 @@ In the case of a clustered database with multiple database shards, only one master endpoint acts as the master endpoint for all master shards, forwarding Redis operations to all shards as needed. -For high availability, you can configure [private and public endpoints]({{< relref "/operate/rs/8.0/networking/private-public-endpoints" >}}) for your databases. +For high availability, you can configure [private and public endpoints](/content/operate/rs/8.0/networking/private-public-endpoints.md) for your databases. ## Cluster manager @@ -121,8 +121,8 @@ Some of the primary functionalities of the cluster manager include: - Monitoring databases and endpoints across all nodes - Running the database resharding process - Running the database provisioning and de-provisioning processes -- Gathering [operational statistics]({{< relref "/operate/rs/8.0/monitoring" >}}) -- Enforcing [license and subscription limitations]({{< relref "/operate/rs/8.0/clusters/configure/license-keys" >}}) +- Gathering [operational statistics](/content/operate/rs/8.0/monitoring/_index.md) +- Enforcing [license and subscription limitations](/content/operate/rs/8.0/clusters/configure/license-keys.md) -You can manage your Redis Software clusters using the [Cluster Manager UI]({{< relref "/operate/rs/8.0/clusters/configure" >}}), [command-line tools]({{< relref "/operate/rs/8.0/references/cli-utilities" >}}), or the [REST API]({{< relref "/operate/rs/8.0/references/rest-api" >}}). +You can manage your Redis Software clusters using the [Cluster Manager UI](/content/operate/rs/8.0/clusters/configure/_index.md), [command-line tools](/content/operate/rs/8.0/references/cli-utilities/_index.md), or the [REST API](/content/operate/rs/8.0/references/rest-api/_index.md). diff --git a/content/operate/rs/8.0/references/upgrade-paths.md b/content/operate/rs/8.0/references/upgrade-paths.md index 2a1a8b45da..29fc5e8f67 100644 --- a/content/operate/rs/8.0/references/upgrade-paths.md +++ b/content/operate/rs/8.0/references/upgrade-paths.md @@ -14,10 +14,9 @@ url: '/operate/rs/8.0/references/upgrade-paths/' {{}} -For detailed upgrade instructions, see [Upgrade a Redis Software cluster]({{}}). +For detailed upgrade instructions, see [Upgrade a Redis Software cluster](/content/operate/rs/8.0/installing-upgrading/upgrading/upgrade-cluster.md). -See the [Redis Software product lifecycle]({{}}) for more information about release numbers and the end-of-life schedule. +See the [Redis Software product lifecycle](/content/operate/rs/8.0/installing-upgrading/product-lifecycle.md) for more information about release numbers and the end-of-life schedule. -{{}} -Redis Enterprise for Kubernetes has its own support lifecycle, which accounts for the Kubernetes distribution lifecycle. For details, see [Supported Kubernetes distributions]({{}}). -{{}} +> [!NOTE] +> Redis Enterprise for Kubernetes has its own support lifecycle, which accounts for the Kubernetes distribution lifecycle. For details, see [Supported Kubernetes distributions](/content/operate/kubernetes/reference/supported_k8s_distributions.md). From 2abd5896713bd883d64fa02c5686709ab5cdafca Mon Sep 17 00:00:00 2001 From: Andy Stark Date: Thu, 24 Sep 2026 10:41:27 +0100 Subject: [PATCH 2/3] DOC-7104: Canonical /commands links, real filenames in relative refs (same fix as #4093 review) Same defect pattern found and fixed on PR #4093 (7.22/references) after human review: 7 bare /commands?group= links in compatibility/commands/ missing the /content/ prefix, and 10 source-relative relrefs in rest-api/requests/{bdbs/actions,debuginfo}/_index.md pointing at a directory/file with no extension (works via Hugo's render-link.html GetPage resolution, confirmed byte-identical rendered href before/after, but not a working link when the same markdown renders in GitHub's PR view or VS Code). This version snapshot is a near-identical copy of 7.22's rest-api tree, so the same instances recur in the same two files. Co-Authored-By: Claude Sonnet 5 --- .../8.0/references/compatibility/commands/cluster.md | 2 +- .../references/compatibility/commands/connection.md | 2 +- .../8.0/references/compatibility/commands/generic.md | 2 +- .../8.0/references/compatibility/commands/pub-sub.md | 2 +- .../references/compatibility/commands/scripting.md | 2 +- .../8.0/references/compatibility/commands/server.md | 2 +- .../compatibility/commands/transactions.md | 2 +- .../rest-api/requests/bdbs/actions/_index.md | 12 ++++++------ .../references/rest-api/requests/debuginfo/_index.md | 8 ++++---- 9 files changed, 17 insertions(+), 17 deletions(-) diff --git a/content/operate/rs/8.0/references/compatibility/commands/cluster.md b/content/operate/rs/8.0/references/compatibility/commands/cluster.md index 07deb10a5c..ab1f3adb90 100644 --- a/content/operate/rs/8.0/references/compatibility/commands/cluster.md +++ b/content/operate/rs/8.0/references/compatibility/commands/cluster.md @@ -14,7 +14,7 @@ url: '/operate/rs/8.0/references/compatibility/commands/cluster/' [Clustering in Redis Software](/content/operate/rs/8.0/databases/durability-ha/clustering.md) and [Redis Cloud](/content/operate/rc/databases/configuration/clustering.md) differs from the [Redis Open Source cluster](/content/operate/oss_and_stack/management/scaling.md) and works with all standard Redis clients. -Redis Software blocks most [cluster commands](/commands?group=cluster). If you try to use a blocked cluster command, it returns an error. +Redis Software blocks most [cluster commands](/content/commands?group=cluster). If you try to use a blocked cluster command, it returns an error. | Command | Redis
Software | Redis
Cloud | Notes | |:--------|:----------------------|:-----------------|:------| diff --git a/content/operate/rs/8.0/references/compatibility/commands/connection.md b/content/operate/rs/8.0/references/compatibility/commands/connection.md index a59e472af1..e65089a0dc 100644 --- a/content/operate/rs/8.0/references/compatibility/commands/connection.md +++ b/content/operate/rs/8.0/references/compatibility/commands/connection.md @@ -12,7 +12,7 @@ weight: 10 url: '/operate/rs/8.0/references/compatibility/commands/connection/' --- -The following tables show which Redis Open Source [connection management commands](/commands?group=connection) are compatible with standard and Active-Active databases in Redis Software and Redis Cloud. +The following tables show which Redis Open Source [connection management commands](/content/commands?group=connection) are compatible with standard and Active-Active databases in Redis Software and Redis Cloud. | Command | Redis
Software | Redis
Cloud | Notes | diff --git a/content/operate/rs/8.0/references/compatibility/commands/generic.md b/content/operate/rs/8.0/references/compatibility/commands/generic.md index aa6dbc580a..3015d7db01 100644 --- a/content/operate/rs/8.0/references/compatibility/commands/generic.md +++ b/content/operate/rs/8.0/references/compatibility/commands/generic.md @@ -12,7 +12,7 @@ weight: 10 url: '/operate/rs/8.0/references/compatibility/commands/generic/' --- -The following table shows which Redis Open Source [key (generic) commands](/commands?group=generic) are compatible with standard and Active-Active databases in Redis Software and Redis Cloud. +The following table shows which Redis Open Source [key (generic) commands](/content/commands?group=generic) are compatible with standard and Active-Active databases in Redis Software and Redis Cloud. | Command | Redis
Software | Redis
Cloud | Notes | |:--------|:----------------------|:-----------------|:------| diff --git a/content/operate/rs/8.0/references/compatibility/commands/pub-sub.md b/content/operate/rs/8.0/references/compatibility/commands/pub-sub.md index 45b979a0f2..96b61e76f8 100644 --- a/content/operate/rs/8.0/references/compatibility/commands/pub-sub.md +++ b/content/operate/rs/8.0/references/compatibility/commands/pub-sub.md @@ -12,7 +12,7 @@ weight: 10 url: '/operate/rs/8.0/references/compatibility/commands/pub-sub/' --- -The following table shows which Redis Open Source [pub/sub commands](/commands?group=pubsub) are compatible with standard and Active-Active databases in Redis Software and Redis Cloud. +The following table shows which Redis Open Source [pub/sub commands](/content/commands?group=pubsub) are compatible with standard and Active-Active databases in Redis Software and Redis Cloud. | Command | Redis
Software | Redis
Cloud | Notes | |:--------|:----------------------|:-----------------|:------| diff --git a/content/operate/rs/8.0/references/compatibility/commands/scripting.md b/content/operate/rs/8.0/references/compatibility/commands/scripting.md index 3228015c71..66c7a67500 100644 --- a/content/operate/rs/8.0/references/compatibility/commands/scripting.md +++ b/content/operate/rs/8.0/references/compatibility/commands/scripting.md @@ -12,7 +12,7 @@ weight: 10 url: '/operate/rs/8.0/references/compatibility/commands/scripting/' --- -The following table shows which Redis Open Source [scripting and function commands](/commands?group=scripting) are compatible with standard and Active-Active databases in Redis Software and Redis Cloud. +The following table shows which Redis Open Source [scripting and function commands](/content/commands?group=scripting) are compatible with standard and Active-Active databases in Redis Software and Redis Cloud. ## Function commands diff --git a/content/operate/rs/8.0/references/compatibility/commands/server.md b/content/operate/rs/8.0/references/compatibility/commands/server.md index 9d54b671b5..d98d3653f9 100644 --- a/content/operate/rs/8.0/references/compatibility/commands/server.md +++ b/content/operate/rs/8.0/references/compatibility/commands/server.md @@ -13,7 +13,7 @@ weight: 10 url: '/operate/rs/8.0/references/compatibility/commands/server/' --- -The following tables show which Redis Open Source [server management commands](/commands?group=server) are compatible with standard and Active-Active databases in Redis Software and Redis Cloud. +The following tables show which Redis Open Source [server management commands](/content/commands?group=server) are compatible with standard and Active-Active databases in Redis Software and Redis Cloud. ## Access control commands diff --git a/content/operate/rs/8.0/references/compatibility/commands/transactions.md b/content/operate/rs/8.0/references/compatibility/commands/transactions.md index f35ed5f145..d35734184d 100644 --- a/content/operate/rs/8.0/references/compatibility/commands/transactions.md +++ b/content/operate/rs/8.0/references/compatibility/commands/transactions.md @@ -12,7 +12,7 @@ weight: 10 url: '/operate/rs/8.0/references/compatibility/commands/transactions/' --- -The following table shows which Redis Open Source [transaction commands](/commands?group=transactions) are compatible with standard and Active-Active databases in Redis Software and Redis Cloud. +The following table shows which Redis Open Source [transaction commands](/content/commands?group=transactions) are compatible with standard and Active-Active databases in Redis Software and Redis Cloud. | Command | Redis
Software | Redis
Cloud | Notes | |:--------|:----------------------|:-----------------|:------| diff --git a/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/_index.md b/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/_index.md index 453b5793c5..948093a321 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/_index.md +++ b/content/operate/rs/8.0/references/rest-api/requests/bdbs/actions/_index.md @@ -17,27 +17,27 @@ url: '/operate/rs/8.0/references/rest-api/requests/bdbs/actions/' | Method | Path | Description | |--------|------|-------------| -| [PUT](./backup_reset_status#put-bdbs-actions-backup-reset-status) | `/v1/bdbs/{uid}/actions/backup_reset_status` | Reset database backup status | +| [PUT](./backup_reset_status.md#put-bdbs-actions-backup-reset-status) | `/v1/bdbs/{uid}/actions/backup_reset_status` | Reset database backup status | ## Export | Method | Path | Description | |--------|------|-------------| -| [PUT](./export_reset_status#put-bdbs-actions-export-reset-status) | `/v1/bdbs/{uid}/actions/export_reset_status` | Reset database export status | -| [POST](./export#post-bdbs-actions-export) | `/v1/bdbs/{uid}/actions/export` | Initiate database export | +| [PUT](./export_reset_status.md#put-bdbs-actions-export-reset-status) | `/v1/bdbs/{uid}/actions/export_reset_status` | Reset database export status | +| [POST](./export.md#post-bdbs-actions-export) | `/v1/bdbs/{uid}/actions/export` | Initiate database export | ## Import | Method | Path | Description | |--------|------|-------------| -| [PUT](./import_reset_status#put-bdbs-actions-import-reset-status) | `/v1/bdbs/{uid}/actions/import_reset_status` | Reset database import status | -| [POST](./import#post-bdbs-actions-import) | `/v1/bdbs/{uid}/actions/import` | Initiate manual dataset import | +| [PUT](./import_reset_status.md#put-bdbs-actions-import-reset-status) | `/v1/bdbs/{uid}/actions/import_reset_status` | Reset database import status | +| [POST](./import.md#post-bdbs-actions-import) | `/v1/bdbs/{uid}/actions/import` | Initiate manual dataset import | ## Optimize shards placement | Method | Path | Description | |--------|------|-------------| -| [GET](./optimize_shards_placement#get-bdbs-actions-optimize-shards-placement) | `/v1/bdbs/{uid}/actions/optimize_shards_placement` | Get optimized shards placement for a database | +| [GET](./optimize_shards_placement.md#get-bdbs-actions-optimize-shards-placement) | `/v1/bdbs/{uid}/actions/optimize_shards_placement` | Get optimized shards placement for a database | ## Rebalance diff --git a/content/operate/rs/8.0/references/rest-api/requests/debuginfo/_index.md b/content/operate/rs/8.0/references/rest-api/requests/debuginfo/_index.md index aa81215186..335c515a56 100644 --- a/content/operate/rs/8.0/references/rest-api/requests/debuginfo/_index.md +++ b/content/operate/rs/8.0/references/rest-api/requests/debuginfo/_index.md @@ -22,12 +22,12 @@ Downloads a support package, which includes logs and information about the clust | Method | Path | Description | |--------|------|-------------| -| [GET](./all#get-all-debuginfo) | `/v1/debuginfo/all` | Gets debug info for all nodes | -| [GET](./all/bdb#get-all-debuginfo-bdb) | `/v1/debuginfo/all/bdb/{bdb_uid}` | Gets debug info for a database from all nodes | +| [GET](./all/_index.md#get-all-debuginfo) | `/v1/debuginfo/all` | Gets debug info for all nodes | +| [GET](./all/bdb.md#get-all-debuginfo-bdb) | `/v1/debuginfo/all/bdb/{bdb_uid}` | Gets debug info for a database from all nodes | ## Get debug info for the current node | Method | Path | Description | |--------|------|-------------| -| [GET](./node#get-debuginfo-node) | `/v1/debuginfo/node` | Gets debug info for the current node | -| [GET](./node/bdb#get-debuginfo-node-bdb) | `/v1/debuginfo/node/bdb/{bdb_uid}` | Gets debug info for a database from the current node | +| [GET](./node/_index.md#get-debuginfo-node) | `/v1/debuginfo/node` | Gets debug info for the current node | +| [GET](./node/bdb.md#get-debuginfo-node-bdb) | `/v1/debuginfo/node/bdb/{bdb_uid}` | Gets debug info for a database from the current node | From 08f1599b467c0125aa9cabb4c2fd5b0feca8301d Mon Sep 17 00:00:00 2001 From: Andy Stark Date: Thu, 24 Sep 2026 11:10:51 +0100 Subject: [PATCH 3/3] DOC-7104: Fix bare /commands links in redis-cli/_index.md (review) Co-Authored-By: Claude Sonnet 5 --- .../rs/8.0/references/cli-utilities/redis-cli/_index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/operate/rs/8.0/references/cli-utilities/redis-cli/_index.md b/content/operate/rs/8.0/references/cli-utilities/redis-cli/_index.md index 7ba40b3eb9..757752f839 100644 --- a/content/operate/rs/8.0/references/cli-utilities/redis-cli/_index.md +++ b/content/operate/rs/8.0/references/cli-utilities/redis-cli/_index.md @@ -14,7 +14,7 @@ weight: $weight url: '/operate/rs/8.0/references/cli-utilities/redis-cli/' --- -The `redis-cli` command-line utility lets you interact with a Redis database. With `redis-cli`, you can run [Redis commands](/commands) directly from the command-line terminal or with [interactive mode](#interactive-mode). +The `redis-cli` command-line utility lets you interact with a Redis database. With `redis-cli`, you can run [Redis commands](/content/commands) directly from the command-line terminal or with [interactive mode](#interactive-mode). If you want to run Redis commands without `redis-cli`, you can [connect to a database with Redis Insight](/content/develop/tools/insight/_index.md) and use the built-in [CLI](/content/develop/tools/insight/_index.md) prompt instead. @@ -150,4 +150,4 @@ See [Scanning for big keys](/content/develop/tools/cli.md#scanning-for-big-keys) ## More info - [Redis CLI documentation](/content/develop/tools/cli.md) -- [Redis commands reference](/commands/) +- [Redis commands reference](/content/commands)