> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cube.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> Introduces Cube deployments and how to browse, create, and operate the environments that run your semantic layer.

Deployments are top-level entities in Cube Cloud. They include the source
code, configuration, allocated resources, API endpoints and essentially
do all the heavy lifting, running workloads and fulfilling requests.

## List of deployments

Each account in Cube can have multiple deployments. To see the list of
deployments, click **Admin** at the bottom of the sidebar, then
click **Deployments**.

With more than one deployment, an admin can pin one as the account-wide default from its
row's **⋯** menu (**Set as default** / **Remove as default**). This is what a user
lands on when they open Cube without a deployment in the URL and haven't set their own
[default deployment](https://docs.cube.dev/docs/preferences.md#default-deployment) or previously switched deployments.

## Creating a new deployment

Creating a new deployment is an essential prerequisite to running a Cube
project in Cube Cloud.

After you've created your [Cube Cloud account][cube-cloud-signup],
click **Create deployment** in the top-right corner of your
list of deployments to jump into the wizard. Watch the following video for
guidance on the rest of the steps:

[YouTube video](https://www.youtube-nocookie.com/embed/HVZ4ytDEjqc)

All deployments within a Cube Cloud account should have unique names.

> [!TIP]
>
> **Let a coding agent configure Cube for you.** On the **Get started with
> Cube** page, which Cube shows while your account has no deployments,
> find **Or let your agent configure Cube** and copy the agent prompt into a
> coding agent such as Claude Code or Cursor. The agent installs the
> \[Cube CLI]\[ref-cli] and follows the steps of
> \[`cube onboarding`]\[ref-cli-onboarding]. Click **Connect MCP** in the same
> section to also connect the \[MCP server]\[ref-mcp-server], so that the agent
> can query your data.

## Demo deployments

After you've created your [Cube Cloud account][cube-cloud-signup] and
proceeded to create a new deployment, you would be prompted to set up a
connection to your [data source][ref-data-source].

If, for any reason, you're not ready or unable to connect your staging or
production data source at the moment, you can click **Create a demo
deployment** in the yellow box:

![](https://ucarecdn.com/559aeebe-d20f-4510-a22c-62532b59cbcc/)

Shortly, Cube Cloud will create and pre-configure a new deployment in your
account. You will see it as **Demo deployment** in the list of
deployments. This new deployment will be:

* Configured to use [DuckDB][ref-duckdb] as the data source.
* Provided with a sample [data model][ref-data-model] backed with CSV files
  in a public S3 bucket.
* Provided with an example of [dynamic data modeling][ref-dynamic-data-models]
  and programmatic [configuration options][ref-config-options].

Watch the following video to for a step-by-step walkthrough:

[YouTube video](https://www.youtube-nocookie.com/embed/XeaZPUQRC8M)

Exploring the demo deployment is a great way to understand how Cube works.
Use the [data model editor][ref-data-model] to review the data model and
make sure to run a few queries in [Playground][ref-playground].

## Deployment status

The **Status** page of each deployment provides a high-level summary of its
components and state. To open it, click **Monitoring** in the sidebar, then
click **Status**. The page has three sections:

* **Integrations** shows the number of API requests in the last 24 hours and
  the status of each API. Click **API credentials** to get the API endpoints
  and connection instructions.
* **Resources & logs** shows the resources allocated in line with the
  [deployment type][ref-deployment-types], with links to their logs.
* **Activity log** shows the most recent events, such as builds and changes to
  the deployment settings. Click **View all** to see the full log.

### Activity log

Each build is shown as **Build #N** with a status icon, the user who triggered
it, and the time when it started. The icon shows whether the build is scheduled
or in progress, [warming up pre-aggregations][ref-warmup], successful, failed,
or cancelled because a newer build replaced it. Click a build to see its logs.

A build of a deployment connected to a Git repository also shows the first 8
characters of the commit SHA and the commit message. To find out which commit
your deployment runs, check the build number in the header of the **Resources &
logs** section, then find that build in the activity log. A build deployed with
the [Cube CLI][ref-cli] shows **Deployed using CLI** instead of a commit.

## Deployment settings

You can manage various settings of a deployment, such as [environment
variables](#environment-variables), by navigating to the **Settings** page of the
deployment.

### Environment variables

You can configure environment variables by navigating to **Settings → Environment
variables** where you can add, edit, or remove environment variables for your
deployment.

For convenience, environment variables are split into two lists: ones that relate to
the [data source][ref-data-sources] configuration and all other variables.
Browsing environment variables is reflected in the [Audit Log][ref-audit-log].

![](https://ucarecdn.com/e7d6cbc3-ed83-492c-9376-dee501ae747a/)

## Cube version

Each [environment][ref-environments] within a Cube Cloud deployment runs a specific
version of Cube that depends on the environment type and the selected [update
channel](#update-channels).

### Current version

You can check the current version of Cube that your deployment runs by navigating to
**Settings → General** and looking at the **Version** field.

### Update channels

Cube Cloud provides two update channels:

* **LTS channel** for infrequent [long-term support][ref-lts] releases with
  critical fixes.
* **Regular channel** for regular releases, which occur more frequently and
  contain both fixes and new features.

You can view or change the update channel by navigating to **Settings → General**
and using the **Update channel** field:

![](https://ucarecdn.com/3ef5fa36-4b27-437c-aa70-dbc0aa01255d/-/format/auto/)

You can select a specific version in the **Version** drop-down. Only versions that have been used by
a deployment during the last 6 months are available in the list.

There's an **Auto-upgrade** option to automatically upgrade to new patch versions, which is
available for both update channels. When it's turned on, an upgrade will occur if a new
[patch version][link-semver] is available in the selected channel. To trigger an upgrade,
deploy a new build to the [production environment][ref-environments-prod] or change its
settings, e.g., by updating environment variables of the Cube Cloud deployment.

Generally, it's recommended to use the *regular channel* to get the latest updates.
You can *pin the version* to a specific one by turning the **Auto-upgrade** toggle off.

If you choose to pin the version, make sure to upgrade periodically, especially when the
next [minor version][ref-distribution-versions] is released. If you use the *LTS channel*,
make sure to upgrade to the latest [LTS version][ref-lts] every few months.

### Changing the version

When you select a different version and save the settings, Cube redeploys the
current build on the new version. It does not start a new build.

The change is shown in the [activity log](#activity-log) as **Cube version update**,
with the previous and the new version. The time of this entry is when the version was
changed, not when the deployment started to serve requests on the new version.

On [Dedicated][ref-deployment-types-dedicated] and
[Multi-cluster][ref-deployment-types-multi-cluster] deployments, instances that run the
previous version keep serving API requests until instances that run the new version
are ready.

## Resource consumption

Cube Cloud deployments only consume resources when they are needed to run workloads:

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

Please refer to [pricing][ref-pricing] to learn how many CCUs each resource
consumes.

[cube-cloud-signup]: https://cubecloud.dev/auth/signup

[ref-deployment-types]: https://docs.cube.dev/admin/deployment/deployment-types.md

[ref-deployment-types-dedicated]: https://docs.cube.dev/admin/deployment/deployment-types.md#dedicated

[ref-deployment-types-multi-cluster]: https://docs.cube.dev/admin/deployment/deployment-types.md#multi-cluster

[ref-warmup]: https://docs.cube.dev/admin/deployment/warm-up.md#pre-aggregation-warm-up

[ref-auto-sus]: https://docs.cube.dev/admin/deployment/auto-suspension.md

[ref-pricing]: https://docs.cube.dev/admin/account-billing/pricing.md#resources

[ref-data-source]: https://docs.cube.dev/admin/connect-to-data/data-sources

[ref-duckdb]: https://docs.cube.dev/admin/connect-to-data/data-sources/duckdb.md

[ref-data-model]: https://docs.cube.dev/docs/data-modeling/overview.md

[ref-dynamic-data-models]: https://docs.cube.dev/docs/data-modeling/dynamic

[ref-config-options]: https://docs.cube.dev/admin/connect-to-data.md#configuration-options

[ref-data-model]: https://docs.cube.dev/docs/data-modeling/data-model-ide.md

[ref-playground]: https://docs.cube.dev/docs/explore-analyze/playground

[ref-cli]: https://docs.cube.dev/reference/cli.md

[ref-cli-onboarding]: https://docs.cube.dev/reference/cli.md#onboarding

[ref-mcp-server]: https://docs.cube.dev/docs/integrations/mcp-server.md

[ref-environments]: https://docs.cube.dev/admin/deployment/environments.md

[ref-environments-prod]: https://docs.cube.dev/admin/deployment/environments.md#production-environment

[ref-lts]: https://docs.cube.dev/admin/account-billing/distribution#long-term-support

[link-semver]: https://semver.org

[ref-data-sources]: https://docs.cube.dev/admin/connect-to-data/data-sources

[ref-audit-log]: https://docs.cube.dev/admin/monitoring/audit-log.md

[ref-distribution-versions]: https://docs.cube.dev/admin/account-billing/distribution#versions


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.