diff --git a/content/operate/_index.md b/content/operate/_index.md index 00e10da784..7b95e89596 100644 --- a/content/operate/_index.md +++ b/content/operate/_index.md @@ -36,7 +36,7 @@ hideListLinks: true |:-----------|:--------------|:-----------|:--------------|:--------------| | Monitoring | [Monitor performance]({{< relref "/operate/rc/databases/monitor-performance" >}}) | [Monitoring]({{}}) | [INFO]({{< relref "/commands/info" >}}), [MONITOR]({{< relref "/commands/monitor" >}}), and [LATENCY DOCTOR]({{< relref "/commands/latency-doctor" >}})
[Analysis with Redis Insight]({{< relref "/develop/tools/insight#database-analysis" >}}) | [Export metrics to Prometheus]({{}}) | | Logging | [System logs]({{< relref "/operate/rc/logs-reports/system-logs" >}}) | [Logging]({{}}) | `/var/log/redis/redis.log`
[SLOWLOG]({{< relref "/commands/slowlog" >}})
[Keyspace notifications]({{< relref "/develop/pubsub/keyspace-notifications" >}}) | [Logs]({{}}) | -| Alerts | [Alerts]({{< relref "/operate/rc/databases/view-edit-database#alerts-section" >}}) | [Alerts and events]({{}}) | [Pub/sub with Redis Sentinel]({{< relref "/operate/oss_and_stack/management/sentinel#pubsub-messages" >}}) | [REDB alertSettings]({{}}) | +| Alerts | [Alerts]({{< relref "/operate/rc/databases/monitor-performance#configure-metric-alerts" >}}) | [Alerts and events]({{}}) | [Pub/sub with Redis Sentinel]({{< relref "/operate/oss_and_stack/management/sentinel#pubsub-messages" >}}) | [REDB alertSettings]({{}}) | | Support | [Contact support](https://redis.io/support/) | [Create support package]({{}}) | | [Contact support](https://redis.io/support/) | ### Security diff --git a/content/operate/rc/databases/back-up-data.md b/content/operate/rc/databases/back-up-data.md index 55c6b59713..f33ebd77e3 100644 --- a/content/operate/rc/databases/back-up-data.md +++ b/content/operate/rc/databases/back-up-data.md @@ -40,9 +40,7 @@ To turn on database backups: {{The Edit button lets you change database settings.}} -1. In the **Durability** section of the **Configuration** tab, locate the **Remote backup** setting: - - {{The Remote backup setting is located in the Durability section of the Configuration tab of the database details screen.}} +1. In the **Configuration** tab, locate the **Remote backup** setting: in the **Performance & availability > Remote backup** section for Essentials databases, or the **Durability** section for Pro databases. When you enable **Remote backup**, additional options appear. The options vary according to your subscription. @@ -58,7 +56,7 @@ When you enable **Remote backup**, additional options appear. The options vary ## Back up and export data on demand -After backups are turned on, you can back up your data at any time. Use the **Backup now** button in the **Durability** section. +After backups are turned on, you can back up your data at any time. Use the **Backup now** button, located in the **Performance & availability > Remote backup** section for Essentials databases, or the **Durability** section for Pro databases. {{Use the Backup Now button to make backups on demand.}} diff --git a/content/operate/rc/databases/connect/_index.md b/content/operate/rc/databases/connect/_index.md index 37f93376fa..ad36b81cfe 100644 --- a/content/operate/rc/databases/connect/_index.md +++ b/content/operate/rc/databases/connect/_index.md @@ -21,9 +21,11 @@ To connect to the database, you need the following information: ### Database endpoints -The database endpoints are listed in the **General** section of the **Configuration** tab for your database. +The database endpoints are listed in the **Configuration** tab for your database: in the **Access** section for Essentials databases, or the **General** section for Pro databases. -{{The General section of the Configuration tab of the database details page.}} +{{The General section of the Configuration tab of the Pro database details page.}} + +{{The Access section for an Essentials database.}} Redis Cloud Pro and Redis Cloud Essentials databases have a public endpoint, which you can access from the public internet. Redis Cloud Pro databases also have a private endpoint. You can connect to the private endpoint from a private network. Before you can connect to the private endpoint, you must set up a private connectivity method, such as: - [VPC peering]({{< relref "/operate/rc/security/vpc-peering" >}}) @@ -40,9 +42,9 @@ You can redirect the dynamic endpoints to a different database at any time, but ### Database username and password -By default, your database is protected by a [**Default user**]({{< relref "/operate/rc/security/access-control/data-access-control/default-user" >}}) with the username `default` and a masked **Default user password**. You can see the default user password in the **Security** section of the **Configuration** details for your database. Select the eye icon to show or hide the password. +By default, your database is protected by a [**Default user**]({{< relref "/operate/rc/security/access-control/data-access-control/default-user" >}}) with the username `default` and a masked **Default user password**. For Essentials databases, select **Default user > Configure** and then select the eye icon to view your password. -{{The Security section of the Configuration tab of the database details page.}} +For Pro databases, you can see the default user password in the **Security** section of the **Configuration** details for your database. Select the eye icon to show or hide the password. If you've turned on [Role-based access control]({{< relref "/operate/rc/security/access-control/data-access-control/role-based-access-control" >}}) for your database and [turned off the default User]({{< relref "/operate/rc/security/access-control/data-access-control/default-user#turn-off-default-user" >}}), use the username and password for your data access role. diff --git a/content/operate/rc/databases/create-database/create-essentials-database.md b/content/operate/rc/databases/create-database/create-essentials-database.md index 93a0b39d3c..d11b628a71 100644 --- a/content/operate/rc/databases/create-database/create-essentials-database.md +++ b/content/operate/rc/databases/create-database/create-essentials-database.md @@ -32,10 +32,6 @@ This guide shows how to create a paid Essentials database. {{The database name, cloud vendor, version, region, type, and durability settings.}} -1. Select **RAM** or **Flex** to choose between a database that uses only RAM or one that uses both RAM and Flash memory. - - Choose Flex for larger datasets and cost-efficient scale when you can tolerate single-digit millisecond latency for warm data. Choose RAM when you need the absolute lowest latency for all data. To learn more about Flex, see [Create a Flex database]({{< relref "/operate/rc/databases/create-database/create-flex-database" >}}). - 1. Redis will generate a database name for you. If you want to change it, you can do so in the **Name** field. 1. Choose a **Cloud vendor** for your database from the list. You can choose between **Amazon Web Services (AWS)**, **Google Cloud**, and **Microsoft Azure** for the Cloud Vendor. @@ -48,11 +44,15 @@ This guide shows how to create a paid Essentials database. 1. The **Type** of database controls the protocol and advanced capabilities. Leave this as **Redis** unless you have a legacy application that uses **Memcached**. -1. Select your desired memory limit. +1. Select your desired plan. {{Available Essentials plans.}} - For a comparison of available plans, see [Redis Cloud Essentials plans]({{< relref "/operate/rc/subscriptions/view-essentials-subscription/essentials-plan-details" >}}). + The plan determines the size of your database and other limits. For a comparison of available plans, see [Redis Cloud Essentials plans]({{< relref "/operate/rc/subscriptions/view-essentials-subscription/essentials-plan-details" >}}). + +1. Select **RAM** or **RAM + SSD (Flex)** to choose between a database that uses only RAM or one that uses both RAM and Flash memory. + + Choose Flex for larger datasets and cost-efficient scale when you can tolerate single-digit millisecond latency for warm data. Choose RAM when you need the absolute lowest latency for all data. To learn more about Flex, see [Create a Flex database]({{< relref "/operate/rc/databases/create-database/create-flex-database" >}}). 1. Choose your **High availability (replication)** settings. diff --git a/content/operate/rc/databases/create-database/create-flex-database.md b/content/operate/rc/databases/create-database/create-flex-database.md index 7ee9151706..27c58d6af2 100644 --- a/content/operate/rc/databases/create-database/create-flex-database.md +++ b/content/operate/rc/databases/create-database/create-flex-database.md @@ -13,7 +13,7 @@ tocEmbedHeaders: true Flex allows your dataset to span both high-performance RAM and cost-efficient dedicated Flash memory. Flex automatically manages data placement between the two tiers, keeping frequently accessed (“hot”) data in RAM for sub-millisecond latency, while moving less active (“warm”) data to Flash to optimize capacity and cost. This dual memory architecture delivers predictable performance at scale, enabling larger datasets without compromising speed or operational simplicity. -Flex databases are currently compatible with most existing Redis applications, except for applications that use Search and Query and Time Series. +Flex databases are currently compatible with most existing Redis applications, except for applications that use Search and Query and Time Series. Flex is available on both Redis Cloud Essentials and Redis Cloud Pro. @@ -26,7 +26,7 @@ Consider Flex when you need to: - Run Redis at terabyte scale while maintaining high throughput and sub-10 ms latency. - Power real-time feature stores for machine learning applications such as fraud detection, recommendation systems, and personalization engines. - Operate large distributed caches that require elastic scaling and consistent performance under heavy load. -- Optimize infrastructure cost by combining high-speed RAM with cost-efficient Flash storage through Flex's automatic data tiering. +- Optimize infrastructure cost by combining high-speed RAM with cost-efficient Flash storage through Flex's automatic data tiering. Flex is **not** a durable data store. It is designed for performance, elasticity, and scalability, not for long-term data persistence. While Flex can temporarily retain data in memory or Flash, it should not be used as a primary system of record or persistent storage layer. @@ -44,7 +44,7 @@ For workloads that require durability and recovery across restarts or failures, After you select **Essentials**, the rest of the database details will appear. Select **Flex (RAM + SSD)** to use Flex. - {{The database name, cloud vendor, version, region, type, and durability settings.}} + {{The database name, cloud vendor, version, region, type, and durability settings.}} 1. Redis will generate a database name for you. If you want to change it, you can do so in the **Database name** field. @@ -103,7 +103,7 @@ In the **Advanced options** of the **Setup** tab, select **Redis Flex**. {{The Flex setting selected.}} -During the **Sizing** step, when you are provisioning your databases, you can select the RAM percentage for your database. The default is 20%, but you can select a percentage between 10% and 50%. Lower RAM percentages reduce cost but may increase latency, while higher RAM percentages improve throughput and latency at higher cost. +During the **Sizing** step, when you are provisioning your databases, you can select the RAM percentage for your database. The default is 20%, but you can select a percentage between 10% and 50%. Lower RAM percentages reduce cost but may increase latency, while higher RAM percentages improve throughput and latency at higher cost. {{The RAM percentage setting.}} diff --git a/content/operate/rc/databases/create-database/create-free-database.md b/content/operate/rc/databases/create-database/create-free-database.md index 6e253e9760..cfc05a3065 100644 --- a/content/operate/rc/databases/create-database/create-free-database.md +++ b/content/operate/rc/databases/create-database/create-free-database.md @@ -19,11 +19,11 @@ You can only have one free database per account. If you already have a free data {{< embed-md "rc-create-db-first-steps.md" >}} -3. Select the type of [subscription]({{< relref "/operate/rc/subscriptions" >}}) you need. For this guide, select **Free**. +3. Select the type of [subscription]({{< relref "/operate/rc/subscriptions" >}}) you need. For this guide, select **Try 30 MB for free**. {{The Subscription selection panel with Free selected.}} - After you select **Free**, the rest of the database settings will appear. + The rest of the database settings will appear. {{The database name, cloud vendor, and region settings.}} diff --git a/content/operate/rc/databases/delete-database.md b/content/operate/rc/databases/delete-database.md index 05a027fae1..52ca0f5992 100644 --- a/content/operate/rc/databases/delete-database.md +++ b/content/operate/rc/databases/delete-database.md @@ -10,41 +10,50 @@ linkTitle: Delete database weight: 45 --- -To delete a database, use the **Delete** button located in the **Danger zone** section of the database's **Configuration** tab. - Deleting a database requires the Account Owner role. Deleted databases cannot be recovered. We recommend [making a backup]({{< relref "/operate/rc/databases/back-up-data.md" >}}), just in case. -1. Sign in to the [Redis Cloud console](https://cloud.redis.io/). +Sign in to the [Redis Cloud console](https://cloud.redis.io/), then follow the steps for your plan to open the **Delete database** confirmation dialog. -1. Select the database from the list. The **Configuration** tab is selected by default. +{{< multitabs id="delete-database" + tab1="Essentials" + tab2="Pro" >}} - {{The Configuration tab of the Database details screen.}} +1. Select the database from the list to open the **Database** screen. -1. Scroll to the **Danger zone**. +1. Select **More actions** > **Delete database**. - {{The Danger Zone of the Database details screen.}} + The More actions menu on the database screen, with Delete database selected. -1. Select the **Delete** button. +-tab-sep- - {{The Delete button is located in the Danger zone section of the database Configuration tab.}} +1. Select the database from the list. The **Configuration** tab is selected by default. -1. The **Delete database** confirmation dialog appears. If this database is the only one in the subscription, you can also delete the subscription at this time. - - - Select **Delete my subscription and stop my payment** to delete both the database and the subscription. - - - Clear **Delete my subscription and stop my payment** to delete the database but keep the subscription. +1. Scroll to the **Danger zone**. - {{< note >}} -You will continue to be charged for your subscription until you delete it, even if there are no databases in your subscription. - {{< /note >}} + The Danger zone of the database details screen. + +1. Select the **Delete** button. + + The Delete button is located in the Danger zone section of the database Configuration tab. + +{{< /multitabs >}} - {{A delete database confirmation dialog asks you to consider deleting the subscription as well.}} +The **Delete database** confirmation dialog appears. If this database is the only one in the subscription, you can also delete the subscription at this time. + +- Select **Delete my subscription and stop my payment** to delete both the database and the subscription. + +- Clear **Delete my subscription and stop my payment** to delete the database but keep the subscription. + +{{< note >}} +You will continue to be charged for your subscription until you delete it, even if there are no databases in your subscription. +{{< /note >}} -1. Select **Delete database** to confirm your choice. +{{A delete database confirmation dialog asks you to consider deleting the subscription as well.}} - {{The Delete database button.}} +Select **Delete database** to confirm your choice. +{{The Delete database button.}} When the operation completes, the database and its data are deleted. diff --git a/content/operate/rc/databases/monitor-performance.md b/content/operate/rc/databases/monitor-performance.md index d4bb816dbb..8bb78fa4e2 100644 --- a/content/operate/rc/databases/monitor-performance.md +++ b/content/operate/rc/databases/monitor-performance.md @@ -81,7 +81,7 @@ For more detailed analysis, consider using [Redis Insight]({{< relref "/develop/ Depending on your subscription plan, you can enable alerts for several metrics for a given database. -To do so, go to the **Configuration** tab of the database and then locate the **Alerts** section. +To do so, locate the alerts settings for your database: for Essentials databases, select the **Alerts** tab on the database screen; for Pro databases, go to the **Configuration** tab and locate the **Alerts** section. | Setting name | Description | Default Value | Accepted Range | |---|---|---|---| diff --git a/content/operate/rc/databases/tag-database.md b/content/operate/rc/databases/tag-database.md index ba48aabcd0..c81d109fbc 100644 --- a/content/operate/rc/databases/tag-database.md +++ b/content/operate/rc/databases/tag-database.md @@ -23,7 +23,7 @@ After you open the [tag manager](#tag-manager), you can use it to add, edit, or ### Open tag manager from the Configuration tab {#configuration-tab} -To learn how to navigate to your database, see [View and edit databases]({{< relref "/operate/rc/databases/view-edit-database" >}}). Select the **Configuration** tab and go to the **General** section to view the tags that are set for your database. +To learn how to navigate to your database, see [View and edit databases]({{< relref "/operate/rc/databases/view-edit-database" >}}). Select the **Configuration** tab to view the tags that are set for your database. For Essentials databases, the **Manage tags** button is at the top of the tab; for Pro databases, go to the **General** section. {{The Configuration tab of the Database details screen.}} diff --git a/content/operate/rc/databases/view-edit-database.md b/content/operate/rc/databases/view-edit-database.md index aed1cc83b6..33a19d52f5 100644 --- a/content/operate/rc/databases/view-edit-database.md +++ b/content/operate/rc/databases/view-edit-database.md @@ -22,8 +22,6 @@ To view the details of a database: 4. Select the database name to open the **Database** page. - {{The Configuration tab of the Database details screen.}} - The **Database** screen lets you review: - Configuration details of a database - Graphs showing performance metrics @@ -35,44 +33,117 @@ For help changing database settings, see [Edit database details](#edit-database- The **Configuration** screen is divided into sections, each dedicated to a specific category. Note that not every section or setting is available to every [subscription plan]({{< relref "/operate/rc/subscriptions/" >}}). +The Configuration tab is organized differently for Essentials and Pro databases. Select your plan type below. + +{{< multitabs id="db-configuration-tab" + tab1="Essentials" + tab2="Pro" >}} + +### Performance & availability + +The **Performance & availability** section defines the plan and backup settings of your database. + +The Performance & availability section for an Essentials database. + +| Setting name | Editable | Description | +|---|---|---| +| **Plan** | ✅ Yes | The plan for your database.

Your Essentials plan determines the size of your database and other limits. For a comparison of available plans, see [Redis Cloud Essentials plans]({{< relref "/operate/rc/subscriptions/view-essentials-subscription/essentials-plan-details" >}}). | +| **High Availability** | ✅ Yes | Whether and how your data replicates across multiple nodes; see [available options]({{< relref "/operate/rc/databases/configuration/high-availability" >}}) | +| **Data persistence** | ✅ Yes | Defines whether (and how) data is saved to disk; see [available options]({{< relref "/operate/rc/databases/configuration/data-persistence" >}}) | +| **Remote backup** | ✅ Yes | When enabled, identifies a location and interval for [data backups]({{< relref "/operate/rc/databases/back-up-data" >}}). | +| **Data eviction policy** | ✅ Yes | Configures which [policy]({{< relref "/operate/rc/databases/configuration/data-eviction-policies" >}}) is applied when your database reaches its memory limit | + +### Access + +The **Access** section shows the connection information for your database. + +The Access section for an Essentials database. + +Here, you can: +- View the number of active connections to your database. +- View the Public endpoint of your database. +- Select **Connect** to [connect to your database]({{< relref "/operate/rc/databases/connect" >}}) + +### Data + +In the **Data** section, you can: + +The Data section for an Essentials database. + +- [Import data]({{< relref "/operate/rc/databases/import-data" >}}) into your database +- Open [Redis Insight]({{< relref "/operate/rc/databases/connect/insight-cloud" >}}) to explore your data. + +### Security + +The **Security** section helps you control access to your database. + +The Security section for an Essentials database. + +| Setting name | Editable | Description | +|---|---|---| +| **Default user** | ✅ Yes | When **On**, permits access using the `default` username with a simple password. Select **Configure** to turn off the default user or change the password. See [Default user]({{< relref "/operate/rc/security/access-control/data-access-control/default-user" >}}) for more information. | +| **CIDR allow list** | ✅ Yes | [Allow list]({{< relref "/operate/rc/security/cidr-whitelist.md" >}}) of IP addresses/security groups permitted to access the database. Select **Configure** to edit the CIDR allow list. | +| **Transport layer security (TLS)** | ✅ Yes | Select **Configure** to turn on [transport layer security]({{< relref "/operate/rc/security/database-security/tls-ssl.md" >}}) (TLS) encryption for database access. | + +### Database info + +The **Database info** section defines basic properties about your database. + +The Database info section for an Essentials database. + +| Setting name | Editable | Description | +|---|---|---| +| **Name** | ✅ Yes | The name given to your database | +| **ID** | ❌ No | The database's numeric ID | +| **Creation** | ❌ No | Date the database was created | +| **Last changed** | ❌ No | Date of last update | +| **Advanced Capabilities** | ❌ No | This setting appears when an [advanced capability]({{< relref "/operate/rc/databases/configuration/advanced-capabilities" >}}) is enabled for a database | +| **Architecture** | ❌ No | Shows whether the database runs in **RAM** or is a [**Flex**]({{< relref "/operate/rc/databases/create-database/create-flex-database" >}}) database | +| **Version** | ✅ Yes | The Redis version your database uses | +| **Protocol** | ✅ Yes | Shows which version of RESP the database uses. See [Redis serialization protocol]({{< relref "/develop/reference/protocol-spec" >}}#resp-versions) for details | + +-tab-sep- + ### General settings The **General** section defines basic properties about your database. -The available settings vary according to your plan, cloud provider, and design choices. For example, if you do not select an Advanced Capability when creating a database, the **Advanced Capabilities** setting is not displayed when you view its configuration details. - -| Setting name | Description | -|:--------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **Database Name** | The name given to your database | -| **Subscription Name** | The name for the subscription your database is a part of | -| **Public endpoint** | Public URI used by any application or client to access the database. Redis Cloud Pro databases can [block the public endpoint]({{< relref "/operate/rc/security/database-security/block-public-endpoints" >}}). | -| **Private endpoint** | Private endpoint URI available to approved clients; use CIDR allow list, VPC peering, or other connectivity options to enable access. (_Redis Cloud Pro only_) | -| **Tags** | A list of the [tags]({{< relref "/operate/rc/databases/tag-database" >}}) associated with the database. Select [Manage tags]({{< relref "/operate/rc/databases/tag-database#configuration-tab" >}}) to manage the database tags. | -| **Vendor** | The Cloud vendor hosting your database: AWS, Google Cloud, or Azure. | -| **Region** | The Cloud vendor region hosting your database | -| **Type** | Displays 'Redis', 'Redis Stack' or 'memcached' based on the value selected when the database was created | -| **Redis version** | Redis version of the database | -| **Auto Tiering** | Checked when the subscription supports Auto Tiering (_Redis Cloud Pro only_) | -| **Active-Active Redis** | Checked when the database is part of an [Active-Active]({{< relref "/operate/rc/databases/active-active" >}}) relationship (_Redis Cloud Pro only_) | -| **Creation time** | Date and time the database was created | -| **Last changed** | Date and time of last update | -| **Supported Protocol(s)** | Shows which version of RESP the database uses. See [Redis serialization protocol]({{< relref "/develop/reference/protocol-spec" >}}#resp-versions) for details | -| **Advanced Capabilities** | This setting appears when an [advanced capability]({{< relref "/operate/rc/databases/configuration/advanced-capabilities" >}}) is enabled for a database | +The Configuration tab of the Database details screen. + +The available settings vary according to your cloud provider and design choices. + +| Setting name | Editable | Description | +|:--------------------------|:---------|:------------| +| **Database Name** | ✅ Yes | The name given to your database | +| **Subscription Name** | ❌ No | The name for the subscription your database is a part of | +| **Public endpoint** | ❌ No | Public URI used by any application or client to access the database. You can [block the public endpoint]({{< relref "/operate/rc/security/database-security/block-public-endpoints" >}}). | +| **Private endpoint** | ❌ No | Private endpoint URI available to approved clients; use CIDR allow list, VPC peering, or other connectivity options to enable access. | +| **Tags** | ✅ Yes | A list of the [tags]({{< relref "/operate/rc/databases/tag-database" >}}) associated with the database. Select [Manage tags]({{< relref "/operate/rc/databases/tag-database#configuration-tab" >}}) to manage the database tags. | +| **Vendor** | ❌ No | The Cloud vendor hosting your database: AWS, Google Cloud, or Azure. | +| **Region** | ❌ No | The Cloud vendor region hosting your database | +| **Type** | ❌ No | Displays 'Redis', 'Redis Stack' or 'memcached' based on the value selected when the database was created | +| **Redis version** | ❌ No | Redis version of the database | +| **Auto Tiering** | ❌ No | Checked when the subscription supports Auto Tiering | +| **Active-Active Redis** | ❌ No | Checked when the database is part of an [Active-Active]({{< relref "/operate/rc/databases/active-active" >}}) relationship | +| **Creation time** | ❌ No | Date and time the database was created | +| **Last changed** | ❌ No | Date and time of last update | +| **Supported Protocol(s)** | ✅ Yes | Shows which version of RESP the database uses. See [Redis serialization protocol]({{< relref "/develop/reference/protocol-spec" >}}#resp-versions) for details | +| **Advanced Capabilities** | ❌ No | This setting appears when an [advanced capability]({{< relref "/operate/rc/databases/configuration/advanced-capabilities" >}}) is enabled for a database | ### Performance section The **Performance** section describes the memory size, throughput, and hashing policy for a database. -{{Use the Performance section to control the size, throughput, and hashing policy for a database.}} +Use the Performance section to control the size, throughput, and hashing policy for a database. -| Setting name |Description| -|:----------------------|:----------| -| **Dataset size** | Maximum size (in GB) for your dataset. See [Dataset size]({{< relref "/operate/rc/databases/configuration/sizing#dataset-size" >}}). | -| **Throughput** | Defines [throughput]({{< relref "/operate/rc/databases/configuration/sizing#throughput" >}}) in terms of maximum operations per second for the database (_Redis Cloud Pro only_). | -| **Memory used** | Memory currently used for your 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" >}}) (_Redis Cloud Pro only_). | -| **OSS Cluster API** | Enables the [Cluster API]({{< relref "/operate/rc/databases/configuration/clustering#oss-cluster-api" >}}) for a database (_Redis Cloud Pro only_).

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

When this option is enabled, you cannot define a custom hashing policy.| To learn more about these settings and when to use them, see [Sizing]({{< relref "/operate/rc/databases/configuration/sizing" >}}) and [Database clustering]({{< relref "/operate/rc/databases/configuration/clustering" >}}). @@ -80,34 +151,34 @@ To learn more about these settings and when to use them, see [Sizing]({{< relref The Durability section helps protect your data when problems occur. These settings define replication, persistence, backup, and eviction policies. -{{Use the Durability section to protect your data from unexpected problems.}} +Use the Durability section to protect your data from unexpected problems. -| Setting name | Description | -|:-------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **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_) | -| **Active-Passive Redis** | When enabled, identifies a path to the [linked database]({{< relref "/operate/rc/databases/migrate-databases#sync-using-active-passive" >}}). (_Redis Cloud Pro only_) | +| Setting name | Editable | Description | +|:-------------------------|:---------|:------------| +| **Data persistence** | ✅ Yes | Defines whether (and how) data is saved to disk; see [available options]({{< relref "/operate/rc/databases/configuration/data-persistence" >}}) | +| **Data eviction policy** | ✅ Yes | Configures which [policy]({{< relref "/operate/rc/databases/configuration/data-eviction-policies" >}}) is applied when your database reaches its memory limit | +| **Remote backup** | ✅ Yes | When enabled, identifies a location and interval for [data backups]({{< relref "/operate/rc/databases/back-up-data" >}}). | +| **Active-Passive Redis** | ✅ Yes | When enabled, identifies a path to the [linked database]({{< relref "/operate/rc/databases/migrate-databases#sync-using-active-passive" >}}). | ### Security section The **Security** section helps you control access to your database. -{{Use the Security settings to control access to your database.}} +Use the Security settings to control access to your database. -|Setting name| Description | -|:-----------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **Default user** | When enabled, permits access using a simple password | -| **Default user password** | Password for default user. A default password is assigned to the database on creation and may be updated. If you [block the public endpoint]({{< relref "/operate/rc/security/database-security/block-public-endpoints" >}}), you can also turn on passwordless authentication for the default user here. | -| **CIDR allow list** | [Allow list]({{< relref "/operate/rc/security/cidr-whitelist.md" >}}) of IP addresses/security groups permitted to access the database. (_Paid plans only_) | -| **Transport layer security (TLS)** | Enables [transport layer security]({{< relref "/operate/rc/security/database-security/tls-ssl.md" >}}) (TLS) encryption for database access. (_Pro plans only_) | +|Setting name| Editable | Description | +|:-----------|:---------|:------------| +| **Default user** | ✅ Yes | When enabled, permits access using a simple password | +| **Default user password** | ✅ Yes | Password for default user. A default password is assigned to the database on creation and may be updated. If you [block the public endpoint]({{< relref "/operate/rc/security/database-security/block-public-endpoints" >}}), you can also turn on passwordless authentication for the default user here. | +| **CIDR allow list** | ✅ Yes | [Allow list]({{< relref "/operate/rc/security/cidr-whitelist.md" >}}) of IP addresses/security groups permitted to access the database. | +| **Transport layer security (TLS)** | ✅ Yes | Enables [transport layer security]({{< relref "/operate/rc/security/database-security/tls-ssl.md" >}}) (TLS) encryption for database access. | ### Alerts section The **Alerts** section defines notification emails sent to your account and the conditions that trigger them. -{{The Alerts section defines the notification emails and their triggering conditions.}} +The Alerts section defines the notification emails and their triggering conditions. The available alerts vary according to the plan type. See [Configure alerts]({{< relref "/operate/rc/databases/monitor-performance#configure-metric-alerts" >}}) for more information. @@ -115,7 +186,7 @@ The available alerts vary according to the plan type. See [Configure alerts]({{< Actions in the **Danger Zone** are permanent and should not be taken lightly. -{{The Danger Zone includes activities that impact data, such as deleting a database. Use with care.}} +The Danger Zone includes activities that impact data, such as deleting a database. Use with care. Here, you can: @@ -124,6 +195,8 @@ Here, you can: For best results, we recommend [backing up data]({{< relref "/operate/rc/databases/back-up-data" >}}) before any danger zone actions. +{{< /multitabs >}} + ## Other actions and info The **View Database** screen also has tabs that let you view: @@ -132,40 +205,38 @@ The **View Database** screen also has tabs that let you view: - **Slowlog**: a log showing recent [slow queries]({{< relref "/commands/slowlog" >}}) run against your database. The log displays when the action started, the duration, the complexity of the operation, and any parameters passed to the operation. +- **Alerts** (_Essentials databases only_): the notification emails sent to your account and the conditions that trigger them. See [Configure alerts]({{< relref "/operate/rc/databases/monitor-performance#configure-metric-alerts" >}}) for more information. + ## Edit database details +Editing your database depends on your plan type. Select your plan type to learn more. + +{{< multitabs id="db-edit-details" + tab1="Essentials" + tab2="Pro" >}} + +You can make direct changes to your database on the database page. Any changes you make won't be saved until you review and confirm them. + +After you've made changes to your database, select **Review changes** to review your changes. If your changes result in any cost changes, you'll see the cost change there. + +The Review changes button lets you review your changes and save them. + +From there, select **Confirm** or **Confirm & pay** to save your changes. + +-tab-sep- + Use the **Edit** button to edit database details. -{{The Edit button lets you change selected database properties.}} - -Because databases exist within the context of a deployment, certain fields cannot be updated, especially those that might lead to data loss. - -Here's what you can change: - -| Section | Setting | Comments | -|:-----------|:-------------------------------|:---------| -| General | Database name || -| | Supported protocol(s) || -| | Tags || -| Performance | Dataset size | | -| | High-availability | _Paid plans only_ | -| | Throughput | _Pro plans only_ | -| | Hashing policy | _Pro plans only_ | -| | OSS Cluster API | _Pro plans only_ | -| Durability | Data persistence | _Paid plans only_ | -| | Data eviction policy | | -| | Remote backup | _Paid plans only_ | -| | Active-Passive Redis | _Pro plans only_ | -| Security | Default user | | -| | Default user password | -| | CIDR allow list | _Paid plans only_ | -| | Transport layer security (TLS) | _Pro plans only_ | -| Alerts | all available for plan type | +The Edit button lets you change selected database properties. Choose **Save database** to save your changes. -{{Use the Save database button to save database changes.}} +Use the Save database button to save database changes. + +{{< /multitabs >}} + +Because databases exist within the context of a deployment, certain fields cannot be updated, especially those that might lead to data loss. Refer to the tables in the previous sections for your plan to learn which settings are editable. If you need to change other details, create a new database and then migrate existing data. diff --git a/content/operate/rc/rc-quickstart.md b/content/operate/rc/rc-quickstart.md index d2083181de..d5b07db5e6 100644 --- a/content/operate/rc/rc-quickstart.md +++ b/content/operate/rc/rc-quickstart.md @@ -73,9 +73,9 @@ If you want to create a different type of database, see the following guides: At this point, you're viewing the **Configuration** details for your new database. Go to the **Security** section of the page. -To connect to your database, you need your username and password. Each database is protected by a **Default user** called `default` and a masked **Default user password**. Select the eye icon to show or hide the password. +To connect to your database, you need your username and password. Each database is protected by a **Default user** called `default` and a masked **Default user password**. Select **Default user > Configure** and then select the eye icon to view your password. -{{The Security section of the Configuration tab of the database details page.}} +{{The Security section of the Configuration tab of the database details page.}} Once you have the username and password, select **Connect** to open the connection wizard. diff --git a/content/operate/rc/security/access-control/data-access-control/default-user.md b/content/operate/rc/security/access-control/data-access-control/default-user.md index a3af5532d8..9bf32fa1da 100644 --- a/content/operate/rc/security/access-control/data-access-control/default-user.md +++ b/content/operate/rc/security/access-control/data-access-control/default-user.md @@ -13,9 +13,7 @@ weight: 5 Password-based authentication is a basic but essential Redis security feature. When you create a Redis Cloud database, your database is given a randomly generated password called the **Default user password**. -This password appears in the **Security** section of the **Configuration** tab of the database details screen. - -{{The Default user password appears in the Security section of the Configuration tab on the database details screen.}} +This password appears in the **Security** section of the **Configuration** tab of the database details screen for Pro databases. For Essentials databases, go to **Security > Default user** and select **Configure** to view the default user password. Use the copy button to copy the password to the clipboard: @@ -29,30 +27,58 @@ See your [Redis client's documentation]({{< relref "/develop/clients" >}}) to le ## Change password -To change the default user password for your database: +How you change the default user password depends on your plan. + +{{< multitabs id="change-default-user-password" + tab1="Essentials" + tab2="Pro" >}} + +1. In the **Security** section of the **Configuration** tab, select **Configure** for the default user. + +1. Enter the new password. Database passwords must be less than 50 characters long. + +1. Select **OK** to save your changes. + +-tab-sep- 1. From the database **Configuration** tab, select **Edit**. - {{The Edit button lets you change the database's default user password.}} + The Edit button lets you change the database's default user password. 1. Under the **Security** section, enter the new password in the **Default user password** field. Database passwords must be less than 50 characters long. 1. Select **Save database** to update the password. - {{Use the Save database button to save the new password.}} + Use the Save database button to save the new password. + +{{< /multitabs >}} ## Turn off default user After you set up [role-based access control]({{< relref "/operate/rc/security/access-control/data-access-control/role-based-access-control" >}}) to limit who can access your database, we recommend that you turn off default user access. -To turn off the default user for a database: +How you turn off the default user depends on your plan. + +{{< multitabs id="turn-off-default-user" + tab1="Essentials" + tab2="Pro" >}} + +1. In the **Security** section of the **Configuration** tab, select **Configure** for the default user. + +1. Turn off the **Default user** switch. + +1. Select **OK** to save your changes. + +-tab-sep- 1. From the database **Configuration** tab, select **Edit**. - {{The Edit database button lets you change the database's default user password.}} + The Edit database button lets you change the database's default user password. 1. Under the **Security** section, select the **Default User** switch to turn it off. 1. Select **Save database**. - {{Use the Save database button to save the new password.}} \ No newline at end of file + Use the Save database button to save your changes. + +{{< /multitabs >}} \ No newline at end of file diff --git a/static/images/rc/create-database-essentials-cloud-vendor.png b/static/images/rc/create-database-essentials-cloud-vendor.png index d22cdd8e18..9a20b4a87f 100644 Binary files a/static/images/rc/create-database-essentials-cloud-vendor.png and b/static/images/rc/create-database-essentials-cloud-vendor.png differ diff --git a/static/images/rc/create-database-subscription-essentials.png b/static/images/rc/create-database-subscription-essentials.png index 89eec6cf37..7c6e8ddaec 100644 Binary files a/static/images/rc/create-database-subscription-essentials.png and b/static/images/rc/create-database-subscription-essentials.png differ diff --git a/static/images/rc/create-database-subscription-free.png b/static/images/rc/create-database-subscription-free.png index bb56749679..58ab7cdc00 100644 Binary files a/static/images/rc/create-database-subscription-free.png and b/static/images/rc/create-database-subscription-free.png differ diff --git a/static/images/rc/create-database-subscription-pro-new.png b/static/images/rc/create-database-subscription-pro-new.png index 2ec77d248c..f71eb762c2 100644 Binary files a/static/images/rc/create-database-subscription-pro-new.png and b/static/images/rc/create-database-subscription-pro-new.png differ diff --git a/static/images/rc/database-details-configuration-tab-access-essentials.png b/static/images/rc/database-details-configuration-tab-access-essentials.png new file mode 100644 index 0000000000..568d15f527 Binary files /dev/null and b/static/images/rc/database-details-configuration-tab-access-essentials.png differ diff --git a/static/images/rc/database-details-configuration-tab-data-essentials.png b/static/images/rc/database-details-configuration-tab-data-essentials.png new file mode 100644 index 0000000000..cbe1fb5b40 Binary files /dev/null and b/static/images/rc/database-details-configuration-tab-data-essentials.png differ diff --git a/static/images/rc/database-details-configuration-tab-database-info-essentials.png b/static/images/rc/database-details-configuration-tab-database-info-essentials.png new file mode 100644 index 0000000000..cbe4cb5c6b Binary files /dev/null and b/static/images/rc/database-details-configuration-tab-database-info-essentials.png differ diff --git a/static/images/rc/database-details-configuration-tab-performance-availability-essentials.png b/static/images/rc/database-details-configuration-tab-performance-availability-essentials.png new file mode 100644 index 0000000000..4a48c53e08 Binary files /dev/null and b/static/images/rc/database-details-configuration-tab-performance-availability-essentials.png differ diff --git a/static/images/rc/database-details-configuration-tab-security-essentials.png b/static/images/rc/database-details-configuration-tab-security-essentials.png new file mode 100644 index 0000000000..5f98c13820 Binary files /dev/null and b/static/images/rc/database-details-configuration-tab-security-essentials.png differ diff --git a/static/images/rc/database-essentials-default-user.png b/static/images/rc/database-essentials-default-user.png new file mode 100644 index 0000000000..d4764d6cf5 Binary files /dev/null and b/static/images/rc/database-essentials-default-user.png differ diff --git a/static/images/rc/database-essentials-review-changes.png b/static/images/rc/database-essentials-review-changes.png new file mode 100644 index 0000000000..240506a86f Binary files /dev/null and b/static/images/rc/database-essentials-review-changes.png differ diff --git a/static/images/rc/database-more-actions-delete-essentials.png b/static/images/rc/database-more-actions-delete-essentials.png new file mode 100644 index 0000000000..eb2abb344c Binary files /dev/null and b/static/images/rc/database-more-actions-delete-essentials.png differ diff --git a/static/images/rc/subscription-new-fixed-tiers.png b/static/images/rc/subscription-new-fixed-tiers.png index 1b56fd1826..ec477dd2c1 100644 Binary files a/static/images/rc/subscription-new-fixed-tiers.png and b/static/images/rc/subscription-new-fixed-tiers.png differ diff --git a/static/images/rc/subscription-new-flex-tiers.png b/static/images/rc/subscription-new-flex-tiers.png index 9336b48ca9..aa110e1d7f 100644 Binary files a/static/images/rc/subscription-new-flex-tiers.png and b/static/images/rc/subscription-new-flex-tiers.png differ