Skip to content

Commit

Permalink
DOC-2944 DOC-3140 Added DB defaults for shard placement and proxy pol…
Browse files Browse the repository at this point in the history
…icies
  • Loading branch information
rrelledge committed Nov 14, 2023
1 parent 3db3021 commit 99b81d7
Show file tree
Hide file tree
Showing 2 changed files with 65 additions and 0 deletions.
59 changes: 59 additions & 0 deletions content/rs/databases/configure/db-defaults.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,3 +109,62 @@ To enable or turn off internode encryption by default, use one of the following
PUT /v1/cluster/policy
{ "data_internode_encryption": <boolean> }
```
### Shard placement
The default [shard placement policy]({{<relref "/rs/databases/memory-performance/shard-placement-policy">}}) determines the distribution of database shards across nodes in the cluster.
To configure default shard placement, use one of the following methods:
- [rladmin tune cluster]({{<relref "/rs/references/cli-utilities/rladmin/tune#tune-cluster">}}):
```sh
rladmin tune cluster default_shards_placement { dense | sparse }
```
- [Update cluster policy]({{<relref "/rs/references/rest-api/requests/cluster/policy#put-cluster-policy">}}) REST API request:
```sh
PUT /v1/cluster/policy
{ "default_shards_placement": "dense | sparse" }
```
### Proxy policies
Redis Enterprise Software uses [proxies]({{<relref "/rs/references/terminology#proxy">}}) to manage and optimize access to database shards. Each node in the cluster runs a single proxy process, which can be active (receives incoming traffic) or passive (waits for failovers).
Configure the following default [proxy policies]({{<relref "/rs/databases/configure/proxy-policy">}}) to determine which nodes' proxies are active and bound to new databases by default.
#### Non-sharded proxy policy
To configure the default proxy policy for non-sharded databases, use one of the following methods:
- [rladmin tune cluster]({{<relref "/rs/references/cli-utilities/rladmin/tune#tune-cluster">}}):
```sh
rladmin tune cluster default_non_sharded_proxy_policy { single | all-master-shards | all-nodes }
```
- [Update cluster policy]({{<relref "/rs/references/rest-api/requests/cluster/policy#put-cluster-policy">}}) REST API request:
```sh
PUT /v1/cluster/policy
{ "default_non_sharded_proxy_policy": "single | all-master-shards | all-nodes" }
```
#### Sharded proxy policy
To configure the default proxy policy for sharded databases, use one of the following methods:
- [rladmin tune cluster]({{<relref "/rs/references/cli-utilities/rladmin/tune#tune-cluster">}}):
```sh
rladmin tune cluster default_sharded_proxy_policy { single | all-master-shards | all-nodes }
```
- [Update cluster policy]({{<relref "/rs/references/rest-api/requests/cluster/policy#put-cluster-policy">}}) REST API request:
```sh
PUT /v1/cluster/policy
{ "default_sharded_proxy_policy": "single | all-master-shards | all-nodes" }
```
6 changes: 6 additions & 0 deletions content/rs/references/cli-utilities/rladmin/tune.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,9 @@ rladmin tune cluster
[ expose_hostnames_for_all_suffixes { enabled | disabled } ]
[ redis_upgrade_policy { latest | major } ]
[ default_redis_version <value> ]
[ default_non_sharded_proxy_policy { single | all-master-shards | all-nodes } ]
[ default_sharded_proxy_policy { single | all-master-shards | all-nodes } ]
[ default_shards_placement { dense | sparse } ]
[ data_internode_encryption { enabled | disabled } ]
[ db_conns_auditing { enabled | disabled } ]
[ acl_pubsub_default { resetchannels | allchannels } ]
Expand All @@ -51,7 +54,10 @@ rladmin tune cluster
| data_internode_encryption | `enabled`<br />`disabled` | Activates or deactivates [internode encryption]({{<relref "/rs/security/encryption/internode-encryption">}}) for new databases |
| db_conns_auditing | `enabled`<br /> `disabled` | Activates or deactivates [connection auditing]({{<relref "/rs/security/audit-events">}}) by default for new databases of a cluster |
| default_concurrent_restore_actions | integer<br />`all` | Default number of concurrent actions when restoring a node from a snapshot (positive integer or "all") |
| default_non_sharded_proxy_policy | `single`<br /><nobr>`all-master-shards`</nobr><br />`all-nodes` | Default [proxy policy]({{<relref "/rs/databases/configure/proxy-policy">}}) for newly created non-sharded databases' endpoints |
| default_redis_version | version number | The default Redis database compatibility version used to create new databases.<br/><br/> The value parameter should be a version number in the form of "x.y" where _x_ represents the major version number and _y_ represents the minor version number. The final value corresponds to the desired version of Redis.<br/><br/>You cannot set _default_redis_version_ to a value higher than that supported by the current _redis_upgrade_policy_ value. |
| default_sharded_proxy_policy | `single`<br />`all-master-shards`<br />`all-nodes` | Default [proxy policy]({{<relref "/rs/databases/configure/proxy-policy">}}) for newly created sharded databases' endpoints |
| default_shards_placement | `dense`<br />`sparse` | New databases place shards according to the default [shard placement policy]({{<relref "/rs/databases/memory-performance/shard-placement-policy">}}) |
| expose_hostnames_for_all_suffixes | `enabled`<br />`disabled` | Exposes hostnames for all DNS suffixes |
| failure_detection_sensitivity | `high`<br />`low` | Predefined thresholds and timeouts for failure detection (previously known as `watchdog_profile`)<br />`high` (previously `local-network`) – high failure detection sensitivity, lower thresholds, faster failure detection and failover<br />`low` (previously `cloud`) – low failure detection sensitivity, higher tolerance for latency variance (also called network jitter) |
| login_lockout_counter_reset_after | time in seconds | Time after failed login attempt before the counter resets to 0 |
Expand Down

0 comments on commit 99b81d7

Please sign in to comment.