Skip to content

docs: Update regarding update channels #9394

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
igorlukanin merged 1 commit into from
Mar 26, 2025
Merged

docs: Update regarding update channels #9394

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 19 additions & 7 deletions docs/pages/product/deployment/cloud/deployments.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,19 +96,29 @@ navigating to <Btn>Overview → Resources & Logs → Cube API</Btn>:

Cube Cloud provides two update channels:

* **Stable channel.** You should manually update the deployment to one of
available stable versions.
* **Latest channel.** On each build, the deployment is automatically updated
to the most up-to-date version of Cube.
* <Btn>LTS channel</Btn> for infrequent [long-term support][ref-lts] releases with
critical fixes.
* <Btn>Regular channel</Btn> 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 <Btn>Settings →
General → Cube version</Btn>:

<Screenshot
src="https://ucarecdn.com/b6ddfc8f-ee37-4b75-8108-ba12c020a9f6/"
highlight="inset(53.75% 42.5% 11.25% 20% round 10px)"
src="https://ucarecdn.com/3ef5fa36-4b27-437c-aa70-dbc0aa01255d/"
highlight="inset(36% 41% 34% 21% round 10px)"
/>

There's an option to <Btn>Upgrade automatically to new patch versions</Btn>, 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 <Btn>Upgrade automatically...</Btn>
toggle off.

## Resource consumption

Cube Cloud deployments only consume resources when they are needed to run workloads:
Expand Down Expand Up @@ -139,4 +149,6 @@ resource consumption in different scenarios.
[ref-data-model]: /product/workspace/data-model
[ref-playground]: /product/workspace/playground
[ref-environments]: /product/workspace/environments
[ref-environments-prod]: /product/workspace/environments#production-environment
[ref-environments-prod]: /product/workspace/environments#production-environment
[ref-lts]: /product/distribution#long-term-support
[link-semver]: https://semver.org
4 changes: 2 additions & 2 deletions docs/pages/product/distribution.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,8 @@ Usually, there are also deprecation notices in the documentation that look simil

</WarningBox>

Additionally, Cube Cloud provides [update channels][ref-update-channels] where
versions are marked as either <Btn>Stable</Btn> or <Btn>Latest</Btn>.
Additionally, Cube Cloud provides <Btn>LTS</Btn> or <Btn>Regular</Btn> [update
channels][ref-update-channels].

### Long-term support

Expand Down