Skip to content

Commit 42ba71e

Browse files
treyspnewtonapple
andcommitted
Chore: upgrade docs Trey edits (#5005)
Co-authored-by: David Dai <ddai@tobikodata.com>
1 parent 9af25a4 commit 42ba71e

File tree

4 files changed

+57
-39
lines changed

4 files changed

+57
-39
lines changed
117 KB
Loading
114 KB
Loading

docs/cloud/features/upgrades.md

Lines changed: 51 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,75 @@
1-
# Upgrades
1+
# Upgrading Tobiko Cloud
22

3-
Upgrading a Tobiko Cloud project can be done by going to `Settings > Upgrade`.
4-
If a new version is available for your project, you'll see an upgrade page like the one below.
5-
You can choose to upgrade to the latest version or specify a custom version.
6-
Clicking the **Upgrade Now** button and confirming will start the upgrade process.
3+
Tobiko regularly releases new versions of Tobiko Cloud that add features and improve reliability.
74

8-
![Tobiko Cloud Upgrade Page](./upgrade/upgrade-ui-latest.png)
5+
This page describes how to upgrade your Tobiko Cloud projects to a newer version.
6+
7+
## Upgrade availability
8+
9+
Navigate to `Settings > Upgrade` in the Tobiko Cloud UI to determine whether a new version of Tobiko Cloud is available for your project.
10+
11+
If your project is already up to date, you will see a grey message:
12+
13+
![Tobiko Cloud Upgrade Already Up-to-Date](./upgrade/upgrade-ui-up-to-date.png)
14+
15+
If a new version is available for your project, the page will include a notification box, version, and blue Upgrade Now button:
16+
17+
![Tobiko Cloud Upgrade Page](./upgrade/upgrade-ui-available.png)
18+
19+
## Upgrading a project
20+
21+
On the Upgrade page, you can choose to upgrade to the latest version or specify a custom version.
922

1023
!!! info "Upgrade Permissions"
11-
Only users with `Admin` permissions can perform upgrades.
24+
Only users with Tobiko Cloud `Admin` permissions can perform upgrades.
25+
26+
!!! danger "Upgrade Side Effects"
27+
The upgrade process may take a few minutes to complete. During this time, your Tobiko Cloud project will be unavailable.
1228

13-
!!! warning "Upgrade Preparations"
14-
The upgrade process can take anywhere from a few minutes to over 30 minutes.
15-
The total time depends on the size of your project and the complexity of the upgrade.
16-
During this time, your Tobiko Cloud project will be unavailable. Any in-progress plans and runs will be aborted:
29+
Any in-progress plans and runs will be aborted:
1730

18-
- Aborted plans will be stopped and must be recreated.
19-
- Aborted runs will be automatically resumed shortly after the upgrade completes.
31+
- Aborted plans will be stopped, and you must **manually** start them again.
32+
- Aborted runs will be automatically resumed shortly after the upgrade completes.
2033

2134
To avoid unexpected interruptions, please notify your team before starting the upgrade.
2235

23-
## Custom Version
36+
### Latest Version
2437

25-
Although it is recommended to always upgrade your Tobiko Cloud project to the latest version,
26-
there may be cases where a team needs to upgrade to a specific version.
38+
Click the **Upgrade Now** button and confirm to begin upgrading your project to the latest version.
2739

28-
For example, a team might have separate staging and production projects.
29-
They may upgrade the staging project first, run tests, and only upgrade the production project after verifying that staging works as expected.
30-
If a new version is released during this testing period, the team may want to upgrade production to the same version used in staging.
31-
Custom version selection supports this workflow.
40+
![Tobiko Cloud Upgrade Page](./upgrade/upgrade-ui-latest.png)
3241

33-
To specify a custom version, select the **Custom** tab on the Upgrade page and enter the desired version in the text box.
42+
### Custom Version
43+
44+
We recommend upgrading your Tobiko Cloud project to the latest version, but you may prefer to upgrade to a specific version.
45+
46+
For example, consider a team that has separate staging and production Tobiko Cloud projects. They upgrade the staging project first, run tests, and only upgrade the production project after verifying that staging works as expected.
47+
48+
If a new version of Tobiko Cloud is released during this testing period, the latest available version will not match the version tested in staging. The team can specify a custom Tobiko Cloud version to upgrade production to the specific version that was already tested in staging.
49+
50+
To specify a custom version, select the **Custom** tab on the Upgrade page and enter your desired version in the text box.
3451

3552
![Tobiko Cloud Upgrade Custom Version](./upgrade/upgrade-ui-custom-version.png)
3653

37-
!!! info "Valid Custom Version"
38-
Enter the custom version **without** the leading `v`.
39-
The version must be valid and greater than the current version of the project.
40-
If the custom version is not valid, an error message will be displayed.
54+
Make sure you are entering a valid custom version by:
4155

42-
## Upgrade Progress
56+
- Entering the custom version **without** the leading `v`
57+
- Confirming that the version is valid and later than the current version of the project
4358

44-
After starting the upgrade, a progress page will be shown.
45-
Once the upgrade is complete, you’ll be automatically redirected back to the upgraded Tobiko Cloud project.
59+
If your custom version is not valid, Tobiko Cloud will display an error message.
4660

47-
![Tobiko Cloud Upgrade Progress](./upgrade/upgrade-ui-progress.png)
61+
After entering the custom version, click the **Upgrade Now** button and confirm to begin the upgrade process.
4862

49-
## Project Already Up-to-Date
63+
## Upgrade Progress
5064

51-
If the project is already on the latest version, you’ll see a message like the one below.
65+
Tobiko Cloud will display a progress page while the upgrade is in progress:
5266

53-
![Tobiko Cloud Upgrade Already Up-to-Date](./upgrade/upgrade-ui-up-to-date.png)
67+
![Tobiko Cloud Upgrade Progress](./upgrade/upgrade-ui-progress.png)
68+
69+
Once the upgrade is complete, Tobiko Cloud will automatically redirect you back to your upgraded project.
5470

5571
## Upgrade Support
5672

57-
If you encounter an issue during the upgrade process, please [report an incident](./incident_reporting.md).
58-
Our support team will follow up as soon as possible.
59-
For the quickest response, we recommend upgrading Monday through Friday between 9 AM and 5 PM PST.
73+
If you encounter an issue during the upgrade process, please [report an incident](./incident_reporting.md). Our support team will follow up as soon as possible.
74+
75+
For the quickest response, we recommend upgrading Monday through Friday between 9am and 5pm PST.

mkdocs.yml

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -111,8 +111,11 @@ nav:
111111
- "Getting Started": cloud/tcloud_getting_started.md
112112
- Cloud Features:
113113
- "Alerts & Notifications": cloud/features/alerts_notifications.md
114-
- cloud/features/debugger_view.md
115114
- cloud/features/data_catalog.md
115+
- cloud/features/debugger_view.md
116+
- Maintenance:
117+
- cloud/features/incident_reporting.md
118+
- cloud/features/upgrades.md
116119
- Scheduler:
117120
- "Cloud": cloud/features/scheduler/scheduler.md
118121
- "Cloud Hybrid Deployments":
@@ -124,9 +127,8 @@ nav:
124127
- Security:
125128
- cloud/features/security/security.md
126129
- cloud/features/security/single_sign_on.md
127-
- cloud/features/incident_reporting.md
128-
- cloud/features/xdb_diffing.md
129-
- cloud/features/upgrades.md
130+
- Tools:
131+
- cloud/features/xdb_diffing.md
130132
# - Observability:
131133
# - cloud/features/observability/overview.md
132134
# - cloud/features/observability/model_freshness.md

0 commit comments

Comments
 (0)