|
| 1 | +--- |
| 2 | +title: Auto-suspension |
| 3 | +permalink: /deployment/cloud/auto-suspension |
| 4 | +category: Deployment |
| 5 | +subCategory: Cube Cloud |
| 6 | +menuOrder: 3 |
| 7 | +--- |
| 8 | + |
| 9 | +<SuccessBox> |
| 10 | + |
| 11 | +Auto-suspension is available in Cube Cloud on |
| 12 | +[Starter and above tiers](https://cube.dev/pricing). |
| 13 | + |
| 14 | +</SuccessBox> |
| 15 | + |
| 16 | +Cube Cloud can automatically suspend deployments when not in use to prevent |
| 17 | +[resource consumption][ref-deployment-pricing] when infrastructure is not being |
| 18 | +actively used, which helps manage spend and preventing unnecessary quota use. |
| 19 | + |
| 20 | +This is useful for deployments that are not used 24/7, such as staging |
| 21 | +deployments. Auto-suspension will hibernate the deployment when **no** API requests |
| 22 | +are received after a period of time, and automatically resume the deployment |
| 23 | +when API requests start coming in again: |
| 24 | + |
| 25 | +<div style="text-align: center"> |
| 26 | + <img |
| 27 | + alt="Cube Cloud auto-suspend flowchart" |
| 28 | + src="https://ucarecdn.com/e9a22d59-e0af-40c5-b590-02f2566663d1/" |
| 29 | + style="border: none" |
| 30 | + width="100%" |
| 31 | + /> |
| 32 | +</div> |
| 33 | + |
| 34 | +[Development Instances][ref-deployment-dev-instance] are auto-suspended |
| 35 | +automatically when not in use for 10 minutes, whereas [Production |
| 36 | +Clusters][ref-deployment-prod-cluster] and [Production |
| 37 | +Multi-Clusters][ref-deployment-prod-multi-cluster] can auto-suspend after no API |
| 38 | +requests were received within a configurable time period. |
| 39 | + |
| 40 | +## Configuration |
| 41 | + |
| 42 | +To configure auto-suspension settings, navigate to the <Btn>Settings</Btn> screen |
| 43 | +in your deployment and click the <Btn>Configuration</Btn> tab, then ensure |
| 44 | +​<Btn>Enable Auto-suspend</Btn> is turned on: |
| 45 | + |
| 46 | +<Screenshot |
| 47 | + highlight="inset(40% 43% 50% 8% round 10px)" |
| 48 | + src="https://ucarecdn.com/5747b03a-d414-455e-a5bf-dbebc64d8ddf/" |
| 49 | +/> |
| 50 | + |
| 51 | +To configure how long Cube Cloud should wait before suspending the deployment, |
| 52 | +adjust <Btn>Auto-suspend threshold (minutes)</Btn> to the desired value and |
| 53 | +click <Btn>Apply</Btn>: |
| 54 | + |
| 55 | +<Screenshot |
| 56 | + highlight="inset(50% 43% 23% 8% round 10px)" |
| 57 | + src="https://ucarecdn.com/4aaa1b98-2af8-4ff9-84f6-e7b9c44c317a/" |
| 58 | +/> |
| 59 | + |
| 60 | +The Cube API instances will temporarily become unavailable while they are |
| 61 | +configured; this usually takes less than a minute. |
| 62 | + |
| 63 | +## Resuming a suspended deployment |
| 64 | + |
| 65 | +To resume a suspended deployment, send a query to Cube via either the API or |
| 66 | +the <Btn>Playground</Btn> screen in Cube Cloud. |
| 67 | + |
| 68 | +<InfoBox> |
| 69 | + |
| 70 | +Opening the deployment in Cube Cloud will also resume the deployment, this is |
| 71 | +because Cube Cloud sends API requests to fetch the deployment details. API |
| 72 | +requests sent to [Development Mode][ref-workspace-dev-api] will also resume the |
| 73 | +deployment. |
| 74 | + |
| 75 | +</InfoBox> |
| 76 | + |
| 77 | +Deployments typically resume in under 30 seconds, but can take significantly |
| 78 | +longer in certain situations depending on two major factors: |
| 79 | + |
| 80 | +- **Data model:** How many cubes and views are defined. |
| 81 | +- **Query complexity:** How complicated the queries being sent to the API are |
| 82 | + |
| 83 | +Complex data models take more time to compile, and complex queries can cause |
| 84 | +response times to be significantly longer than usual. |
| 85 | + |
| 86 | +[ref-deployment-dev-instance]: |
| 87 | + /cloud/configuration/deployment-types#development-instance |
| 88 | +[ref-deployment-prod-cluster]: |
| 89 | + /cloud/configuration/deployment-types#production-cluster |
| 90 | +[ref-deployment-prod-multi-cluster]: |
| 91 | + /cloud/configuration/deployment-types#production-multi-cluster |
| 92 | +[ref-deployment-pricing]: /cloud/pricing |
| 93 | +[ref-workspace-dev-api]: /cloud/workspace/development-api |
0 commit comments