Skip to content

Commit

Permalink
Merge pull request #235 from redis/DOC-3746
Browse files Browse the repository at this point in the history
DOC-3476: New Packaging Phase 2: Dataset size changes
  • Loading branch information
cmilesb authored May 28, 2024
2 parents 40c7008 + 1778f35 commit d4c2b6a
Show file tree
Hide file tree
Showing 16 changed files with 38 additions and 34 deletions.
12 changes: 6 additions & 6 deletions content/embeds/rc-pro-use-cases-billing-units.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@

The following table shows the default use case settings for a Pro database.

| **Type** | High Availability | Data Persistence | Capabilities | Eviction Policy |
|---|---|---|---|---|
| **Cache** | Single-zone | None | None | `volatile-lru` |
| **Database** | Multi-zone | Append-only file every 1 sec | Search & query, JSON, Probabilistic, Time Series | None |
| **Vector Search** | Multi-zone | Append-only file every 1 sec | Search & query, JSON | None |
| **Custom** | Single-zone | Append-only file every 1 sec | None | None |
| **Type** | High Availability | Data Persistence | Eviction Policy |
|---|---|---|---|
| **Cache** | Single-zone | None | `volatile-lru` |
| **Database** | Multi-zone | Append-only file every 1 sec | None |
| **Vector Search** | Multi-zone | Append-only file every 1 sec | None |
| **Custom** | Single-zone | Append-only file every 1 sec | None |

## Billing Unit types

Expand Down
12 changes: 12 additions & 0 deletions content/operate/rc/changelog/may-2024.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,15 @@ If you have an active SAML configuration, you can still sign in with SAML SSO, b
See [Create an Active-Active database]({{< relref "/operate/rc/databases/create-database/create-active-active-database" >}}) to learn how to create an Active-Active database.

See [Search and query Active-Active databases]({{< relref "/operate/oss_and_stack/stack-with-enterprise/search/search-active-active" >}}) to learn how to use Search and query on Active-Active databases.

## Enhancements

### Dataset size

We now distinguish between dataset size and memory limit to reduce confusion.

For Redis Cloud Essentials, the plan size refers to the full memory limit, not the dataset size. If you select high availability for an Essentials database, your dataset size will be half of the plan size. Both the total memory limit and dataset size are listed under **Database details** when you create an Essentials database.

For Redis Cloud Pro, you define your dataset size when you create the database, and we calculate your total memory limit automatically based on the features you choose.

See [Dataset size]({{< relref "/operate/rc/databases/configuration/clustering#dataset-size" >}}) for more information.
8 changes: 6 additions & 2 deletions content/operate/rc/databases/configuration/clustering.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,9 +165,13 @@ their order to suit your application's requirements.
- **PCRE_ANCHORED:** the pattern is constrained to match only at
the start of the string which is being searched.

## Memory limit {#dataset-size}
## Dataset size {#dataset-size}

The memory limit represents the maximum amount of memory for the database, which includes data values, keys, module data, and overhead for specific features. High availability features, such as replication and Active-Active, increase memory consumption.
The dataset size of a database is a part of the full memory limit for the database. The memory limit represents the maximum amount of memory for the database, which includes data values, keys, module data, and overhead for specific features. High availability features, such as replication and Active-Active, increase memory consumption, so in those cases your dataset size and memory limit will be different.

For Redis Cloud Essentials, the plan size refers to the full memory limit, not the dataset size. Both the total memory limit and dataset size are listed under **Database details** when you create an Essentials database.

For Redis Cloud Pro, you define your dataset size when you create the database, and we calculate your total memory limit based on the features you choose.

Here are some general guidelines:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,11 @@ Replication can affect performance as traffic increases to synchronize all copie

## Dataset size

For both Redis Cloud Essentials and Redis Cloud Pro, replication doubles the dataset size you need for your database.
For both Redis Cloud Essentials and Redis Cloud Pro, replication requires a memory limit that is double the dataset size of your database.

For Redis Cloud Essentials, the size of the plan you choose includes replication. Therefore, if you choose replication, the dataset size you can use is half of the stated plan size. For example, if you choose a 1 GB plan, Redis allocates 512 MB for the dataset size, and the other 512 MB for replication.

For Redis Cloud Pro, you also need to double the amount of memory needed if you choose replication.
For Redis Cloud Pro, you select your dataset size when you create your database, and we calculate your memory limit based on the replication settings you choose.

## Zone setting maintenance

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -79,22 +79,10 @@ You can't add or remove capabilities after you create your database.

Selected capabilities will be available in all regions, including those added in the future.

For Search and query databases, use the [Sizing calculator](https://redis.io/redisearch-sizing-calculator/) to estimate your index size and throughput requirements.
For Search and query databases, use the [Sizing calculator](https://redis.io/redisearch-sizing-calculator/) to estimate your index size and throughput requirements. When you're entering the dataset size for your database, add the estimated index size from the Sizing calculator to your expected dataset size.

See [Search and query Active-Active databases]({{< relref "/operate/oss_and_stack/stack-with-enterprise/search/search-active-active" >}}) to learn how to use Search and query on Active-Active databases.

## Define memory limit

Active-Active databases have specific memory requirements that differ from non-replicated Redis.

Select **Memory calculator** to calculate the memory limit for your Active-Active database.

{{<image filename="images/rc/active-active-memory-calculator.png" width="75%" alt="The memory calculator. Enter your expected database size to see the memory limit." >}}

In the Memory calculator, enter your expected dataset size. For Search and query databases, add the estimated index size from the [Sizing calculator](https://redis.io/redisearch-sizing-calculator/) to your expected dataset size.

Select **Apply** to apply the calculated memory limit.

## Define throughput

Each Active-Active instance coordinates changes with every other instance, which increases memory use and throughput.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ This guide shows how to create an Essentials database.

These settings may already be set based on the use case you selected. You can change them now if you like.

1. Select the desired dataset size. To create a free database, select the 30 MB dataset size. You can only have one free database at a time.
1. Select the desired memory limit. To create a free database, select the 30 MB memory limit. You can only have one free database at a time.

{{<image filename="images/rc/subscription-new-fixed-tiers.png" alt="Available Essentials plans." >}}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,12 +57,13 @@ The **Scalability** section lets you manage the maximum size, throughput, and ha

| Setting name | Description |
|:--------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Memory limit** | Maximum size (in GB) for your database. See [Memory limit]({{< relref "/operate/rs/databases/durability-ha/clustering#dataset-size" >}}) for sizing considerations. |
| **Throughput** | Defines throughput in terms of maximum operations per second for the database. See [Throughput]({{< relref "/operate/rs/databases/durability-ha/clustering#throughput" >}}) for more information. |
| **Dataset size** | Maximum size (in GB) for your dataset. See [Dataset size]({{< relref "/operate/rc/databases/configuration/clustering#dataset-size" >}}) for sizing considerations. |
| **Throughput** | Defines throughput in terms of maximum operations per second for the database. See [Throughput]({{< relref "/operate/rc/databases/configuration/clustering#throughput" >}}) for more info. |
| **High availability** | Replicates your data across multiple nodes, as allowed by your subscription plan. See [High availability]({{< relref "/operate/rc/databases/configuration/high-availability" >}}) for more info|
| **Hashing policy** | Defines the [hashing policy]({{< relref "/operate/rc/databases/configuration/clustering#manage-the-hashing-policy" >}}). |
| **OSS Cluster API** | Enables the [Cluster API]({{< relref "/operate/rc/databases/configuration/clustering#oss-cluster-api" >}}) for a database<br/><br/>When this option is enabled, you cannot define a custom hashing policy. |

To learn more about these settings and when to use them, see [Database clustering]({{< relref "/operate/rs/databases/durability-ha/clustering.md" >}}).
To learn more about these settings and when to use them, see [Database clustering]({{< relref "/operate/rc/databases/configuration/clustering" >}}).

## Durability section

Expand All @@ -73,7 +74,6 @@ The **Durability** section helps you keep your database (and your data) availabl

| Setting name | Description |
|:-------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **High availability** | Replicates your data across multiple nodes, as allowed by your subscription plan |
| **Data persistence** | Defines whether (and how) data is saved to disk; [available options]({{< relref "/operate/rc/databases/configuration/data-persistence.md" >}}) depending on your plan type |
| **Data eviction policy** | Configures which [policy]({{< relref "/operate/rc/databases/configuration/data-eviction-policies.md" >}}) is applied when your database reaches its memory limit |
| **Remote backup** | When enabled, identifies a location and interval for [data backups]({{< relref "/operate/rc/databases/back-up-data" >}}) |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ By default, you're shown basic settings, which include:
| **Name** | A custom name for your database (_required_) |
| **Advanced Capabilities** | Advanced data types used by the database. Choose from [Search and query]({{< relref "/operate/oss_and_stack/stack-with-enterprise/search" >}}), [JSON]({{< relref "/operate/oss_and_stack/stack-with-enterprise/json" >}}), [Time series]({{< relref "/operate/oss_and_stack/stack-with-enterprise/timeseries" >}}), [Probabilistic]({{< relref "/operate/oss_and_stack/stack-with-enterprise/bloom" >}}), or [Graph (EOL)]({{< relref "/operate/oss_and_stack/stack-with-enterprise/deprecated-features/graph" >}}). |
| **Throughput** | Identifies maximum throughput for the database, which is specified in terms of operations per second (**Ops/sec**). See [Throughput]({{< relref "/operate/rc/databases/configuration/clustering#throughput" >}}) for more information. |
| **Memory Limit (GB)** | The size limit for the database. Specify small sizes as decimals of 1.0&nbsp;GB; example: `0.1` GB (minimum).|
| **Dataset size (GB)** | The amount of data for your dataset. Specify small sizes as decimals of 1.0&nbsp;GB; example: `0.1` GB (minimum). We calculate the total memory limit for you based on the other settings you choose for your database. |
| **High Availability** | Indicates whether a replica copy of the database is maintained in case the primary database becomes unavailable. (Warning: Doubles memory consumption). See [High Availability]({{< relref "/operate/rc/databases/configuration/high-availability" >}}). |
| **Data Persistence** | Defines the data persistence policy, if any. See [Database persistence]({{< relref "/operate/rs/databases/configure/database-persistence.md" >}}). |

Expand All @@ -119,9 +119,9 @@ Select **More options** to specify values for the following settings.
| **Supported Protocol(s)** | Choose between RESP2 and RESP3 _(Redis 7.2 only)_. See [Redis serialization protocol]({{< relref "/develop/reference/protocol-spec" >}}#resp-versions) for details |
| **Quantity** | Number of databases to create with these settings. |

When finished, select **Save database** to create your database.
When finished, select **Save configuration** to save your database configuration.

{{<image filename="images/rc/button-database-save.png" width="140px" alt="Select the Save Database button to define your new database." >}}
{{<image filename="images/rc/button-configuration-save.png" width="140px" alt="Select the Save configuration button to define your new database." >}}

Use the **Add database** button to define additional databases or select the **Continue button** to display the **Review and create** tab.

Expand Down
6 changes: 3 additions & 3 deletions content/operate/rc/databases/view-edit-database.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,10 @@ The **Scalability** section is primarily for Redis Cloud Pro plans. Redis Cloud

| Setting name |Description|
|:----------------------|:----------|
| **Plan Memory limit** | Maximum size (in GB) for your database. |
| **Dataset size** | Maximum size (in GB) for your dataset. |
| **Memory used** | Memory currently used for your database. |
| **Throughput** | Defines throughput in terms of maximum operations per second for the database | |
| **Throughput** | Defines throughput in terms of maximum operations per second for the database |
| **High availability** | Replicates your data across multiple nodes; [available options]({{< relref "/operate/rc/databases/configuration/high-availability" >}}) depend on your plan type |
| **Hashing policy** | Defines the [hashing policy]({{< relref "/operate/rc/databases/configuration/clustering#manage-the-hashing-policy" >}}). |
| **OSS Cluster API** | Enables the [Cluster API]({{< relref "/operate/rc/databases/create-database#oss-cluster-api" >}}) for a database.<br/><br/>When this option is enabled, you cannot define a custom hashing policy.|

Expand All @@ -82,7 +83,6 @@ The Durability section helps protect your data when problems occur. These setti

| Setting name | Description |
|:-------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **High availability** | Replicates your data across multiple nodes; [available options]({{< relref "/operate/rc/databases/configuration/high-availability" >}}) depend on your plan type |
| **Data persistence** | Defines whether (and how) data is saved to disk; [available options]({{< relref "/operate/rc/databases/configuration/data-persistence" >}}) depend on your plan type |
| **Data eviction policy** | Configures which [policy]({{< relref "/operate/rc/databases/configuration/data-eviction-policies" >}}) is applied when your database reaches its memory limit |
| **Remote backup** | When enabled, identifies a location and interval for [data backups]({{< relref "/operate/rc/databases/back-up-data" >}}). (_Paid plans only_) |
Expand Down
Binary file added static/images/rc/button-configuration-save.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/images/rc/database-new-flexible-durability.png
100755 → 100644
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/images/rc/database-new-flexible-scalability.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/images/rc/flexible-add-database-advanced.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/images/rc/flexible-add-database-basic.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d4c2b6a

Please sign in to comment.