diff --git a/docs/cloud/features/upgrade/upgrade-ui-available.png b/docs/cloud/features/upgrade/upgrade-ui-available.png new file mode 100644 index 0000000000..a9ea90fa08 Binary files /dev/null and b/docs/cloud/features/upgrade/upgrade-ui-available.png differ diff --git a/docs/cloud/features/upgrade/upgrade-ui-custom-version.png b/docs/cloud/features/upgrade/upgrade-ui-custom-version.png new file mode 100644 index 0000000000..810861a741 Binary files /dev/null and b/docs/cloud/features/upgrade/upgrade-ui-custom-version.png differ diff --git a/docs/cloud/features/upgrade/upgrade-ui-latest.png b/docs/cloud/features/upgrade/upgrade-ui-latest.png new file mode 100644 index 0000000000..c6e34cb534 Binary files /dev/null and b/docs/cloud/features/upgrade/upgrade-ui-latest.png differ diff --git a/docs/cloud/features/upgrade/upgrade-ui-progress.png b/docs/cloud/features/upgrade/upgrade-ui-progress.png new file mode 100644 index 0000000000..78282628ec Binary files /dev/null and b/docs/cloud/features/upgrade/upgrade-ui-progress.png differ diff --git a/docs/cloud/features/upgrade/upgrade-ui-up-to-date.png b/docs/cloud/features/upgrade/upgrade-ui-up-to-date.png new file mode 100644 index 0000000000..e044ad1d8d Binary files /dev/null and b/docs/cloud/features/upgrade/upgrade-ui-up-to-date.png differ diff --git a/docs/cloud/features/upgrades.md b/docs/cloud/features/upgrades.md new file mode 100644 index 0000000000..c6ee00d713 --- /dev/null +++ b/docs/cloud/features/upgrades.md @@ -0,0 +1,75 @@ +# Upgrading Tobiko Cloud + +Tobiko regularly releases new versions of Tobiko Cloud that add features and improve reliability. + +This page describes how to upgrade your Tobiko Cloud projects to a newer version. + +## Upgrade availability + +Navigate to `Settings > Upgrade` in the Tobiko Cloud UI to determine whether a new version of Tobiko Cloud is available for your project. + +If your project is already up to date, you will see a grey message: + +![Tobiko Cloud Upgrade Already Up-to-Date](./upgrade/upgrade-ui-up-to-date.png) + +If a new version is available for your project, the page will include a notification box, version, and blue Upgrade Now button: + +![Tobiko Cloud Upgrade Page](./upgrade/upgrade-ui-available.png) + +## Upgrading a project + +On the Upgrade page, you can choose to upgrade to the latest version or specify a custom version. + +!!! info "Upgrade Permissions" + Only users with Tobiko Cloud `Admin` permissions can perform upgrades. + +!!! danger "Upgrade Side Effects" + The upgrade process may take a few minutes to complete. During this time, your Tobiko Cloud project will be unavailable. + + Any in-progress plans and runs will be aborted: + + - Aborted plans will be stopped, and you must **manually** start them again. + - Aborted runs will be automatically resumed shortly after the upgrade completes. + + To avoid unexpected interruptions, please notify your team before starting the upgrade. + +### Latest Version + +Click the **Upgrade Now** button and confirm to begin upgrading your project to the latest version. + +![Tobiko Cloud Upgrade Page](./upgrade/upgrade-ui-latest.png) + +### Custom Version + +We recommend upgrading your Tobiko Cloud project to the latest version, but you may prefer to upgrade to a specific version. + +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. + +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. + +To specify a custom version, select the **Custom** tab on the Upgrade page and enter your desired version in the text box. + +![Tobiko Cloud Upgrade Custom Version](./upgrade/upgrade-ui-custom-version.png) + +Make sure you are entering a valid custom version by: + + - Entering the custom version **without** the leading `v` + - Confirming that the version is valid and later than the current version of the project + +If your custom version is not valid, Tobiko Cloud will display an error message. + +After entering the custom version, click the **Upgrade Now** button and confirm to begin the upgrade process. + +## Upgrade Progress + +Tobiko Cloud will display a progress page while the upgrade is in progress: + +![Tobiko Cloud Upgrade Progress](./upgrade/upgrade-ui-progress.png) + +Once the upgrade is complete, Tobiko Cloud will automatically redirect you back to your upgraded project. + +## Upgrade Support + +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. + +For the quickest response, we recommend upgrading Monday through Friday between 9am and 5pm PST. \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 0ffbcde316..34156b1b66 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -111,8 +111,11 @@ nav: - "Getting Started": cloud/tcloud_getting_started.md - Cloud Features: - "Alerts & Notifications": cloud/features/alerts_notifications.md - - cloud/features/debugger_view.md - cloud/features/data_catalog.md + - cloud/features/debugger_view.md + - Maintenance: + - cloud/features/incident_reporting.md + - cloud/features/upgrades.md - Scheduler: - "Cloud": cloud/features/scheduler/scheduler.md - "Cloud Hybrid Deployments": @@ -124,8 +127,8 @@ nav: - Security: - cloud/features/security/security.md - cloud/features/security/single_sign_on.md - - cloud/features/incident_reporting.md - - cloud/features/xdb_diffing.md + - Tools: + - cloud/features/xdb_diffing.md # - Observability: # - cloud/features/observability/overview.md # - cloud/features/observability/model_freshness.md