Skip to content

Commit e480389

Browse files
authored
docs: rename deployment types shared dedicated (cube-js#10769)
* docs: rename deployment types to Shared and Dedicated Renames the Cube Cloud deployment types in the Mintlify docs: Development -> Shared (compute shared with other Cube customers) Production -> Dedicated (compute dedicated to your deployment) Multi-cluster keeps its short name; the legacy "Production multi-cluster" form becomes "Multi-cluster deployment" / "Dedicated multi-cluster" since multi-cluster scales Dedicated deployments. The canonical deployment-types page gets explicit heading IDs ({#shared}, {#dedicated}, {#multi-cluster}) and a brief high-level explanation of what "shared" vs "dedicated" means for compute, in the intro bullets and at the top of each section. All in-repo cross-references (pricing, deployment admin pages, monitoring, semantic-layer-sync, refreshing pre-aggregations) are updated to the new anchors. Internal markdown link-reference keys (e.g. ref-production-cluster) are kept as-is to minimize churn; only the URL fragments change. Out of scope: legacy /docs Next.js site, .cursor/rules/namings-rule.mdc, docs.json redirects, and the Contentful screenshots that still show the old names visually (alt text is updated). Made-with: Cursor * docs: clarify Shared deployment compute wording Per Pavel's feedback, "shared with other Cube customers" is inaccurate (in dedicated-infra setups it's only shared within the account) and uncomfortable for customers with dedicated infrastructure. Reword to "shared with other deployments within the selected region", which is accurate in both cases. Made-with: Cursor * docs: remove outdated screenshots and CLI deploy section - deployment-types.mdx: drop the three Settings screenshots; the surrounding instructions read fine without them. - continuous-deployment.mdx: drop the entire "Deploy with CLI" section (Manual Deploys + Continuous Deployment subsections, and the orphan ref-workspace-cli link); the CLI deploy flow is no longer recommended. Made-with: Cursor
1 parent 1f755a1 commit e480389

12 files changed

Lines changed: 131 additions & 226 deletions

File tree

docs-mintlify/admin/account-billing/pricing.mdx

Lines changed: 56 additions & 56 deletions
Large diffs are not rendered by default.

docs-mintlify/admin/deployment/auto-suspension.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ deployments**. See [effects on experience][self-effects] for details.
2323

2424
<Info>
2525

26-
Auto-suspension is not avaiable for [production multi-clusters][ref-prod-multi-cluster].
26+
Auto-suspension is not avaiable for [Multi-cluster deployments][ref-prod-multi-cluster].
2727

2828
</Info>
2929

@@ -35,9 +35,9 @@ deployment when API requests start coming in again:
3535
<img src="https://ucarecdn.com/e9a22d59-e0af-40c5-b590-02f2566663d1/" alt="Cube Cloud auto-suspend flowchart" />
3636
</Frame>
3737

38-
[Development instances][ref-deployment-dev-instance] are auto-suspended
39-
automatically when not in use for 30 minutes, whereas [production
40-
clusters][ref-deployment-prod-cluster] can auto-suspend after no API
38+
[Shared deployments][ref-deployment-dev-instance] are auto-suspended
39+
automatically when not in use for 30 minutes, whereas [Dedicated
40+
deployments][ref-deployment-prod-cluster] can auto-suspend after no API
4141
requests were received within a configurable time period.
4242

4343
During auto-suspension, resources are monitored in 5 minute intervals. This
@@ -114,9 +114,9 @@ longer in certain situations depending on two major factors:
114114
Complex data models take more time to compile, and complex queries can cause
115115
response times to be significantly longer than usual.
116116

117-
[ref-deployment-dev-instance]: /docs/deployment/cloud/deployment-types#development-instance
118-
[ref-deployment-prod-cluster]: /docs/deployment/cloud/deployment-types#production-cluster
119-
[ref-prod-multi-cluster]: /docs/deployment/cloud/deployment-types#production-multi-cluster
117+
[ref-deployment-dev-instance]: /docs/deployment/cloud/deployment-types#shared
118+
[ref-deployment-prod-cluster]: /docs/deployment/cloud/deployment-types#dedicated
119+
[ref-prod-multi-cluster]: /docs/deployment/cloud/deployment-types#multi-cluster
120120
[ref-deployment-pricing]: /admin/account-billing/pricing
121121
[ref-monitoring]: /admin/deployment/monitoring-integrations
122122
[ref-data-model]: /docs/data-modeling/overview

docs-mintlify/admin/deployment/continuous-deployment.mdx

Lines changed: 0 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -48,71 +48,3 @@ session prior to connecting to your GitHub account from Cube.
4848

4949
Cube Cloud will automatically deploy from the specified production branch
5050
(`master` by default).
51-
52-
## Deploy with CLI
53-
54-
<Warning>
55-
56-
Enabling this option will cause the **Data Model** page to display the
57-
last known state of a Git-based codebase (if available), instead of reflecting
58-
the latest modifications made. It is important to note that the logic will still
59-
be updated in both the API and the Playground.
60-
61-
</Warning>
62-
63-
You can use [the CLI][ref-workspace-cli] to set up continuous deployment for a
64-
Git repository. You can also use it to manually deploy changes without
65-
continuous deployment.
66-
67-
### Manual Deploys
68-
69-
You can deploy your Cube project manually. This method uploads data models and
70-
configuration files directly from your local project directory.
71-
72-
You can obtain a Cube Cloud deploy token from your
73-
deployment's **Settings** screen.
74-
75-
```bash
76-
npx cubejs-cli deploy --token TOKEN
77-
```
78-
79-
### Continuous Deployment
80-
81-
You can use Cube CLI with your continuous integration tool.
82-
83-
<Info>
84-
85-
You can use the `CUBE_CLOUD_DEPLOY_AUTH` environment variable to pass the Cube
86-
Cloud deploy token to Cube CLI.
87-
88-
</Info>
89-
90-
Below is an example configuration for GitHub Actions:
91-
92-
```yaml
93-
name: My Cube App
94-
on:
95-
push:
96-
paths:
97-
- "**"
98-
branches:
99-
- "master"
100-
jobs:
101-
deploy:
102-
name: Deploy My Cube App
103-
runs-on: ubuntu-latest
104-
timeout-minutes: 30
105-
steps:
106-
- name: Checkout
107-
uses: actions/checkout@v2
108-
- name: Use Node.js 20.x
109-
uses: actions/setup-node@v1
110-
with:
111-
node-version: 20.x
112-
- name: Install Cube backend server core
113-
run: npm i @cubejs-backend/server-core
114-
- name: Deploy to Cube Cloud
115-
run: npx cubejs-cli deploy --token ${{ secrets.CUBE_CLOUD_DEPLOY_AUTH }}
116-
```
117-
118-
[ref-workspace-cli]: /docs/workspace/cli

docs-mintlify/admin/deployment/deployment-types.mdx

Lines changed: 36 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -1,79 +1,72 @@
11
---
22
title: Deployment types
33
sidebarTitle: Deployment types
4-
description: "Cube provides three deployment types: Development, Production, and Multi-cluster."
4+
description: "Cube provides three deployment types: Shared, Dedicated, and Multi-cluster."
55
---
66

7-
* [Development](#development) — designed for development use cases.
8-
* [Production](#production) — designed for production workloads and
9-
high-availability.
7+
* [Shared](#shared) — designed for development use cases. Runs on compute
8+
shared with other deployments within the selected region.
9+
* [Dedicated](#dedicated) — designed for production workloads and
10+
high-availability. Runs on compute dedicated to your deployment.
1011
* [Multi-cluster](#multi-cluster) — designed for demanding production workloads,
1112
high-scalability, high-availability, and advanced multi-tenancy configurations.
13+
Runs on multiple Dedicated deployments.
1214

13-
## Development
15+
## Shared {#shared}
1416

1517
<Info>
1618

1719
Available for free, no credit card required. Your free trial is limited to 2
18-
development deployments and only 1,000 queries per day. Upgrade to
20+
Shared deployments and only 1,000 queries per day. Upgrade to
1921
[any paid plan](https://cube.dev/pricing) to unlock all features.
2022

2123
</Info>
2224

23-
<div style={{ textAlign: "center" }}>
24-
<img
25-
alt="High-level architecture diagram of a Development deployment"
26-
src="https://ucarecdn.com/adaa000a-c562-4eb4-9687-6f57f0f4c22b/"
27-
style={{ border: "none" }}
28-
width="100%"
29-
/>
30-
</div>
3125

32-
Development deployments are designed for development use cases only. This makes
26+
Shared deployments run on compute shared with other deployments within the
27+
selected region, which keeps the cost low but means resources aren't reserved
28+
for you exclusively.
29+
30+
Shared deployments are designed for development use cases only. This makes
3331
it easy to get started with Cube quickly, and also allows you to build and
3432
query pre-aggregations on-demand.
3533

36-
Development deployments don't have dedicated [refresh workers][ref-refresh-worker]
34+
Shared deployments don't have dedicated [refresh workers][ref-refresh-worker]
3735
and, consequently, they do not refresh pre-aggregations on schedule.
3836

39-
Development deployments do not provide high-availability nor do they guarantee
40-
fast response times. Development deployments also [auto-suspend][ref-auto-sus]
37+
Shared deployments do not provide high-availability nor do they guarantee
38+
fast response times. Shared deployments also [auto-suspend][ref-auto-sus]
4139
after 30 minutes of inactivity, which can cause the first request after the
4240
deployment wakes up to take additional time to process. They also have
4341
[limits][ref-limits] on the maximum number of queries per day and the maximum
44-
number of Cube Store Workers. We **strongly** advise not using a Development
42+
number of Cube Store Workers. We **strongly** advise not using a Shared
4543
deployment in a production environment, it is for testing and learning about
4644
Cube only and will not deliver a production-level experience for your users.
4745

48-
You can try a Development deployment by
46+
You can try a Shared deployment by
4947
[signing up for Cube](https://cubecloud.dev/auth/signup) to try it free
5048
(no credit card required).
5149

52-
## Production
50+
## Dedicated {#dedicated}
5351

5452
<Info>
5553

5654
Available on [all paid plans](https://cube.dev/pricing).
5755

5856
</Info>
5957

60-
<div style={{ textAlign: "center" }}>
61-
<img
62-
alt="High-level architecture diagram of a Production deployment"
63-
src="https://ucarecdn.com/fcb57d7a-09ee-4854-9282-db443a5ee61d/"
64-
style={{ border: "none" }}
65-
width="100%"
66-
/>
67-
</div>
6858

69-
Production deployments are designed to support high-availability production
59+
Dedicated deployments run on compute dedicated exclusively to your deployment,
60+
giving you predictable performance and full control over capacity.
61+
62+
Dedicated deployments are designed to support high-availability production
7063
workloads. It consists of several key components, including starting with 2 Cube
7164
API instances, 1 Cube Refresh Worker and 2 Cube Store Routers - all of which run
7265
on dedicated infrastructure. The deployment can automatically scale to meet the
7366
needs of your workload by adding more components as necessary; check the page on
7467
[scalability][ref-scalability] to learn more.
7568

76-
## Multi-cluster
69+
## Multi-cluster {#multi-cluster}
7770

7871
Multi-cluster deployments are designed for demanding production workloads,
7972
high-scalability, high-availability, and large [multi-tenancy][ref-multitenancy]
@@ -86,54 +79,38 @@ Available on [Premium and above plans](https://cube.dev/pricing).
8679
</Info>
8780

8881
It provides you with two options:
89-
* Scale the number of [Production](#production) deployments serving your
90-
workload, allowing to route requests over up to 10 production deployments and
82+
* Scale the number of [Dedicated](#dedicated) deployments serving your
83+
workload, allowing to route requests over up to 10 Dedicated deployments and
9184
up to 100 API instances.
9285
* Optionally, scale the number of Cube Store routers, allowing for increased
9386
Cube Store querying performance.
9487

95-
<div style={{ textAlign: "center" }}>
96-
<img
97-
alt="High-level architecture diagram of a Multi-cluster deployment"
98-
src="https://ucarecdn.com/0ab1eb5c-7aba-4e9c-8951-1998d4b714f0/"
99-
style={{ border: "none" }}
100-
width="100%"
101-
/>
102-
</div>
10388

104-
Each production deployment is billed separately, and all production deployments
89+
Each Dedicated deployment is billed separately, and all Dedicated deployments
10590
can use auto-scaling to match demand.
10691

10792
### Configuring Multi-cluster
10893

10994
To switch your deployment to Multi-cluster, navigate to
11095
**Settings → General**, select it under **Type**, and confirm
111-
with ****:
112-
113-
<Frame>
114-
<img src="https://ucarecdn.com/30e357ce-4252-4676-bb1d-e46eb1f753ef/" />
115-
</Frame>
96+
with ****.
11697

117-
To set the number of production deployments within your Multi-cluster
98+
To set the number of Dedicated deployments within your Multi-cluster
11899
deployment, navigate to **Settings → Configuration** and edit
119100
**Number of clusters**.
120101

121-
<Frame>
122-
<img src="https://ucarecdn.com/1da76aca-200a-410a-b84c-59b3d14ced9f/" />
123-
</Frame>
102+
### Routing traffic between Dedicated deployments
124103

125-
### Routing traffic between production deployments
126-
127-
Cube routes requests between multiple production deployments within a
104+
Cube routes requests between multiple Dedicated deployments within a
128105
Multi-cluster deployment based on [`context_to_app_id`][ref-ctx-to-app-id].
129106
In most cases, it should return an identifier that does not change over time
130107
for each tenant.
131108

132109
The following implementation will make sure that all requests from a
133-
particular tenant are always routed to the same production deployment. This
134-
approach ensures that only one production deployment keeps compiled data model
110+
particular tenant are always routed to the same Dedicated deployment. This
111+
approach ensures that only one Dedicated deployment keeps compiled data model
135112
cache for each tenant and serves its requests. It allows to reduce the
136-
footprint of the compiled data model cache on individual production deployments.
113+
footprint of the compiled data model cache on individual Dedicated deployments.
137114

138115
<CodeGroup>
139116

@@ -159,7 +136,7 @@ module.exports = {
159136

160137
If your implementation of `context_to_app_id` returns identifiers that change
161138
over time for each tenant, requests from one tenant would likely hit multiple
162-
production deployments and you would not have the benefit of reduced memory
139+
Dedicated deployments and you would not have the benefit of reduced memory
163140
footprint. Also you might see 502 or timeout errors in case of different
164141
deployment nodes would return different `context_to_app_id` results for the
165142
same request.
@@ -169,11 +146,7 @@ same request.
169146
## Switching between deployment types
170147

171148
To switch a deployment's type, go to the deployment's **Settings** screen
172-
and select from the available options:
173-
174-
<Frame>
175-
<img src="https://ucarecdn.com/fbde6a1e-734a-4091-8edd-922dc1ee7e1c/" alt="Deployment Settings page showing Development, Production, and Multi-cluster options" />
176-
</Frame>
149+
and select from the available options.
177150

178151
[ref-ctx-to-app-id]: /reference/configuration/config#context_to_app_id
179152
[ref-limits]: /docs/deployment/cloud/limits#resources

docs-mintlify/admin/deployment/environments.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ The production environment is _always available_ unless [suspended][ref-suspend]
2525
### Resources and costs
2626

2727
Depending on the [deployment type][ref-deployment-types], the production environment
28-
either runs on a development instance or on a production cluster with [multiple API
28+
either runs on a Shared deployment or on a Dedicated deployment with [multiple API
2929
instances][ref-api-instance-scalability], incurring [relevant
3030
costs][ref-pricing-deployment-tiers].
3131

@@ -59,7 +59,7 @@ regardless of user activity.
5959

6060
### Resources and costs
6161

62-
Staging environments run on development instances, incurring [relevant
62+
Staging environments run on Shared deployments, incurring [relevant
6363
costs][ref-pricing-deployment-tiers]. However, they automatically suspend after 10 minutes
6464
of inactivity, regardless of the [availability](#availability) setting, so you are only
6565
charged for the time when staging environments are being used.
@@ -83,7 +83,7 @@ development mode. Otherwise, queries to this environment will fail.
8383

8484
### Resources and costs
8585

86-
Development environments run on development instances, incurring [relevant
86+
Development environments run on Shared deployments, incurring [relevant
8787
costs][ref-pricing-deployment-tiers]. However, they automatically suspend after 10 minutes
8888
of inactivity, so you are only charged for the time when development environments are
8989
being used.

docs-mintlify/admin/deployment/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -173,8 +173,8 @@ Cube Cloud deployments only consume resources when they are needed to run worklo
173173

174174
* For the [production environment][ref-environments-prod], resources are always consumed
175175
unless a deployment is [suspended][ref-auto-sus].
176-
* For any other [environment][ref-environments], a development instance is allocated
177-
while it's active. After a period of inactivity, the development instance is deallocated.
176+
* For any other [environment][ref-environments], a Shared deployment is allocated
177+
while it's active. After a period of inactivity, the Shared deployment is deallocated.
178178
* For pre-aggregations, Cube Store workers are allocated while there's some
179179
activity related to pre-aggregations, e.g., API endpoints are serving
180180
requests to pre-aggregations, pre-aggregations are being built, etc.

docs-mintlify/admin/deployment/limits.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ types][ref-deployment-types] and [product tiers][ref-pricing]:
2929
| Number of deployments | 2 | Unlimited | Unlimited | Unlimited |
3030
| Number of API instances per deployment | 1 | 10 | 10 | [Contact us][cube-contact-us] |
3131
| Number of Cube Store workers per deployment | 2 | 16 | 16 | [Contact us][cube-contact-us] |
32-
| Queries per day for each [development instance][ref-dev-instance] | 1,000 | 10,000 | Unlimited | Unlimited |
33-
| Queries per day for each [production cluster][ref-prod-cluster] || 50,000 | Unlimited | Unlimited |
32+
| Queries per day for each [Shared deployment][ref-dev-instance] | 1,000 | 10,000 | Unlimited | Unlimited |
33+
| Queries per day for each [Dedicated deployment][ref-prod-cluster] || 50,000 | Unlimited | Unlimited |
3434
| [Query History][ref-query-history] — retention period | 1 day | Depends on the [tier][ref-query-history-tiers] | Depends on the [tier][ref-query-history-tiers] | Depends on the [tier][ref-query-history-tiers] |
3535
| [Query History][ref-query-history] — queries processed per day for each deployment | 1,000 | Depends on the [tier][ref-query-history-tiers] | Depends on the [tier][ref-query-history-tiers] | Depends on the [tier][ref-query-history-tiers] |
3636
| [Audit Log][ref-audit-log] — retention period |||| 30 days |
@@ -58,7 +58,7 @@ This is a hard limit. Usage is calculated per Cube Cloud account, i.e., in total
5858
for all deployments within an account.
5959

6060
When a threshold is hit, further queries will not be processed. In that case,
61-
consider upgrading a development instance to a production cluster.
61+
consider upgrading a Shared deployment to a Dedicated deployment.
6262
Alternatively, consider upgrading to [another tier][ref-pricing].
6363

6464
### Queries processed by Query History per day
@@ -101,8 +101,8 @@ response.
101101
[ref-pricing]: /admin/account-billing/pricing
102102
[ref-query-history]: /admin/monitoring/query-history
103103
[ref-monitoring-integrations]: /admin/deployment/monitoring-integrations
104-
[ref-dev-instance]: /docs/deployment/cloud/deployment-types#development-instance
105-
[ref-prod-cluster]: /docs/deployment/cloud/deployment-types#production-cluster
104+
[ref-dev-instance]: /docs/deployment/cloud/deployment-types#shared
105+
[ref-prod-cluster]: /docs/deployment/cloud/deployment-types#dedicated
106106
[cube-contact-us]: https://cube.dev/contact
107107
[ref-query-history-tiers]: /admin/account-billing/pricing#query-history-tiers
108108
[ref-audit-log]: /admin/monitoring/audit-log

docs-mintlify/admin/deployment/scalability.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,17 @@ description: Tune Cube Cloud throughput and pre-aggregation capacity by scaling
55

66
Cube Cloud also allows adding additional infrastructure to your deployment to
77
increase scalability and performance beyond what is available with each
8-
Production Deployment.
8+
Dedicated deployment.
99

1010
## Auto-scaling of API instances
1111

12-
With a Production Cluster, 2 Cube API Instances are included. That said, it
12+
With a Dedicated deployment, 2 Cube API Instances are included. That said, it
1313
is very common to use more, and [additional API instances][ref-limits] can be
1414
added to your deployment to increase the throughput of your queries. A rough
1515
estimate is that 1 Cube API Instance is needed for every 5-10
1616
requests-per-second served. Cube API Instances can also auto-scale as needed.
1717

18-
To change how many Cube API instances are available in the Production Cluster,
18+
To change how many Cube API instances are available in the Dedicated deployment,
1919
go to the deployment’s **Settings** screen, and open
2020
the **Configuration** tab. From this screen, you can set the minimum and
2121
maximum number of Cube API instances for a deployment:

0 commit comments

Comments
 (0)