diff --git a/docs/content/product/administration/workspace/_meta.js b/docs/content/product/administration/workspace/_meta.js index 8b3e2146fb8e5..20a6bdacb43f5 100644 --- a/docs/content/product/administration/workspace/_meta.js +++ b/docs/content/product/administration/workspace/_meta.js @@ -21,5 +21,9 @@ export default { title: "Semantic Catalog", display: "hidden" }, + "maintenance-window": { + title: "Maintenance window", + display: "hidden" + }, "recipes": "Recipes", } diff --git a/docs/content/product/administration/workspace/maintenance-window.mdx b/docs/content/product/administration/workspace/maintenance-window.mdx new file mode 100644 index 0000000000000..f85db79c10b37 --- /dev/null +++ b/docs/content/product/administration/workspace/maintenance-window.mdx @@ -0,0 +1,98 @@ +# Maintenance window + +Cube Cloud can apply platform updates to your infrastructure during a +scheduled weekly time slot instead of immediately as they are released. +This gives you control over **when** updates happen, reducing the risk +of unexpected changes during peak hours. + + + +Maintenance window is available for deployments with +[dedicated infrastructure][ref-dedicated] on +[Enterprise and above plans](https://cube.dev/pricing). + + + +## How it works + +Cube Cloud automatically takes daily snapshots of all current service +versions. Each snapshot captures a consistent, known-good combination +of service versions at that point in time. + +A snapshot must be at least **24 hours old** before it becomes eligible +for deployment. This ensures that only versions confirmed stable in +production are promoted to tenants with a maintenance window enabled. + +During the configured maintenance window, the system automatically +advances your deployment to the latest eligible snapshot. Outside of the +window, no updates are applied. + + + +You do not choose specific versions. The system manages version +progression automatically — the maintenance window only controls +**when** the update happens. + + + +## What gets updated + +The maintenance window applies to all Cube Cloud services for your +deployment, including: + +- **Control-plane services** — the infrastructure serving the Cube Cloud + UI, API, and orchestration. +- **Data-plane services** — the infrastructure responsible for query + execution, builds, and worker lifecycle in dedicated regions. + +Both control-plane and data-plane services are updated to the same +snapshot during the window. + +## Configuration + +Navigate to Admin → Settings → Maintenance Window in the Cube Cloud +console. + + + +1. Toggle **Enable Scheduled Maintenance Window** to on. +2. Select the **Day of week** (e.g., Sunday). +3. Select the **Time (UTC)** — the hour when the update window opens + (e.g., 02:00 UTC). + +Settings are saved automatically. + + + +The maintenance window spans **one hour** starting from the selected +time. For example, selecting 02:00 means updates may be applied between +02:00 and 02:59 UTC on the selected day. + + + +When you enable the maintenance window for the first time, the day +defaults to **Sunday** and the time defaults to **02:00 UTC**. +Your deployment is immediately assigned the latest eligible snapshot +so that it starts from a known, stable version. + +## FAQ + +### What happens if I disable the maintenance window? + +Your deployment returns to the default behavior — receiving updates +immediately as they are released. + +### What if no new snapshot is available during my maintenance window? + +Nothing happens. The system only advances your deployment if a newer +eligible snapshot exists. If you are already on the latest eligible +snapshot, the maintenance window is a no-op. + +### How far behind the latest release will my services be? + +At most, your services will be behind by the interval between your +maintenance windows (typically one week) plus the 24-hour eligibility +buffer. For example, with a Sunday 02:00 UTC window, your services +could be up to ~8 days behind the latest release in the worst case. + +[ref-dedicated]: /product/deployment/cloud/deployment-types#production-cluster