Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 71 additions & 0 deletions .cursor/rules/namings-rule.mdc
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,77 @@ alwaysApply: true
- **Production** — production deployment type (legacy: "Production cluster")
- **Multi-cluster** — multi-cluster production deployment type (legacy: "Production multi-cluster")

# Plan Tier Naming

Cube's commercial plan tiers, in order: **Free**, **Starter**, **Premium**,
**Enterprise**. **Enterprise is the top tier — nothing is above it.**

When describing plan availability:

- ✅ "Available on the [Enterprise plan]" (single tier, top of stack)
- ✅ "Available on [Premium and above plans]" (Premium + Enterprise)
- ✅ "Available on [Starter and above plans]" (Starter + Premium + Enterprise)
- ❌ Do **not** write "Enterprise and above plans" — there is nothing above
Enterprise. Use "Enterprise plan" (singular) instead.
- For Enterprise-only features that require an additional purchase, use
"Available as an add-on on the [Enterprise plan]".
- For features that depend on another add-on, name the dependency:
"Available on the [Enterprise plan] with the [Single-tenant infrastructure]
add-on."

## Plan availability callouts

Use Mintlify's `<Note>` (gray) component — **not** `<Info>` (blue) — for
plan-availability messages. `<Info>` is the catch-all blue callout used
heavily throughout the docs for general "by the way" notes; using a different
color for plan gating makes it visually distinct and scannable.

```mdx
<Note>

Available on the [Enterprise plan](https://cube.dev/pricing).

</Note>
```

Place the callout immediately after the section heading it applies to.

# Infrastructure Naming

Infrastructure options are a separate, orthogonal concept from deployment types.
A deployment of any type runs on top of one of these infrastructure options:

- **Multi-tenant infrastructure** — deployments share compute and network with
other customers. Legacy: "Shared infrastructure".
- **Single-tenant infrastructure** — deployments run in a dedicated VPC inside
a Cube Cloud account; not shared with any other customer. Legacy: "Dedicated
infrastructure".
- **Single-tenant infrastructure with CSPS** — same as single-tenant, but
data at-rest is stored in a customer-supplied object store. Legacy:
"Dedicated infrastructure with CSPS".
- **BYOC (Bring Your Own Cloud)** — Cube Cloud data plane is fully hosted in
the customer's cloud account.

Guidance:

- Always use **single-tenant** / **multi-tenant** in customer-facing prose,
headings, navigation labels, and card titles. These terms are an industry
standard and remove the naming collision with the **Shared** and **Dedicated**
deployment types.
- Do **not** rename URL anchors (`#shared-infrastructure`,
`#dedicated-infrastructure`, `#dedicated-infrastructure-with-csps`) or
internal link reference IDs (e.g., `[ref-dedicated-infra]`); keep these
stable so external inbound links keep working. Use Mintlify's explicit
anchor syntax (`## Single-tenant infrastructure {#dedicated-infrastructure}`)
to preserve them.
- Do **not** rename product/region identifier slugs that contain `shared`,
`dedicated`, or `byoc` (e.g., `aws-us-east-1-shared`, `aws-us-east-1-t-12345-prod`).
These are literal strings used by the product.
- Avoid bare adjectives like "dedicated infrastructure" when you mean a
Dedicated **deployment type** running on its own compute. Prefer phrases
like "compute dedicated to your deployment" to avoid implying single-tenant
infrastructure.

# Product Taxonomy
Make sure to use correct terms.

Expand Down
4 changes: 2 additions & 2 deletions docs-mintlify/admin/account-billing/budgets.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ As an account administrator, you can define rules which trigger notifications
when your account's usage exceeds a certain threshold. These rules are called
"budgets".

<Info>
<Note>

Available on [Premium and above plans](https://cube.dev/pricing).

</Info>
</Note>

<video width="100%" controls>
<source
Expand Down
10 changes: 5 additions & 5 deletions docs-mintlify/admin/account-billing/pricing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ account_:

| Resource type | CCUs per hour | Notes |
| --- | :---: | --- |
| [Dedicated infrastructure][ref-dedicated-infra] | 3 | — |
| [Single-tenant infrastructure][ref-dedicated-infra] | 3 | — |
| [Audit Log][ref-audit-log] | <nobr>4..6</nobr> | Depends on the [chosen tier](#audit-log-tiers) |

The following resource types incur cost and apply to the _whole Cube Cloud account_:
Expand All @@ -125,7 +125,7 @@ requests through [APIs & integrations][ref-apis] under the following tiers:

You can upgrade to a chosen tier in the
**Settings** of your deployment.
Upgrading to the M tier is only available on [Enterprise and above][cube-pricing] product tiers.
Upgrading to the M tier is only available on the [Enterprise][cube-pricing] product tier.

### Cube Store Worker tiers

Expand Down Expand Up @@ -207,7 +207,7 @@ increase it to continue using AI features.
The following examples provide insight into the total cost to use Cube Cloud:
- [Small-scale deployment](#small-scale-deployment) (Dedicated deployment, Premium product tier, S deployment tier).
- [Medium-scale deployment](#medium-scale-deployment) (Dedicated deployment with auto-scaling, Enterprise product tier, S deployment tier).
- [Large-scale deployment](#large-scale-deployment) (Multi-cluster deployment with dedicated infrastructure, Enterprise product tier, M deployment tier).
- [Large-scale deployment](#large-scale-deployment) (Multi-cluster deployment with single-tenant infrastructure, Enterprise product tier, M deployment tier).

### Small-scale deployment

Expand Down Expand Up @@ -267,7 +267,7 @@ its globally distributed workforce, customer base, and (or) partners to operate

This organization:
* Uses the Enterprise product tier of Cube Cloud.
* Uses [dedicated infrastructure][ref-dedicated-infra].
* Uses [single-tenant infrastructure][ref-dedicated-infra].
* Runs a Multi-cluster deployment that is active 24/7, includes 3 Dedicated deployments (M tier), with each
Dedicated deployment auto-scaling up to 10 API instances during a few peak hours every day.
* Operates on a large volume of data that requires the usage of 16 Cube Store Workers to run
Expand All @@ -280,7 +280,7 @@ of data engineers.

| Resource | Usage per month | CCU per month |
| ---------------------------------------------- | ---------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
| Dedicated infrastructure | 1 region ×<br/>24 hours per day ×<br/>30 days | 720 hours ×<br/>3 CCUs per hour =<br/>**2160 CCUs** |
| Single-tenant infrastructure | 1 region ×<br/>24 hours per day ×<br/>30 days | 720 hours ×<br/>3 CCUs per hour =<br/>**2160 CCUs** |
| Multi-cluster deployment | 3 Dedicated deployments ×<br/>24 hours per day ×<br/>30 days | 2160 hours ×<br/>8 CCUs per hour =<br/>**17280 CCUs** |
| Additional Cube API Instance | 3 Dedicated deployments ×<br/>(10 – 2) API Instances ×<br/>4 hours per day ×<br/>30 days | 2880 hours ×<br/>2 CCU per hour =<br/>**5760 CCUs** |
| Cube Store Worker | 1 Multi-cluster deployment ×<br/>16 Cube Store Workers ×<br/>12 hours per day ×<br/>30 days | 5760 hours ×<br/>1 CCU per hour =<br/>**5760 CCUs** |
Expand Down
4 changes: 2 additions & 2 deletions docs-mintlify/admin/ai/bring-your-own-model.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ sidebarTitle: Bring Your Own Model
description: Configure custom LLM providers for AI agents in Cube, including supported providers, setup, and billing implications.
---

<Info>
<Note>

Available on the [Enterprise plan](https://cube.dev/pricing).

</Info>
</Note>

Bring Your Own Model (BYOM) lets you connect your own LLM provider to power
AI agents in Cube, instead of using the built-in models. This gives you full
Expand Down
2 changes: 1 addition & 1 deletion docs-mintlify/admin/ai/memory-isolation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Even when using the SQL API or custom views, hidden members and non-public entit

### Optional Infrastructure Isolation

Many customers run in shared multi-tenant regions, but dedicated infrastructure and BYOC (Bring Your Own Cloud) variants are available. These provide stronger blast-radius isolation at the cluster, storage, and key-management levels.
Many customers run in multi-tenant regions, but single-tenant infrastructure and BYOC (Bring Your Own Cloud) variants are available. These provide stronger blast-radius isolation at the cluster, storage, and key-management levels.

## Practical Implications

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ the required fields:
</Frame>

Cube Cloud also supports connecting to data sources within private VPCs
if [dedicated infrastructure][ref-dedicated-infra] is used. Check out the
if [single-tenant infrastructure][ref-dedicated-infra] is used. Check out the
[VPC connectivity guide][ref-cloud-conf-vpc] for details.

[ref-dedicated-infra]: /docs/deployment/cloud/infrastructure#dedicated-infrastructure
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ The following fields are required when creating an AWS Redshift connection:
</Frame>

Cube Cloud also supports connecting to data sources within private VPCs
if [dedicated infrastructure][ref-dedicated-infra] is used. Check out the
if [single-tenant infrastructure][ref-dedicated-infra] is used. Check out the
[VPC connectivity guide][ref-cloud-conf-vpc] for details.

[ref-dedicated-infra]: /docs/deployment/cloud/infrastructure#dedicated-infrastructure
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ The following fields are required when creating a BigQuery connection:
</Frame>

Cube Cloud also supports connecting to data sources within private VPCs
if [dedicated infrastructure][ref-dedicated-infra] is used. Check out the
if [single-tenant infrastructure][ref-dedicated-infra] is used. Check out the
[VPC connectivity guide][ref-cloud-conf-vpc] for details.

[ref-dedicated-infra]: /docs/deployment/cloud/infrastructure#dedicated-infrastructure
Expand Down
4 changes: 2 additions & 2 deletions docs-mintlify/admin/connect-to-data/data-sources/ksqldb.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ description: ksqlDB is a purpose-built database for stream processing applicatio
[ksqlDB](https://ksqldb.io) is a purpose-built database for stream processing
applications, ingesting data from [Apache Kafka](https://kafka.apache.org).

<Info>
<Note>

Available on the [Enterprise plan](https://cube.dev/pricing).
[Contact us](https://cube.dev/contact) for details.

</Info>
</Note>

See how you can use ksqlDB and Cube Cloud to power real-time analytics in Power BI:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ description: "Microsoft Fabric is an all-in-one analytics solution for enterpris
enterprises. It offers a comprehensive suite of services, including a
data warehouse.

<Info>
<Note>

Available on the [Enterprise plan](https://cube.dev/pricing).
[Contact us](https://cube.dev/contact) for details.

</Info>
</Note>

## Setup

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ description: "SingleStore is a distributed SQL database that offers high-through
[SingleStore][link-singlestore] is a distributed SQL database that offers
high-throughput transactions (inserts and upserts) and low-latency analytics.

<Info>
<Note>

Available on the [Enterprise plan](https://cube.dev/pricing).
[Contact us](https://cube.dev/contact) for details.

</Info>
</Note>

## Setup

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ The following fields are required when creating a Snowflake connection:
</Frame>

Cube Cloud also supports connecting to data sources within private VPCs
if [dedicated infrastructure][ref-dedicated-infra] is used. Check out the
if [single-tenant infrastructure][ref-dedicated-infra] is used. Check out the
[VPC connectivity guide][ref-cloud-conf-vpc] for details.

[ref-dedicated-infra]: /docs/deployment/cloud/infrastructure#dedicated-infrastructure
Expand Down
58 changes: 29 additions & 29 deletions docs-mintlify/admin/connect-to-data/visualization-tools/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,33 +17,33 @@ page, please [file an issue](https://github.com/cube-js/cube/issues) on GitHub.
## BI & data exploration

<CardGroup cols={2}>
<Card title="Amazon QuickSight" img="https://static.cube.dev/icons/quicksight.svg" href="visualization-tools/quicksight">
<Card title="Amazon QuickSight" img="https://static.cube.dev/icons/quicksight.svg" href="/admin/connect-to-data/visualization-tools/quicksight">
</Card>
<Card title="Apache Superset" img="https://static.cube.dev/icons/superset.svg" href="visualization-tools/superset">
<Card title="Apache Superset" img="https://static.cube.dev/icons/superset.svg" href="/admin/connect-to-data/visualization-tools/superset">
</Card>
<Card title="Hashboard" img="https://static.cube.dev/icons/hashboard.svg" href="visualization-tools/hashboard">
<Card title="Hashboard" img="https://static.cube.dev/icons/hashboard.svg" href="/admin/connect-to-data/visualization-tools/hashboard">
</Card>
<Card title="Klipfolio" img="https://static.cube.dev/icons/klipfolio-light.svg" href="visualization-tools/klipfolio">
<Card title="Klipfolio" img="https://static.cube.dev/icons/klipfolio-light.svg" href="/admin/connect-to-data/visualization-tools/klipfolio">
</Card>
<Card title="Looker Studio" img="https://static.cube.dev/icons/looker.svg" href="visualization-tools/looker-studio">
<Card title="Looker Studio" img="https://static.cube.dev/icons/looker.svg" href="/admin/connect-to-data/visualization-tools/looker-studio">
</Card>
<Card title="Metabase" img="https://static.cube.dev/icons/metabase.svg" href="visualization-tools/metabase">
<Card title="Metabase" img="https://static.cube.dev/icons/metabase.svg" href="/admin/connect-to-data/visualization-tools/metabase">
</Card>
<Card title="Microsoft Power BI" img="https://static.cube.dev/icons/power-bi-dark.svg" href="visualization-tools/powerbi">
<Card title="Microsoft Power BI" img="https://static.cube.dev/icons/power-bi-dark.svg" href="/admin/connect-to-data/visualization-tools/powerbi">
</Card>
<Card title="Preset" img="https://static.cube.dev/icons/preset.svg" href="visualization-tools/superset">
<Card title="Preset" img="https://static.cube.dev/icons/preset.svg" href="/admin/connect-to-data/visualization-tools/superset">
</Card>
<Card title="Push.ai" img="https://static.cube.dev/icons/push-ai-light.svg" href="visualization-tools/push-ai">
<Card title="Push.ai" img="https://static.cube.dev/icons/push-ai-light.svg" href="/admin/connect-to-data/visualization-tools/push-ai">
</Card>
<Card title="Qlik Sense" img="https://static.cube.dev/icons/qlik-sense.svg" href="visualization-tools/qlik-sense">
<Card title="Qlik Sense" img="https://static.cube.dev/icons/qlik-sense.svg" href="/admin/connect-to-data/visualization-tools/qlik-sense">
</Card>
<Card title="Sigma" img="https://static.cube.dev/icons/sigma.svg" href="visualization-tools/sigma">
<Card title="Sigma" img="https://static.cube.dev/icons/sigma.svg" href="/admin/connect-to-data/visualization-tools/sigma">
</Card>
<Card title="Steep" img="https://static.cube.dev/icons/steep-light.svg" href="visualization-tools/steep">
<Card title="Steep" img="https://static.cube.dev/icons/steep-light.svg" href="/admin/connect-to-data/visualization-tools/steep">
</Card>
<Card title="Tableau" img="https://static.cube.dev/icons/tableau.svg" href="visualization-tools/tableau">
<Card title="Tableau" img="https://static.cube.dev/icons/tableau.svg" href="/admin/connect-to-data/visualization-tools/tableau">
</Card>
<Card title="ThoughtSpot" img="https://static.cube.dev/icons/thoughtspot.svg" href="visualization-tools/thoughtspot">
<Card title="ThoughtSpot" img="https://static.cube.dev/icons/thoughtspot.svg" href="/admin/connect-to-data/visualization-tools/thoughtspot">
</Card>
</CardGroup>

Expand All @@ -53,40 +53,40 @@ API](/reference/sql-api).
## Spreadsheets

<CardGroup cols={2}>
<Card title="Google Sheets" img="https://static.cube.dev/icons/google-sheets.svg" href="visualization-tools/google-sheets">
<Card title="Google Sheets" img="https://static.cube.dev/icons/google-sheets.svg" href="/admin/connect-to-data/visualization-tools/google-sheets">
</Card>
<Card title="Microsoft Excel" img="https://static.cube.dev/icons/excel.svg" href="visualization-tools/excel">
<Card title="Microsoft Excel" img="https://static.cube.dev/icons/excel.svg" href="/admin/connect-to-data/visualization-tools/excel">
</Card>
</CardGroup>

## Notebooks

<CardGroup cols={2}>
<Card title="Deepnote" img="https://static.cube.dev/icons/deepnote.svg" href="visualization-tools/deepnote">
<Card title="Deepnote" img="https://static.cube.dev/icons/deepnote.svg" href="/admin/connect-to-data/visualization-tools/deepnote">
</Card>
<Card title="Hex" img="https://static.cube.dev/icons/hex.svg" href="visualization-tools/hex">
<Card title="Hex" img="https://static.cube.dev/icons/hex.svg" href="/admin/connect-to-data/visualization-tools/hex">
</Card>
<Card title="Jupyter" img="https://static.cube.dev/icons/jupyter.svg" href="visualization-tools/jupyter">
<Card title="Jupyter" img="https://static.cube.dev/icons/jupyter.svg" href="/admin/connect-to-data/visualization-tools/jupyter">
</Card>
<Card title="Observable" img="https://static.cube.dev/icons/observable.svg" href="visualization-tools/observable">
<Card title="Observable" img="https://static.cube.dev/icons/observable.svg" href="/admin/connect-to-data/visualization-tools/observable">
</Card>
<Card title="Streamlit" img="https://static.cube.dev/icons/streamlit.svg" href="visualization-tools/streamlit">
<Card title="Streamlit" img="https://static.cube.dev/icons/streamlit.svg" href="/admin/connect-to-data/visualization-tools/streamlit">
</Card>
</CardGroup>

## Customer data platforms

<CardGroup cols={2}>
<Card title="Hightouch" img="https://static.cube.dev/icons/hightouch-dark.svg" href="visualization-tools/hightouch">
<Card title="Hightouch" img="https://static.cube.dev/icons/hightouch-dark.svg" href="/admin/connect-to-data/visualization-tools/hightouch">
</Card>
<Card title="RudderStack" img="https://static.cube.dev/icons/rudderstack.svg" href="visualization-tools/rudderstack">
<Card title="RudderStack" img="https://static.cube.dev/icons/rudderstack.svg" href="/admin/connect-to-data/visualization-tools/rudderstack">
</Card>
</CardGroup>

## Data governance

<CardGroup cols={2}>
<Card title="Databricks Unity Catalog" img="https://static.cube.dev/icons/databricks.svg" href="visualization-tools/unity-catalog">
<Card title="Databricks Unity Catalog" img="https://static.cube.dev/icons/databricks.svg" href="/admin/connect-to-data/visualization-tools/unity-catalog">
</Card>
</CardGroup>

Expand All @@ -96,20 +96,20 @@ The following tools deliver data insights closer to end users, e.g., by
providing a conversational interface for semantic layer:

<CardGroup cols={2}>
<Card title="LangChain" img="https://static.cube.dev/icons/langchain.svg" href="visualization-tools/langchain">
<Card title="LangChain" img="https://static.cube.dev/icons/langchain.svg" href="/admin/connect-to-data/visualization-tools/langchain">
</Card>
</CardGroup>

## Low-code tools

<CardGroup cols={2}>
<Card title="Appsmith" img="https://static.cube.dev/icons/appsmith.svg" href="visualization-tools/appsmith">
<Card title="Appsmith" img="https://static.cube.dev/icons/appsmith.svg" href="/admin/connect-to-data/visualization-tools/appsmith">
</Card>
<Card title="Bubble" img="https://static.cube.dev/icons/bubble.svg" href="visualization-tools/bubble">
<Card title="Bubble" img="https://static.cube.dev/icons/bubble.svg" href="/admin/connect-to-data/visualization-tools/bubble">
</Card>
<Card title="Budibase" img="https://static.cube.dev/icons/budibase.svg" href="visualization-tools/budibase">
<Card title="Budibase" img="https://static.cube.dev/icons/budibase.svg" href="/admin/connect-to-data/visualization-tools/budibase">
</Card>
<Card title="Retool" img="https://static.cube.dev/icons/retool.svg" href="visualization-tools/retool">
<Card title="Retool" img="https://static.cube.dev/icons/retool.svg" href="/admin/connect-to-data/visualization-tools/retool">
</Card>
</CardGroup>

Expand Down
Loading
Loading