Skip to content

Commit 7ecdbae

Browse files
committed
docs: Add a note on Cube version for auto-suspended instances
1 parent c998ac9 commit 7ecdbae

2 files changed

Lines changed: 8 additions & 4 deletions

File tree

docs/content/product/_meta.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
export default {
22
"introduction": "Introduction",
33
"getting-started": "Getting started",
4-
"configuration": "Data Sources",
4+
"configuration": "Configuration",
55
"data-modeling": "Data modeling",
66
"exploration": "Explore & Analyze",
77
"presentation": "Present & Share",

docs/content/product/administration/deployment/auto-suspension.mdx

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,15 +57,18 @@ from running.
5757
- [Monitoring integrations][ref-monitoring] are also suspended, which prevents
5858
the export of metrics and logs.
5959

60-
When a deployment is resumed from auto-suspension:
60+
When a deployment is [resumed](#resuming-a-suspended-deployment) from auto-suspension:
6161

6262
- [Data model][ref-data-model] compilation would need to be done from scratch.
6363
It applies to all tenants in case [multitenancy][ref-multitenancy] is set up.
64-
Consequently, one or more queries served after a deployment is resumed from
64+
Consequently, one or more requests served after a deployment is resumed from
6565
auto-suspension are likely to have suboptimal performance.
6666
- [Refresh worker][ref-refresh-worker] would need to refresh all
6767
pre-aggregations that became stale during the suspension, competing for the
6868
query queue with API instances and compromising the end-user experience.
69+
- Until the deployment is fully resumed, the requests will be served by transient,
70+
on-demand API instances with limited performance. There are no guarantees for the
71+
[version][ref-cube-version] of Cube these API instances will be running.
6972

7073
## Configuration
7174

@@ -120,4 +123,5 @@ response times to be significantly longer than usual.
120123
[ref-multitenancy]: /product/configuration/multitenancy
121124
[self-effects]: #effects-on-experience
122125
[ref-refresh-worker]: /product/deployment#refresh-worker
123-
[ref-sls]: /product/apis-integrations/semantic-layer-sync#on-schedule
126+
[ref-sls]: /product/apis-integrations/semantic-layer-sync#on-schedule
127+
[ref-cube-version]: /product/administration/deployment/deployments#cube-version

0 commit comments

Comments
 (0)