diff --git a/content/commands/bitcount.md b/content/commands/bitcount.md index d203d36353..d307bfa547 100644 --- a/content/commands/bitcount.md +++ b/content/commands/bitcount.md @@ -151,9 +151,7 @@ web site simply calling the `BITCOUNT` command against the bitmap. A similar pattern where user IDs are used instead of days is described in the article called "[Fast easy realtime metrics using Redis -bitmaps][hbgc212fermurb]". - -[hbgc212fermurb]: http://blog.getspool.com/2011/11/29/fast-easy-realtime-metrics-using-redis-bitmaps +bitmaps](http://blog.getspool.com/2011/11/29/fast-easy-realtime-metrics-using-redis-bitmaps)". ### Performance considerations diff --git a/content/commands/bitop.md b/content/commands/bitop.md index 661427ddd9..e30e94ff32 100644 --- a/content/commands/bitop.md +++ b/content/commands/bitop.md @@ -189,9 +189,7 @@ Different bitmaps can be combined in order to obtain a target bitmap where the population counting operation is performed. See the article called "[Fast easy realtime metrics using Redis -bitmaps][hbgc212fermurb]" for an interesting use cases. - -[hbgc212fermurb]: http://blog.getspool.com/2011/11/29/fast-easy-realtime-metrics-using-redis-bitmaps +bitmaps](http://blog.getspool.com/2011/11/29/fast-easy-realtime-metrics-using-redis-bitmaps)" for an interesting use cases. ### Performance considerations diff --git a/content/commands/brpop.md b/content/commands/brpop.md index a21baaf3a6..e616bb50e4 100644 --- a/content/commands/brpop.md +++ b/content/commands/brpop.md @@ -68,12 +68,10 @@ are no elements to pop from any of the given lists. An element is popped from the tail of the first list that is non-empty, with the given keys being checked in the order that they are given. -See the [BLPOP documentation][cb] for the exact semantics, since `BRPOP` is +See the [BLPOP documentation]({{< relref "/commands/blpop" >}}) for the exact semantics, since `BRPOP` is identical to [`BLPOP`]({{< relref "/commands/blpop" >}}) with the only difference being that it pops elements from the tail of a list instead of popping from the head. -[cb]: /commands/blpop - ## Required arguments
key [key ...] diff --git a/content/commands/bzpopmax.md b/content/commands/bzpopmax.md index 41a150da7e..ea7dabc07e 100644 --- a/content/commands/bzpopmax.md +++ b/content/commands/bzpopmax.md @@ -75,12 +75,10 @@ non-empty, with the given keys being checked in the order that they are given. The `timeout` argument is interpreted as a double value specifying the maximum number of seconds to block. A timeout of zero can be used to block indefinitely. -See the [BZPOPMIN documentation][cb] for the exact semantics, since `BZPOPMAX` +See the [BZPOPMIN documentation]({{< relref "/commands/bzpopmin" >}}) for the exact semantics, since `BZPOPMAX` is identical to [`BZPOPMIN`]({{< relref "/commands/bzpopmin" >}}) with the only difference being that it pops members with the highest scores instead of popping the ones with the lowest scores. -[cb]: /commands/bzpopmin - ## Required arguments
key [key ...] diff --git a/content/commands/bzpopmin.md b/content/commands/bzpopmin.md index 9442103024..8f53fe6cc5 100644 --- a/content/commands/bzpopmin.md +++ b/content/commands/bzpopmin.md @@ -75,12 +75,10 @@ non-empty, with the given keys being checked in the order that they are given. The `timeout` argument is interpreted as a double value specifying the maximum number of seconds to block. A timeout of zero can be used to block indefinitely. -See the [BLPOP documentation][cl] for the exact semantics, since `BZPOPMIN` is +See the [BLPOP documentation]({{< relref "/commands/blpop" >}}) for the exact semantics, since `BZPOPMIN` is identical to [`BLPOP`]({{< relref "/commands/blpop" >}}) with the only difference being the data structure being popped from. -[cl]: /commands/blpop - ## Required arguments
key [key ...] diff --git a/content/commands/command-docs.md b/content/commands/command-docs.md index 933a34b1ed..6055f616ee 100644 --- a/content/commands/command-docs.md +++ b/content/commands/command-docs.md @@ -86,9 +86,7 @@ The following keys may be included in the mapped reply: 1. The Redis version that the entry applies to. 2. The description of the change. * **arguments:** an array of maps that describe the command's arguments. - Please refer to the [Redis command arguments][td] page for more information. - -[td]: /develop/reference/command-arguments + Please refer to the [Redis command arguments]({{< relref "/develop/reference/command-arguments" >}}) page for more information. ## Optional arguments diff --git a/content/commands/command.md b/content/commands/command.md index a5f7ce2da3..0f65e17350 100644 --- a/content/commands/command.md +++ b/content/commands/command.md @@ -56,9 +56,9 @@ The exact number of elements in the array depends on the server's version. 1. First key 1. Last key 1. Step -1. [ACL categories][ta] (as of Redis 6.0) -1. [Tips][tb] (as of Redis 7.0) -1. [Key specifications][td] (as of Redis 7.0) +1. [ACL categories]({{< relref "/operate/oss_and_stack/management/security/acl" >}}) (as of Redis 6.0) +1. [Tips]({{< relref "/develop/reference/command-tips.md" >}}) (as of Redis 7.0) +1. [Key specifications]({{< relref "/develop/reference/key-specs.md" >}}) (as of Redis 7.0) 1. Subcommands (as of Redis 7.0) ## Name @@ -96,7 +96,7 @@ Command flags are an array. It can contain the following simple strings (status This flag is used for monitoring latency with the [`LATENCY`]({{< relref "/commands/latency" >}}) command. * **loading:** the command is allowed while the database is loading. * **movablekeys:** the _first key_, _last key_, and _step_ values don't determine all key positions. - Clients need to use [`COMMAND GETKEYS`]({{< relref "/commands/command-getkeys" >}}) or [key specifications][td] in this case. + Clients need to use [`COMMAND GETKEYS`]({{< relref "/commands/command-getkeys" >}}) or [key specifications]({{< relref "/develop/reference/key-specs.md" >}}) in this case. See below for more details. * **no_auth:** executing the command doesn't require authentication. * **no_async_loading:** the command is denied during asynchronous loading (that is when a replica uses disk-less `SWAPDB SYNC`, and allows access to the old dataset). @@ -105,12 +105,12 @@ Command flags are an array. It can contain the following simple strings (status * **noscript:** the command can't be called from [scripts]({{< relref "/develop/programmability/eval-intro" >}}) or [functions]({{< relref "/develop/programmability/functions-intro" >}}). * **pubsub:** the command is related to [Redis Pub/Sub]({{< relref "/develop/pubsub" >}}). * **random**: the command returns random results, which is a concern with verbatim script replication. - As of Redis 7.0, this flag is a [command tip][tb]. + As of Redis 7.0, this flag is a [command tip]({{< relref "/develop/reference/command-tips.md" >}}). * **readonly:** the command doesn't modify data. * **sort_for_script:** the command's output is sorted when called from a script. * **skip_monitor:** the command is not shown in [`MONITOR`]({{< relref "/commands/monitor" >}})'s output. * **skip_slowlog:** the command is not shown in [`SLOWLOG`]({{< relref "/commands/slowlog" >}})'s output. - As of Redis 7.0, this flag is a [command tip][tb]. + As of Redis 7.0, this flag is a [command tip]({{< relref "/develop/reference/command-tips.md" >}}). * **stale:** the command is allowed while a replica has stale data. * **write:** the command may modify data. @@ -146,7 +146,7 @@ You can use the [`COMMAND GETKEYS`]({{< relref "/commands/command-getkeys" >}}) As of Redis 7.0, clients can use the [key specifications](#key-specifications) to identify the positions of key names. The only commands that require using [`COMMAND GETKEYS`]({{< relref "/commands/command-getkeys" >}}) are [`SORT`]({{< relref "/commands/sort" >}}) and [`MIGRATE`]({{< relref "/commands/migrate" >}}) for clients that parse keys' specifications. -For more information, please refer to the [key specifications page][tr]. +For more information, please refer to the [key specifications page]({{< relref "/develop/reference/key-specs.md" >}}). ## First key @@ -200,21 +200,21 @@ Unlike [`MGET`]({{< relref "/commands/mget" >}}), which uses a step value of _1_ ## ACL categories This is an array of simple strings that are the ACL categories to which the command belongs. -Please refer to the [Access Control List][ta] page for more information. +Please refer to the [Access Control List]({{< relref "/operate/oss_and_stack/management/security/acl" >}}) page for more information. ## Command tips Helpful information about the command. To be used by clients/proxies. -Please check the [Command tips][tb] page for more information. +Please check the [Command tips]({{< relref "/develop/reference/command-tips.md" >}}) page for more information. ## Key specifications This is an array consisting of the command's key specifications. Each element in the array is a map describing a method for locating keys in the command's arguments. -For more information please check the [key specifications page][td]. +For more information please check the [key specifications page]({{< relref "/develop/reference/key-specs.md" >}}). ## Subcommands @@ -222,11 +222,6 @@ This is an array containing all of the command's subcommands, if any. Some Redis commands have subcommands (e.g., the `REWRITE` subcommand of [`CONFIG`]({{< relref "/commands/config" >}})). Each element in the array represents one subcommand and follows the same specifications as those of `COMMAND`'s reply. -[ta]: /operate/oss_and_stack/management/security/acl -[tb]: /develop/reference/command-tips.md -[td]: /develop/reference/key-specs.md -[tr]: /develop/reference/key-specs.md - ## Examples The following is `COMMAND`'s output for the [`GET`]({{< relref "/commands/get" >}}) command: diff --git a/content/commands/discard.md b/content/commands/discard.md index 2953b9bf4f..1e61cc261b 100644 --- a/content/commands/discard.md +++ b/content/commands/discard.md @@ -30,11 +30,9 @@ summary: Discards a transaction. syntax_fmt: DISCARD title: DISCARD --- -Flushes all previously queued commands in a [transaction][tt] and restores the +Flushes all previously queued commands in a [transaction]({{< relref "/develop/using-commands/transactions" >}}) and restores the connection state to normal. -[tt]: /develop/interact/transactions - If [`WATCH`]({{< relref "/commands/watch" >}}) was used, `DISCARD` unwatches all keys watched by the connection. ## Redis Software and Redis Cloud compatibility diff --git a/content/commands/exec.md b/content/commands/exec.md index f94d138d82..41b03f3c91 100644 --- a/content/commands/exec.md +++ b/content/commands/exec.md @@ -34,15 +34,11 @@ This command's behavior varies in clustered Redis environments. See the [multi-k {{< /note >}} -Executes all previously queued commands in a [transaction][tt] and restores the +Executes all previously queued commands in a [transaction]({{< relref "/develop/using-commands/transactions" >}}) and restores the connection state to normal. -[tt]: /develop/interact/transactions - When using [`WATCH`]({{< relref "/commands/watch" >}}), `EXEC` will execute commands only if the watched keys were -not modified, allowing for a [check-and-set mechanism][ttc]. - -[ttc]: /develop/interact/transactions#cas +not modified, allowing for a [check-and-set mechanism]({{< relref "/develop/using-commands/transactions#cas" >}}). ## Redis Software and Redis Cloud compatibility diff --git a/content/commands/expire.md b/content/commands/expire.md index 3140fd4839..7468073946 100644 --- a/content/commands/expire.md +++ b/content/commands/expire.md @@ -100,12 +100,9 @@ inherit all the characteristics of `Key_B`. Note that calling `EXPIRE`/[`PEXPIRE`]({{< relref "/commands/pexpire" >}}) with a non-positive timeout or [`EXPIREAT`]({{< relref "/commands/expireat" >}})/[`PEXPIREAT`]({{< relref "/commands/pexpireat" >}}) with a time in the past will result in the key being -[deleted][del] rather than expired (accordingly, the emitted [key event][ntf] +[deleted]({{< relref "/commands/del" >}}) rather than expired (accordingly, the emitted [key event]({{< relref "/develop/pubsub/keyspace-notifications" >}}) will be `del`, not `expired`). -[del]: /commands/del -[ntf]: /develop/use/keyspace-notifications - ## Required arguments
key diff --git a/content/commands/expireat.md b/content/commands/expireat.md index 21a1d53253..37d896077a 100644 --- a/content/commands/expireat.md +++ b/content/commands/expireat.md @@ -75,11 +75,9 @@ title: EXPIREAT --- `EXPIREAT` has the same effect and semantic as [`EXPIRE`]({{< relref "/commands/expire" >}}), but instead of specifying the number of seconds representing the TTL (time to live), it takes -an absolute [Unix timestamp][hewowu] (seconds since January 1, 1970). A +an absolute [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time) (seconds since January 1, 1970). A timestamp in the past will delete the key immediately. -[hewowu]: http://en.wikipedia.org/wiki/Unix_time - Please for the specific semantics of the command refer to the documentation of [`EXPIRE`]({{< relref "/commands/expire" >}}). diff --git a/content/commands/info.md b/content/commands/info.md index 2e8827c728..dfc8c100a3 100644 --- a/content/commands/info.md +++ b/content/commands/info.md @@ -146,7 +146,7 @@ Here is the meaning of all fields in the **memory** section: * `used_memory`: Total number of bytes allocated by Redis using its allocator (either standard **libc**, **jemalloc**, or an alternative - allocator such as [**tcmalloc**][hcgcpgp]) + allocator such as [**tcmalloc**](http://code.google.com/p/google-perftools/)) * `used_memory_human`: Human readable representation of previous value * `used_memory_rss`: Number of bytes that Redis allocated as seen by the operating system (a.k.a resident set size). This is the number reported by @@ -648,8 +648,6 @@ It won't be included when `INFO` or `INFO ALL` are called, and it is returned on * `allocator_resident_lua`: Total bytes resident (RSS) in the allocator specifically for Lua. This includes pages that can be released to the OS (by `MEMORY PURGE`, or just waiting). * `allocator_frag_bytes_lua`: Delta between `allocator_active_lua` and `allocator_allocated_lua`. -[hcgcpgp]: http://code.google.com/p/google-perftools/ - **A note about the word slave used in this man page**: Starting with Redis 5, if not for backward compatibility, the Redis project no longer uses the word slave. Unfortunately in this command the word slave is part of the protocol, so we'll be able to remove such occurrences only when this API will be naturally deprecated. **Modules generated sections**: Starting with Redis 6, modules can inject their information into the `INFO` command. These are excluded by default even when the `all` argument is provided (it will include a list of loaded modules but not their generated info fields). To get these you must use either the `modules` argument or `everything`. diff --git a/content/commands/latency-doctor.md b/content/commands/latency-doctor.md index 06403a05ba..81c12b6f0e 100644 --- a/content/commands/latency-doctor.md +++ b/content/commands/latency-doctor.md @@ -72,9 +72,7 @@ I have a few advices for you: **Note:** the doctor has erratic psychological behaviors, so we recommend interacting with it carefully. -For more information refer to the [Latency Monitoring Framework page][lm]. - -[lm]: /operate/oss_and_stack/management/optimization/latency-monitor.md +For more information refer to the [Latency Monitoring Framework page]({{< relref "/operate/oss_and_stack/management/optimization/latency-monitor.md" >}}). ## Redis Software and Redis Cloud compatibility diff --git a/content/commands/latency-graph.md b/content/commands/latency-graph.md index eb2f4420f3..4c265d6bac 100644 --- a/content/commands/latency-graph.md +++ b/content/commands/latency-graph.md @@ -103,9 +103,7 @@ first graphed event happened 15 seconds ago. The graph is normalized in the min-max scale so that the zero (the underscore in the lower row) is the minimum, and a # in the higher row is the maximum. -For more information refer to the [Latency Monitoring Framework page][lm]. - -[lm]: /operate/oss_and_stack/management/optimization/latency-monitor.md +For more information refer to the [Latency Monitoring Framework page]({{< relref "/operate/oss_and_stack/management/optimization/latency-monitor.md" >}}). ## Redis Software and Redis Cloud compatibility diff --git a/content/commands/latency-help.md b/content/commands/latency-help.md index d2b7f0b7ee..2091eb2532 100644 --- a/content/commands/latency-help.md +++ b/content/commands/latency-help.md @@ -29,9 +29,7 @@ title: LATENCY HELP The `LATENCY HELP` command returns a helpful text describing the different subcommands. -For more information refer to the [Latency Monitoring Framework page][lm]. - -[lm]: /operate/oss_and_stack/management/optimization/latency-monitor.md +For more information refer to the [Latency Monitoring Framework page]({{< relref "/operate/oss_and_stack/management/optimization/latency-monitor.md" >}}). ## Redis Software and Redis Cloud compatibility diff --git a/content/commands/latency-history.md b/content/commands/latency-history.md index ddf0442a16..b1318bd760 100644 --- a/content/commands/latency-history.md +++ b/content/commands/latency-history.md @@ -80,9 +80,7 @@ The latency event to return the history for. 2) (integer) 1001 ``` -For more information refer to the [Latency Monitoring Framework page][lm]. - -[lm]: /operate/oss_and_stack/management/optimization/latency-monitor.md +For more information refer to the [Latency Monitoring Framework page]({{< relref "/operate/oss_and_stack/management/optimization/latency-monitor.md" >}}). ## Redis Software and Redis Cloud compatibility diff --git a/content/commands/latency-latest.md b/content/commands/latency-latest.md index 37d2340f77..5d6f16da40 100644 --- a/content/commands/latency-latest.md +++ b/content/commands/latency-latest.md @@ -61,9 +61,7 @@ OK 4) (integer) 1001 ``` -For more information refer to the [Latency Monitoring Framework page][lm]. - -[lm]: /operate/oss_and_stack/management/optimization/latency-monitor.md +For more information refer to the [Latency Monitoring Framework page]({{< relref "/operate/oss_and_stack/management/optimization/latency-monitor.md" >}}). ## Redis Software and Redis Cloud compatibility diff --git a/content/commands/latency-reset.md b/content/commands/latency-reset.md index a91ff70382..f71ec3f873 100644 --- a/content/commands/latency-reset.md +++ b/content/commands/latency-reset.md @@ -66,9 +66,7 @@ Valid values for `event` are: * `fork` * `rdb-unlink-temp-file` -For more information refer to the [Latency Monitoring Framework page][lm]. - -[lm]: /operate/oss_and_stack/management/optimization/latency-monitor.md +For more information refer to the [Latency Monitoring Framework page]({{< relref "/operate/oss_and_stack/management/optimization/latency-monitor.md" >}}). ## Optional arguments diff --git a/content/commands/multi.md b/content/commands/multi.md index 594efced49..1a8880c06e 100644 --- a/content/commands/multi.md +++ b/content/commands/multi.md @@ -35,11 +35,9 @@ This command's behavior varies in clustered Redis environments. See the [multi-k {{< /note >}} -Marks the start of a [transaction][tt] block. +Marks the start of a [transaction]({{< relref "/develop/using-commands/transactions" >}}) block. Subsequent commands will be queued for atomic execution using [`EXEC`]({{< relref "/commands/exec" >}}). -[tt]: /develop/interact/transactions - ## Redis Software and Redis Cloud compatibility | Redis
Software | Redis
Cloud | Notes | diff --git a/content/commands/restore.md b/content/commands/restore.md index cdbc902967..b8a46cd170 100644 --- a/content/commands/restore.md +++ b/content/commands/restore.md @@ -96,9 +96,7 @@ If `ttl` is 0 the key is created without any expire, otherwise the specified expire time (in milliseconds) is set. If the `ABSTTL` modifier was used, `ttl` should represent an absolute -[Unix timestamp][hewowu] (in milliseconds) in which the key will expire. - -[hewowu]: http://en.wikipedia.org/wiki/Unix_time +[Unix timestamp](http://en.wikipedia.org/wiki/Unix_time) (in milliseconds) in which the key will expire. For eviction purposes, you may use the `IDLETIME` or `FREQ` modifiers. See [`OBJECT`]({{< relref "/commands/object" >}}) for more information. diff --git a/content/commands/setbit.md b/content/commands/setbit.md index f5df4b74c1..91855b4ee9 100644 --- a/content/commands/setbit.md +++ b/content/commands/setbit.md @@ -119,7 +119,7 @@ the entire bitmap. Bitmaps are not an actual data type, but a set of bit-oriented operations defined on the String type (for more information refer to the -[Bitmaps section of the Data Types Introduction page][ti]). This means that +[Bitmaps section of the Data Types Introduction page]({{< relref "/develop/data-types#bitmaps" >}})). This means that bitmaps can be used with string commands, and most importantly with [`SET`]({{< relref "/commands/set" >}}) and [`GET`]({{< relref "/commands/get" >}}). @@ -147,8 +147,6 @@ native programming language. Symmetrically, it is also possible to set an entire bitmap by performing the bits-to-bytes encoding in the client and calling [`SET`]({{< relref "/commands/set" >}}) with the resultant string. -[ti]: /develop/data-types-intro#bitmaps - ### Pattern: setting multiple bits `SETBIT` excels at setting single bits, and can be called several times when diff --git a/content/commands/sort.md b/content/commands/sort.md index 9ffc1ebefd..350e61a920 100644 --- a/content/commands/sort.md +++ b/content/commands/sort.md @@ -123,8 +123,8 @@ syntax_fmt: "SORT key [BY\_pattern] [LIMIT\_offset count] [GET\_pattern [GET pat \ ...]] [ASC | DESC] [ALPHA] [STORE\_destination]" title: SORT --- -Returns or stores the elements contained in the [list][tdtl], [set][tdts] or -[sorted set][tdtss] at `key`. +Returns or stores the elements contained in the [list]({{< relref "/develop/data-types#lists" >}}), [set]({{< relref "/develop/data-types#set" >}}) or +[sorted set]({{< relref "/develop/data-types#sorted-sets" >}}) at `key`. There is also the [`SORT_RO`]({{< relref "/commands/sort_ro" >}}) read-only variant of this command. @@ -132,10 +132,6 @@ By default, sorting is numeric and elements are compared by their value interpreted as double precision floating point number. This is `SORT` in its simplest form: -[tdtl]: /develop/data-types#lists -[tdts]: /develop/data-types#set -[tdtss]: /develop/data-types#sorted-sets - ``` SORT mylist ``` diff --git a/content/commands/sync.md b/content/commands/sync.md index 336b9fb831..7d527e17ea 100644 --- a/content/commands/sync.md +++ b/content/commands/sync.md @@ -36,9 +36,7 @@ stream from the master. It has been replaced in newer versions of Redis by [`PSYNC`]({{< relref "/commands/psync" >}}). For more information about replication in Redis please check the -[replication page][tr]. - -[tr]: /operate/oss_and_stack/management/replication +[replication page]({{< relref "/operate/oss_and_stack/management/replication" >}}). ## Redis Software and Redis Cloud compatibility diff --git a/content/commands/unwatch.md b/content/commands/unwatch.md index d00ca91544..d98ceceb95 100644 --- a/content/commands/unwatch.md +++ b/content/commands/unwatch.md @@ -30,9 +30,7 @@ summary: Forgets about watched keys of a transaction. syntax_fmt: UNWATCH title: UNWATCH --- -Flushes all the previously watched keys for a [transaction][tt]. - -[tt]: /develop/interact/transactions +Flushes all the previously watched keys for a [transaction]({{< relref "/develop/using-commands/transactions" >}}). If you call [`EXEC`]({{< relref "/commands/exec" >}}) or [`DISCARD`]({{< relref "/commands/discard" >}}), there's no need to manually call `UNWATCH`. diff --git a/content/commands/watch.md b/content/commands/watch.md index 59baa395d2..acd40b88f6 100644 --- a/content/commands/watch.md +++ b/content/commands/watch.md @@ -54,9 +54,7 @@ This command's behavior varies in clustered Redis environments. See the [multi-k Marks the given keys to be watched for conditional execution of a -[transaction][tt]. - -[tt]: /develop/interact/transactions +[transaction]({{< relref "/develop/using-commands/transactions" >}}). ## Redis Software and Redis Cloud compatibility diff --git a/content/commands/zadd.md b/content/commands/zadd.md index 85c94071d0..82da88b773 100644 --- a/content/commands/zadd.md +++ b/content/commands/zadd.md @@ -211,9 +211,7 @@ The current score of an element can be retrieved using the [`ZSCORE`]({{< relref that can also be used to verify if an element already exists or not. For an introduction to sorted sets, see the data types page on [sorted -sets][tdtss]. - -[tdtss]: /develop/data-types#sorted-sets +sets]({{< relref "/develop/data-types#sorted-sets" >}}). ### Elements with the same score diff --git a/content/develop/ai/redisvl/0.14.0/user_guide/sql_to_redis_queries.md b/content/develop/ai/redisvl/0.14.0/user_guide/sql_to_redis_queries.md index daadf91012..735e8ce8c2 100644 --- a/content/develop/ai/redisvl/0.14.0/user_guide/sql_to_redis_queries.md +++ b/content/develop/ai/redisvl/0.14.0/user_guide/sql_to_redis_queries.md @@ -500,7 +500,7 @@ results ### Aggregations -See docs for redis supported reducer functions: [https://redis.io/docs/latest/develop/ai/search-and-query/advanced-concepts/aggregations/#supported-groupby-reducers](docs). +See docs for redis supported reducer functions: [docs](https://redis.io/docs/latest/develop/ai/search-and-query/advanced-concepts/aggregations/#supported-groupby-reducers). ```python diff --git a/content/develop/ai/redisvl/0.23.0/user_guide/how_to_guides/mcp_authentication.md b/content/develop/ai/redisvl/0.23.0/user_guide/how_to_guides/mcp_authentication.md index f8bd258f36..5415241485 100644 --- a/content/develop/ai/redisvl/0.23.0/user_guide/how_to_guides/mcp_authentication.md +++ b/content/develop/ai/redisvl/0.23.0/user_guide/how_to_guides/mcp_authentication.md @@ -19,7 +19,7 @@ authenticated. Authentication is a separate concern from **transport security** (Host/Origin validation), which is always on for the HTTP transports and defends against DNS rebinding independently of auth. See -[Transport Security](mcp.md#transport-security-host-origin-validation). Both +[Transport Security]({{< relref "mcp#transport-security-host-origin-validation" >}}). Both layers apply together: auth decides *who* may call; the Host/Origin guard rejects requests whose claimed authority is not allowlisted. {{< /note >}} diff --git a/content/develop/ai/redisvl/0.6.0/user_guide/_index.md b/content/develop/ai/redisvl/0.6.0/user_guide/_index.md index f6e957b3bc..d3d3f5cbd9 100644 --- a/content/develop/ai/redisvl/0.6.0/user_guide/_index.md +++ b/content/develop/ai/redisvl/0.6.0/user_guide/_index.md @@ -84,13 +84,3 @@ User guides provide helpful resources for using RedisVL and its different compon * [Optimize](threshold_optimization/#optimize) * [Test it out](threshold_optimization/#test-it-out) * [Cleanup](threshold_optimization/#cleanup) -* [Release Guides](release_guide/) - * [0.5.1 Feature Overview](release_guide/0_5_0_release/) - * [HybridQuery class](release_guide/0_5_0_release/#hybridquery-class) - * [TextQueries](release_guide/0_5_0_release/#textqueries) - * [Threshold optimization](release_guide/0_5_0_release/#threshold-optimization) - * [Schema validation](release_guide/0_5_0_release/#schema-validation) - * [Timestamp filters](release_guide/0_5_0_release/#timestamp-filters) - * [Batch search](release_guide/0_5_0_release/#batch-search) - * [Vector normalization](release_guide/0_5_0_release/#vector-normalization) - * [Hybrid policy on knn with filters](release_guide/0_5_0_release/#hybrid-policy-on-knn-with-filters) diff --git a/content/develop/ai/redisvl/0.7.0/user_guide/_index.md b/content/develop/ai/redisvl/0.7.0/user_guide/_index.md index 6376349e2f..6f878b0f19 100644 --- a/content/develop/ai/redisvl/0.7.0/user_guide/_index.md +++ b/content/develop/ai/redisvl/0.7.0/user_guide/_index.md @@ -84,13 +84,3 @@ User guides provide helpful resources for using RedisVL and its different compon * [Optimize](threshold_optimization/#optimize) * [Test it out](threshold_optimization/#test-it-out) * [Cleanup](threshold_optimization/#cleanup) -* [Release Guides](release_guide/) - * [0.5.1 Feature Overview](release_guide/0_5_0_release/) - * [HybridQuery class](release_guide/0_5_0_release/#hybridquery-class) - * [TextQueries](release_guide/0_5_0_release/#textqueries) - * [Threshold optimization](release_guide/0_5_0_release/#threshold-optimization) - * [Schema validation](release_guide/0_5_0_release/#schema-validation) - * [Timestamp filters](release_guide/0_5_0_release/#timestamp-filters) - * [Batch search](release_guide/0_5_0_release/#batch-search) - * [Vector normalization](release_guide/0_5_0_release/#vector-normalization) - * [Hybrid policy on knn with filters](release_guide/0_5_0_release/#hybrid-policy-on-knn-with-filters) diff --git a/content/develop/ai/redisvl/user_guide/how_to_guides/mcp_authentication.md b/content/develop/ai/redisvl/user_guide/how_to_guides/mcp_authentication.md index 364d366a20..7b9e11f067 100644 --- a/content/develop/ai/redisvl/user_guide/how_to_guides/mcp_authentication.md +++ b/content/develop/ai/redisvl/user_guide/how_to_guides/mcp_authentication.md @@ -20,7 +20,7 @@ authenticated. Authentication is a separate concern from **transport security** (Host/Origin validation), which is always on for the HTTP transports and defends against DNS rebinding independently of auth. See -[Transport Security](mcp.md#transport-security-host-origin-validation). Both +[Transport Security]({{< relref "mcp#transport-security-host-origin-validation" >}}). Both layers apply together: auth decides *who* may call; the Host/Origin guard rejects requests whose claimed authority is not allowlisted. {{< /note >}} diff --git a/content/develop/ai/search-and-query/advanced-concepts/aggregations-syntax.md b/content/develop/ai/search-and-query/advanced-concepts/aggregations-syntax.md index 17ed7fc3a7..30bb605d4f 100644 --- a/content/develop/ai/search-and-query/advanced-concepts/aggregations-syntax.md +++ b/content/develop/ai/search-and-query/advanced-concepts/aggregations-syntax.md @@ -23,10 +23,6 @@ The [main aggregations page]({{< relref "/develop/ai/search-and-query/advanced-c `GROUPBY` ... `REDUCE` ... `APPLY` ... `GROUPBY` ... `REDUCE` -{{< note >}} -The examples on this page are based on a hypothetical "products" data set, which you can [download here](./data/products.txt). -{{< /note >}} - ## Syntax and expression ordering The `FT.AGGREGATE` command processes multiple expressions in a pipeline. Below is the recommended order: diff --git a/content/develop/clients/nodejs/amr.md b/content/develop/clients/nodejs/amr.md index 7384f0f4ef..edc0f976a1 100644 --- a/content/develop/clients/nodejs/amr.md +++ b/content/develop/clients/nodejs/amr.md @@ -155,7 +155,7 @@ authorityConfig: { }, // ... ``` -See Microsoft's [Authority]([Authority](https://learn.microsoft.com/en-us/entra/identity-platform/msal-client-application-configuration#authority)) +See Microsoft's [Authority](https://learn.microsoft.com/en-us/entra/identity-platform/msal-client-application-configuration#authority) docs for more information. ### Authenticate with a service principal diff --git a/content/develop/get-started/faq.md b/content/develop/get-started/faq.md index 2316f44a0e..826ac4db91 100644 --- a/content/develop/get-started/faq.md +++ b/content/develop/get-started/faq.md @@ -112,11 +112,9 @@ memory it will fail. Setting `overcommit_memory` to 1 tells Linux to relax and perform the fork in a more optimistic allocation fashion, and this is indeed what you want for Redis. -You can refer to the [proc(5)][proc5] man page for explanations of the +You can refer to the [proc(5)](http://man7.org/linux/man-pages/man5/proc.5.html) man page for explanations of the available values. -[proc5]: http://man7.org/linux/man-pages/man5/proc.5.html - ## Are Redis on-disk snapshots atomic? Yes, the Redis background saving process is always forked when the server is diff --git a/content/develop/reference/clients.md b/content/develop/reference/clients.md index c7a6803583..9a9c0fc745 100644 --- a/content/develop/reference/clients.md +++ b/content/develop/reference/clients.md @@ -199,7 +199,7 @@ In the above example two clients are connected to the Redis server. Let's look a * **omem**: The amount of memory used by the client for the output buffer. * **cmd**: The last executed command. -See the [[`CLIENT LIST`]({{< relref "/commands/client-list" >}})](/commands/client-list) documentation for the full listing of fields and their purpose. +See the [`CLIENT LIST`]({{< relref "/commands/client-list" >}}) documentation for the full listing of fields and their purpose. Once you have the list of clients, you can close a client's connection using the [`CLIENT KILL`]({{< relref "/commands/client-kill" >}}) command, specifying the client address as its argument. diff --git a/content/develop/reference/command-arguments.md b/content/develop/reference/command-arguments.md index 6aacb16cf7..c03d07f5c1 100644 --- a/content/develop/reference/command-arguments.md +++ b/content/develop/reference/command-arguments.md @@ -43,7 +43,7 @@ Every element in the _arguments_ array is a map with the following fields: - **block:** the argument is a container for nested arguments. This type enables grouping arguments and applying a property (such as _optional_) to all (see the [`XADD`]({{< relref "/commands/xadd" >}}) example below). * **key_spec_index:** this value is available for every argument of the _key_ type. - It is a 0-based index of the specification in the command's [key specifications][tr] that corresponds to the argument. + It is a 0-based index of the specification in the command's [key specifications]({{< relref "/develop/reference/key-specs.md" >}}) that corresponds to the argument. * **token**: a constant literal that precedes the argument (user input) itself. * **summary:** a short description of the argument. * **since:** the debut Redis version of the argument (or for module commands, the module version). @@ -57,8 +57,6 @@ Every element in the _arguments_ array is a map with the following fields: For arguments types other than _oneof_ and _block_, this is a string that describes the value in the command's syntax. For the _oneof_ and _block_ types, this is an array of nested arguments, each being a map as described in this section. -[tr]: /develop/reference/key-specs.md - ## Example The trimming clause of [`XADD`]({{< relref "/commands/xadd" >}}), i.e., `[MAXLEN|MINID [=|~] threshold [LIMIT count]]`, is represented at the top-level as _block_-typed argument. diff --git a/content/integrate/redisom-for-java/_index.md b/content/integrate/redisom-for-java/_index.md index 5a3ca329fd..d18e4f0162 100644 --- a/content/integrate/redisom-for-java/_index.md +++ b/content/integrate/redisom-for-java/_index.md @@ -27,7 +27,7 @@ Redis OM Spring provides a robust repository and custom object-mapping abstracti ## What you’ll need: -* Redis Stack: See [{{< relref "/operate/oss_and_stack/install/install-stack/" >}}]({{< relref "/operate/oss_and_stack/install/install-stack/" >}}) +* Redis Stack: See [Install Redis Open Source]({{< relref "/operate/oss_and_stack/install/install-stack/" >}}) * [Redis Insight]({{< relref "/develop/tools/insight" >}}) * Your favorite browser * Java 11 or greater diff --git a/content/operate/kubernetes/release-notes/previous-releases/k8s-5-4-10-8.md b/content/operate/kubernetes/release-notes/previous-releases/k8s-5-4-10-8.md index 69d14c0404..9f967e395c 100644 --- a/content/operate/kubernetes/release-notes/previous-releases/k8s-5-4-10-8.md +++ b/content/operate/kubernetes/release-notes/previous-releases/k8s-5-4-10-8.md @@ -26,7 +26,7 @@ Follow these [instructions]({{< relref "/operate/kubernetes/upgrade/upgrade-redi Pay special attention to the yaml file naming changes and new yaml files that have been created for this release. These are highlighted in the quick start guide. {{< /note >}} -- Rack Awareness - Support for the [Redis Software Rack Awareness][{{< relref "/operate/rs/clusters/configure/rack-zone-awareness.md" >}}] feature was introduced to the Kubernetes deployment. It enables deploying nodes to different zones, in a multi-zone Kubernetes cluster. Databases that are rack-aware will have the cluster populate their master shard and replica shards in different nodes, across different zones or failure domains. This enables maintaining data persistence in case of zone failure. +- Rack Awareness - Support for the [Redis Software Rack Awareness]({{< relref "/operate/rs/clusters/configure/rack-zone-awareness.md" >}}) feature was introduced to the Kubernetes deployment. It enables deploying nodes to different zones, in a multi-zone Kubernetes cluster. Databases that are rack-aware will have the cluster populate their master shard and replica shards in different nodes, across different zones or failure domains. This enables maintaining data persistence in case of zone failure. - OLM Support - Redis Enterprise for Kubernetes is now RedHat OpenShift certified and can be effortlessly configured and deployed in Kubernetes clusters supporting OLM, including OpenShift 4.x clusters, with just a few clicks. OLM based deployments do not require Kubernetes cluster administrator rights to deploy the operator. diff --git a/content/operate/oss_and_stack/management/optimization/benchmarks/index.md b/content/operate/oss_and_stack/management/optimization/benchmarks/index.md index 200bdfb95b..9969ffef73 100644 --- a/content/operate/oss_and_stack/management/optimization/benchmarks/index.md +++ b/content/operate/oss_and_stack/management/optimization/benchmarks/index.md @@ -126,7 +126,7 @@ specified with `-c`) sends the next command only when the reply of the previous command is received, this means that the server will likely need a read call in order to read each command from every client. Also RTT is paid as well. -Redis supports [pipelining](/topics/pipelining), so it is possible to send +Redis supports [pipelining](/develop/using-commands/pipelining), so it is possible to send multiple commands at once, a feature often exploited by real world applications. Redis pipelining is able to dramatically improve the number of operations per second a server is able to deliver. diff --git a/content/operate/oss_and_stack/management/security/_index.md b/content/operate/oss_and_stack/management/security/_index.md index 10c49147f0..4b1a4662ca 100644 --- a/content/operate/oss_and_stack/management/security/_index.md +++ b/content/operate/oss_and_stack/management/security/_index.md @@ -20,7 +20,7 @@ You can learn more about access control, data protection and encryption, secure For security-related contacts, open an issue on GitHub, or when you feel it is really important to preserve the security of the communication, use this -[downloadable GPG key](/operate/oss_and_stack/management/security/gpgkey.txt). +[downloadable GPG key](gpgkey.txt). ## Security model diff --git a/content/operate/oss_and_stack/stack-with-enterprise/release-notes/redisgraph/redisgraph-2.0-release-notes.md b/content/operate/oss_and_stack/stack-with-enterprise/release-notes/redisgraph/redisgraph-2.0-release-notes.md index 2c1c664ebf..2c8afbb60c 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/release-notes/redisgraph/redisgraph-2.0-release-notes.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/release-notes/redisgraph/redisgraph-2.0-release-notes.md @@ -250,7 +250,7 @@ Full details: - Major features - #[339](https://github.com/RedisGraph/RedisGraph/issues/339) Full Graph Response. RedisGraph now allows to return Graph entities such as Nodes and Relationships. This feature also enables graph visualisation. - - #[558](https://github.com/RedisGraph/RedisGraph/issues/558) Indexing functionality replaced by [RediSearch](redisearch.io). This results in support for + - #[558](https://github.com/RedisGraph/RedisGraph/issues/558) Indexing functionality replaced by [RediSearch](https://redisearch.io). This results in support for - compound indices - full text search - graph-aided search diff --git a/content/operate/oss_and_stack/stack-with-enterprise/release-notes/redisstack/redisstack-7.2-release-notes.md b/content/operate/oss_and_stack/stack-with-enterprise/release-notes/redisstack/redisstack-7.2-release-notes.md index 199e6bb0ae..8101027eea 100644 --- a/content/operate/oss_and_stack/stack-with-enterprise/release-notes/redisstack/redisstack-7.2-release-notes.md +++ b/content/operate/oss_and_stack/stack-with-enterprise/release-notes/redisstack/redisstack-7.2-release-notes.md @@ -889,7 +889,7 @@ JSON introduces two new commands: Graph capabilities are no longer included in Redis Stack. See the [RedisGraph End-of-Life Announcement](https://redis.com/blog/redisgraph-eol/). > [!WARNING] -If you are using graph capabilities with an older version of Redis Stack - please don't upgrade. +> If you are using graph capabilities with an older version of Redis Stack - please don't upgrade. **Triggers and functions preview**: Triggers and functions is part of Redis Stack 7.2 as public preview, any feedback is highly appreciated. diff --git a/content/operate/rs/7.22/references/rest-api/permissions.md b/content/operate/rs/7.22/references/rest-api/permissions.md index 5f5d9adf94..050b125134 100644 --- a/content/operate/rs/7.22/references/rest-api/permissions.md +++ b/content/operate/rs/7.22/references/rest-api/permissions.md @@ -40,7 +40,7 @@ Available management roles include: | cluster_viewer | [view_all_bdb_stats](#view_all_bdb_stats), [view_all_bdbs_alerts](#view_all_bdbs_alerts), [view_all_bdbs_info](#view_all_bdbs_info), [view_all_nodes_alerts](#view_all_nodes_alerts), [view_all_nodes_checks](#view_all_nodes_checks), [view_all_nodes_info](#view_all_nodes_info), [view_all_nodes_stats](#view_all_nodes_stats), [view_all_proxies_info](#view_all_proxies_info), [view_all_redis_acls_info](#view_all_redis_acls_info), [view_all_roles_info](#view_all_roles_info), [view_all_shard_stats](#view_all_shard_stats), [view_bdb_alerts](#view_bdb_alerts), [view_bdb_info](#view_bdb_info), [view_bdb_recovery_plan](#view_bdb_recovery_plan), [view_bdb_stats](#view_bdb_stats), [view_cluster_alerts](#view_cluster_alerts), [view_cluster_info](#view_cluster_info), [view_cluster_modules](#view_cluster_modules), [view_cluster_stats](#view_cluster_stats), [view_crdb](#view_crdb), [view_crdb_list](#view_crdb_list), [view_crdb_task](#view_crdb_task), [view_crdb_task_list](#view_crdb_task_list), [view_endpoint_stats](#view_endpoint_stats), [view_license](#view_license), [view_logged_events](#view_logged_events), [view_node_alerts](#view_node_alerts), [view_node_check](#view_node_check), [view_node_info](#view_node_info), [view_node_stats](#view_node_stats), [view_proxy_info](#view_proxy_info), [view_redis_acl_info](#view_redis_acl_info), [view_role_info](#view_role_info), [view_shard_stats](#view_shard_stats), [view_status_of_all_node_actions](#view_status_of_all_node_actions), [view_status_of_cluster_action](#view_status_of_cluster_action), [view_status_of_node_action](#view_status_of_node_action) | | db_member | [create_bdb](#create_bdb), [create_crdb](#create_crdb), [delete_bdb](#delete_bdb), [delete_crdb](#delete_crdb), [edit_bdb_module](#edit_bdb_module), [failover_shard](#failover_shard), [flush_crdb](#flush_crdb), [migrate_shard](#migrate_shard), [purge_instance](#purge_instance), [reset_bdb_current_backup_status](#reset_bdb_current_backup_status), [reset_bdb_current_export_status](#reset_bdb_current_export_status), [reset_bdb_current_import_status](#reset_bdb_current_import_status), [start_bdb_export](#start_bdb_export), [start_bdb_import](#start_bdb_import), [start_bdb_recovery](#start_bdb_recovery), [update_bdb](#update_bdb), [update_bdb_alerts](#update_bdb_alerts), [update_bdb_with_action](#update_bdb_with_action), [update_crdb](#update_crdb), [view_all_bdb_stats](#view_all_bdb_stats), [view_all_bdbs_alerts](#view_all_bdbs_alerts), [view_all_bdbs_info](#view_all_bdbs_info), [view_all_nodes_alerts](#view_all_nodes_alerts), [view_all_nodes_checks](#view_all_nodes_checks), [view_all_nodes_info](#view_all_nodes_info), [view_all_nodes_stats](#view_all_nodes_stats), [view_all_proxies_info](#view_all_proxies_info), [view_all_redis_acls_info](#view_all_redis_acls_info), [view_all_roles_info](#view_all_roles_info), [view_all_shard_stats](#view_all_shard_stats), [view_bdb_alerts](#view_bdb_alerts), [view_bdb_info](#view_bdb_info), [view_bdb_recovery_plan](#view_bdb_recovery_plan), [view_bdb_stats](#view_bdb_stats), [view_cluster_alerts](#view_cluster_alerts), [view_cluster_info](#view_cluster_info), [view_cluster_modules](#view_cluster_modules), [view_cluster_stats](#view_cluster_stats), [view_crdb](#view_crdb), [view_crdb_list](#view_crdb_list), [view_crdb_task](#view_crdb_task), [view_crdb_task_list](#view_crdb_task_list), [view_debugging_info](#view_debugging_info), [view_endpoint_stats](#view_endpoint_stats), [view_license](#view_license), [view_logged_events](#view_logged_events), [view_node_alerts](#view_node_alerts), [view_node_check](#view_node_check), [view_node_info](#view_node_info), [view_node_stats](#view_node_stats), [view_proxy_info](#view_proxy_info), [view_redis_acl_info](#view_redis_acl_info), [view_redis_pass](#view_redis_pass), [view_role_info](#view_role_info), [view_shard_stats](#view_shard_stats), [view_status_of_all_node_actions](#view_status_of_all_node_actions), [view_status_of_cluster_action](#view_status_of_cluster_action), [view_status_of_node_action](#view_status_of_node_action) | | db_viewer | [view_all_bdb_stats](#view_all_bdb_stats), [view_all_bdbs_alerts](#view_all_bdbs_alerts), [view_all_bdbs_info](#view_all_bdbs_info), [view_all_nodes_alerts](#view_all_nodes_alerts), [view_all_nodes_checks](#view_all_nodes_checks), [view_all_nodes_info](#view_all_nodes_info), [view_all_nodes_stats](#view_all_nodes_stats), [view_all_proxies_info](#view_all_proxies_info), [view_all_redis_acls_info](#view_all_redis_acls_info), [view_all_roles_info](#view_all_roles_info), [view_all_shard_stats](#view_all_shard_stats), [view_bdb_alerts](#view_bdb_alerts), [view_bdb_info](#view_bdb_info), [view_bdb_recovery_plan](#view_bdb_recovery_plan), [view_bdb_stats](#view_bdb_stats), [view_cluster_alerts](#view_cluster_alerts), [view_cluster_info](#view_cluster_info), [view_cluster_modules](#view_cluster_modules), [view_cluster_stats](#view_cluster_stats), [view_crdb](#view_crdb), [view_crdb_list](#view_crdb_list), [view_crdb_task](#view_crdb_task), [view_crdb_task_list](#view_crdb_task_list), [view_endpoint_stats](#view_endpoint_stats), [view_license](#view_license), [view_node_alerts](#view_node_alerts), [view_node_check](#view_node_check), [view_node_info](#view_node_info), [view_node_stats](#view_node_stats), [view_proxy_info](#view_proxy_info), [view_redis_acl_info](#view_redis_acl_info), [view_role_info](#view_role_info), [view_shard_stats](#view_shard_stats), [view_status_of_all_node_actions](#view_status_of_all_node_actions), [view_status_of_cluster_action](#view_status_of_cluster_action), [view_status_of_node_action](#view_status_of_node_action) | -| user_manager | [config_ldap](#config_ldap), [create_ldap_mapping](#create_ldap_mapping), [create_new_user](#create_new_user), [create_role](#create_role), [create_redis_acl](#create_redis_acl), [delete_ldap_mapping](#delete_ldap_mapping), [delete_redis_acl](#delete_redis_acl), [delete_role](#delete_role), [delete_user](#delete_user), [install_new_license](#install_new_license), [update_ldap_mapping](#update_ldap_mapping), [update_proxy](#update_proxy), [update_role](#update_role), [update_redis_acl](#update_redis_acl), [update_user](#update_user), [view_all_bdb_stats](#view_all_bdb_stats), [view_all_bdbs_alerts](#view_all_bdbs_alerts), [view_all_bdbs_info](#view_all_bdbs_info), [view_all_ldap_mappings_info](#view_all_ldap_mappings_info), [view_all_nodes_alerts](view_all_nodes_alerts), [view_all_nodes_checks](#view_all_nodes_checks), [view_all_nodes_info](#view_all_nodes_info), [view_all_nodes_stats](#view_all_nodes_stats), [view_all_proxies_info](#view_all_proxies_info), [view_all_redis_acls_info](#view_all_redis_acls_info), [view_all_roles_info](#view_all_roles_info), [view_all_shard_stats](#view_all_shard_stats), [view_all_users_info](#view_all_users_info), [view_bdb_alerts](#view_bdb_alerts), [view_bdb_info](#view_bdb_info), [view_bdb_stats](#view_bdb_stats), [view_cluster_alerts](#view_cluster_alerts), [view_cluster_info](#view_cluster_info), [view_cluster_keys](#view_cluster_keys), [view_cluster_modules](#view_cluster_modules), [view_cluster_stats](#view_cluster_stats), [view_crdb](#view_crdb), [view_crdb_list](#view_crdb_list), [view_crdb_task](#view_crdb_task), [view_crdb_task_list](#view_crdb_task_list), [view_endpoint_stats](#view_endpoint_stats), [view_ldap_config](#view_ldap_config), [view_ldap_mapping_info](#view_ldap_mapping_info), [view_license](#view_license), [view_logged_events](#view_logged_events), [view_node_alerts](#view_node_alerts), [view_node_check](#view_node_check), [view_node_info](#view_node_info), [view_node_stats](#view_node_stats), [view_proxy_info](#view_proxy_info), [view_redis_acl_info](#view_redis_acl_info), [view_redis_pass](#view_redis_pass), [view_role_info](#view_role_info), [view_shard_stats](#view_shard_stats), [view_status_of_all_node_actions](#view_status_of_all_node_actions), [view_status_of_cluster_action](#view_status_of_cluster_action), [view_status_of_node_action](#view_status_of_node_action), [view_user_info](#view_user_info) +| user_manager | [config_ldap](#config_ldap), [create_ldap_mapping](#create_ldap_mapping), [create_new_user](#create_new_user), [create_role](#create_role), [create_redis_acl](#create_redis_acl), [delete_ldap_mapping](#delete_ldap_mapping), [delete_redis_acl](#delete_redis_acl), [delete_role](#delete_role), [delete_user](#delete_user), [install_new_license](#install_new_license), [update_ldap_mapping](#update_ldap_mapping), [update_proxy](#update_proxy), [update_role](#update_role), [update_redis_acl](#update_redis_acl), [update_user](#update_user), [view_all_bdb_stats](#view_all_bdb_stats), [view_all_bdbs_alerts](#view_all_bdbs_alerts), [view_all_bdbs_info](#view_all_bdbs_info), [view_all_ldap_mappings_info](#view_all_ldap_mappings_info), [view_all_nodes_alerts](#view_all_nodes_alerts), [view_all_nodes_checks](#view_all_nodes_checks), [view_all_nodes_info](#view_all_nodes_info), [view_all_nodes_stats](#view_all_nodes_stats), [view_all_proxies_info](#view_all_proxies_info), [view_all_redis_acls_info](#view_all_redis_acls_info), [view_all_roles_info](#view_all_roles_info), [view_all_shard_stats](#view_all_shard_stats), [view_all_users_info](#view_all_users_info), [view_bdb_alerts](#view_bdb_alerts), [view_bdb_info](#view_bdb_info), [view_bdb_stats](#view_bdb_stats), [view_cluster_alerts](#view_cluster_alerts), [view_cluster_info](#view_cluster_info), [view_cluster_keys](#view_cluster_keys), [view_cluster_modules](#view_cluster_modules), [view_cluster_stats](#view_cluster_stats), [view_crdb](#view_crdb), [view_crdb_list](#view_crdb_list), [view_crdb_task](#view_crdb_task), [view_crdb_task_list](#view_crdb_task_list), [view_endpoint_stats](#view_endpoint_stats), [view_ldap_config](#view_ldap_config), [view_ldap_mapping_info](#view_ldap_mapping_info), [view_license](#view_license), [view_logged_events](#view_logged_events), [view_node_alerts](#view_node_alerts), [view_node_check](#view_node_check), [view_node_info](#view_node_info), [view_node_stats](#view_node_stats), [view_proxy_info](#view_proxy_info), [view_redis_acl_info](#view_redis_acl_info), [view_redis_pass](#view_redis_pass), [view_role_info](#view_role_info), [view_shard_stats](#view_shard_stats), [view_status_of_all_node_actions](#view_status_of_all_node_actions), [view_status_of_cluster_action](#view_status_of_cluster_action), [view_status_of_node_action](#view_status_of_node_action), [view_user_info](#view_user_info) | ## Roles list per permission diff --git a/content/operate/rs/7.8/references/rest-api/permissions.md b/content/operate/rs/7.8/references/rest-api/permissions.md index 73556b0598..609b7a25c7 100644 --- a/content/operate/rs/7.8/references/rest-api/permissions.md +++ b/content/operate/rs/7.8/references/rest-api/permissions.md @@ -40,7 +40,7 @@ Available management roles include: | cluster_viewer | [view_all_bdb_stats](#view_all_bdb_stats), [view_all_bdbs_alerts](#view_all_bdbs_alerts), [view_all_bdbs_info](#view_all_bdbs_info), [view_all_nodes_alerts](#view_all_nodes_alerts), [view_all_nodes_checks](#view_all_nodes_checks), [view_all_nodes_info](#view_all_nodes_info), [view_all_nodes_stats](#view_all_nodes_stats), [view_all_proxies_info](#view_all_proxies_info), [view_all_redis_acls_info](#view_all_redis_acls_info), [view_all_roles_info](#view_all_roles_info), [view_all_shard_stats](#view_all_shard_stats), [view_bdb_alerts](#view_bdb_alerts), [view_bdb_info](#view_bdb_info), [view_bdb_recovery_plan](#view_bdb_recovery_plan), [view_bdb_stats](#view_bdb_stats), [view_cluster_alerts](#view_cluster_alerts), [view_cluster_info](#view_cluster_info), [view_cluster_modules](#view_cluster_modules), [view_cluster_stats](#view_cluster_stats), [view_crdb](#view_crdb), [view_crdb_list](#view_crdb_list), [view_crdb_task](#view_crdb_task), [view_crdb_task_list](#view_crdb_task_list), [view_endpoint_stats](#view_endpoint_stats), [view_license](#view_license), [view_logged_events](#view_logged_events), [view_node_alerts](#view_node_alerts), [view_node_check](#view_node_check), [view_node_info](#view_node_info), [view_node_stats](#view_node_stats), [view_proxy_info](#view_proxy_info), [view_redis_acl_info](#view_redis_acl_info), [view_role_info](#view_role_info), [view_shard_stats](#view_shard_stats), [view_status_of_all_node_actions](#view_status_of_all_node_actions), [view_status_of_cluster_action](#view_status_of_cluster_action), [view_status_of_node_action](#view_status_of_node_action) | | db_member | [create_bdb](#create_bdb), [create_crdb](#create_crdb), [delete_bdb](#delete_bdb), [delete_crdb](#delete_crdb), [edit_bdb_module](#edit_bdb_module), [failover_shard](#failover_shard), [flush_crdb](#flush_crdb), [migrate_shard](#migrate_shard), [purge_instance](#purge_instance), [reset_bdb_current_backup_status](#reset_bdb_current_backup_status), [reset_bdb_current_export_status](#reset_bdb_current_export_status), [reset_bdb_current_import_status](#reset_bdb_current_import_status), [start_bdb_export](#start_bdb_export), [start_bdb_import](#start_bdb_import), [start_bdb_recovery](#start_bdb_recovery), [update_bdb](#update_bdb), [update_bdb_alerts](#update_bdb_alerts), [update_bdb_with_action](#update_bdb_with_action), [update_crdb](#update_crdb), [view_all_bdb_stats](#view_all_bdb_stats), [view_all_bdbs_alerts](#view_all_bdbs_alerts), [view_all_bdbs_info](#view_all_bdbs_info), [view_all_nodes_alerts](#view_all_nodes_alerts), [view_all_nodes_checks](#view_all_nodes_checks), [view_all_nodes_info](#view_all_nodes_info), [view_all_nodes_stats](#view_all_nodes_stats), [view_all_proxies_info](#view_all_proxies_info), [view_all_redis_acls_info](#view_all_redis_acls_info), [view_all_roles_info](#view_all_roles_info), [view_all_shard_stats](#view_all_shard_stats), [view_bdb_alerts](#view_bdb_alerts), [view_bdb_info](#view_bdb_info), [view_bdb_recovery_plan](#view_bdb_recovery_plan), [view_bdb_stats](#view_bdb_stats), [view_cluster_alerts](#view_cluster_alerts), [view_cluster_info](#view_cluster_info), [view_cluster_modules](#view_cluster_modules), [view_cluster_stats](#view_cluster_stats), [view_crdb](#view_crdb), [view_crdb_list](#view_crdb_list), [view_crdb_task](#view_crdb_task), [view_crdb_task_list](#view_crdb_task_list), [view_debugging_info](#view_debugging_info), [view_endpoint_stats](#view_endpoint_stats), [view_license](#view_license), [view_logged_events](#view_logged_events), [view_node_alerts](#view_node_alerts), [view_node_check](#view_node_check), [view_node_info](#view_node_info), [view_node_stats](#view_node_stats), [view_proxy_info](#view_proxy_info), [view_redis_acl_info](#view_redis_acl_info), [view_redis_pass](#view_redis_pass), [view_role_info](#view_role_info), [view_shard_stats](#view_shard_stats), [view_status_of_all_node_actions](#view_status_of_all_node_actions), [view_status_of_cluster_action](#view_status_of_cluster_action), [view_status_of_node_action](#view_status_of_node_action) | | db_viewer | [view_all_bdb_stats](#view_all_bdb_stats), [view_all_bdbs_alerts](#view_all_bdbs_alerts), [view_all_bdbs_info](#view_all_bdbs_info), [view_all_nodes_alerts](#view_all_nodes_alerts), [view_all_nodes_checks](#view_all_nodes_checks), [view_all_nodes_info](#view_all_nodes_info), [view_all_nodes_stats](#view_all_nodes_stats), [view_all_proxies_info](#view_all_proxies_info), [view_all_redis_acls_info](#view_all_redis_acls_info), [view_all_roles_info](#view_all_roles_info), [view_all_shard_stats](#view_all_shard_stats), [view_bdb_alerts](#view_bdb_alerts), [view_bdb_info](#view_bdb_info), [view_bdb_recovery_plan](#view_bdb_recovery_plan), [view_bdb_stats](#view_bdb_stats), [view_cluster_alerts](#view_cluster_alerts), [view_cluster_info](#view_cluster_info), [view_cluster_modules](#view_cluster_modules), [view_cluster_stats](#view_cluster_stats), [view_crdb](#view_crdb), [view_crdb_list](#view_crdb_list), [view_crdb_task](#view_crdb_task), [view_crdb_task_list](#view_crdb_task_list), [view_endpoint_stats](#view_endpoint_stats), [view_license](#view_license), [view_node_alerts](#view_node_alerts), [view_node_check](#view_node_check), [view_node_info](#view_node_info), [view_node_stats](#view_node_stats), [view_proxy_info](#view_proxy_info), [view_redis_acl_info](#view_redis_acl_info), [view_role_info](#view_role_info), [view_shard_stats](#view_shard_stats), [view_status_of_all_node_actions](#view_status_of_all_node_actions), [view_status_of_cluster_action](#view_status_of_cluster_action), [view_status_of_node_action](#view_status_of_node_action) | -| user_manager | [config_ldap](#config_ldap), [create_ldap_mapping](#create_ldap_mapping), [create_new_user](#create_new_user), [create_role](#create_role), [create_redis_acl](#create_redis_acl), [delete_ldap_mapping](#delete_ldap_mapping), [delete_redis_acl](#delete_redis_acl), [delete_role](#delete_role), [delete_user](#delete_user), [install_new_license](#install_new_license), [update_ldap_mapping](#update_ldap_mapping), [update_proxy](#update_proxy), [update_role](#update_role), [update_redis_acl](#update_redis_acl), [update_user](#update_user), [view_all_bdb_stats](#view_all_bdb_stats), [view_all_bdbs_alerts](#view_all_bdbs_alerts), [view_all_bdbs_info](#view_all_bdbs_info), [view_all_ldap_mappings_info](#view_all_ldap_mappings_info), [view_all_nodes_alerts](view_all_nodes_alerts), [view_all_nodes_checks](#view_all_nodes_checks), [view_all_nodes_info](#view_all_nodes_info), [view_all_nodes_stats](#view_all_nodes_stats), [view_all_proxies_info](#view_all_proxies_info), [view_all_redis_acls_info](#view_all_redis_acls_info), [view_all_roles_info](#view_all_roles_info), [view_all_shard_stats](#view_all_shard_stats), [view_all_users_info](#view_all_users_info), [view_bdb_alerts](#view_bdb_alerts), [view_bdb_info](#view_bdb_info), [view_bdb_stats](#view_bdb_stats), [view_cluster_alerts](#view_cluster_alerts), [view_cluster_info](#view_cluster_info), [view_cluster_keys](#view_cluster_keys), [view_cluster_modules](#view_cluster_modules), [view_cluster_stats](#view_cluster_stats), [view_crdb](#view_crdb), [view_crdb_list](#view_crdb_list), [view_crdb_task](#view_crdb_task), [view_crdb_task_list](#view_crdb_task_list), [view_endpoint_stats](#view_endpoint_stats), [view_ldap_config](#view_ldap_config), [view_ldap_mapping_info](#view_ldap_mapping_info), [view_license](#view_license), [view_logged_events](#view_logged_events), [view_node_alerts](#view_node_alerts), [view_node_check](#view_node_check), [view_node_info](#view_node_info), [view_node_stats](#view_node_stats), [view_proxy_info](#view_proxy_info), [view_redis_acl_info](#view_redis_acl_info), [view_redis_pass](#view_redis_pass), [view_role_info](#view_role_info), [view_shard_stats](#view_shard_stats), [view_status_of_all_node_actions](#view_status_of_all_node_actions), [view_status_of_cluster_action](#view_status_of_cluster_action), [view_status_of_node_action](#view_status_of_node_action), [view_user_info](#view_user_info) +| user_manager | [config_ldap](#config_ldap), [create_ldap_mapping](#create_ldap_mapping), [create_new_user](#create_new_user), [create_role](#create_role), [create_redis_acl](#create_redis_acl), [delete_ldap_mapping](#delete_ldap_mapping), [delete_redis_acl](#delete_redis_acl), [delete_role](#delete_role), [delete_user](#delete_user), [install_new_license](#install_new_license), [update_ldap_mapping](#update_ldap_mapping), [update_proxy](#update_proxy), [update_role](#update_role), [update_redis_acl](#update_redis_acl), [update_user](#update_user), [view_all_bdb_stats](#view_all_bdb_stats), [view_all_bdbs_alerts](#view_all_bdbs_alerts), [view_all_bdbs_info](#view_all_bdbs_info), [view_all_ldap_mappings_info](#view_all_ldap_mappings_info), [view_all_nodes_alerts](#view_all_nodes_alerts), [view_all_nodes_checks](#view_all_nodes_checks), [view_all_nodes_info](#view_all_nodes_info), [view_all_nodes_stats](#view_all_nodes_stats), [view_all_proxies_info](#view_all_proxies_info), [view_all_redis_acls_info](#view_all_redis_acls_info), [view_all_roles_info](#view_all_roles_info), [view_all_shard_stats](#view_all_shard_stats), [view_all_users_info](#view_all_users_info), [view_bdb_alerts](#view_bdb_alerts), [view_bdb_info](#view_bdb_info), [view_bdb_stats](#view_bdb_stats), [view_cluster_alerts](#view_cluster_alerts), [view_cluster_info](#view_cluster_info), [view_cluster_keys](#view_cluster_keys), [view_cluster_modules](#view_cluster_modules), [view_cluster_stats](#view_cluster_stats), [view_crdb](#view_crdb), [view_crdb_list](#view_crdb_list), [view_crdb_task](#view_crdb_task), [view_crdb_task_list](#view_crdb_task_list), [view_endpoint_stats](#view_endpoint_stats), [view_ldap_config](#view_ldap_config), [view_ldap_mapping_info](#view_ldap_mapping_info), [view_license](#view_license), [view_logged_events](#view_logged_events), [view_node_alerts](#view_node_alerts), [view_node_check](#view_node_check), [view_node_info](#view_node_info), [view_node_stats](#view_node_stats), [view_proxy_info](#view_proxy_info), [view_redis_acl_info](#view_redis_acl_info), [view_redis_pass](#view_redis_pass), [view_role_info](#view_role_info), [view_shard_stats](#view_shard_stats), [view_status_of_all_node_actions](#view_status_of_all_node_actions), [view_status_of_cluster_action](#view_status_of_cluster_action), [view_status_of_node_action](#view_status_of_node_action), [view_user_info](#view_user_info) | ## Roles list per permission 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 52eb9609f5..36dd8410ab 100644 --- a/content/operate/rs/8.0/references/rest-api/permissions.md +++ b/content/operate/rs/8.0/references/rest-api/permissions.md @@ -40,7 +40,7 @@ Available management roles include: | cluster_viewer | [view_all_bdb_stats](#view_all_bdb_stats), [view_all_bdbs_alerts](#view_all_bdbs_alerts), [view_all_bdbs_info](#view_all_bdbs_info), [view_all_metrics](#view_all_metrics), [view_all_nodes_alerts](#view_all_nodes_alerts), [view_all_nodes_checks](#view_all_nodes_checks), [view_all_nodes_info](#view_all_nodes_info), [view_all_nodes_stats](#view_all_nodes_stats), [view_all_proxies_info](#view_all_proxies_info), [view_all_redis_acls_info](#view_all_redis_acls_info), [view_all_roles_info](#view_all_roles_info), [view_all_shard_stats](#view_all_shard_stats), [view_bdb_alerts](#view_bdb_alerts), [view_bdb_info](#view_bdb_info), [view_bdb_recovery_plan](#view_bdb_recovery_plan), [view_bdb_stats](#view_bdb_stats), [view_cluster_alerts](#view_cluster_alerts), [view_cluster_info](#view_cluster_info), [view_cluster_modules](#view_cluster_modules), [view_cluster_stats](#view_cluster_stats), [view_crdb](#view_crdb), [view_crdb_list](#view_crdb_list), [view_crdb_task](#view_crdb_task), [view_crdb_task_list](#view_crdb_task_list), [view_endpoint_stats](#view_endpoint_stats), [view_license](#view_license), [view_logged_events](#view_logged_events), [view_node_alerts](#view_node_alerts), [view_node_check](#view_node_check), [view_node_info](#view_node_info), [view_node_stats](#view_node_stats), [view_proxy_info](#view_proxy_info), [view_redis_acl_info](#view_redis_acl_info), [view_role_info](#view_role_info), [view_shard_stats](#view_shard_stats), [view_sso](#view_sso), [view_status_of_all_node_actions](#view_status_of_all_node_actions), [view_status_of_cluster_action](#view_status_of_cluster_action), [view_status_of_node_action](#view_status_of_node_action) | | db_member | [create_bdb](#create_bdb), [create_crdb](#create_crdb), [delete_bdb](#delete_bdb), [delete_crdb](#delete_crdb), [edit_bdb_module](#edit_bdb_module), [failover_shard](#failover_shard), [flush_crdb](#flush_crdb), [migrate_shard](#migrate_shard), [purge_instance](#purge_instance), [reset_bdb_current_backup_status](#reset_bdb_current_backup_status), [reset_bdb_current_export_status](#reset_bdb_current_export_status), [reset_bdb_current_import_status](#reset_bdb_current_import_status), [start_bdb_export](#start_bdb_export), [start_bdb_import](#start_bdb_import), [start_bdb_recovery](#start_bdb_recovery), [update_bdb](#update_bdb), [update_bdb_alerts](#update_bdb_alerts), [update_bdb_with_action](#update_bdb_with_action), [update_crdb](#update_crdb), [upgrade_crdb](#upgrade_crdb), [view_all_bdb_stats](#view_all_bdb_stats), [view_all_bdbs_alerts](#view_all_bdbs_alerts), [view_all_bdbs_info](#view_all_bdbs_info), [view_all_nodes_alerts](#view_all_nodes_alerts), [view_all_nodes_checks](#view_all_nodes_checks), [view_all_nodes_info](#view_all_nodes_info), [view_all_nodes_stats](#view_all_nodes_stats), [view_all_proxies_info](#view_all_proxies_info), [view_all_redis_acls_info](#view_all_redis_acls_info), [view_all_roles_info](#view_all_roles_info), [view_all_shard_stats](#view_all_shard_stats), [view_bdb_alerts](#view_bdb_alerts), [view_bdb_info](#view_bdb_info), [view_bdb_recovery_plan](#view_bdb_recovery_plan), [view_bdb_stats](#view_bdb_stats), [view_cluster_alerts](#view_cluster_alerts), [view_cluster_info](#view_cluster_info), [view_cluster_modules](#view_cluster_modules), [view_cluster_stats](#view_cluster_stats), [view_crdb](#view_crdb), [view_crdb_list](#view_crdb_list), [view_crdb_task](#view_crdb_task), [view_crdb_task_list](#view_crdb_task_list), [view_debugging_info](#view_debugging_info), [view_endpoint_stats](#view_endpoint_stats), [view_license](#view_license), [view_logged_events](#view_logged_events), [view_node_alerts](#view_node_alerts), [view_node_check](#view_node_check), [view_node_info](#view_node_info), [view_node_stats](#view_node_stats), [view_proxy_info](#view_proxy_info), [view_redis_acl_info](#view_redis_acl_info), [view_redis_pass](#view_redis_pass), [view_role_info](#view_role_info), [view_shard_stats](#view_shard_stats), [view_sso](#view_sso), [view_status_of_all_node_actions](#view_status_of_all_node_actions), [view_status_of_cluster_action](#view_status_of_cluster_action), [view_status_of_node_action](#view_status_of_node_action) | | db_viewer | [view_all_bdb_stats](#view_all_bdb_stats), [view_all_bdbs_alerts](#view_all_bdbs_alerts), [view_all_bdbs_info](#view_all_bdbs_info), [view_all_nodes_alerts](#view_all_nodes_alerts), [view_all_nodes_checks](#view_all_nodes_checks), [view_all_nodes_info](#view_all_nodes_info), [view_all_nodes_stats](#view_all_nodes_stats), [view_all_proxies_info](#view_all_proxies_info), [view_all_redis_acls_info](#view_all_redis_acls_info), [view_all_roles_info](#view_all_roles_info), [view_all_shard_stats](#view_all_shard_stats), [view_bdb_alerts](#view_bdb_alerts), [view_bdb_info](#view_bdb_info), [view_bdb_recovery_plan](#view_bdb_recovery_plan), [view_bdb_stats](#view_bdb_stats), [view_cluster_alerts](#view_cluster_alerts), [view_cluster_info](#view_cluster_info), [view_cluster_modules](#view_cluster_modules), [view_cluster_stats](#view_cluster_stats), [view_crdb](#view_crdb), [view_crdb_list](#view_crdb_list), [view_crdb_task](#view_crdb_task), [view_crdb_task_list](#view_crdb_task_list), [view_endpoint_stats](#view_endpoint_stats), [view_license](#view_license), [view_node_alerts](#view_node_alerts), [view_node_check](#view_node_check), [view_node_info](#view_node_info), [view_node_stats](#view_node_stats), [view_proxy_info](#view_proxy_info), [view_redis_acl_info](#view_redis_acl_info), [view_role_info](#view_role_info), [view_shard_stats](#view_shard_stats), [view_sso](#view_sso), [view_status_of_all_node_actions](#view_status_of_all_node_actions), [view_status_of_cluster_action](#view_status_of_cluster_action), [view_status_of_node_action](#view_status_of_node_action) | -| user_manager | [config_ldap](#config_ldap), [create_ldap_mapping](#create_ldap_mapping), [create_new_user](#create_new_user), [create_role](#create_role), [create_redis_acl](#create_redis_acl), [delete_ldap_mapping](#delete_ldap_mapping), [delete_redis_acl](#delete_redis_acl), [delete_role](#delete_role), [delete_user](#delete_user), [install_new_license](#install_new_license), [update_ldap_mapping](#update_ldap_mapping), [update_proxy](#update_proxy), [update_role](#update_role), [update_redis_acl](#update_redis_acl), [update_user](#update_user), [view_all_bdb_stats](#view_all_bdb_stats), [view_all_bdbs_alerts](#view_all_bdbs_alerts), [view_all_bdbs_info](#view_all_bdbs_info), [view_all_ldap_mappings_info](#view_all_ldap_mappings_info), [view_all_nodes_alerts](view_all_nodes_alerts), [view_all_nodes_checks](#view_all_nodes_checks), [view_all_nodes_info](#view_all_nodes_info), [view_all_nodes_stats](#view_all_nodes_stats), [view_all_proxies_info](#view_all_proxies_info), [view_all_redis_acls_info](#view_all_redis_acls_info), [view_all_roles_info](#view_all_roles_info), [view_all_shard_stats](#view_all_shard_stats), [view_all_users_info](#view_all_users_info), [view_bdb_alerts](#view_bdb_alerts), [view_bdb_info](#view_bdb_info), [view_bdb_stats](#view_bdb_stats), [view_cluster_alerts](#view_cluster_alerts), [view_cluster_info](#view_cluster_info), [view_cluster_keys](#view_cluster_keys), [view_cluster_modules](#view_cluster_modules), [view_cluster_stats](#view_cluster_stats), [view_crdb](#view_crdb), [view_crdb_list](#view_crdb_list), [view_crdb_task](#view_crdb_task), [view_crdb_task_list](#view_crdb_task_list), [view_endpoint_stats](#view_endpoint_stats), [view_ldap_config](#view_ldap_config), [view_ldap_mapping_info](#view_ldap_mapping_info), [view_license](#view_license), [view_logged_events](#view_logged_events), [view_node_alerts](#view_node_alerts), [view_node_check](#view_node_check), [view_node_info](#view_node_info), [view_node_stats](#view_node_stats), [view_proxy_info](#view_proxy_info), [view_redis_acl_info](#view_redis_acl_info), [view_redis_pass](#view_redis_pass), [view_role_info](#view_role_info), [view_shard_stats](#view_shard_stats), [view_sso](#view_sso), [view_status_of_all_node_actions](#view_status_of_all_node_actions), [view_status_of_cluster_action](#view_status_of_cluster_action), [view_status_of_node_action](#view_status_of_node_action), [view_user_info](#view_user_info) +| user_manager | [config_ldap](#config_ldap), [create_ldap_mapping](#create_ldap_mapping), [create_new_user](#create_new_user), [create_role](#create_role), [create_redis_acl](#create_redis_acl), [delete_ldap_mapping](#delete_ldap_mapping), [delete_redis_acl](#delete_redis_acl), [delete_role](#delete_role), [delete_user](#delete_user), [install_new_license](#install_new_license), [update_ldap_mapping](#update_ldap_mapping), [update_proxy](#update_proxy), [update_role](#update_role), [update_redis_acl](#update_redis_acl), [update_user](#update_user), [view_all_bdb_stats](#view_all_bdb_stats), [view_all_bdbs_alerts](#view_all_bdbs_alerts), [view_all_bdbs_info](#view_all_bdbs_info), [view_all_ldap_mappings_info](#view_all_ldap_mappings_info), [view_all_nodes_alerts](#view_all_nodes_alerts), [view_all_nodes_checks](#view_all_nodes_checks), [view_all_nodes_info](#view_all_nodes_info), [view_all_nodes_stats](#view_all_nodes_stats), [view_all_proxies_info](#view_all_proxies_info), [view_all_redis_acls_info](#view_all_redis_acls_info), [view_all_roles_info](#view_all_roles_info), [view_all_shard_stats](#view_all_shard_stats), [view_all_users_info](#view_all_users_info), [view_bdb_alerts](#view_bdb_alerts), [view_bdb_info](#view_bdb_info), [view_bdb_stats](#view_bdb_stats), [view_cluster_alerts](#view_cluster_alerts), [view_cluster_info](#view_cluster_info), [view_cluster_keys](#view_cluster_keys), [view_cluster_modules](#view_cluster_modules), [view_cluster_stats](#view_cluster_stats), [view_crdb](#view_crdb), [view_crdb_list](#view_crdb_list), [view_crdb_task](#view_crdb_task), [view_crdb_task_list](#view_crdb_task_list), [view_endpoint_stats](#view_endpoint_stats), [view_ldap_config](#view_ldap_config), [view_ldap_mapping_info](#view_ldap_mapping_info), [view_license](#view_license), [view_logged_events](#view_logged_events), [view_node_alerts](#view_node_alerts), [view_node_check](#view_node_check), [view_node_info](#view_node_info), [view_node_stats](#view_node_stats), [view_proxy_info](#view_proxy_info), [view_redis_acl_info](#view_redis_acl_info), [view_redis_pass](#view_redis_pass), [view_role_info](#view_role_info), [view_shard_stats](#view_shard_stats), [view_sso](#view_sso), [view_status_of_all_node_actions](#view_status_of_all_node_actions), [view_status_of_cluster_action](#view_status_of_cluster_action), [view_status_of_node_action](#view_status_of_node_action), [view_user_info](#view_user_info) | ## Roles list per permission diff --git a/content/operate/rs/references/rest-api/permissions.md b/content/operate/rs/references/rest-api/permissions.md index 35ba0a29f5..2210a1c4d1 100644 --- a/content/operate/rs/references/rest-api/permissions.md +++ b/content/operate/rs/references/rest-api/permissions.md @@ -39,7 +39,7 @@ Available management roles include: | cluster_viewer | [view_all_bdb_stats](#view_all_bdb_stats), [view_all_bdbs_alerts](#view_all_bdbs_alerts), [view_all_bdbs_info](#view_all_bdbs_info), [view_all_metrics](#view_all_metrics), [view_all_nodes_alerts](#view_all_nodes_alerts), [view_all_nodes_checks](#view_all_nodes_checks), [view_all_nodes_info](#view_all_nodes_info), [view_all_nodes_stats](#view_all_nodes_stats), [view_all_proxies_info](#view_all_proxies_info), [view_all_redis_acls_info](#view_all_redis_acls_info), [view_all_roles_info](#view_all_roles_info), [view_all_shard_stats](#view_all_shard_stats), [view_bdb_alerts](#view_bdb_alerts), [view_bdb_info](#view_bdb_info), [view_bdb_recovery_plan](#view_bdb_recovery_plan), [view_bdb_stats](#view_bdb_stats), [view_cluster_alerts](#view_cluster_alerts), [view_cluster_info](#view_cluster_info), [view_cluster_modules](#view_cluster_modules), [view_cluster_stats](#view_cluster_stats), [view_crdb](#view_crdb), [view_crdb_list](#view_crdb_list), [view_crdb_task](#view_crdb_task), [view_crdb_task_list](#view_crdb_task_list), [view_endpoint_stats](#view_endpoint_stats), [view_license](#view_license), [view_logged_events](#view_logged_events), [view_node_alerts](#view_node_alerts), [view_node_check](#view_node_check), [view_node_info](#view_node_info), [view_node_stats](#view_node_stats), [view_proxy_info](#view_proxy_info), [view_redis_acl_info](#view_redis_acl_info), [view_role_info](#view_role_info), [view_shard_stats](#view_shard_stats), [view_sso](#view_sso), [view_status_of_all_node_actions](#view_status_of_all_node_actions), [view_status_of_cluster_action](#view_status_of_cluster_action), [view_status_of_node_action](#view_status_of_node_action) | | db_member | [create_bdb](#create_bdb), [create_crdb](#create_crdb), [delete_bdb](#delete_bdb), [delete_crdb](#delete_crdb), [edit_bdb_module](#edit_bdb_module), [failover_shard](#failover_shard), [flush_crdb](#flush_crdb), [migrate_shard](#migrate_shard), [purge_instance](#purge_instance), [reset_bdb_current_backup_status](#reset_bdb_current_backup_status), [reset_bdb_current_export_status](#reset_bdb_current_export_status), [reset_bdb_current_import_status](#reset_bdb_current_import_status), [start_bdb_export](#start_bdb_export), [start_bdb_import](#start_bdb_import), [start_bdb_recovery](#start_bdb_recovery), [update_bdb](#update_bdb), [update_bdb_alerts](#update_bdb_alerts), [update_bdb_with_action](#update_bdb_with_action), [update_crdb](#update_crdb), [upgrade_crdb](#upgrade_crdb), [view_all_bdb_stats](#view_all_bdb_stats), [view_all_bdbs_alerts](#view_all_bdbs_alerts), [view_all_bdbs_info](#view_all_bdbs_info), [view_all_nodes_alerts](#view_all_nodes_alerts), [view_all_nodes_checks](#view_all_nodes_checks), [view_all_nodes_info](#view_all_nodes_info), [view_all_nodes_stats](#view_all_nodes_stats), [view_all_proxies_info](#view_all_proxies_info), [view_all_redis_acls_info](#view_all_redis_acls_info), [view_all_roles_info](#view_all_roles_info), [view_all_shard_stats](#view_all_shard_stats), [view_bdb_alerts](#view_bdb_alerts), [view_bdb_info](#view_bdb_info), [view_bdb_recovery_plan](#view_bdb_recovery_plan), [view_bdb_stats](#view_bdb_stats), [view_cluster_alerts](#view_cluster_alerts), [view_cluster_info](#view_cluster_info), [view_cluster_modules](#view_cluster_modules), [view_cluster_stats](#view_cluster_stats), [view_crdb](#view_crdb), [view_crdb_list](#view_crdb_list), [view_crdb_task](#view_crdb_task), [view_crdb_task_list](#view_crdb_task_list), [view_debugging_info](#view_debugging_info), [view_endpoint_stats](#view_endpoint_stats), [view_license](#view_license), [view_logged_events](#view_logged_events), [view_node_alerts](#view_node_alerts), [view_node_check](#view_node_check), [view_node_info](#view_node_info), [view_node_stats](#view_node_stats), [view_proxy_info](#view_proxy_info), [view_redis_acl_info](#view_redis_acl_info), [view_redis_pass](#view_redis_pass), [view_role_info](#view_role_info), [view_shard_stats](#view_shard_stats), [view_sso](#view_sso), [view_status_of_all_node_actions](#view_status_of_all_node_actions), [view_status_of_cluster_action](#view_status_of_cluster_action), [view_status_of_node_action](#view_status_of_node_action) | | db_viewer | [view_all_bdb_stats](#view_all_bdb_stats), [view_all_bdbs_alerts](#view_all_bdbs_alerts), [view_all_bdbs_info](#view_all_bdbs_info), [view_all_nodes_alerts](#view_all_nodes_alerts), [view_all_nodes_checks](#view_all_nodes_checks), [view_all_nodes_info](#view_all_nodes_info), [view_all_nodes_stats](#view_all_nodes_stats), [view_all_proxies_info](#view_all_proxies_info), [view_all_redis_acls_info](#view_all_redis_acls_info), [view_all_roles_info](#view_all_roles_info), [view_all_shard_stats](#view_all_shard_stats), [view_bdb_alerts](#view_bdb_alerts), [view_bdb_info](#view_bdb_info), [view_bdb_recovery_plan](#view_bdb_recovery_plan), [view_bdb_stats](#view_bdb_stats), [view_cluster_alerts](#view_cluster_alerts), [view_cluster_info](#view_cluster_info), [view_cluster_modules](#view_cluster_modules), [view_cluster_stats](#view_cluster_stats), [view_crdb](#view_crdb), [view_crdb_list](#view_crdb_list), [view_crdb_task](#view_crdb_task), [view_crdb_task_list](#view_crdb_task_list), [view_endpoint_stats](#view_endpoint_stats), [view_license](#view_license), [view_node_alerts](#view_node_alerts), [view_node_check](#view_node_check), [view_node_info](#view_node_info), [view_node_stats](#view_node_stats), [view_proxy_info](#view_proxy_info), [view_redis_acl_info](#view_redis_acl_info), [view_role_info](#view_role_info), [view_shard_stats](#view_shard_stats), [view_sso](#view_sso), [view_status_of_all_node_actions](#view_status_of_all_node_actions), [view_status_of_cluster_action](#view_status_of_cluster_action), [view_status_of_node_action](#view_status_of_node_action) | -| user_manager | [config_ldap](#config_ldap), [create_ldap_mapping](#create_ldap_mapping), [create_new_user](#create_new_user), [create_role](#create_role), [create_redis_acl](#create_redis_acl), [delete_ldap_mapping](#delete_ldap_mapping), [delete_redis_acl](#delete_redis_acl), [delete_role](#delete_role), [delete_user](#delete_user), [install_new_license](#install_new_license), [update_ldap_mapping](#update_ldap_mapping), [update_proxy](#update_proxy), [update_role](#update_role), [update_redis_acl](#update_redis_acl), [update_user](#update_user), [view_all_bdb_stats](#view_all_bdb_stats), [view_all_bdbs_alerts](#view_all_bdbs_alerts), [view_all_bdbs_info](#view_all_bdbs_info), [view_all_ldap_mappings_info](#view_all_ldap_mappings_info), [view_all_nodes_alerts](view_all_nodes_alerts), [view_all_nodes_checks](#view_all_nodes_checks), [view_all_nodes_info](#view_all_nodes_info), [view_all_nodes_stats](#view_all_nodes_stats), [view_all_proxies_info](#view_all_proxies_info), [view_all_redis_acls_info](#view_all_redis_acls_info), [view_all_roles_info](#view_all_roles_info), [view_all_shard_stats](#view_all_shard_stats), [view_all_users_info](#view_all_users_info), [view_bdb_alerts](#view_bdb_alerts), [view_bdb_info](#view_bdb_info), [view_bdb_stats](#view_bdb_stats), [view_cluster_alerts](#view_cluster_alerts), [view_cluster_info](#view_cluster_info), [view_cluster_keys](#view_cluster_keys), [view_cluster_modules](#view_cluster_modules), [view_cluster_stats](#view_cluster_stats), [view_crdb](#view_crdb), [view_crdb_list](#view_crdb_list), [view_crdb_task](#view_crdb_task), [view_crdb_task_list](#view_crdb_task_list), [view_endpoint_stats](#view_endpoint_stats), [view_ldap_config](#view_ldap_config), [view_ldap_mapping_info](#view_ldap_mapping_info), [view_license](#view_license), [view_logged_events](#view_logged_events), [view_node_alerts](#view_node_alerts), [view_node_check](#view_node_check), [view_node_info](#view_node_info), [view_node_stats](#view_node_stats), [view_proxy_info](#view_proxy_info), [view_redis_acl_info](#view_redis_acl_info), [view_redis_pass](#view_redis_pass), [view_role_info](#view_role_info), [view_shard_stats](#view_shard_stats), [view_sso](#view_sso), [view_status_of_all_node_actions](#view_status_of_all_node_actions), [view_status_of_cluster_action](#view_status_of_cluster_action), [view_status_of_node_action](#view_status_of_node_action), [view_user_info](#view_user_info) +| user_manager | [config_ldap](#config_ldap), [create_ldap_mapping](#create_ldap_mapping), [create_new_user](#create_new_user), [create_role](#create_role), [create_redis_acl](#create_redis_acl), [delete_ldap_mapping](#delete_ldap_mapping), [delete_redis_acl](#delete_redis_acl), [delete_role](#delete_role), [delete_user](#delete_user), [install_new_license](#install_new_license), [update_ldap_mapping](#update_ldap_mapping), [update_proxy](#update_proxy), [update_role](#update_role), [update_redis_acl](#update_redis_acl), [update_user](#update_user), [view_all_bdb_stats](#view_all_bdb_stats), [view_all_bdbs_alerts](#view_all_bdbs_alerts), [view_all_bdbs_info](#view_all_bdbs_info), [view_all_ldap_mappings_info](#view_all_ldap_mappings_info), [view_all_nodes_alerts](#view_all_nodes_alerts), [view_all_nodes_checks](#view_all_nodes_checks), [view_all_nodes_info](#view_all_nodes_info), [view_all_nodes_stats](#view_all_nodes_stats), [view_all_proxies_info](#view_all_proxies_info), [view_all_redis_acls_info](#view_all_redis_acls_info), [view_all_roles_info](#view_all_roles_info), [view_all_shard_stats](#view_all_shard_stats), [view_all_users_info](#view_all_users_info), [view_bdb_alerts](#view_bdb_alerts), [view_bdb_info](#view_bdb_info), [view_bdb_stats](#view_bdb_stats), [view_cluster_alerts](#view_cluster_alerts), [view_cluster_info](#view_cluster_info), [view_cluster_keys](#view_cluster_keys), [view_cluster_modules](#view_cluster_modules), [view_cluster_stats](#view_cluster_stats), [view_crdb](#view_crdb), [view_crdb_list](#view_crdb_list), [view_crdb_task](#view_crdb_task), [view_crdb_task_list](#view_crdb_task_list), [view_endpoint_stats](#view_endpoint_stats), [view_ldap_config](#view_ldap_config), [view_ldap_mapping_info](#view_ldap_mapping_info), [view_license](#view_license), [view_logged_events](#view_logged_events), [view_node_alerts](#view_node_alerts), [view_node_check](#view_node_check), [view_node_info](#view_node_info), [view_node_stats](#view_node_stats), [view_proxy_info](#view_proxy_info), [view_redis_acl_info](#view_redis_acl_info), [view_redis_pass](#view_redis_pass), [view_role_info](#view_role_info), [view_shard_stats](#view_shard_stats), [view_sso](#view_sso), [view_status_of_all_node_actions](#view_status_of_all_node_actions), [view_status_of_cluster_action](#view_status_of_cluster_action), [view_status_of_node_action](#view_status_of_node_action), [view_user_info](#view_user_info) | ## Roles list per permission