|
1 | | -# Upgrades |
| 1 | +# Upgrading Tobiko Cloud |
2 | 2 |
|
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. |
7 | 4 |
|
8 | | - |
| 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 | + |
| 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 | + |
| 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. |
9 | 22 |
|
10 | 23 | !!! 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. |
12 | 28 |
|
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: |
17 | 30 |
|
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. |
20 | 33 |
|
21 | 34 | To avoid unexpected interruptions, please notify your team before starting the upgrade. |
22 | 35 |
|
23 | | -## Custom Version |
| 36 | +### Latest Version |
24 | 37 |
|
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. |
27 | 39 |
|
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 | + |
32 | 41 |
|
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. |
34 | 51 |
|
35 | 52 |  |
36 | 53 |
|
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: |
41 | 55 |
|
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 |
43 | 58 |
|
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. |
46 | 60 |
|
47 | | - |
| 61 | +After entering the custom version, click the **Upgrade Now** button and confirm to begin the upgrade process. |
48 | 62 |
|
49 | | -## Project Already Up-to-Date |
| 63 | +## Upgrade Progress |
50 | 64 |
|
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: |
52 | 66 |
|
53 | | - |
| 67 | + |
| 68 | + |
| 69 | +Once the upgrade is complete, Tobiko Cloud will automatically redirect you back to your upgraded project. |
54 | 70 |
|
55 | 71 | ## Upgrade Support |
56 | 72 |
|
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. |
0 commit comments