Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

RC: New Packaging Documentation updates #3222

Merged
merged 23 commits into from
Mar 28, 2024
Merged
Show file tree
Hide file tree
Changes from 18 commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
798e26e
Fixed on GCP changes
cmilesb Mar 11, 2024
a66efcc
Changed Fixed and Flexible to Essentials and Pro except where already…
cmilesb Mar 14, 2024
b82bb37
Merge branch 'DOC-3251' into rc-packaging
cmilesb Mar 14, 2024
9d12de0
marketplace integrations
cmilesb Mar 14, 2024
af29351
Merge branch 'master' into rc-packaging
cmilesb Mar 14, 2024
4cf065b
RC Packaging: Quick Start (#3201)
cmilesb Mar 20, 2024
c329d86
RC Packaging: Split create databases into 3 and implement Essentials …
cmilesb Mar 21, 2024
8eafe47
RC Packaging: View and Edit databases (#3204)
cmilesb Mar 21, 2024
0737dbe
Merge branch 'master' into rc-packaging
cmilesb Mar 21, 2024
52abcca
Merge branch 'master' into rc-packaging
cmilesb Mar 25, 2024
fb3eea7
fix build error
cmilesb Mar 25, 2024
fe8ff33
Fix small image
cmilesb Mar 25, 2024
1e93df0
RC New packaging: Create Pro databases (#3219)
cmilesb Mar 26, 2024
4447863
RC New Packaging: Remove Create Subscription pages (#3211)
cmilesb Mar 26, 2024
9631668
RC New Packaging: Create Active-Active database (#3217)
cmilesb Mar 26, 2024
49e2d2b
Fix image size
cmilesb Mar 26, 2024
2b9ccb4
Remove old logo link
cmilesb Mar 26, 2024
2d6384d
image fixes
cmilesb Mar 26, 2024
abe8e3a
Update content/rc/cloud-integrations/aws-marketplace/aws-bedrock/set-…
cmilesb Mar 27, 2024
59aa26c
Update content/rc/subscriptions/view-essentials-subscription/essentia…
cmilesb Mar 27, 2024
6a91208
Merge branch 'master' into rc-packaging
cmilesb Mar 27, 2024
1271377
RC: Throughput moving to ops/sec for search & query changelog updates…
cmilesb Mar 28, 2024
1762fbe
Merge branch 'master' into rc-packaging
cmilesb Mar 28, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 0 additions & 12 deletions content/embeds/create-subscription-next-steps.md

This file was deleted.

22 changes: 22 additions & 0 deletions content/embeds/rc-create-db-first-steps.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
Before creating a Redis Cloud database, you need to [create an account]({{< relref "rc/rc-quickstart.md" >}}).

To create a database in your Redis Cloud account:

1. Sign in to the [Redis Cloud console](https://app.redislabs.com).

2. Select the **New database** button.

{{<image filename="images/rc/button-database-new.png" alt="The New Database button creates a new database." width="120px">}}{{< /image >}}

This displays the **Create database** screen.

3. Select your Redis use case. There are four pre-defined use cases:

{{<image filename="images/rc/create-database-redis-use-cases.png" alt="The Redis Use case panel">}}{{< /image >}}

- **Cache**: Stores short-term or volatile data. Can be used for session management, semantic cache, session store, and other uses where data is short-lived.
- **Database**: Stores durable and consistent data. Can be used for document databases, feature storage, gaming leaderboards, durable caches, and other uses where your data needs to be highly available and persistent.
- **Vector search**: Manages and manipulates vector data. Can be used for Generative AI, recommendation systems, visual search, and other uses where you can search and query your data.
- **Custom**: If your Redis use case doesn't match any of the other use cases, you can choose this option to customize all of your settings.

Select the use case that best matches your Redis use case. You can always change the settings later. See [Use case settings](#use-case-settings) to view the settings for each use case.
2 changes: 1 addition & 1 deletion content/embeds/rc-fixed-upgrade-limitation.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
As of January 2024, new and upgraded Fixed subscriptions are limited to one database per subscription. If you have a Fixed subscription created before January 2024, you can add databases up to the previous plan limit. If you choose to upgrade your plan, you can keep your databases, but you will need to create a new subscription to add another database.
As of January 2024, new and upgraded Redis Cloud Essentials subscriptions are limited to one database per subscription. If you have a Redis Cloud Essentials subscription created before January 2024, you can add databases up to the previous plan limit. If you choose to upgrade your plan, you can keep your databases, but you will need to create a new subscription to add another database.
29 changes: 29 additions & 0 deletions content/embeds/rc-pro-use-cases-billing-units.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
## Use case settings

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 |

## Billing Unit types

The Redis Billing Unit types associated with your Pro subscription depend on your database memory size and throughput requirements.

| Shard type | Capacity (Memory/Throughput) |
|:------------|:----------|
| Micro | 1GB / 1K ops/sec |
| High-throughput | 2.5GB / 25K ops/sec |
| Small | 12.5GB / 12.5K ops/sec |
| Large | 25GB / 25K ops/sec |
| Very large<sup>[1](#table-note-1)</sup> | 50GB / 5K ops/sec |
| XLarge<sup>[2](#table-note-2)</sup> | 50GB / 10K ops/sec |

1. <a name="table-note-1" style="display: block; height: 80px; margin-top: -80px;"></a>Used for databases with Auto Tiering before Redis 7.2.

2. <a name="table-note-2" style="display: block; height: 80px; margin-top: -80px;"></a>Used for hosted databases with Auto Tiering for Redis 7.2 and later.

Prices vary according to the cloud provider and region. Minimum prices apply. To learn more, see [Cloud pricing](https://redis.com/redis-enterprise-cloud/pricing/).
22 changes: 11 additions & 11 deletions content/embeds/rc-tags-tag-module.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
Here, you can:
You can select the tag's **Key** and **Value** from the suggestions, or you can enter your own.

- Select **Add tag** to add a tag.
{{<image filename="images/rc/tags-new-tag.png" alt="The New tag fields." >}}{{< /image >}}

{{<image filename="images/rc/tags-button-add-tag.png" alt="The Add tag button." width=100px >}}{{< /image >}}
A valid tag must follow these guidelines:
- Tag keys must be between 2 and 64 characters long, and values must be at least 2 characters long.
- Tags can only have lowercase letters, numbers, spaces, and these special characters: `-`, `_`, `.`, `+`, `@`, and `:`.

{{<image filename="images/rc/tags-new-tag.png" alt="The New tag fields." >}}{{< /image >}}

You can select the tag's **Key** and **Value** from the suggestions, or you can enter your own.

A valid tag must follow these guidelines:
- Tag keys must be between 2 and 64 characters long, and values must be at least 2 characters long.
- Tags can only have lowercase letters, numbers, spaces, and these special characters: `-`, `_`, `.`, `+`, `@`, and `:`.
After you add your first tag, you can:

- Select the **Key** or **Value** field of an existing tag and enter new text to edit it.

- Select **Delete** next to a tag to delete it.

{{<image filename="images/rc/tags-icon-delete.png" alt="Delete button." >}}{{< /image >}}
{{<image filename="images/rc/tags-icon-delete.png" alt="Delete button." >}}{{< /image >}}

- Select **Add additional tag** to add another tag.

{{<image filename="images/rc/tags-button-add-additional-tag.png" alt="The Add additional tag button." width="200px" >}}{{< /image >}}
21 changes: 11 additions & 10 deletions content/rc/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,24 +34,25 @@ Use the [Quick start]({{<relref "/rc/rc-quickstart">}}) to create a free subscri
- [Connect with Redis client]({{<relref "/rc/rc-quickstart#using-redis-client">}})
- [Connect with RedisInsight]({{<relref "/rc/rc-quickstart#using-redisinsight">}})

## Databases
Create and manage [Redis databases]({{<relref "/rc/databases">}}) in the cloud.
- [Create database]({{<relref "/rc/databases/create-database">}})
- [View and edit databases]({{<relref "/rc/databases/view-edit-database">}})
- [Monitor performance]({{<relref "/rc/databases/monitor-performance">}})
- [Manage databases]({{<relref "/rc/databases/configuration">}})
- [Redis commands](https://redis.io/commands/) & [compatibility]({{<relref "/rc/compatibility">}})

## Subscriptions
Learn about the [types of subscriptions]({{<relref "/rc/subscriptions">}}).
- [Create a fixed subscription]({{<relref "/rc/subscriptions/create-fixed-subscription">}})
- [Create a flexible subscription]({{<relref "/rc/subscriptions/create-flexible-subscription">}})
- [View and upgrade Essentials plan]({{<relref "/rc/subscriptions/view-essentials-subscription">}})
- [Essentials plans]({{<relref "/rc/subscriptions/view-essentials-subscription/essentials-plan-details">}})
- [View and edit Pro plan]({{<relref "/rc/subscriptions/view-pro-subscription">}})

## Accounts & settings
Manage Redis Cloud [accounts and settings]({{<relref "/rc/accounts">}}).
- [Billing and payments]({{<relref "/rc/billing-and-payments">}})
- [Manage cloud integrations]({{<relref "/rc/cloud-integrations">}})

## Databases
Create and manage [Redis databases]({{<relref "/rc/databases">}}) in the cloud.
- [Create database]({{<relref "/rc/databases/create-database">}})
- [View and edit databases]({{<relref "/rc/databases/view-edit-database">}})
- [Monitor performance]({{<relref "/rc/databases/monitor-performance">}})
- [Manage databases]({{<relref "/rc/databases/configuration">}})
- [Redis commands](https://redis.io/commands/) & [compatibility]({{<relref "/rs/references/compatibility">}})

## Security
Manage [secure connections]({{<relref "/rc/security">}}) to cloud databases.
- [Access management]({{<relref "/rc/security/access-control/access-management">}}) for admin console security and account management
Expand Down
2 changes: 1 addition & 1 deletion content/rc/accounts/account-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The available tabs depend on your subscription type and may include:

- The **Account** tab displays basic information associated with your account, including general info, address details, time zone setting, security settings, and provider integration details.

- The **Cloud Account** tab is displayed for Flexible (or Annual) subscriptions hosted on Amazon Web Services (AWS). To learn more, see [Manage AWS cloud accounts]({{<relref "rc/cloud-integrations/aws-cloud-accounts/">}}).
- The **Cloud Account** tab is displayed for Redis Cloud Pro subscriptions hosted on Amazon Web Services (AWS). To learn more, see [Manage AWS cloud accounts]({{<relref "rc/cloud-integrations/aws-cloud-accounts/">}}).

- The **Integrations** tab lets you manage certain integrations. For more information on the Confluent Cloud integration, see [Use the Redis Sink Confluent Connector]({{<relref "rc/cloud-integrations/aws-cloud-accounts/">}}).

Expand Down
2 changes: 1 addition & 1 deletion content/rc/api/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ You can use the API to:

1. [Manage subscriptions]({{< relref "/rc/api/examples/manage-subscriptions.md" >}})
1. Database examples
1. [Create database]({{< relref "/rc/api/examples/create-database.md" >}})
1. [Create database]({{< relref "/rc/api/examples/create-database" >}})
1. [Update database]({{< relref "/rc/api/examples/update-database.md" >}})
1. [Back up and import data]({{< relref "/rc/api/examples/back-up-and-import-data.md" >}})
1. [Manage cloud accounts]({{< relref "/rc/api/examples/manage-cloud-accounts.md" >}})
Expand Down
2 changes: 1 addition & 1 deletion content/rc/api/examples/back-up-and-import-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ aliases: /rv/api/how-to/backup-and-import-databases/

## Back up a database

When you create or update a database in a Flexible or Annual account, you can specify the (optional) `periodicBackupPath` parameter
When you create or update a database, you can specify the (optional) `periodicBackupPath` parameter
with a [backup path]({{<relref "/rc/databases/back-up-data">}}).
This parameter enables periodic and on-demand backup operations for the specified database.

Expand Down
2 changes: 1 addition & 1 deletion content/rc/api/examples/create-database.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ aliases: /rv/api/how-to/create-and-manage-databases/

You can use the Redis Cloud REST API to create databases.

These examples use the [`cURL` utility]({{< relref "/rc/api/get-started/use-rest-api#use-the-curl-http-client" >}}). You can use any REST client to work with the Redis Cloud REST API. The examples in this article refer to databases that are part of Flexible subscriptions.
These examples use the [`cURL` utility]({{< relref "/rc/api/get-started/use-rest-api#use-the-curl-http-client" >}}). You can use any REST client to work with the Redis Cloud REST API. The examples in this article refer to Redis Cloud Pro databases.

## Create a database

Expand Down
2 changes: 1 addition & 1 deletion content/rc/api/examples/manage-subscriptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ aliases: /rv/api/how-to/create-and-manage-subscriptions/
/rc/api/examples/manage-subscriptions.md
---

The Redis Cloud REST API lets you create and manage all kinds of subscriptions. The examples in this article refer to Flexible subscriptions.
The Redis Cloud REST API lets you create and manage all kinds of subscriptions. The examples in this article refer to Redis Cloud Pro subscriptions.

## Create a subscription

Expand Down
2 changes: 1 addition & 1 deletion content/rc/api/examples/update-database.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ aliases: /rv/api/how-to/update-databases/

The API operation that updates an existing database is: `PUT /subscriptions/{subscription-id}/databases/{database-id}`

This API operation uses the same [provisioning lifecycle]({{< relref "/rc/api/get-started/process-lifecycle.md" >}}) as the [create database]({{< relref "/rc/api/examples/create-database.md" >}}) operation. The examples in this article refer to databases that are part of Flexible subscriptions.
This API operation uses the same [provisioning lifecycle]({{< relref "/rc/api/get-started/process-lifecycle.md" >}}) as the [create database]({{< relref "/rc/api/examples/create-database" >}}) operation. The examples in this article refer to Redis Cloud Pro databases.

## Database update request JSON body

Expand Down
4 changes: 2 additions & 2 deletions content/rc/api/get-started/enable-the-api.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
Title: Enable the API
description: Use the Redis Cloud dashboard to enable the REST API. (Requires a Flexible or Fixed account.)
description: Use the Redis Cloud dashboard to enable the REST API.
weight: 10
alwaysopen: false
categories: ["RC"]
Expand All @@ -14,7 +14,7 @@ aliases: /rv/api/how-to/enable-your-account-to-use-api/

---

If you have a Flexible (or Annual) Redis Cloud subscription, you can use a REST API to manage your subscription programmatically.
If you have a Redis Cloud subscription, you can use a REST API to manage your subscription programmatically.

For security reasons, the Redis Cloud API is disabled by default.

Expand Down
2 changes: 1 addition & 1 deletion content/rc/api/how-to/metrics-and-performance-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ You can get metrics and usage statistics for a database from the API operation:

`GET /subscriptions/{subscription-id}/databases/{database-id}/metrics?metricSpan={metric-span}`.

The metrics API is supported for Flexible and Annual subscriptions.
The metrics API is supported for Redis Cloud Pro subscriptions.

The query accepts 3 parameters:

Expand Down
6 changes: 3 additions & 3 deletions content/rc/changelog/august-2023.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This changelog lists new features, enhancements, and other changes added to Redi

### Redis 7.2 flexible opt-in

You can opt in to Redis 7.2 on [Flexible subscriptions]({{<relref "/rc/subscriptions/create-flexible-subscription">}}). Redis 7.2 introduces several changes to existing Redis commands; see the [list of breaking changes]({{<relref "/rc/changelog/june-2023#redis-72-breaking-changes">}}) published in June's changelog for more details.
You can opt in to Redis 7.2 on [Flexible subscriptions]({{<relref "/rc/databases/create-database/create-pro-database-new">}}). Redis 7.2 introduces several changes to existing Redis commands; see the [list of breaking changes]({{<relref "/rc/changelog/june-2023#redis-72-breaking-changes">}}) published in June's changelog for more details.

### Triggers and functions preview

Expand All @@ -24,9 +24,9 @@ A preview of [triggers and functions]({{<relref "/stack/triggers-functions">}})
- AWS Asia Pacific - Singapore (`ap-southeast-1`)
- GCP Asia Pacific - Tokyo (`asia-northeast1`)

To use it, [create a fixed subscription]({{<relref "/rc/subscriptions/create-fixed-subscription">}}) in one of these regions. Then, [create your database]({{<relref "/rc/databases/create-database">}}) and set the database Type to Redis and select Triggers and Functions in the drop-down. Or, set the database Type to Redis Stack to get all of our advanced capabilities.
To use it, [create a fixed subscription]({{<relref "/rc/databases/create-database/create-essentials-database">}}) in one of these regions. Then, [create your database]({{<relref "/rc/databases/create-database">}}) and set the database Type to Redis and select Triggers and Functions in the drop-down. Or, set the database Type to Redis Stack to get all of our advanced capabilities.

If you'd like to use triggers and functions with a [Flexible subscription]({{<relref "/rc/subscriptions/create-flexible-subscription">}}), contact [support](https://redis.com/company/support/).
If you'd like to use triggers and functions with a [Flexible subscription]({{<relref "/rc/databases/create-database/create-pro-database-new">}}), contact [support](https://redis.com/company/support/).

For more information about triggers and functions, see the [triggers and functions documentation](https://redis.io/docs/interact/programmability/triggers-and-functions).

Expand Down
4 changes: 2 additions & 2 deletions content/rc/changelog/december-2023.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ aliases: []

### Active-Active JSON support

[Active-Active databases]({{<relref "rc/databases/active-active-redis">}}) on Redis Cloud now support the [JSON]({{< relref "/stack/json" >}}) data type.
[Active-Active databases]({{<relref "rc/databases/configuration/active-active-redis">}}) on Redis Cloud now support the [JSON]({{< relref "/stack/json" >}}) data type.

See [Create an Active-Active subscription]({{<relref "rc/subscriptions/create-active-active-subscription">}}) to learn how to create an Active-Active subscription.
See [Create an Active-Active subscription]({{<relref "/rc/databases/create-database/create-active-active-database">}}) to learn how to create an Active-Active subscription.

### Mutual TLS enhancements

Expand Down
2 changes: 1 addition & 1 deletion content/rc/changelog/february-2024.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,5 @@ The Redis Cloud console will now notify you through email and on the application

### CIDR overlap detection

When you [create a new Flexible subscription]({{<relref "/rc/subscriptions/create-flexible-subscription">}}), the Redis Cloud console will now detect if the Classless Inter-Domain Routing (CIDR) subnet range you specify is in use by another Flexible subscription on the same account. This will allow you to address and resolve CIDR conflicts in your Redis deployment.
When you [create a new Flexible subscription]({{<relref "/rc/databases/create-database/create-pro-database-new">}}), the Redis Cloud console will now detect if the Classless Inter-Domain Routing (CIDR) subnet range you specify is in use by another Flexible subscription on the same account. This will allow you to address and resolve CIDR conflicts in your Redis deployment.

2 changes: 1 addition & 1 deletion content/rc/changelog/january-2023.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,6 @@ This changelog lists new features, enhancements, and other changes added to Redi

- Add users with first name and last name

- Select multiple [availability zones]({{<relref "/rc/subscriptions/create-flexible-subscription#availability-zones">}})
- Select multiple [availability zones]({{<relref "/rc/databases/configuration/high-availability#availability-zones">}})

- Additional enhancements
2 changes: 1 addition & 1 deletion content/rc/changelog/june-2023.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This changelog lists new features, enhancements, and other changes added to Redi

### Redis 7.2 fixed opt-in

You can opt in to Redis 7.2 on [Fixed subscriptions]({{<relref "/rc/subscriptions/create-fixed-subscription">}}) in selected regions in AWS and GCP. Redis 7.2 introduces several changes to existing Redis commands; see the [list of breaking changes](#redis-72-breaking-changes) for more details.
You can opt in to Redis 7.2 on [Fixed subscriptions]({{<relref "/rc/databases/create-database/create-essentials-database">}}) in selected regions in AWS and GCP. Redis 7.2 introduces several changes to existing Redis commands; see the [list of breaking changes](#redis-72-breaking-changes) for more details.

### Export database list to CSV includes Active-Active

Expand Down
2 changes: 1 addition & 1 deletion content/rc/changelog/march-2023.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This changelog lists new features, enhancements, and other changes added to Redi

### Redis 7.0 preview

A preview of Redis 7.0 is available for [Fixed subscriptions]({{<relref "/rc/subscriptions/create-fixed-subscription">}}) in selected regions in AWS and GCP. However, some Redis 7.0 functionality might not be fully available during preview. Redis 7.0 also introduces several changes to existing Redis commands; see the [list of breaking changes](#redis-70-breaking-changes) for more details.
A preview of Redis 7.0 is available for [Fixed subscriptions]({{<relref "/rc/databases/create-database/create-essentials-database">}}) in selected regions in AWS and GCP. However, some Redis 7.0 functionality might not be fully available during preview. Redis 7.0 also introduces several changes to existing Redis commands; see the [list of breaking changes](#redis-70-breaking-changes) for more details.

The following tables show which new open source Redis 7.0 commands are supported in Redis 7.0 subscriptions.

Expand Down
Loading
Loading