Skip to content

Commit 7473c10

Browse files
committed
DEV: document Redis 8 breaking changes to ACL handling
1 parent 550a474 commit 7473c10

File tree

2 files changed

+14
-10
lines changed

2 files changed

+14
-10
lines changed

content/operate/oss_and_stack/management/security/acl.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -289,19 +289,19 @@ The following is a list of command categories and their meanings:
289289
* **bitmap** - Data type: all bitmap related commands.
290290
* **blocking** - Potentially blocking the connection until released by another
291291
command.
292-
* **bloom** - Data type: all Bloom filter related commands.
293-
* **cms** - Data type: count-min sketch related commands.
292+
* **bloom** - Data type: all Bloom filter related commands. <sup>[1](#cmd-note-1)</sup>
293+
* **cms** - Data type: count-min sketch related commands. <sup>[1](#cmd-note-1)</sup>
294294
* **connection** - Commands affecting the connection or other connections.
295295
This includes [`AUTH`](/commands/auth), [`SELECT`](/commands/select), [`COMMAND`](/commands/command), [`CLIENT`](/commands/client), [`ECHO`](/commands/echo), [`PING`](/commands/ping), etc.
296-
* **cuckoo** - Data type: all Cuckoo filter related commands.
296+
* **cuckoo** - Data type: all Cuckoo filter related commands. <sup>[1](#cmd-note-1)</sup>
297297
* **dangerous** - Potentially dangerous commands (each should be considered with care for
298298
various reasons). This includes [`FLUSHALL`](/commands/flushall), [`MIGRATE`](/commands/migrate), [`RESTORE`](/commands/restore), [`SORT`](/commands/sort), [`KEYS`](/commands/keys),
299299
[`CLIENT`](/commands/client), [`DEBUG`](/commands/debug), [`INFO`](/commands/info), [`CONFIG`](/commands/config), [`SAVE`](/commands/save), [`REPLICAOF`](/commands/replicaof), etc.
300300
* **fast** - Fast O(1) commands. May loop on the number of arguments, but not the number of elements in the key.
301301
* **geo** - Data type: all geospatial index related commands.
302302
* **hash** - Data type: all hash related commands.
303303
* **hyperloglog** - Data type: all hyperloglog related commands.
304-
* **json** - Data type: all JSON related commands.
304+
* **json** - Data type: all JSON related commands. <sup>[1](#cmd-note-1)</sup>
305305
* **keyspace** - Writing or reading from keys, databases, or their metadata
306306
in a type agnostic way. Includes [`DEL`](/commands/del), [`RESTORE`](/commands/restore), [`DUMP`](/commands/dump), [`RENAME`](/commands/rename), [`EXISTS`](/commands/exists), [`DBSIZE`](/commands/dbsize),
307307
[`KEYS`](/commands/keys), [`SCAN`](/commands/scan), [`EXPIRE`](/commands/expire), [`TTL`](/commands/ttl), [`FLUSHALL`](/commands/flushall), etc. Commands that may modify the keyspace,
@@ -311,18 +311,22 @@ The following is a list of command categories and their meanings:
311311
* **pubsub** - all pubsub related commands.
312312
* **read** - Reading from keys (values or metadata). Note that commands that don't interact with keys, will not have either `read` or `write`.
313313
* **scripting** - Scripting related.
314-
* **search** - All search related commands. Only ACL users with access to a superset of the key prefixes defined during index creation can create, modify, or read the index. For example, a user with the key ACL pattern `h:*` can create an index with keys prefixed by `h:*` or `h:p*`, but not keys prefixed by `h*`, `k:*`, or `k*`, because these prefixes may involve keys to which the user does not have access.
314+
* **search** - All search related commands. Only ACL users with access to a superset of the key prefixes defined during index creation can create, modify, or read the index. For example, a user with the key ACL pattern `h:*` can create an index with keys prefixed by `h:*` or `h:p*`, but not keys prefixed by `h*`, `k:*`, or `k*`, because these prefixes may involve keys to which the user does not have access. <sup>[1](#cmd-note-1)</sup>
315315
* **set** - Data type: all set related commands.
316316
* **sortedset** - Data type: all sorted set related commands.
317317
* **slow** - All commands that are not `fast`.
318318
* **stream** - Data type: all stream related commands.
319319
* **string** - Data type: all string related commands.
320-
* **tdigest** - Data type: all t-digest related commands.
321-
* **timeseries** - Data type: all time series related commands.
322-
* **topk** - Data type: all top-k related commands.
320+
* **tdigest** - Data type: all t-digest related commands. <sup>[1](#cmd-note-1)</sup>
321+
* **timeseries** - Data type: all time series related commands. <sup>[1](#cmd-note-1)</sup>
322+
* **topk** - Data type: all top-k related commands. <sup>[1](#cmd-note-1)</sup>
323323
* **transaction** - [`WATCH`](/commands/watch) / [`MULTI`](/commands/multi) / [`EXEC`](/commands/exec) related commands.
324324
* **write** - Writing to keys (values or metadata). Note that commands that don't interact with keys, will not have either `read` or `write`.
325325

326+
1. <a name="cmd-note-1"></a>Before Redis 8, the existing ACL categories @read, @write, @dangerous, @admin, @slow, and @fast did not include commands for the Redis Query Engine, JSON, time series, and probabilistic data structures.
327+
328+
Starting with Redis 8, Redis includes all Query Engine, JSON, time series, Bloom filter, cuckoo filter, top-k, count-min sketch, and t-digest commands in these existing ACL categories.
329+
326330
NOTE: Redis can also show you a list of all categories and the exact commands each category includes using the Redis [`ACL CAT`](/commands/acl-cat) command.
327331
It can be used in two forms:
328332

content/operate/oss_and_stack/stack-with-enterprise/release-notes/redisce/redisos-8.0-release-notes.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,9 +72,9 @@ Stand alone RediSearch, RedisJSON, RedisTimeSeries, and RedisBloom modules are n
7272
- See the [build instructions]({{< relref "/operate/oss_and_stack/install/build-stack" >}}) for information about building from source code.
7373
- New configuration file: `redis-full.conf`, loads Redis with all components,
7474
and contains new configuration parameters for Redis Query Engine and the new data structures .
75-
- New ACL categories: `@search`, `@json`, `@timeseries`, `@bloom`, `@cuckoo`, `@cms`, `@topk`, and `@tdigest`.
76-
- Commands are also included in the existing ACL categories such as `@read` and `@write`.
75+
- Before Redis 8, the existing ACL categories @read, @write, @dangerous, @admin, @slow, and @fast did not include commands for the Redis Query Engine, JSON, time series, and probabilistic data structures.
7776

77+
Starting with Redis 8, Redis includes all Query Engine, JSON, time series, Bloom filter, cuckoo filter, top-k, count-min sketch, and t-digest commands in these existing ACL categories.
7878
- More than 30 performance and resource utilization improvements.
7979
- A new I/O threading implementation, which enables throughput increase on multi-core environments
8080
(set with the `io-threads` configuration parameter).

0 commit comments

Comments
 (0)