Skip to content

Commit e4c4bc5

Browse files
committed
Merge branch 'main' into DOC-5564
2 parents 672f932 + 00e69d9 commit e4c4bc5

File tree

22 files changed

+936
-8
lines changed

22 files changed

+936
-8
lines changed

content/develop/clients/jedis/failover.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ description: Improve reliability using the failover/failback features of Jedis.
1313
linkTitle: Failover/failback
1414
title: Failover and failback
1515
weight: 50
16+
draft: true
1617
---
1718

1819
Jedis supports [failover and failback](https://en.wikipedia.org/wiki/Failover)

content/develop/data-types/probabilistic/top-k.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,4 +100,4 @@ Insertion in a top-k has time complexity of O(K + depth) ≈ O(K) and lookup has
100100
- [HeavyKeeper: An Accurate Algorithm for Finding Top-k Elephant Flows.](https://yangtonghome.github.io/uploads/HeavyKeeper_ToN.pdf)
101101

102102
## References
103-
- [Meet Top-K: an Awesome Probabilistic Addition to RedisBloom](https://redis.com/blog/meet-top-k-awesome-probabilistic-addition-redisbloom/)
103+
- [Meet Top-K: an Awesome Probabilistic Addition to Redis](https://redis.com/blog/meet-top-k-awesome-probabilistic-addition-redis/)
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
LinkTitle: Railway Redis
3+
Title: Redis on Railway
4+
alwaysopen: false
5+
categories:
6+
- docs
7+
- integrate
8+
- oss
9+
- rs
10+
description: Deploy and host Redis on Railway. The Railway Redis database template allows you to provision and connect to a Redis database with zero configuration.
11+
group: cloud-service
12+
summary: Railway simplifies your infrastructure stack from servers to observability with a single, scalable, easy-to-use platform. The Railway Redis database template allows you to provision and connect a Redis database with zero configuration, alongside your other services. Scale your application with Redis on Railway with highly performant networking and intuitive scaling.
13+
type: integration
14+
weight: 7
15+
---
16+
17+
[Railway](https://railway.com?utm_medium=integration&utm_source=docs&utm_campaign=redis) simplifies your infrastructure stack from databases to servers to observability with a single, scalable, easy-to-use platform. Companies of all sizes deploy full-stack applications on Railway and benefit from highly performant networking, intuitive vertical and horizontal scaling, and isolated environments with pull request deploys. Railway's template marketplace includes thousands of one-click deploy templates, including Redis.
18+
19+
{{< image filename="/images/rc/railway-redis-canvas.png" >}}
20+
21+
This is a guide to deploying Redis on Railway, using the official template.
22+
23+
## Deploy Redis to Railway
24+
25+
Navigate to a new Railway project at [railway.com/new](https://railway.com/new?utm_medium=integration&utm_source=docs&utm_campaign=redis). Add a Redis database to your project via the `ctrl / cmd + k` menu, and type `Redis`.
26+
27+
You can also deploy it via the [template](https://railway.com/deploy/redis) from the Railway template marketplace.
28+
29+
{{< image filename="/images/rc/railway-redis-add.gif" >}}
30+
31+
Upon deployment, you will have a Redis service running in your project, deployed from the [redis](https://hub.docker.com/_/redis) Docker image.
32+
33+
Since the deployed container is pulled from the [redis](https://hub.docker.com/_/redis) image in Docker Hub, you can modify the deployment based on the [instructions in Docker Hub](https://hub.docker.com/_/redis).
34+
35+
## Connecting to your Railway Redis Service
36+
37+
It is possible to connect to Redis externally by using the [TCP Proxy](https://docs.railway.com/deploy/exposing-your-app#tcp-proxying?utm_medium=integration&utm_source=docs&utm_campaign=redis) which is enabled by default.
38+
39+
## Backup and Monitoring
40+
41+
Especially for production environments, performing backups and monitoring the health of your data is essential. Consider adding:
42+
43+
- **Backups**: Automate regular backups to ensure data recovery in case of failure. We suggest checking out Railway's native [Backups](https://docs.railway.com/reference/backups?utm_medium=integration&utm_source=docs&utm_campaign=redis) feature.
44+
45+
- **Observability**: Implement monitoring for insights into performance and health of your Redis cluster. You can integrate a Redis exporter for Prometheus, although we do not provide a specific template at this time.
46+
47+
## Additional Resources
48+
49+
- [Railway Redis guide](https://docs.railway.com/guides/redis?utm_medium=integration&utm_source=docs&utm_campaign=redis)
50+
- [Railway platform features](https://railway.com/features?utm_medium=integration&utm_source=docs&utm_campaign=redis)

content/operate/rc/api/api-reference/openapi.json

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@
2222
"security": [
2323
{
2424
"x-api-key": [],
25-
"x-api-secret-key": []
25+
"x-api-secret-key": [],
26+
"X-Auth-Token": []
2627
}
2728
],
2829
"tags": [
@@ -15359,6 +15360,7 @@
1535915360
"DATABASE_MODULE_MUST_BE_DEFINED_ONCE",
1536015361
"DATABASE_MEMCACHED_CONTAINS_MODULES",
1536115362
"DATABASE_MEMCACHED_NOT_SUPPORT_OSS_CLUSTER_API",
15363+
"REDIS_ON_FLASH_DATABASE_MEMCACHED_PROTOCOL_IS_NOT_ALLOWED",
1536215364
"DATABASE_MEMCACHED_CONTAINS_REDIS_PASSWORD",
1536315365
"DATABASE_MEMCACHED_CONTAINS_REDIS_DEFAULT_USER",
1536415366
"DATABASE_MEMCACHED_SASL_USERNAME_IS_BLANK",
@@ -15380,6 +15382,7 @@
1538015382
"DATABASE_INVALID_MODULE",
1538115383
"DATABASE_INVALID_MODULE_PARAMETER",
1538215384
"DATABASE_INVALID_MODULE_PARAMETER_VALUE",
15385+
"DATABASE_EXPLICIT_MODULES_NOT_SUPPORTED_FOR_THIS_REDIS_VERSION",
1538315386
"DATABASE_INVALID_ALERT_VALUE",
1538415387
"DATABASE_SHARDING_TYPE_IS_IMMUTABLE",
1538515388
"DATABASE_SHARDING_TYPE_IS_NOT_SUPPORTED",
@@ -17005,6 +17008,11 @@
1700517008
"type": "apiKey",
1700617009
"name": "x-api-secret-key",
1700717010
"in": "header"
17011+
},
17012+
"X-Auth-Token": {
17013+
"type": "apiKey",
17014+
"name": "X-Auth-Token",
17015+
"in": "header"
1700817016
}
1700917017
}
1701017018
}

content/operate/rc/billing-and-payments.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,4 +116,12 @@ For any special circumstances that may warrant a refund, please contact [Support
116116

117117
## Download cost report
118118

119-
{{< embed-md "rc-cost-report-csv.md" >}}
119+
{{< embed-md "rc-cost-report-csv.md" >}}
120+
121+
## Troubleshoot
122+
123+
See [Billing](https://support.redislabs.com/hc/en-us/categories/26174537325842-Billing) on the Redis knowledge base for help troubleshooting billing issues:
124+
- [Resolving payment failures in Redis Cloud](https://support.redislabs.com/hc/en-us/articles/26266042933522-Resolving-Payment-Failures-in-Redis-Cloud)
125+
- [Credit card retry behavior and troubleshooting](https://support.redislabs.com/hc/en-us/articles/27697187187986-Credit-Card-Retry-Behavior-and-Troubleshooting)
126+
- [Access invoices and payment links](https://support.redislabs.com/hc/en-us/articles/26265945230226-Access-Invoices-and-Payment-Links-in-the-Portal)
127+
- [How to find payment information](https://support.redislabs.com/hc/en-us/articles/26266104144914-How-to-Find-Payment-Information)

content/operate/rc/cloud-integrations/aws-marketplace/_index.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,4 +57,8 @@ If your AWS Marketplace account is deactivated or otherwise unavailable, you won
5757

5858
If you are the owner of more than one Redis Cloud account and have already associated your AWS marketplace account with one or more of your Redis accounts, you can add your AWS marketplace account to your other Redis Cloud accounts.
5959

60-
{{< embed-md "rc-marketplace-account-add.md" >}}
60+
{{< embed-md "rc-marketplace-account-add.md" >}}
61+
62+
## Disconnect AWS Marketplace account
63+
64+
See [Disconnect AWS Marketplace account](https://support.redislabs.com/hc/en-us/articles/29215779949074-Disconnect-Redis-Cloud-from-AWS-Marketplace) on the Redis knowledge base for help disconnecting your AWS Marketplace account from your Redis Cloud account.

content/operate/rc/cloud-integrations/gcp-marketplace/_index.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,4 +72,8 @@ If your Google Cloud Marketplace account is deactivated or otherwise unavailable
7272

7373
If you are the owner of more than one Redis Cloud account and have already associated your Google Cloud marketplace account with one or more of your Redis accounts, you can add your Google Cloud marketplace account to your other Redis Cloud accounts.
7474

75-
{{< embed-md "rc-marketplace-account-add.md" >}}
75+
{{< embed-md "rc-marketplace-account-add.md" >}}
76+
77+
## Disconnect Google Cloud marketplace account
78+
79+
See [Disconnect Google Cloud Marketplace account](https://support.redislabs.com/hc/en-us/articles/29209085344018-Disconnect-Redis-Cloud-from-Google-Cloud-Marketplace) on the Redis knowledge base for help disconnecting your Google Cloud Marketplace account from your Redis Cloud account.

content/operate/rc/resilient-apps.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,17 @@ When you're developing your apps, it is best to use specific Redis Client featur
6060

6161
See [Clients]({{< relref "/develop/clients" >}}) to learn how to connect with the official Redis clients.
6262

63+
### Production usage guides
64+
65+
For production-ready configurations and best practices, see the production usage guides for each client:
66+
67+
- [redis-py]({{< relref "/develop/clients/redis-py/produsage" >}})
68+
- [Node.js]({{< relref "/develop/clients/nodejs/produsage" >}})
69+
- [Jedis]({{< relref "/develop/clients/jedis/produsage" >}})
70+
- [Lettuce]({{< relref "/develop/clients/lettuce/produsage" >}})
71+
- [go-redis]({{< relref "/develop/clients/go/produsage" >}})
72+
- [NRedisStack]({{< relref "/develop/clients/dotnet/produsage" >}})
73+
6374
### Re-attempt connections
6475

6576
Some clients allow you to re-try connecting to your database if the connection fails. For these clients, we recommend that you implement connection re-attempts to ensure high availability and connection stability.
@@ -78,6 +89,12 @@ The [WAIT]({{< relref "/commands/wait" >}}) and [WAITAOF]({{< relref "/commands/
7889

7990
For more info, see [Use the WAIT command for strong consistency]({{< relref "/operate/rs/clusters/optimize/wait" >}}).
8091

92+
## Test failover behavior
93+
94+
You can test your app's failover behavior in Redis Cloud by running a failover test. A failover test in Redis Cloud simulates a controlled disruption such as an endpoint migration, node failure, or cluster outage to confirm that your app can reconnect, recover, and continue operating without data loss. These tests are a critical part of validating high-availability and disaster recovery, ensuring that applications meet recovery time and recovery point objectives.
95+
96+
For more info, see [How to run a Failover Test in Redis Cloud](https://support.redislabs.com/hc/en-us/articles/29001166157074-How-to-Run-a-Failover-Test-in-Redis-Cloud).
97+
8198
## More info
8299

83100
- [Redis Clients]({{< relref "/develop/clients" >}})

content/operate/rc/troubleshoot.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
Title: Troubleshoot Redis Cloud issues with the Redis Cloud knowledge base
3+
alwaysopen: false
4+
categories:
5+
- docs
6+
- operate
7+
- rc
8+
description: Use the Redis Cloud knowledge base to find answers to common Redis Cloud questions.
9+
linktitle: Troubleshoot
10+
weight: 87
11+
---
12+
13+
The [Redis Cloud knowledge base](https://support.redislabs.com/hc/en-us/categories/26174183986450-Redis-Cloud) provides articles to help you troubleshoot common Redis Cloud issues.
14+
15+
## Account and User Management
16+
17+
- [Restore access to your Redis Cloud account](https://support.redislabs.com/hc/en-us/articles/27496470929170-Restore-Access-to-Your-Redis-Cloud-Account)
18+
- [Cancel a Redis Cloud subscription](https://support.redislabs.com/hc/en-us/articles/27215953424786-Cancel-a-Redis-Cloud-Subscription)
19+
- [Delete a Redis Cloud account](https://support.redislabs.com/hc/en-us/articles/26180817014162-Delete-a-Redis-Cloud-Account)
20+
- [Submit a Redis Cloud privacy deletion request](https://support.redislabs.com/hc/en-us/articles/27646907553170-Submit-a-Redis-Cloud-Privacy-Deletion-Request)
21+
22+
## Billing and Payments
23+
24+
- [Resolving payment failures in Redis Cloud](https://support.redislabs.com/hc/en-us/articles/26266042933522-Resolving-Payment-Failures-in-Redis-Cloud)
25+
- [Credit card retry behavior and troubleshooting](https://support.redislabs.com/hc/en-us/articles/27697187187986-Credit-Card-Retry-Behavior-and-Troubleshooting)
26+
- [Access invoices and payment links](https://support.redislabs.com/hc/en-us/articles/26265945230226-Access-Invoices-and-Payment-Links-in-the-Portal)
27+
- [How to find payment information](https://support.redislabs.com/hc/en-us/articles/26266104144914-How-to-Find-Payment-Information)
28+
29+
## Database management and observability
30+
31+
- [Manage network usage and subscription limits in Redis Cloud Essentials](https://support.redislabs.com/hc/en-us/articles/27315881501202-Manage-Network-Usage-and-Subscription-Limits-in-Redis-Cloud-Essentials)
32+
- [Configuring Access Control and RBAC in Redis Cloud](https://support.redislabs.com/hc/en-us/articles/28595965192338-Configuring-Access-Control-and-RBAC-in-Redis-Cloud)
33+
- [How to run a Failover Test in Redis Cloud](https://support.redislabs.com/hc/en-us/articles/29001166157074-How-to-Run-a-Failover-Test-in-Redis-Cloud)

content/operate/rs/7.8/databases/recover.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,21 @@ After the databases are recovered, make sure your Redis clients can successfully
193193

194194
If you enable the automatic recovery cluster policy, Redis Enterprise tries to quickly recover as much data as possible from before the disaster.
195195

196-
To enable automatic recovery, [update the cluster policy]({{< relref "/operate/rs/7.8/references/rest-api/requests/cluster/policy#put-cluster-policy" >}}) using the REST API:
196+
To enable automatic recovery, use one of the following methods:
197+
198+
{{< multitabs id="enable-auto-recovery"
199+
tab1="rladmin"
200+
tab2="REST API" >}}
201+
202+
To enable automatic recovery using `rladmin`, run the [`rladmin tune cluster`]({{<relref "/operate/rs/7.8/references/cli-utilities/rladmin/tune#tune-cluster">}}) command:
203+
204+
```sh
205+
rladmin tune cluster auto_recovery enabled
206+
```
207+
208+
-tab-sep-
209+
210+
To enable automatic recovery using the REST API, use an [update cluster policy]({{< relref "/operate/rs/7.8/references/rest-api/requests/cluster/policy#put-cluster-policy" >}}) request:
197211

198212
```sh
199213
PUT /v1/cluster/policy
@@ -202,6 +216,8 @@ PUT /v1/cluster/policy
202216
}
203217
```
204218

219+
{{< /multitabs >}}
220+
205221
Redis Enterprise tries to recover databases from the best existing persistence files. If a persistence file isn't available, which can happen if its host node is down, the automatic recovery process waits for it to become available.
206222
207223
For each database, you can set the `recovery_wait_time` to define how many seconds the database waits for a persistence file to become available before recovery. After the wait time elapses, the recovery process continues, which can result in partial or full data loss. The default value is `-1`, which means to wait forever. Short wait times can increase the risk of potential data loss.

0 commit comments

Comments
 (0)