Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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: 6 additions & 6 deletions content/embeds/cluster-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,30 +6,30 @@

1. Select **Create new cluster**.

{{<image filename="images/rs/screenshots/cluster/setup/create-cluster.png" alt="When you first install Redis Software, you need to set up a cluster." >}}
![When you first install Redis Software, you need to set up a cluster.](/images/rs/screenshots/cluster/setup/create-cluster.png)

2. Enter an email and password for the administrator account, then select **Next** to proceed to cluster setup.

{{<image filename="images/rs/screenshots/cluster/setup/admin-credentials.png" alt="Set the credentials for your admin user." >}}
![Set the credentials for your admin user.](/images/rs/screenshots/cluster/setup/admin-credentials.png)

You can also use these credentials to connect to the [REST API]({{< relref "/operate/rs/references/rest-api" >}}).

3. Enter your cluster license key if you have one. Otherwise, a trial version is installed.

{{<image filename="images/rs/screenshots/cluster/setup/cluster-license-key.png" alt="Enter your cluster license key if you have one." >}}
![Enter your cluster license key if you have one.](/images/rs/screenshots/cluster/setup/cluster-license-key.png)

4. In the **Configuration** section, enter a cluster FQDN such as `cluster.local`, then select **Next**.

{{<image filename="images/rs/screenshots/cluster/setup/config-cluster.png" alt="Configure the cluster FQDN." >}}
![Configure the cluster FQDN.](/images/rs/screenshots/cluster/setup/config-cluster.png)

{{< warning >}}
If the FQDN is `cluster.local`, you cannot configure DNS. You cannot change the FQDN after cluster creation.
{{< /warning >}}

1. On the node setup screen, select **Create cluster** to accept the defaults.

{{<image filename="images/rs/screenshots/cluster/setup/node-settings.png" alt="Configure the node specific settings." >}}
![Configure the node specific settings.](/images/rs/screenshots/cluster/setup/node-settings.png)

6. Select **OK** to acknowledge the replacement of the HTTPS TLS certificate on the node. If you receive a browser warning, you can proceed safely.

{{<image filename="images/rs/screenshots/cluster/setup/https-page-refresh-modal.png" alt="Modal shown when a page refresh is needed because the certificates have been updated." >}}
![Modal shown when a page refresh is needed because the certificates have been updated.](/images/rs/screenshots/cluster/setup/https-page-refresh-modal.png)
7 changes: 4 additions & 3 deletions content/embeds/quick-db-setup.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,19 @@
1. On the **Databases** screen, select **Quick database**.

{{<image filename="images/rs/screenshots/databases/db-screen.png" alt="Select Quick database on the Databases screen." >}}
![Select Quick database on the Databases screen.](/images/rs/screenshots/databases/db-screen.png)

1. Enter 12000 for the **Port**.

If port 12000 is not available, enter any available port number between 10000 to 19999 or leave it blank to let the cluster assign a port number for you. You will use this port number to connect to the database.

{{<image filename="images/rs/screenshots/databases/quick-db.png" alt="Create a quick database." >}}
![Create a quick database.](/images/rs/screenshots/databases/quick-db.png)

1. Select **Create** to create your database.

When you see **Database active** appear on the database configuration screen, the database is activated and ready for you to use.

{{<image filename="images/rs/icons/db-active-icon.png" width="150px" alt="Database active icon." >}}
![Database active icon.](/images/rs/icons/db-active-icon.png)
{width="150px"}


You now have a Redis database!
6 changes: 4 additions & 2 deletions content/embeds/rc-aa-cidr.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,10 @@ Every CIDR should be unique to properly route network traffic between each Activ

When all **Deployment CIDR** regions display a green checkmark, you're ready to continue.

{{<image filename="images/rc/icon-cidr-address-ok.png" width="30px" alt="Green checkmarks indicate valid CIDR address values." >}}
![Green checkmarks indicate valid CIDR address values.](/images/rc/icon-cidr-address-ok.png)
{width="30px"}

Red exclamation marks indicate error conditions; the tooltip provides additional details.

{{<image filename="images/rc/icon-cidr-address-error.png" width="30px" alt="Red exclamation points indicate CIDR address problems." >}}
![Red exclamation points indicate CIDR address problems.](/images/rc/icon-cidr-address-error.png)
{width="30px"}
3 changes: 2 additions & 1 deletion content/embeds/rc-cost-report-csv.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
---
Select the **Cost report** button to download a report of all shard costs in CSV format.

{{<image filename="images/rc/button-cost-report-download.png" width=150px alt="The cost report download button." >}}
![The cost report download button.](/images/rc/button-cost-report-download.png)
{width="150px"}

The report gives a breakdown of all your Redis billing unit costs, per subscription and database, by month. Subscriptions under the minimum subscription price are broken down into actual billing unit prices and the difference from minimum price.
3 changes: 2 additions & 1 deletion content/embeds/rc-create-db-first-steps.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ To create a database in your Redis Cloud account:

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">}}
![The New Database button creates a new database.](/images/rc/button-database-new.png)
{width="120px"}

This displays the **Create database** screen.
2 changes: 1 addition & 1 deletion content/embeds/rc-create-db-use-cases.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
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">}}
![The Redis Use case panel](/images/rc/create-database-redis-use-cases.png)

- **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.
Expand Down
6 changes: 4 additions & 2 deletions content/embeds/rc-credit-card-add.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
If you have not already added a business address to your account, you must enter one. Redis uses your business address for communication, invoicing, and tax purposes.

{{<image filename="images/rc/billing-add-first-card.png" width="80%" alt="The Add credit card screen before a business address has already been added." >}}
![The Add credit card screen before a business address has already been added.](/images/rc/billing-add-first-card.png)
{width="80%"}

If you already have a business address, you don't need to enter one here. See [Account settings]({{< relref "/operate/rc/accounts/account-settings" >}}) to learn how to update your business address.

{{<image filename="images/rc/billing-add-credit-card.png" width="80%" alt="The Add credit card screen after a business address has already been added." >}}
![The Add credit card screen after a business address has already been added.](/images/rc/billing-add-credit-card.png)
{width="80%"}

If the card's billing address is the same as your account's business address, select **Same as business address** to fill the billing address with your business address details.
2 changes: 1 addition & 1 deletion content/embeds/rc-endpoint-description.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ horse-battery-staple-12345.db.redis.io

You can see the Dynamic endpoints for databases with both static and dynamic endpoints by expanding the **Dynamic endpoints** section in the **General** section of the **Configuration** tab.

{{<image filename="images/rc/databases-configuration-general-endpoints-legacy.png" alt="The Static and dynamic endpoints for a database with both kinds of endpoints." >}}
![The Static and dynamic endpoints for a database with both kinds of endpoints.](/images/rc/databases-configuration-general-endpoints-legacy.png)
3 changes: 2 additions & 1 deletion content/embeds/rc-get-prometheus-endpoint.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
In the **Metrics** tab of your database, select **Connect to Prometheus > Copy Prometheus endpoint** to save your Prometheus endpoint to the clipboard.

{{<image filename="images/rc/database-metrics-connect-prometheus.png" width="250px" alt="Use the Connect to Prometheus button to get the Prometheus endpoint.">}}
![Use the Connect to Prometheus button to get the Prometheus endpoint.](/images/rc/database-metrics-connect-prometheus.png)
{width="250px"}

You can also get the Prometheus endpoint by calling [`GET /subscriptions/{subscriptionId}`]({{< relref "/operate/rc/api/api-reference#tag/Subscriptions-Pro/operation/getSubscriptionById" >}}) and getting the `prometheusEndpoint` from the response.
6 changes: 4 additions & 2 deletions content/embeds/rc-marketplace-account-add.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,14 @@ To do this:

1. Select **Add Marketplace account**.

{{<image filename="images/rc/add-marketplace-account.png" width="300px" alt="The Add marketplace account button." >}}
![The Add marketplace account button.](/images/rc/add-marketplace-account.png)
{width="300px"}

1. Select the marketplace account you want to connect and confirm that it will pay for your Redis Cloud resources going forward.

1. Select **Connect account**.

{{<image filename="images/rc/button-connect-account.png" width="150px" alt="The Connect account button." >}}
![The Connect account button.](/images/rc/button-connect-account.png)
{width="150px"}

Your marketplace account is now connected to your Redis Cloud account. If you would like to disconnect your marketplace account from your Redis Cloud account, select **Disconnect**.
3 changes: 2 additions & 1 deletion content/embeds/rc-opt-in-to-72.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
Select **Opt-in to 7.2** to request to upgrade your subscription and databases to Redis 7.2 (*Redis 6.2 and earlier only*).

{{<image filename="images/rc/button-opt-in-to-72.png" width=150px alt="Opt-in to 7.2 button." >}}
![Opt-in to 7.2 button.](/images/rc/button-opt-in-to-72.png)
{width="150px"}

The upgrade will start one week from your request, according to [maintenance windows]({{< relref "/operate/rc/subscriptions/maintenance/set-maintenance-windows" >}}).

Expand Down
18 changes: 12 additions & 6 deletions content/embeds/rc-rdi-create-rdi-workspace.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,23 @@ To create a Data Integration workspace for an existing [Pro subscription]({{< re

1. From the Redis Cloud console, select **Data Integration** from the left-hand menu. If you don't have any workspaces yet, select **Create workspace** to go to the **Create workspace** page.

{{<image filename="images/rc/rdi/rdi-create-workspace-button.png" alt="The create workspace button." width=200px >}}
![The create workspace button.](/images/rc/rdi/rdi-create-workspace-button.png)
{width="200px"}

If you already have a workspace deployed, you'll see your current workspaces. Select **New workspace** to go to the **Create workspace** page.

{{<image filename="images/rc/rdi/rdi-new-workspace-button.png" alt="The new workspace button." width=150px >}}
![The new workspace button.](/images/rc/rdi/rdi-new-workspace-button.png)
{width="150px"}

You can also go to the **Data Integration** tab from your subscription or database page and select **Create workspace** to go to the **Create workspace** page for your subscription.

{{<image filename="images/rc/rdi/rdi-create-workspace-button.png" alt="The create workspace button." width=200px >}}
![The create workspace button.](/images/rc/rdi/rdi-create-workspace-button.png)
{width="200px"}

2. Select your Pro subscription from the list if it's not already selected.

{{<image filename="images/rc/rdi/rdi-create-workspace-select-subscription.png" alt="The select pro subscription drop down." width=80% >}}
![The select pro subscription drop down.](/images/rc/rdi/rdi-create-workspace-select-subscription.png)
{width="80%"}

3. A **Data Integration subnet (CIDR)** is automatically generated for you. Each RDI workspace uses a dedicated `/22` CIDR.

Expand All @@ -27,10 +31,12 @@ To create a Data Integration workspace for an existing [Pro subscription]({{< re

If the automatic suggestion is missing or unsuitable, select another unused `/22` CIDR in the same private range. For more information, see [VPC CIDR block association restrictions](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-cidr-blocks.html#vpc-resize).

{{<image filename="images/rc/rdi/rdi-create-workspace-cidr.png" alt="The select pro subscription drop down." width=80% >}}
![The select pro subscription drop down.](/images/rc/rdi/rdi-create-workspace-cidr.png)
{width="80%"}

4. Select **Create workspace** to create your workspace.

{{<image filename="images/rc/rdi/rdi-create-workspace-button.png" alt="The create workspace button." width=200px >}}
![The create workspace button.](/images/rc/rdi/rdi-create-workspace-button.png)
{width="200px"}

Your workspace will be created in the background. You can select **Create pipeline** to [create your pipeline]({{<relref "/operate/rc/rdi/define">}}) while the workspace is provisioning, or you can select **Create pipeline later** to go back to the Redis Cloud console.
8 changes: 5 additions & 3 deletions content/embeds/rc-tags-tag-module.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
You can select the tag's **Key** and **Value** from the suggestions, or you can enter your own.

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

A valid tag must follow these guidelines:
- Tag keys must be between 1 and 64 characters long, and values must be at least 1 character long.
Expand All @@ -12,8 +12,10 @@ After you add your first tag, you can:

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

{{<image filename="images/rc/icon-delete-lb.png" width="36px" alt="Delete button." >}}
![Delete button.](/images/rc/icon-delete-lb.png)
{width="36px"}

- 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" >}}
![The Add additional tag button.](/images/rc/tags-button-add-additional-tag.png)
{width="200px"}
6 changes: 4 additions & 2 deletions content/embeds/rc-version-upgrade.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
Select **Version upgrade** to request to upgrade your subscription and databases if there is a later version available.

{{<image filename="images/rc/button-version-upgrade.png" width=150px alt="Version upgrade button." >}}
![Version upgrade button.](/images/rc/button-version-upgrade.png)
{width="150px"}

Select the version to upgrade your databases from the list and select **Upgrade** to submit the upgrade request.

{{<image filename="images/rc/version-upgrade-request.png" width=80% alt="Version upgrade request list with version 7.4 selected." >}}
![Version upgrade request list with version 7.4 selected.](/images/rc/version-upgrade-request.png)
{width="80%"}

The upgrade will start one week from your request, according to your subscription's [maintenance windows]({{< relref "/operate/rc/subscriptions/maintenance/set-maintenance-windows" >}}).

Expand Down
4 changes: 2 additions & 2 deletions content/embeds/rdi-db-reqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,13 @@
When you create the RDI database, expand the **Clustering** section and make sure the
**Sharding** option is *unchecked* (as shown below).

{{< image filename="images/rdi/ingest/RDIClusterSetting.webp" alt="The Sharding option is unchecked in the Clustering section of the create database form." >}}
![The Sharding option is unchecked in the Clustering section of the create database form.](/images/rdi/ingest/RDIClusterSetting.webp)

You can check if your RDI database is clustered from its **Configuration** tab in the
Cluster Manager UI. In the **Clustering** section, **Sharding** should be set to **Disabled**,
as shown in the following screenshot:

{{< image filename="images/rdi/ingest/RDICheckUnclustered.webp" alt="The Clustering section of the database Configuration tab shows Sharding: Disabled." >}}
![The Clustering section of the database Configuration tab shows Sharding: Disabled.](/images/rdi/ingest/RDICheckUnclustered.webp)

If you find the database has been clustered by mistake, you must create a new database with
sharding disabled before continuing with the RDI installation.
4 changes: 2 additions & 2 deletions content/embeds/replica-of-tls-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ To enable TLS for Replica Of cluster connections:

1. Expand the **Replica Of and Active-Active authentication (Syncer certificate)** section.

{{<image filename="images/rs/screenshots/cluster/security-syncer-cert.png" alt="Syncer certificate for Replica Of and Active-Active authentication.">}}
![Syncer certificate for Replica Of and Active-Active authentication.](/images/rs/screenshots/cluster/security-syncer-cert.png)

1. Download or copy the syncer certificate.

Expand All @@ -18,7 +18,7 @@ To enable TLS for Replica Of cluster connections:

1. Select **Mutual TLS (Client authentication)**.

{{<image filename="images/rs/screenshots/databases/security-tls-replica-of.png" alt="Replica Of TLS authentication configuration.">}}
![Replica Of TLS authentication configuration.](/images/rs/screenshots/databases/security-tls-replica-of.png)

1. Select **+ Add certificate**, paste or upload the syncer certificate, then select **Done**.

Expand Down
2 changes: 1 addition & 1 deletion content/embeds/rs-observability.md
Original file line number Diff line number Diff line change
Expand Up @@ -565,7 +565,7 @@ The built-in configuration, `error_rules.yml`, has a single alert: Critical Conn
If you open the Prometheus console, by default located at port 9090, and select the Alert tab,
you will see this alert, as well as the alerts in any other file you have included as a rules file.

{{< image filename="/images/playbook_prometheus-alerts.png" alt="prometheus alerts image" >}}
![prometheus alerts image](/images/playbook_prometheus-alerts.png)

The following is a list of alerts contained in the `alerts.yml` file. There are several points to consider:

Expand Down
9 changes: 5 additions & 4 deletions content/embeds/rs-prometheus-grafana-quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ You can use Prometheus and Grafana to:

- Display Redis Software metrics alongside data from other systems

{{<image filename="images/rs/grafana-prometheus.png" alt="Graphic showing how Prometheus and Grafana collect and display data from a Redis Software Cluster. Prometheus collects metrics from the Redis Software cluster, and Grafana queries those metrics for visualization." width="80%" class="mx-auto block my-6 p-4 border border-redis-pen-300 rounded-lg shadow-sm">}}
![Graphic showing how Prometheus and Grafana collect and display data from a Redis Software Cluster. Prometheus collects metrics from the Redis Software cluster, and Grafana queries those metrics for visualization.](/images/rs/grafana-prometheus.png)
{width="80%" class="mx-auto block my-6 p-4 border border-redis-pen-300 rounded-lg shadow-sm"}

To get started with Prometheus and Grafana, see the following [quick start](#quick-start) or see [Redis Software Observability with Prometheus and Grafana](https://redis.io/learn/operate/observability/redis-software-prometheus-and-grafana) for a more detailed tutorial.

Expand Down Expand Up @@ -197,7 +198,7 @@ We recommend running Prometheus in Docker only for development and testing.

1. Select **Status** and then **Targets** to check that Prometheus is collecting data from your Redis Software cluster.

{{<image filename="images/rs/prometheus-target.png" alt="The Redis Software target showing that Prometheus is connected to the Redis Software Cluster.">}}
![The Redis Software target showing that Prometheus is connected to the Redis Software Cluster.](/images/rs/prometheus-target.png)

If Prometheus is connected to the cluster, you can type **node_up** in the Expression field on the Prometheus home page to see the cluster metrics.

Expand All @@ -216,14 +217,14 @@ We recommend running Prometheus in Docker only for development and testing.

1. Select **Prometheus** from the list of data source types.

{{<image filename="images/rs/prometheus-datasource.png" alt="The Prometheus data source in the list of data sources on Grafana.">}}
![The Prometheus data source in the list of data sources on Grafana.](/images/rs/prometheus-datasource.png)

1. Enter the Prometheus configuration information:

- Name: `redis-enterprise`
- URL: `http://<your prometheus server name>:9090`

{{<image filename="images/rs/prometheus-connection.png" alt="The Prometheus connection form in Grafana.">}}
![The Prometheus connection form in Grafana.](/images/rs/prometheus-connection.png)

{{< note >}}

Expand Down
Loading
Loading