Skip to content

Commit 6a4f763

Browse files
committed
docs: remove references to Redis
1 parent f74c8e8 commit 6a4f763

File tree

11 files changed

+61
-56
lines changed

11 files changed

+61
-56
lines changed

docs/content/Caching/Lambda-Pre-Aggregations.mdx

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,8 @@ usually [streaming][streaming-pre-agg], as a speed layer.
1515

1616
Lambda pre-aggregations only work with Cube Store.
1717

18-
Additionally, we’re going to remove support for external storages, other than
19-
Cube Store, later this year. [Cube Store will replace
20-
Redis][cube-blog-replace-redis] and, therefore will be a required component to
21-
run Cube even without pre-aggregations.
22-
2318
</WarningBox>
2419

25-
[cube-blog-replace-redis]: https://cube.dev/blog/replacing-redis-with-cube-store
26-
2720
## Use cases
2821

2922
Below we are looking at the most common examples of using lambda

docs/content/Caching/Overview.mdx

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ menuOrder: 1
99
<div style="text-align: center">
1010
<img
1111
alt="Request vs Cube caching layers"
12-
src="https://ucarecdn.com/4c037618-4cf9-48a7-abcb-da8922048cdd/"
12+
src="https://ucarecdn.com/532e9ffd-390c-42b4-9f56-f6080c587414/"
1313
style="border: none"
1414
width="100%"
1515
/>
@@ -193,7 +193,6 @@ every pre-aggregation's details: the list of queries it serves and all its
193193
versions.
194194

195195
[link-cube-cloud]: https://cube.dev/cloud
196-
[link-redis]: https://redis.io
197196
[ref-config-preagg-schema]: /config#pre-aggregations-schema
198197
[ref-dev-playground]: /dev-tools/dev-playground
199198
[ref-development-mode]: /configuration/overview#development-mode
@@ -202,4 +201,3 @@ versions.
202201
/deployment/production-checklist#set-up-refresh-worker
203202
[ref-schema-ref-cube-refresh-key]: /schema/reference/cube#refresh-key
204203
[ref-schema-ref-preaggs]: /schema/reference/pre-aggregations
205-
[replace-redis]: https://cube.dev/blog/replacing-redis-with-cube-store

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -291,4 +291,3 @@ allows requests from the Cube deployment.
291291
[link-wsl2]: https://docs.microsoft.com/en-us/windows/wsl/install-win10
292292
[ref-caching-partitioning]: /caching/using-pre-aggregations#partitioning
293293
[ref-config-env]: /reference/environment-variables
294-
[replace-redis]: https://cube.dev/blog/replacing-redis-with-cube-store

docs/content/Configuration/Config.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ interface CubejsConfiguration {
7575
subject?: string;
7676
claimsNamespace?: string;
7777
};
78-
cacheAndQueueDriver: 'memory' | 'redis';
78+
cacheAndQueueDriver: 'memory' | 'cubestore';
7979
orchestratorOptions:
8080
| OrchestratorOptions
8181
| ((context: RequestContext) => OrchestratorOptions);
@@ -687,8 +687,8 @@ Can also be set using `CUBEJS_JWT_CLAIMS_NAMESPACE`.
687687

688688
### <--{"id" : "Options Reference"}--> cacheAndQueueDriver
689689

690-
The cache and queue driver to use for the Cube deployment. Defaults to `memory`
691-
in development, `redis` in production.
690+
The cache and queue driver to use for the Cube.js deployment. Defaults to
691+
`memory` in development, `cubestore` in production.
692692

693693
### <--{"id" : "Options Reference"}--> orchestratorOptions
694694

docs/content/Configuration/Environment-Variables-Reference.mdx

Lines changed: 43 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ The cache and queue driver to use for the Cube deployment.
9999

100100
| Possible Values | Default in Development | Default in Production |
101101
| ----------------- | ---------------------- | --------------------- |
102-
| `redis`, `memory` | `memory` | `redis` |
102+
| `cubestore`, `memory` | `memory` | `cubestore` |
103103

104104
## `CUBEJS_CONCURRENCY`
105105

@@ -714,6 +714,13 @@ pre-aggregations.
714714

715715
## `CUBEJS_REDIS_PASSWORD`
716716

717+
<WarningBox>
718+
719+
This environment variable is deprecated. Update to v0.32.0 or later
720+
to use Cube Store instead of Redis.
721+
722+
</WarningBox>
723+
717724
The password used to connect to the Redis server.
718725

719726
| Possible Values | Default in Development | Default in Production |
@@ -722,6 +729,13 @@ The password used to connect to the Redis server.
722729

723730
## `CUBEJS_REDIS_POOL_MAX`
724731

732+
<WarningBox>
733+
734+
This environment variable is deprecated. Update to v0.32.0 or later
735+
to use Cube Store instead of Redis.
736+
737+
</WarningBox>
738+
725739
The maximum number of connections to keep active in the Redis connection pool
726740
for a single [`appId`][ref-config-conf-ctx-to-appid] (tenant). Must be higher
727741
than [`CUBEJS_REDIS_POOL_MIN`](#cubejs-redis-pool-min).
@@ -732,6 +746,13 @@ than [`CUBEJS_REDIS_POOL_MIN`](#cubejs-redis-pool-min).
732746

733747
## `CUBEJS_REDIS_POOL_MIN`
734748

749+
<WarningBox>
750+
751+
This environment variable is deprecated. Update to v0.32.0 or later
752+
to use Cube Store instead of Redis.
753+
754+
</WarningBox>
755+
735756
The minimum number of connections to keep active in the Redis connection pool
736757
for a single [`appId`][ref-config-conf-ctx-to-appid] (tenant). Must be lower
737758
than [`CUBEJS_REDIS_POOL_MAX`](#cubejs-redis-pool-max).
@@ -742,6 +763,13 @@ than [`CUBEJS_REDIS_POOL_MAX`](#cubejs-redis-pool-max).
742763

743764
## `CUBEJS_REDIS_TLS`
744765

766+
<WarningBox>
767+
768+
This environment variable is deprecated. Update to v0.32.0 or later
769+
to use Cube Store instead of Redis.
770+
771+
</WarningBox>
772+
745773
If `true`, then the connection to the Redis server is protected by TLS
746774
authentication.
747775

@@ -751,6 +779,13 @@ authentication.
751779

752780
## `CUBEJS_REDIS_URL`
753781

782+
<WarningBox>
783+
784+
This environment variable is deprecated. Update to v0.32.0 or later
785+
to use Cube Store instead of Redis.
786+
787+
</WarningBox>
788+
754789
The host URL for a Redis server.
755790

756791
| Possible Values | Default in Development | Default in Production |
@@ -759,6 +794,13 @@ The host URL for a Redis server.
759794

760795
## `CUBEJS_REDIS_USE_IOREDIS`
761796

797+
<WarningBox>
798+
799+
This environment variable is deprecated. Update to v0.32.0 or later
800+
to use Cube Store instead of Redis.
801+
802+
</WarningBox>
803+
762804
Use [`ioredis`][gh-ioredis] instead of [`redis`][gh-node-redis].
763805

764806
| Possible Values | Default in Development | Default in Production |

docs/content/Configuration/Overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ mode does the following:
3535
pre-aggregations][link-scheduled-refresh]
3636
- Allows another log level to be set (`trace`)
3737
- Enables [Developer Playground][link-dev-playground] on `http://localhost:4000`
38-
- Uses `memory` instead of `redis` as the default cache/queue engine
38+
- Uses `memory` instead of `cubestore` as the default cache/queue engine
3939
- Logs incorrect/invalid configuration for `externalRefresh` /`waitForRenew`
4040
instead of throwing errors
4141

docs/content/Cube-Cloud/Cloud-Workspace/Observability/Log-Export.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ earlier:
7171
```toml
7272
[sinks.loki]
7373
type = "loki"
74-
inputs = [ "cubejs-server", "redis", "refresh-scheduler", "ext-db" ]
74+
inputs = [ "cubejs-server", "refresh-scheduler", "ext-db" ]
7575
endpoint = "https://logs-prod-us-central1.grafana.net"
7676
[sinks.loki.encoding]
7777
codec = "json"
@@ -119,7 +119,6 @@ the Overview page, you should now see a new "Log Export" resource:
119119
Valid values for `input` are
120120

121121
- `cubejs-server`
122-
- `redis`
123122
- `refresh-scheduler`
124123
- `ext-db`
125124
- `warmup-job`

docs/content/Cube-Cloud/Configuration/Deployment-Types.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,6 +185,5 @@ from the available options:
185185
/>
186186
</div>
187187

188-
[cube-blog-replace-redis]: https://cube.dev/blog/replacing-redis-with-cube-store
189188
[cube-contact-us]: https://cube.dev/contact
190189
[ref-conf-ref-ctx-to-app-id]: /config#options-reference-context-to-app-id

docs/content/Deployment/Overview.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -283,4 +283,3 @@ services:
283283
[ref-deploy-docker]: /deployment/platforms/docker
284284
[ref-config-env]: /reference/environment-variables
285285
[ref-config-js]: /config
286-
[replace-redis]: https://cube.dev/blog/replacing-redis-with-cube-store

docs/content/Deployment/Platform-Docker.mdx

Lines changed: 12 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@ production-ready stack would at minimum consist of:
2929
- A Cube Refresh Worker
3030
- A Cube Store Router node
3131
- One or more Cube Store Worker nodes
32-
- A Redis instance
3332

3433
An example stack using BigQuery as a data source is provided below:
3534

@@ -55,15 +54,14 @@ services:
5554
- CUBEJS_DB_BQ_CREDENTIALS=<BQ-KEY>
5655
- CUBEJS_DB_EXPORT_BUCKET=cubestore
5756
- CUBEJS_CUBESTORE_HOST=cubestore_router
58-
- CUBEJS_REDIS_URL=redis://redis:6379
5957
- CUBEJS_API_SECRET=secret
6058
volumes:
6159
- .:/cube/conf
6260
depends_on:
61+
- cube_refresh_worker
62+
- cubestore_router
6363
- cubestore_worker_1
6464
- cubestore_worker_2
65-
- cube_refresh_worker
66-
- redis
6765

6866
cube_refresh_worker:
6967
restart: always
@@ -74,7 +72,6 @@ services:
7472
- CUBEJS_DB_BQ_CREDENTIALS=<BQ-KEY>
7573
- CUBEJS_DB_EXPORT_BUCKET=cubestore
7674
- CUBEJS_CUBESTORE_HOST=cubestore_router
77-
- CUBEJS_REDIS_URL=redis://redis:6379
7875
- CUBEJS_API_SECRET=secret
7976
- CUBEJS_REFRESH_WORKER=true
8077
volumes:
@@ -118,20 +115,13 @@ services:
118115
- .cubestore:/cube/data
119116
depends_on:
120117
- cubestore_router
121-
122-
redis:
123-
image: bitnami/redis:latest
124-
environment:
125-
- ALLOW_EMPTY_PASSWORD=yes
126-
logging:
127-
driver: none
128118
```
129119
130120
## Set up reverse proxy
131121
132-
In production, the Cube API should be served over an HTTPS connection to ensure
133-
security of the data in-transit. We recommend using a reverse proxy; as an
134-
example, let's use [NGINX][link-nginx].
122+
In production, the Cube API should be served over an HTTPS connection to
123+
ensure security of the data in-transit. We recommend using a reverse proxy; as
124+
an example, let's use [NGINX][link-nginx].
135125
136126
<InfoBox>
137127
@@ -192,9 +182,9 @@ post][medium-letsencrypt-nginx] may be useful.
192182

193183
### <--{"id" : "Security"}--> Use JSON Web Tokens
194184

195-
Cube can be configured to use industry-standard JSON Web Key Sets for securing
196-
its API and limiting access to data. To do this, we'll define the relevant
197-
options on our Cube API instance:
185+
Cube can be configured to use industry-standard JSON Web Key Sets for
186+
securing its API and limiting access to data. To do this, we'll define the
187+
relevant options on our Cube API instance:
198188

199189
<WarningBox>
200190

@@ -235,9 +225,9 @@ services:
235225

236226
### <--{"id" : "Security"}--> Securing Cube Store
237227

238-
All Cube Store nodes (both router and workers) should only be accessible to Cube
239-
API instances and refresh workers. To do this with Docker Compose, we simply
240-
need to make sure that none of the Cube Store services have any exposed ports.
228+
All Cube Store nodes (both router and workers) should only be accessible to
229+
Cube API instances and refresh workers. To do this with Docker Compose, we
230+
simply need to make sure that none of the Cube Store services have any exposed
241231

242232
## Monitoring
243233

@@ -259,7 +249,7 @@ cubestore_router_1 | 2021-06-02 15:03:20,915 INFO [cubestore::metastore] Cre
259249
cubestore_router_1 | 2021-06-02 15:03:20,950 INFO [cubestore::cluster] Meta store port open on 0.0.0.0:9999
260250
cubestore_router_1 | 2021-06-02 15:03:20,951 INFO [cubestore::mysql] MySQL port open on 0.0.0.0:3306
261251
cubestore_router_1 | 2021-06-02 15:03:20,952 INFO [cubestore::http] Http Server is listening on 0.0.0.0:3030
262-
cube_1 | 🚀 Cube server (%CURRENT_VERSION) is listening on 4000
252+
cube_1 | 🚀 Cube API server (%CURRENT_VERSION) is listening on 4000
263253
cubestore_worker_2_1 | 2021-06-02 15:03:24,945 INFO [cubestore::cluster] Worker port open on 0.0.0.0:9001
264254
cubestore_worker_1_1 | 2021-06-02 15:03:24,830 INFO [cubestore::cluster] Worker port open on 0.0.0.0:9001
265255
```

0 commit comments

Comments
 (0)