Skip to content

Commit

Permalink
Merge pull request #2955 from balena-io/vipulgupta2048/upgrade
Browse files Browse the repository at this point in the history
Update instructions for SV/OS upgrade
  • Loading branch information
vipulgupta2048 authored Apr 9, 2024
2 parents e6996de + b453a06 commit 8d168af
Show file tree
Hide file tree
Showing 8 changed files with 16 additions and 10 deletions.
12 changes: 8 additions & 4 deletions pages/reference/OS/updates/self-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,19 @@ For device types and {{ $names.os.lower }} versions that are not yet supported,

## Running an update

To run an update for an individual device, navigate to that device's *Settings* tab, go to the section *OS version*, and select the version of {{ $names.os.lower }} you would like to update to:
To run an update for an individual device, navigate to that device's *Settings* tab, go to the section *OS version*, and select the version of {{ $names.os.lower }} you would like to update to. After making your selection, click the *Save* button.

![Update device](/img/common/updates/update-os.png)

Updates can also be made to multiple devices in the same fleet. From the device list, click the checkbox to the left of any online devices you wish to update. Then use the *Actions* dropdown in the upper-right corner of the dashboard, and choose the *Update {{ $names.os.lower }}* action:
Updates can also be made to multiple devices in the same fleet. From the device list, click the checkbox to the left of any online devices you wish to update. Then use the *Modify* dropdown to choose the *OS version* option to set and trigger an update on all selected devices.

![Device group update](/img/common/updates/group-update.png)

__Note:__ Updates to the balena Supervisor, {{ $names.company.lower }}'s agent on the device, can be triggered independently. Read more about that process [here](/reference/supervisor/supervisor-upgrades).
From the dialog box that opens, select the OS version you would like to update to and click the `Apply` button to trigger the OS update.

![device group update, dialog box](/img/common/updates/group-update-dialog.png)

__Note:__ Updates to the balena Supervisor, {{ $names.company.lower }}'s agent on the device, can be [triggered independently](/reference/supervisor/supervisor-upgrades).

After an update begins, the device summary page will show a progress bar that marks the steps completed for the update. Some steps that take longer, such as the device downloading the new OS image, may make the progress bar appear stuck. This doesn't mean anything has gone wrong with your update. We are working on making the update process more informative.

Expand All @@ -37,7 +41,7 @@ If your {{ $names.os.lower }} update fails for any reason, the device should sti

[Update locks](https://docs.balena.io/learn/deploy/release-strategy/update-locking/) is a mechanism that allows applications to enter critical sections of code and prevent updates that would interrupt the application from running. Update locks can also be used to delay the reboot that applies a hostOS update operation until the application exits the critical section by removing the update locks. HostOS update operations require the use of exclusive locks and will not respect shared locks. [Overriding update locks](https://docs.balena.io/learn/deploy/release-strategy/update-locking/#overriding-the-lock) will ignore existing locks and allow a hostOS update process to proceed with a reboot.

You can learn more about what exactly goes on during the update process [here][update-process].
Check out our [update process][update-process] to understand how the process goes through each step.

<!-- links -->
[forums]:{{ $names.forums_domain }}/
Expand Down
13 changes: 8 additions & 5 deletions pages/reference/supervisor/supervisor-upgrades.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,21 @@ whereby an independent Supervisor upgrade is preferable:
* Less downtime (if any)
* Smaller update size

To run an update for an individual device, navigate to that device's *Actions* tab, click *Update Supervisor*, and
To run an update for an individual device, navigate to that device's *Settings* tab, scroll down to *Supervisor version* section, and
select the version of the balena Supervisor you would like to update to:

![Supervisor device upgrade](/img/common/updates/supervisor-device-upgrade.png)

Updates can also be issued to multiple devices in the same fleet with the same CPU architecture. From the device
list, click the checkbox to the left of any online devices you wish to update. Then click the *Actions* button in the
upper-right corner of the dashboard, followed by *Update Supervisor*:
list, click the checkbox to the left of any online devices you wish to update. Then use the *Modify* dropdown to select the *Supervisor version* option:

![Supervisor batch upgrade](/img/common/updates/supervisor-batch-upgrade.svg)
![Supervisor batch upgrade](/img/common/updates/supervisor-batch-upgrade.png)

Additionally, these devices can be scheduled for an offline device. The update will be performed once the device comes
From the dialog box that opens, select the Supervisor version you would like to update to and click the `Apply` button to trigger the Supervisor update.

![Supervisor batch upgrade dialog](/img/common/updates/supervisor-batch-upgrade-dialog.png)

Additionally, these updates can be scheduled for an offline device as well. The update will be performed once the device comes
back online and successfully connects to the {{ $names.cloud.lower }} backend.

__Note:__ Only devices running {{ $names.os.lower }} v2.12.0 or greater are able to upgrade the Supervisor independently.
Expand Down
Binary file added static/img/common/updates/group-update-dialog.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/common/updates/group-update.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 0 additions & 1 deletion static/img/common/updates/supervisor-batch-upgrade.svg

This file was deleted.

Binary file modified static/img/common/updates/supervisor-device-upgrade.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8d168af

Please sign in to comment.