Skip to content

Commit a87e9cf

Browse files
authored
docs: Add message that Cube Store will replace Redis (#5011)
1 parent b7fb20b commit a87e9cf

File tree

4 files changed

+40
-7
lines changed

4 files changed

+40
-7
lines changed

docs/content/Caching/Overview.mdx

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,11 @@ menuOrder: 1
66
---
77

88
Cube.js provides a two-level caching system. The first level is **in-memory**
9-
cache and is active by default. We recommend using [Redis][link-redis] for
10-
in-memory cache when [running Cube.js in production][ref-production-checklist].
9+
cache and is active by default. Currently, [Redis][link-redis] is being used for
10+
in-memory cache and queue management for [clsutered Cube
11+
deployments][ref-production-checklist]. Cube Store will [replace
12+
Redis][replace-redis] in late
13+
2022.
1114

1215
Cube.js [in-memory cache](#in-memory-cache) acts as a buffer for your database
1316
when there's a burst of requests hitting the same data from multiple concurrent
@@ -85,9 +88,7 @@ database to populate the cache with the results and return them.
8588
### <--{"id" : "In-memory Cache"}--> Refresh Keys
8689

8790
Cube.js takes great care to prevent unnecessary queries from hitting your
88-
database. The first stage caching system caches query results in Redis (or in
89-
the in-memory store in development), but Cube.js needs a way to know if the data
90-
powering that query result has changed. If the underlying data isn't any
91+
database. The first stage caching system caches query results, but Cube.js needs a way to know if the data powering that query result has changed. If the underlying data isn't any
9192
different, the cached result is valid and can be returned skipping an expensive
9293
query, but if there is a difference, the query needs to be re-run and its result
9394
cached.
@@ -193,3 +194,4 @@ versions.
193194
/deployment/production-checklist#set-up-refresh-worker
194195
[ref-schema-ref-cube-refresh-key]: /schema/reference/cube#refresh-key
195196
[ref-schema-ref-preaggs]: /schema/reference/pre-aggregations
197+
[replace-redis]: https://cube.dev/blog/replacing-redis-with-cube-store

docs/content/Caching/Running-in-Production.mdx

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,14 @@ Cube.js makes use of two different kinds of cache:
1313
In development, Cube.js uses in-memory storage on the server. In production, we
1414
**strongly** recommend running Redis as a separate service.
1515

16+
<WarningBox>
17+
18+
Cube Store [will replace
19+
Redis][replace-redis] for in-memory cache and queue management in late
20+
2022.
21+
22+
</WarningBox>
23+
1624
Cube Store is enabled by default when running Cube.js in development mode. In
1725
production, Cube Store **must** run as a separate process. The easiest way to do
1826
this is to use the official Docker images for Cube.js and Cube Store.
@@ -248,3 +256,4 @@ allows requests from the Cube.js deployment.
248256
[ref-caching-partitioning]: /caching/using-pre-aggregations#partitioning
249257
[ref-config-env]: /reference/environment-variables#cube-store
250258
[ref-config-env-cloud-storage]: /reference/environment-variables#cloud-storage
259+
[replace-redis]: https://cube.dev/blog/replacing-redis-with-cube-store

docs/content/Deployment/Overview.mdx

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,11 @@ one or multiple API instances, a Refresh Worker, Redis and a Cube Store cluster.
3434
pre-aggregated data or connected database(s) for raw data. The **Refresh
3535
Worker** builds and refreshes pre-aggregations in the background. **Cube Store**
3636
ingests pre-aggregations built by Refresh Worker and responds to queries from
37-
API instances. **Redis** is used to manage the queue and query-level cache.
37+
API instances.
38+
39+
**Redis** is used to manage the queue and query-level cache. Please note, we
40+
are planning to [replace Redis with Cube Store][replace-redis] for in-memory cache and queue management in late
41+
2022.
3842

3943
API instances and Refresh Worker can be configured via [environment
4044
variables][ref-config-env] or [cube.js configuration file][ref-config-js]. They
@@ -283,6 +287,14 @@ services:
283287

284288
## Redis
285289

290+
<WarningBox>
291+
292+
Cube Store [will replace
293+
Redis][replace-redis] for in-memory cache and queue management in late
294+
2022.
295+
296+
</WarningBox>
297+
286298
Cube.js uses Redis, an in-memory data structure store, for query caching and
287299
queue.
288300

@@ -327,7 +339,7 @@ If you want to run Cube.js in production without Redis, you can use
327339

328340
<WarningBox>
329341

330-
Serverless and clustered deployments can't be run without Redis as it is used to
342+
Clustered deployments can't be run without Redis as it is used to
331343
manage the query queue.
332344

333345
</WarningBox>
@@ -342,3 +354,4 @@ manage the query queue.
342354
[ref-deploy-sls-gcp]: /deployment/platforms/serverless/google-cloud
343355
[ref-config-env]: /reference/environment-variables
344356
[ref-config-js]: /config
357+
[replace-redis]: https://cube.dev/blog/replacing-redis-with-cube-store

docs/content/Deployment/Production-Checklist.mdx

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,14 @@ configured database][ref-config-connect-db] to set it up.
7070

7171
## Set up Redis
7272

73+
<WarningBox>
74+
75+
Cube Store [will replace
76+
Redis][replace-redis] for in-memory cache and queue management in late
77+
2022.
78+
79+
</WarningBox>
80+
7381
Cube.js requires [Redis](https://redis.io/), an in-memory data structure store,
7482
to run in production.
7583

@@ -168,3 +176,4 @@ deployment's health and be alerted to any issues.
168176
[ref-config-env-vars-general]: /reference/environment-variables#general
169177
[ref-api-readyz]: /rest-api#readyz
170178
[ref-api-livez]: /rest-api#livez
179+
[replace-redis]: https://cube.dev/blog/replacing-redis-with-cube-store

0 commit comments

Comments
 (0)