The Redis OSS Cluster API support in Redis Enterprise Software (RS) provides a simple mechanism for cluster-aware Redis clients to learn and know the cluster topology. This enables clients to connect directly to an RS proxy on the node hosting the master shard for the data being operated on.

For more information, see Redis OSS Cluster API.

Multi-key commands are only allowed when all keys are mapped to the same slot. To verify this, make sure that the CLUSTER KEYSLOT reply is the same for all keys in the multi-key command.

Note: The OSS Cluster API setting is not cluster-wide. The setting only applies to the specified database.

Configuring an RS Database to Use the OSS Cluster API

To configure an RS database to use the OSS Cluster API:

  1. Make sure that the database meets these requirements:
    • The database must use the standard hashing policy.
    • The database proxy policy is all-master-shards.
    • The database proxy policy must not use node include or exclude.
    • The database is not a CRDB.
  2. Find the database ID to make sure that we convert the correct database.

    $ sudo rladmin info db | grep test
    db:4 [test]:

    In this example, the db ID is 4.

  3. Using the rladmin command line utility, enable the OSS Cluster API for the specified database.

    $ sudo rladmin
    rladmin> tune db <database name or ID> oss_cluster enabled

    Note: To disable OSS Cluster API with rladmin, run: tune db <database name or ID> oss_cluster disable

To get the benefits of using the OSS Cluster API, make sure that you are using Redis clients that are cluster-aware, such as redis-py-cluster or jedis.