The keydb-docs from snapchat

When trying to figure out how to remove a dead replica from replication, I could not find any information on how to do that. Just before implementing replicaof no one, I found issue Snapchat/KeyDB#192 which solved my problem, but that feature appears undocumented. This desperately needs communicated in the keydb documentation:

https://docs.keydb.dev/docs/commands#replicaof

There's a block of text that ambiguously talks about removing replication from an "old server," but it's confusing and seemingly incomplete. When you issue replicaof <downed host> <port> it just says OK Already connected to specified master . Mentioning the remove feature here is ideal.

If a server is already a replica of some master, REPLICAOF <hostname> <port> will stop the replication against the old server and start the synchronization against the new one, discarding the old dataset.

Thanks! We love the product so far.

Add in list of supported Data Structures for Multi-Master Config

Include detailed description of data-types supported with multi-master and elaborate on potential issues related to data types not supported. This issue brought over from KeyDB repo #395

Update Dockerfiles Document to link to source

Snapchat/KeyDB#559
https://github.com/Snapchat/KeyDB/tree/main/pkg/docker

The docs instruction should link to the github source dockerfiles to ensure it is up to date.

Navbar items not fitting

Navbar items do not fit when the view width is 997px to 1302px.

Lots of inconsistencies with regards to the name KeyDB <=> Redis

I am trying to follow the documentation but noticed that there are a lot of inconsistencies with the name.
I think this is true in many places but I would like to focus on one in particular, https://docs.keydb.dev/docs/first-test/.

There are no such files: ./utils/KeyDB_init_script but there are ./utils/redis_init_script.
There are no such file: ./redis.conf but there are ./keydb.conf.
More importantly, the scripts themselves have mixed name. In the documentation, I am told to change KeyDBPort but there are no such variables, but there are REDISPORT.

I am probably going to find more.
I want to submit a PR but I don't know how big a change/what is the desired name to be.
I suspect this happened because the Redis documentation was simply find+replace'ed to KeyDB.
AFAIK, this project aims to have feature parity with Redis but with different internal implementation.
If that is the case, wouldn't it be better to simply have Redis docs + some appendix?

[IDEA] Frequently Encountered WARNINGS/CRITICAL

Create a new FAQ-like article that explains some commonly produced warnings/critical messages from KeyDB error logs.

CLIENT KILL and multi-threaded

https://docs.keydb.dev/docs/commands#client-kill

Need to fix this paragraph somehow as KeyDB is multithreaded

Due to the single-threaded nature of KeyDB, it is not possible to kill a client connection while it is executing a command. From the client point of view, the connection can never be closed in the middle of the execution of a command. However, the client will notice the connection has been closed only when the next command is sent (and results in network error).

Document supported hardware architectures

Hi!

I have checked the documentation but did not find any word about supported architectures - only about supported operating systems.

Could you please put the information about supported architectures to the documentation please? E.e. about supported architectures for different operating systems, some specific requirements to the supported instructions, if you have any (e.g. maybe AVX is required - I do not know).

This kind of information is important for the end-users. I have created the same issue to the Redis-doc repo: redis/redis-doc#2001

Even if you have no limitations on supported platforms and/or instruction sets, please at least write a note which OS-configurations are most battle-tested.

Thanks in advance!

Document downgrade process

Hi.

After reading the documentation it is not clear for me, how downgrade process should be performed over the database. Could you please describe somewhere in the documentation:

How to downgrade the database to the older version (hopefully with no downtime)
Maybe some compatibility policies and notes between versions

Thanks in advance!

Add more details to role

https://docs.keydb.dev/docs/commands#role

Snapchat/KeyDB#165

The config file documentation still mentions KeyDB Enterprise

From https://docs.keydb.dev/docs/config-file/:

# Enable Enterprise?  KeyDB Enterprise provides support for Enterprise only features
#   note: you may omit the license key to demo Enterprise features for a limited time
# enable-enterprise [License Key]

# Enable FLASH support? (Enterprise Only)
# storage-provider flash /path/to/flash/db

As far as I understand, Enterprise doesn't exist any more.

Kubernetes deployment with active replication

Moved from Snapchat/KeyDB#128
Original request by @mattharrigan

Please add documentation for how to deploy a KeyDB cluster with active replication on Kubernetes with persistent volumes. One possibility would be to use KeyDB for this tutorial https://kubernetes.io/docs/tutorials/stateless-application/guestbook/. Thank you

Global "KeyDB" variable in EVAL docs

The documentation for EVAL uses a global KeyDB variable: https://github.com/EQ-Alpha/KeyDB-docs/blob/master/docs/commands.md#eval

I can only use redis as a global variable however, using KeyDB errors because it is not defined. Is this a setting somewhere, or is the documentation wrong? I'd rather use "KeyDB" in the scripts if I could choose of course 😉

Remove $ from the commands or use any other syntax highlighter

There are few places which uses $ in the command and it becomes hard to copy and paste

Inaccurate example of active-replica dropping databases

Correct me if I'm wrong but databases are merged and not dropped when active-replica is yes.

It seems that it was implemented as part of the initial roll out of active-replica in the commit below so I'm not sure if the documentation was wrong from the beginning or if I'm somehow mistaken

Snapchat/KeyDB@91e6368

KeyDB-docs/docs/active-rep.md

Line 25 in 3fef1d1

Server B will drop its database and load server A's dataset

Provide a ChangeLog

Currently there is no changelog that is easily found.

This is essential to understand fundamental changes between versions

Update FLUSHALL from Redis

https://redis.io/commands/flushall

Documentation: support for TLS

There appears to be a discrepency on TLS support. Is TLS a feature available by default or does this require building from source?

Is TLS in the builds pulled from .git or the PPA's?

On https://github.com/Snapchat/KeyDB/blob/main/TLS.md it says:

TLS support is enabled in the default build. To build without TLS, run make BUILD_TLS=no.

But on
https://docs.keydb.dev/docs/encryption/ it says:

To build with TLS support you'll need OpenSSL development libraries (e.g. libssl-dev on Debian/Ubuntu).

Run make BUILD_TLS=yes.

Add that multimaster has failover but active replication doesn't

https://community.keydb.dev/t/read-only-active-replicas/164/3

Search bar highlight text is difficult to read

When searching in either light or dark modes, the highlight color makes it difficult to read. Need to update highlight color for search bar

Stop translating documentation automatically!

It appears documentation website is automatically translated when coming from a non-english browser.

When you would think it's a good idea, instead it's the worst idea ever, because config samples or code is also translated.

in https://docs.keydb.dev/docs/active-rep the first configuration file shown, in french, is :

# en supposant que les paramètres ci-dessous ont été définis et que l'adresse IP de cette instance est 10.0.0.2
port 6379
requirepass mon mot de passe123
masterauth mon mot de passe123
# vous devrez configurer les éléments suivants
réplique active oui
réplique de 10.0.0.3 6379

Yes, that makes no sense at all.

Please, stop translating doc pages (or at least provide an easy way to show english version).

[EDIT]
Wow, translation just disappeared. I'm not crazy, was it just a test ? Performed on december 15th around 11am GMT.

CLIENT UNPAUSE

Need to decide whether to add client unpause

https://github.com/redis/redis-doc/blob/master/commands/client-unpause.md

6th Draft Multimaster Edit Document

From Slack Community :

Advanced Configuration: Rewrite Replica Quorum / Replica-serve-stale-data

Provide more low-level detail

Investigate on failover between active replication and multi-master : https://community.keydb.dev/t/read-only-active-replicas/164/3
Slack community

RESP3 Null values

I am writing a KeyDB client library for the V language, I have noticed that KeyDB is currently responding with RESP2 $-1\r\n and *-1\r\n instead of using RESP3 _\r\n.

Is KeyDB going to switch to RESP3 protocol or is it going to stay on RESP2?

Add replicaof remove ip port to the current command docs

https://docs.keydb.dev/docs/commands#replicaof

Snapchat/KeyDB#192

Add more examples to commands with additional options

Certain commands have additional options that contains a description but not an example. It would be nice to provide additional examples to these certain commands.

For example

https://redis.io/commands/zunionstore

is missing an example for the AGGREGATE option.