Skip to content

Commit 6135ae6

Browse files
hassankhanhassankhan
committed
docs(cloud): improve documentation about Cube Cloud deployment types
1 parent 07e6fa7 commit 6135ae6

File tree

1 file changed

+149
-12
lines changed

1 file changed

+149
-12
lines changed

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

Lines changed: 149 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,157 @@ category: Configuration
55
menuOrder: 2
66
---
77

8-
Cube Cloud deployment type determines the features, scalability, and
9-
availability of your deployment.
8+
## Pricing
109

11-
## Single Instance Deployments
10+
Cube Cloud pricing is based on consumption of compute power which we measure
11+
using Cube Compute Units. The units are priced based on which subscription plan
12+
you have chosen. Each plan has different features and functionality that you
13+
should review as you think about what is right for your business.
1214

13-
Single Instance deployments are designed for development use-cases only.
14-
If not used for over an hour, it'll take additional time to process the first request.
15-
Refresh Worker is active only when a Single Instance serves the workload.
15+
<InfoBox heading="What's a Cube Compute Unit?">
1616

17-
## Cluster Deployments
17+
A **Cube Compute Unit** is a way to measure compute power used to run Cube Cloud
18+
infrastructure. The price of a compute unit is determined by the Cube Cloud plan
19+
you're subscribed to.
1820

19-
Cluster deployments are designed for production workload. Cluster deployment
20-
includes the following components:
21+
</InfoBox>
2122

22-
- Cube API instances
23-
- Cube Refresh Workers
24-
- Redis for Cache and Queue
23+
| Node Type | Compute Unit per hour |
24+
| ------------------------- | :-------------------: |
25+
| Cube Production Cluster | `4` |
26+
| Cube Development Instance | `1` |
27+
| Cube Store Worker | `1` |
28+
| Cube API Instance | `1` |
29+
30+
Cube Cloud has four subscription plans that you can review on
31+
[the main website](https://cube.dev/pricing). The subscription plan you choose
32+
will determine the price per Cube Compute Unit (CCU). Each subscription plan
33+
determines the features, scalability, availability, as well as the speed and
34+
scope of support you may receive for your deployment.
35+
36+
## Development Instance
37+
38+
<InfoBox>
39+
40+
You can try a Development Instance for free - no credit card required. Your free
41+
trial is limited to 2 development instances and only 1,000 API requests per day.
42+
43+
</InfoBox>
44+
45+
Development Instances are designed for development use-cases only. This makes it
46+
easy to get started with Cube Cloud quickly, and also allows you to build and
47+
query pre-aggregations on-demand.
48+
49+
Development Instances do not provide high-availability nor do they guarantee
50+
fast response times. Development Instances also hibernate after 60 minutes of
51+
inactivity, which can cause the first request after hibernation to take
52+
additional time to process. They also have a 10,000 requests per day limit. We
53+
**strongly** advise not using a development instance in a production
54+
environment, it is for testing and learning about Cube only and will not deliver
55+
a production-level experience for your users.
56+
57+
You can try a Cube Cloud development instance by
58+
[signing up for Cube Cloud](https://cubecloud.dev/auth/signup) to try it free
59+
(no credit card required).
60+
61+
## Production Cluster
62+
63+
Production Clusters are designed to support high-availability production
64+
workloads. It consists of several key components, including starting with 2 Cube
65+
API instances, 1 Cube Refresh Worker and 2 Cube Store Routers - all of which run
66+
on dedicated infrastructure. The cluster can automatically scale to meet the
67+
needs of your workload by adding more components as necessary; check the
68+
[Limits section](#limits) below.
69+
70+
## Production Multi-Cluster
71+
72+
<InfoBox>
73+
74+
This deployment type is only available on **Enterprise Premier** plans. Please
75+
[contact our sales team](https://cube.dev/contact) if interested.
76+
77+
</InfoBox>
78+
79+
The Enterprise Premier version of Cube Cloud also makes it easy to deploy
80+
Production Multi-Clusters, which allows for larger amounts of data as well as
81+
load balancing for multi-tenant deployments with over 1,000 tenants. Each
82+
additional cluster is charged separately, and all clusters can use auto-scaling
83+
to match demand.
84+
85+
Cube Cloud routes traffic between the Production Clusters based on
86+
[`contextToAppId()`][ref-conf-ref-ctx-to-app-id].
87+
88+
## Limits
89+
90+
Cube Cloud also allows adding additional infrastructure to your deployment to
91+
increase scalability and performance beyond what is available with each
92+
Production Deployment.
93+
94+
### Cube Store Worker
95+
96+
| | Free Tier | Starter | Premium | Enterprise | Enterprise Premier |
97+
| ----------------------- | :-------: | :-----: | :-----: | :--------: | :----------------: |
98+
| Storage size per worker | N/A | 150GB | 150GB | 150GB | Custom |
99+
100+
Cube Store Workers are used to build and persist pre-aggregations. Each Worker
101+
has a maximum of 150GB of storage; additional Cube Store workers can be added to
102+
your deployment to both increase storage space and improve pre-aggregation
103+
performance. A minimum of 2 Cube Store Workers is required for pre-aggregations;
104+
this can be adjusted. For a rough estimate, it will take approximately 2 Cube
105+
Store Workers per 4 gigs of pre-aggregated data per day.
106+
107+
To change the number of Cube Store Workers in a deployment, go to the
108+
deployment’s Settings page, and open the Configuration tab. From this screen,
109+
you can set the number of Cube Store Workers from the dropdown:
110+
111+
<div style="text-align: center">
112+
<img
113+
alt="Cube Cloud Deployment Settings page showing auto-scaling configuration options"
114+
src="https://ucarecdn.com/3b39c56f-d553-4612-b4f0-07084cc4b742/"
115+
style="border: none"
116+
width="100%"
117+
/>
118+
</div>
119+
120+
### Cube API Instance
121+
122+
| | Free Tier | Starter | Premium | Enterprise | Enterprise Premier |
123+
| -------------------- | :-------: | :-----: | :-------: | :--------: | :----------------: |
124+
| API requests per day | 1,000 | 200,000 | Unlimited | Unlimited | Unlimited |
125+
126+
With a Production Deployment, 2 Cube API Instances are included. That said, it
127+
is very common to use more, and additional Cube API instances can be added to
128+
your deployment to increase the throughput of your queries. A rough estimate is
129+
that 1 Cube API Instance is needed for every 5-10 requests-per-second served.
130+
Cube API Instances can also auto-scale as needed.
131+
132+
To change how many Cube API instances are available in the Production Cluster,
133+
go to the deployment’s Settings page, and open the Configuration tab. From this
134+
screen, you can set the minimum and maximum number of Cube API instances for a
135+
deployment:
136+
137+
<div style="text-align: center">
138+
<img
139+
alt="Cube Cloud Deployment Settings page showing auto-scaling configuration options"
140+
src="https://ucarecdn.com/3b39c56f-d553-4612-b4f0-07084cc4b742/"
141+
style="border: none"
142+
width="100%"
143+
/>
144+
</div>
145+
146+
## Switching between deployment types
147+
148+
To switch a deployment's type, go to the deployment's settings page and select
149+
from the available options:
150+
151+
<div style="text-align: center">
152+
<img
153+
alt="Cube Cloud Deployment Settings page showing Development Instance, Production Cluster, and Production Multi-Cluster options"
154+
src="https://ucarecdn.com/fbde6a1e-734a-4091-8edd-922dc1ee7e1c/"
155+
style="border: none"
156+
width="100%"
157+
/>
158+
</div>
159+
160+
[cube-blog-replace-redis]: https://cube.dev/blog/replacing-redis-with-cube-store
161+
[ref-conf-ref-ctx-to-app-id]: /config#options-reference-context-to-app-id

0 commit comments

Comments
 (0)