Documentation
Deployment warm-up

Deployment warm-up

Deployment warm-up improves querying performance by executing time-consuming tasks after a Cube Cloud deployment is spun up but before it's exposed to requests from users.

Deployment warm-up is available in Cube Cloud on Starter and above (opens in a new tab) product tiers.

Deployment warm-up is only available for production cluster and production multi-cluster deployments.

There are two warm-up options:

Data model warm-up

By default, an API instance compiles the data model and stores results in the data model compilation cache when the first request hits that API instance. For multi-tenant configurations, a request from a particular tenant would only trigger the data model compilation for that tenant.

Depending on the complexity of the data model (i.e., the number of cubes, views, and their members) and the use of dynamic data models, its compilation might take from a few milliseconds to a few seconds.

Data-model warm-up will compile the data model before a Cube Cloud deployment is exposed to requests from users, making sure that they aren't affected by the data model compilation time.

If a data model warm-up takes more than 15 minutes, the deployment will be considered unhealthy and rolled back.

Configuring data model warm-up

To configure data model warm-up, navigate to Settings → Configuration and enable Warm-up data model before deploying API:

Pre-aggregation warm-up

By default, the refresh worker takes care of pre-aggregation refresh and runs pre-aggregation builds. When first requests hit API instances, it's possible that pre-aggregations would still be being built and users would need to wait or the completion of that process.

Depending on the volume of data and the configuration of pre-aggregations, their builds might take from seconds to minutes.

Pre-aggregation warm-up will refresh pre-aggregations before a Cube Cloud deployment is exposed to requests from users, making sure they aren't affected by the pre-aggregation build time.

If a pre-aggregation warm-up takes more than 24 hours, it will be cancelled. However, the deployment will still succeed.

Configuring pre-aggregation warm-up

To configure pre-aggregation warm-up, navigate to Settings → Configuration and enable Warm-up pre-aggregations before deploying API: