# Enable OSS Cluster API

```json metadata
{
  "title": "Enable OSS Cluster API",
  "description": "",
  "categories": ["docs","operate","rs"],
  "tableOfContents": {"sections":[{"id":"prerequisites","title":"Prerequisites"},{"children":[{"id":"active-active-databases","title":"Active-Active databases"}],"id":"enable-oss-cluster-api-support","title":"Enable OSS Cluster API support"},{"id":"change-preferred-ip-type","title":"Change preferred IP type"},{"id":"turn-off-oss-cluster-api-support","title":"Turn off OSS Cluster API support"},{"id":"multi-key-command-support","title":"Multi-key command support"}]}

,
  "codeExamples": []
}
```
Review [OSS Cluster API](https://redis.io/docs/latest/operate/rs/clusters/optimize/oss-cluster-api) to determine if you should enable this feature for your database.

## Prerequisites

The OSS Cluster API is supported only when a database meets specific criteria.

The database must:

- Use the standard [hashing policy](https://redis.io/docs/latest/operate/rs/databases/durability-ha/clustering#supported-hashing-policies).
- Have the [proxy policy](https://redis.io/docs/latest/operate/rs/databases/configure/proxy-policy) set to either _All primary shards_ or _All nodes_.

In addition, the database must _not_:

- Use node `include` or `exclude` in the proxy policy.
- Use [RedisTimeSeries](https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/timeseries) or [RedisGears](https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1) modules.

The OSS Cluster API setting applies to individual databases instead of the entire cluster.


For Kubernetes deployments, see [Enable cluster-aware clients (OSS Cluster API)](https://redis.io/docs/latest/operate/kubernetes/networking/cluster-aware-clients).


## Enable OSS Cluster API support

You can use the Cluster Manager UI, the `rladmin` utility, or the REST API to enable OSS Cluster API support for a database.

When you enable OSS Cluster API support for an existing database, the change applies to new connections but does not affect existing connections. Clients must close existing connections and reconnect to apply the change.

**Cluster Manager UI:**

When you use the Cluster Manager UI to enable the OSS Cluster API, it automatically configures the [prerequisites](https://redis.io/docs/latest/operate/rs/databases/configure/oss-cluster-api#prerequisites).

To enable the OSS Cluster API for an existing database in the Cluster Manager UI:

1. From the database's **Configuration** tab, click **Edit**.

1. Expand the **Clustering** section.

1. Enable **Sharding**.

1. Select **OSS Cluster API**.

    <img src="../../../../../images/rs/screenshots/databases/config-clustering-oss-cluster-api-7-22.png" alt="Use the *OSS Cluster API* setting to enable the API for the selected database.">

1. Click **Save**.

You can also use the Cluster Manager UI to enable the setting when creating a new database.

**rladmin:**

You can use the [`rladmin` utility](https://redis.io/docs/latest/operate/rs/references/cli-utilities/rladmin/) to enable the OSS Cluster API for Redis Software databases, including Replica Of databases.

For Active-Active (CRDB) databases, [use the crdb-cli utility](#active-active-databases).

Ensure the [prerequisites](https://redis.io/docs/latest/operate/rs/databases/configure/oss-cluster-api#prerequisites) have been configured.  Then, enable the OSS Cluster API for a Redis database from the command line:

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

To determine the current setting for a database from the command line, use `rladmin info db` to return the value of the `oss_cluster` setting.

```sh
$ rladmin info db test | grep oss_cluster:
  oss_cluster: enabled
```

The OSS Cluster API setting applies to the specified database only; it does not apply to the cluster.

**REST API:**

You can enable the OSS Cluster API when you [create a database](https://redis.io/docs/latest/operate/rs/references/rest-api/requests/bdbs#post-bdbs-v1) using the REST API:

```sh
POST /v1/bdbs
{ 
  "oss_cluster": true,
  // Other database configuration parameters
}
```

To enable the OSS Cluster API for an existing database, you can use an [update database configuration](https://redis.io/docs/latest/operate/rs/references/rest-api/requests/bdbs#put-bdbs) REST API request:

```sh
PUT /v1/bdbs/<database-id>
{ "oss_cluster": true }
```



### Active-Active databases

The OSS Cluster API setting applies to all instances of the Active-Active database across participating clusters. To enable the OSS Cluster API for Active-Active databases, use the [Cluster Manager UI](#cluster-manager-ui) or the [`crdb-cli`](https://redis.io/docs/latest/operate/rs/references/cli-utilities/crdb-cli) utility.

**Cluster Manager UI:**

When you use the Cluster Manager UI to enable the OSS Cluster API, it automatically configures the [prerequisites](https://redis.io/docs/latest/operate/rs/databases/configure/oss-cluster-api#prerequisites).

To enable the OSS Cluster API for an existing Active-Active database in the Cluster Manager UI:

1. From the database's **Configuration** tab, click **Edit**.

1. Expand the **Clustering** section.

1. Sharding must be enabled during Active-Active database creation.

1. Select **OSS Cluster API**.

    <img src="../../../../../images/rs/screenshots/databases/config-clustering-oss-cluster-api-active-active-7-22.png" alt="Use the *OSS Cluster API* setting to enable the API for the selected database.">

1. Click **Save**.

You can also use the Cluster Manager UI to enable the setting when creating a new database.

**crdb-cli:**

To create an Active-Active database and enable the OSS Cluster API with `crdb-cli`:

```sh
$ crdb-cli crdb create --name <name> \
    --memory-size 10g --port <port> \
    --sharding true --shards-count 2  \
    --replication true --oss-cluster true --proxy-policy all-master-shards \
    --instance fqdn=<fqdn>,username=<user>,password=<pass> \
    --instance fqdn=<fqdn>,username=<user>,password=<pass> \
    --instance fqdn=<fqdn>,username=<user>,password=<pass>
```

See the [`crdb-cli crdb create`](https://redis.io/docs/latest/operate/rs/references/cli-utilities/crdb-cli/crdb/create) reference for more options.

To enable the OSS Cluster API for an existing Active-Active database with `crdb-cli`:

1. Obtain the `CRDB-GUID` for the new database:

    ```sh
    $ crdb-cli crdb list
    CRDB-GUID    NAME   REPL-ID  CLUSTER-FQDN
    <CRDB-GUID>  Test   4        cluster1.local
    ```

1. Use the `CRDB-GUID` to enable the OSS Cluster API:

    ```sh
    $ crdb-cli crdb update --crdb-guid <CRDB-GUID> \
        --oss-cluster true
    ```



## Change preferred IP type

By default, using [`CLUSTER SLOTS`](https://redis.io/docs/latest/commands/cluster-slots) and [`CLUSTER SHARDS`](https://redis.io/docs/latest/commands/cluster-shards) in a Redis Software cluster exposes the internal IP addresses for databases with the OSS Cluster API enabled.

To use external IP addresses instead of internal IP addresses, run the following [`rladmin tune db`](https://redis.io/docs/latest/operate/rs/references/cli-utilities/rladmin/tune#tune-db) command for each affected database:

```sh
$ rladmin tune db db:<database-id> oss_cluster_api_preferred_ip_type external
```

## Turn off OSS Cluster API support

To deactivate OSS Cluster API support for a database, use one of the following methods:

**Cluster Manager UI:**

To turn off the OSS Cluster API for standard databases or Active-Active databases in the Cluster Manager UI:

1. From the database's **Configuration** tab, click **Edit**.

1. Expand the **Clustering** section.

1. Clear the **OSS Cluster API** checkbox.

1. Click **Save**.

**rladmin:**

For standard databases, including Replica Of, you can use `rladmin` to turn off the OSS Cluster API:

```sh
$ rladmin tune db <name or ID> oss_cluster disabled
```

**crdb-cli:**

For Active-Active databases, you can use `crdb-cli` to turn off the OSS Cluster API:

```sh
$ crdb-cli crdb update --crdb-guid <CRDB-GUID> \
        --oss-cluster false
```



When you turn off OSS Cluster API support for an existing database, the change applies to new connections but does not affect existing connections. Clients must close existing connections and reconnect to apply the change.

## Multi-key command support

When you enable the OSS Cluster API for a database, 
[multi-key commands](https://redis.io/docs/latest/operate/rc/databases/configuration/clustering#multikey-operations) are only allowed when all keys are mapped to the same slot.

To verify that your database meets this requirement, make sure that the `CLUSTER KEYSLOT` reply is the same for all keys affected by the multi-key command.  To learn more, see [multi-key operations](https://redis.io/docs/latest/operate/rs/databases/durability-ha/clustering#multikey-operations).