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
23 changes: 11 additions & 12 deletions content/operate/rs/flex/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Flex moves data between RAM and flash based on access patterns:
- Less active data moves to cost-efficient flash storage.
- Data accessed from flash promotes back to RAM automatically.

Redis uses an [LRU (least recently used)]({{< relref "/develop/reference/eviction#apx-lru" >}}) eviction policy to manage data placement. When memory pressure increases, Flex identifies cold objects, transfers them to flash, and frees RAM for new or frequently accessed keys.
Redis uses an [LRU (least recently used)](/content/develop/reference/eviction/index.md#apx-lru) eviction policy to manage data placement. When memory pressure increases, Flex identifies cold objects, transfers them to flash, and frees RAM for new or frequently accessed keys.

This process requires no application changes. Your existing Redis commands work across both storage tiers.

Expand All @@ -41,12 +41,12 @@ This design delivers predictable latency and throughput as datasets grow beyond

## Compatibility

Flex is compatible with the Redis API and supports all [Redis data types]({{<relref "/develop/data-types">}}), including JSON and probabilistic data structures (Bloom filters, Count-Min Sketch, Top-K), as well as [Redis Search]({{<relref "/develop/ai/search-and-query">}}).
Flex is compatible with the Redis API and supports all [Redis data types](/content/develop/data-types/_index.md), including JSON and probabilistic data structures (Bloom filters, Count-Min Sketch, Top-K), as well as [Redis Search](/content/develop/ai/search-and-query/_index.md).

The following features are not yet supported with Flex:

- [Time series]({{<relref "/develop/data-types/timeseries">}})
- [Active-Active]({{<relref "/operate/rs/databases/active-active">}})
- [Time series](/content/develop/data-types/timeseries/_index.md)
- [Active-Active](/content/operate/rs/databases/active-active/_index.md)

## When to use Flex

Expand All @@ -57,21 +57,20 @@ Use Flex when you need to:
- Operate large distributed caches with elastic scaling and consistent performance under heavy load
- Reduce infrastructure costs by combining high-speed RAM with cost-efficient flash storage

{{<note>}}
Flex does not replace long-term data persistence. For workloads that require durability and recovery across restarts or failures, use Redis persistence features like [AOF (Append-Only File)]({{< relref "/operate/oss_and_stack/management/persistence#append-only-file" >}}), [RDB snapshots]({{< relref "/operate/oss_and_stack/management/persistence#snapshotting" >}}), or both. For more information, see [Database persistence]({{< relref "/operate/rs/databases/configure/database-persistence" >}}).
{{</note>}}
> [!NOTE]
> Flex does not replace long-term data persistence. For workloads that require durability and recovery across restarts or failures, use Redis persistence features like [AOF (Append-Only File)](/content/operate/oss_and_stack/management/persistence.md#append-only-file), [RDB snapshots](/content/operate/oss_and_stack/management/persistence.md#snapshotting), or both. For more information, see [Database persistence](/content/operate/rs/databases/configure/database-persistence.md).

## Flex and Auto Tiering

Flex replaces [Auto Tiering]({{< relref "/operate/rs/7.22/databases/auto-tiering" >}}) (formerly known as Redis on Flash). Redis Software selects the implementation based on your Redis version:
Flex replaces [Auto Tiering](/content/operate/rs/7.22/databases/auto-tiering/_index.md) (formerly known as Redis on Flash). Redis Software selects the implementation based on your Redis version:

| Redis database version | Flex | Auto Tiering |
|------------------------|------|--------------|
| 8.0 and later | <span title="Supported">&#x2705;</span> | <span title="Not supported">&#x274c;</span> |
| 7.4 | <span title="Supported">&#x2705;</span> | <span title="Supported">&#x2705;</span>|
| 7.2 and earlier | <span title="Not supported">&#x274c;</span> | <span title="Supported">&#x2705;</span> |

For Redis Software version 7.22.2-22 or earlier, see [Auto Tiering]({{< relref "/operate/rs/7.22/databases/auto-tiering" >}}).
For Redis Software version 7.22.2-22 or earlier, see [Auto Tiering](/content/operate/rs/7.22/databases/auto-tiering/_index.md).

### Differences between Flex and Auto Tiering

Expand All @@ -87,6 +86,6 @@ For Redis Software version 7.22.2-22 or earlier, see [Auto Tiering]({{< relref "

## Next steps

- [Plan your deployment]({{< relref "/operate/rs/flex/plan" >}}): Review hardware requirements, sizing guidelines, and limitations.
- [Get started]({{< relref "/operate/rs/flex/get-started" >}}): Configure Flex on your cluster.
- [Scale your deployment]({{< relref "/operate/rs/flex/scale" >}}): Learn scaling strategies and best practices.
- [Plan your deployment](/content/operate/rs/flex/plan.md): Review hardware requirements, sizing guidelines, and limitations.
- [Get started](/content/operate/rs/flex/get-started.md): Configure Flex on your cluster.
- [Scale your deployment](/content/operate/rs/flex/scale.md): Learn scaling strategies and best practices.
13 changes: 6 additions & 7 deletions content/operate/rs/flex/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ description: Configure Flex databases on your Redis Software cluster.
linkTitle: Get started
weight: 20
---
This page guides you through a quick setup of [Flex]({{< relref "/operate/rs/flex" >}}) with a single node for testing and demo purposes.
This page guides you through a quick setup of [Flex](/content/operate/rs/flex/_index.md) with a single node for testing and demo purposes.

For production environments, see [Plan a Flex deployment for Redis Software]({{<relref "/operate/rs/flex/plan">}}) and more detailed installation instructions in the [install and setup]({{< relref "/operate/rs/installing-upgrading" >}}) section.
For production environments, see [Plan a Flex deployment for Redis Software](/content/operate/rs/flex/plan.md) and more detailed installation instructions in the [install and setup](/content/operate/rs/installing-upgrading/_index.md) section.

To set up a Redis Software cluster using Flex with a single node:

Expand Down Expand Up @@ -86,10 +86,9 @@ sudo lsblk
1. Direct your browser to `https://localhost:8443` on the host machine to
see the Redis Software Cluster Manager UI.

{{<note>}}
Depending on your browser, you may see a certificate error.
Choose "continue to the website" to go to the setup screen.
{{</note>}}
> [!NOTE]
> Depending on your browser, you may see a certificate error.
> Choose "continue to the website" to go to the setup screen.

1. Click **Create new cluster**.

Expand Down Expand Up @@ -125,7 +124,7 @@ You now have a Flex database.

## Connect to your database

After you create the database, you can connect to it and store data. See [Test client connection]({{<relref "/operate/rs/databases/connect/test-client-connectivity">}}) for connection options and examples.
After you create the database, you can connect to it and store data. See [Test client connection](/content/operate/rs/databases/connect/test-client-connectivity.md) for connection options and examples.

## Next steps

Expand Down
18 changes: 9 additions & 9 deletions content/operate/rs/flex/plan.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ When planning a Flex deployment, consider the following flash drive requirements

- Flash storage must be greater than the total provisioned database size to account for write buffers, space amplification, and more. Flash space should be approximately three times the total memory limit of all Flex databases on the node. Because you can increase a database's memory limit after creation, size flash storage for the expected peak memory limit.

See the general Redis Software [hardware requirements]({{<relref "/operate/rs/installing-upgrading/install/plan-deployment/hardware-requirements">}}) for additional requirements.
See the general Redis Software [hardware requirements](/content/operate/rs/installing-upgrading/install/plan-deployment/hardware-requirements.md) for additional requirements.

## Sizing guidelines

Expand Down Expand Up @@ -79,12 +79,12 @@ Actual performance can vary based on your data model, commands, and network late

| Data type/feature | Flex support |
|------------------|--------------|
| [Active-Active databases]({{<relref "/operate/rs/databases/active-active">}}) | <span title="Not supported">&#x274c;</span>Not supported |
| [JSON]({{<relref "/develop/data-types/json">}}) | <span title="Supported">&#x2705;</span> Supported |
| [Probabilistic data structures]({{<relref "/develop/data-types/#probabilistic-data-types">}}) | <span title="Supported">&#x2705;</span> Supported |
| [Redis Search]({{<relref "/develop/ai/search-and-query">}}) | <span title="Supported">&#x2705;</span> Supported |
| Standard [Redis data types]({{<relref "/develop/data-types">}}) | <span title="Supported">&#x2705;</span> Supported |
| [Time series]({{<relref "/develop/data-types/timeseries">}}) | <span title="Not supported">&#x274c;</span>Not supported |
| [Active-Active databases](/content/operate/rs/databases/active-active/_index.md) | <span title="Not supported">&#x274c;</span>Not supported |
| [JSON](/content/develop/data-types/json/_index.md) | <span title="Supported">&#x2705;</span> Supported |
| [Probabilistic data structures](/content/develop/data-types/_index.md#probabilistic-data-types) | <span title="Supported">&#x2705;</span> Supported |
| [Redis Search](/content/develop/ai/search-and-query/_index.md) | <span title="Supported">&#x2705;</span> Supported |
| Standard [Redis data types](/content/develop/data-types/_index.md) | <span title="Supported">&#x2705;</span> Supported |
| [Time series](/content/develop/data-types/timeseries/_index.md) | <span title="Not supported">&#x274c;</span>Not supported |

## Best practices

Expand All @@ -108,5 +108,5 @@ Actual performance can vary based on your data model, commands, and network late

## Next steps

- [Get started]({{< relref "/operate/rs/flex/get-started" >}}): Configure Flex on your cluster.
- [Scale your deployment]({{< relref "/operate/rs/flex/scale" >}}): Learn scaling strategies.
- [Get started](/content/operate/rs/flex/get-started.md): Configure Flex on your cluster.
- [Scale your deployment](/content/operate/rs/flex/scale.md): Learn scaling strategies.
11 changes: 5 additions & 6 deletions content/operate/rs/flex/scale.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,13 +105,13 @@ To add shards using the Cluster Manager UI:

1. Click **Save**.

To add nodes to the cluster, see [Add a node]({{<relref "/operate/rs/clusters/add-node">}}) for instructions.
To add nodes to the cluster, see [Add a node](/content/operate/rs/clusters/add-node.md) for instructions.

### Increase RAM-to-flash ratio

To improve throughput and lower latency, you can expand the in-memory tier to serve a higher proportion of requests directly from RAM. This strategy is recommended when low latency is your primary goal and you don't need to increase the dataset size.

Before increasing the RAM-to-flash ratio, you might need to add more nodes to accommodate additional RAM. See [Add a node]({{<relref "/operate/rs/clusters/add-node">}}) for instructions.
Before increasing the RAM-to-flash ratio, you might need to add more nodes to accommodate additional RAM. See [Add a node](/content/operate/rs/clusters/add-node.md) for instructions.

To increase the RAM-to-flash ratio using the Cluster Manager UI:

Expand All @@ -135,8 +135,7 @@ For self-managed Redis Flex deployments, ensure the cluster has sufficient physi

- Adequate vCPU to support increased shard count or throughput.

{{<warning>}}
Scaling operations will fail or underperform if the underlying cluster is resource-constrained.
{{</warning>}}
> [!WARNING]
> Scaling operations will fail or underperform if the underlying cluster is resource-constrained.

See Flex [hardware requirements]({{<relref "/operate/rs/flex/plan#hardware-requirements">}}) for more information.
See Flex [hardware requirements](/content/operate/rs/flex/plan.md#hardware-requirements) for more information.
18 changes: 9 additions & 9 deletions content/operate/rs/monitoring/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,31 +20,31 @@ to monitor the performance of your databases.

In the Redis Software Cluster Manager UI, you can view metrics, configure alerts, and send notifications based on alert parameters. You can also access metrics and configure alerts through the REST API.

See [Metrics and alerts for monitoring v1]({{<relref "/operate/rs/monitoring/v1_monitoring">}}) for more information.
See [Metrics and alerts for monitoring v1](/content/operate/rs/monitoring/v1_monitoring.md) for more information.

## Metrics stream engine

The new metrics stream engine is generally available as of [Redis Software version 8.0]({{<relref "/operate/rs/release-notes/rs-8-0-releases">}}) This new engine exposes the v2 Prometheus scraping endpoint at `https://<cluster_name>:8070/v2`, exports all time-series metrics to external monitoring tools, and enables real-time monitoring.
The new metrics stream engine is generally available as of [Redis Software version 8.0](/content/operate/rs/release-notes/rs-8-0-releases/_index.md) This new engine exposes the v2 Prometheus scraping endpoint at `https://<cluster_name>:8070/v2`, exports all time-series metrics to external monitoring tools, and enables real-time monitoring.

See [Metrics stream engine for monitoring v2]({{<relref "/operate/rs/monitoring/metrics_stream_engine">}}) for more information.
See [Metrics stream engine for monitoring v2](/content/operate/rs/monitoring/metrics_stream_engine/_index.md) for more information.

## Integrate with external monitoring tools

To integrate Redis Software metrics into your monitoring environment, see the following integration guides:

- [Grafana]({{<relref "/integrate/prometheus-with-redis-enterprise">}})
- [Grafana](/content/integrate/prometheus-with-redis-enterprise/_index.md)

- [Datadog]({{<relref "/integrate/datadog-with-redis-enterprise">}})
- [Datadog](/content/integrate/datadog-with-redis-enterprise/_index.md)

- [Dynatrace]({{<relref "/integrate/dynatrace-with-redis-enterprise">}})
- [Dynatrace](/content/integrate/dynatrace-with-redis-enterprise/_index.md)

- [New Relic]({{<relref "/integrate/new-relic-with-redis-enterprise">}})
- [New Relic](/content/integrate/new-relic-with-redis-enterprise/_index.md)

For a detailed tutorial to deploy a complete monitoring stack with Prometheus and Grafana, see [Redis Software Observability with Prometheus and Grafana](https://redis.io/learn/operate/observability/redis-software-prometheus-and-grafana).

Filter [Libraries and tools]({{<relref "/integrate">}}) by "observability" for additional tools and guides.
Filter [Libraries and tools](/content/integrate/_index.md) by "observability" for additional tools and guides.

## Metrics reference

Make sure you read the [definition of each metric]({{< relref "/operate/rs/references/metrics/" >}})
Make sure you read the [definition of each metric](/content/operate/rs/references/metrics/_index.md)
so that you understand exactly what it represents.
17 changes: 8 additions & 9 deletions content/operate/rs/monitoring/db-availability.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,10 @@ weight: 80
aliases: /operate/rs/databases/durability-ha/db-availability/
---

You can use the [database availability API]({{<relref "/operate/rs/references/rest-api/requests/bdbs/availability">}}) to verify whether a Redis Software database is available to perform read and write operations and can respond to queries from client applications. Load balancers and automated monitoring tools can use this API to monitor database availability.
You can use the [database availability API](/content/operate/rs/references/rest-api/requests/bdbs/availability.md) to verify whether a Redis Software database is available to perform read and write operations and can respond to queries from client applications. Load balancers and automated monitoring tools can use this API to monitor database availability.

{{<note>}}
Database availability does not guarantee data availability.
{{</note>}}
> [!NOTE]
> Database availability does not guarantee data availability.

## Check database availability for monitoring

Expand All @@ -29,11 +28,11 @@ GET /v1/bdbs/<database_id>/availability

If the OSS Cluster API is enabled, this request verifies all endpoints for this database are available. Otherwise, it verifies the database has at least one available endpoint.

An endpoint is available only if the database's primary (master) shards are reachable and the endpoint's listener port is bound. If either check fails, the database is reported as unavailable, and the [`error_code` and `description`]({{<relref "/operate/rs/references/rest-api/requests/bdbs/availability#get-db-error-codes">}}) identify the specific reason.
An endpoint is available only if the database's primary (master) shards are reachable and the endpoint's listener port is bound. If either check fails, the database is reported as unavailable, and the [`error_code` and `description`](/content/operate/rs/references/rest-api/requests/bdbs/availability.md#get-db-error-codes) identify the specific reason.

Returns the status code 200 OK if the database is available.

If the database is unavailable, returns an error status code and a JSON object that contains [`error_code` and `description` fields]({{<relref "/operate/rs/references/rest-api/requests/bdbs/availability#get-db-error-codes">}}).
If the database is unavailable, returns an error status code and a JSON object that contains [`error_code` and `description` fields](/content/operate/rs/references/rest-api/requests/bdbs/availability.md#get-db-error-codes).

## Check local database endpoint availability for load balancers

Expand All @@ -45,7 +44,7 @@ GET /v1/local/bdbs/<database_id>/endpoint/availability

Returns HTTP status code 200 OK if all primary (master) shards are reachable from the local database endpoint.

If the local database endpoint is unavailable, returns an error status code and a JSON object that contains [`error_code` and `description` fields]({{<relref "/operate/rs/references/rest-api/requests/bdbs/availability#get-endpoint-error-codes">}}).
If the local database endpoint is unavailable, returns an error status code and a JSON object that contains [`error_code` and `description` fields](/content/operate/rs/references/rest-api/requests/bdbs/availability.md#get-endpoint-error-codes).

## Use lag-aware availability checks for disaster recovery {#lag-aware}

Expand All @@ -55,7 +54,7 @@ The database availability API supports lag-aware availability checks that consid

The lag tolerance threshold is 100 milliseconds by default. Depending on factors such as workload, network conditions, and throughput, you might want to adjust the lag tolerance threshold.

To change the default threshold for the entire cluster, set `availability_lag_tolerance_ms` with an [update cluster]({{<relref "/operate/rs/references/rest-api/requests/cluster#put-cluster">}}) request:
To change the default threshold for the entire cluster, set `availability_lag_tolerance_ms` with an [update cluster](/content/operate/rs/references/rest-api/requests/cluster/_index.md#put-cluster) request:

```sh
PUT /v1/cluster
Expand Down Expand Up @@ -93,7 +92,7 @@ GET /v1/local/bdbs/<database_id>/endpoint/availability?extend_check=lag&availabi

## Availability by database status

The following table shows the relationship between a database's status and availability. For more details about the database status values, see [BDB status field]({{<relref "/operate/rs/references/rest-api/objects/bdb/status">}}).
The following table shows the relationship between a database's status and availability. For more details about the database status values, see [BDB status field](/content/operate/rs/references/rest-api/objects/bdb/status.md).

| Database status | Availability |
|-----------------|--------------|
Expand Down
Loading
Loading