From 989ec83a27621cab6c53dd026c2407dfe1b1b179 Mon Sep 17 00:00:00 2001 From: Hugh Brown Date: Tue, 9 Jun 2020 14:18:34 -0700 Subject: [PATCH] Add supervisor upgrade document Connects-to: https://github.com/balena-io/balena-io/issues/2157 Change-type: patch Signed-off-by: Hugh Brown --- docs/upgrades.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 docs/upgrades.md diff --git a/docs/upgrades.md b/docs/upgrades.md new file mode 100644 index 00000000..2d6f4fe9 --- /dev/null +++ b/docs/upgrades.md @@ -0,0 +1,13 @@ +# Upgrading the balena Supervisor + +The balena Supervisor can be upgraded separately from the host OS. This can be done to apply bug fixes, or to take advantage of new features. + +## Upgrade paths + +Downgrades of the supervisor are not supported. + +Upgrading to a new minor version is supported, and should be seamless. + +Upgrading to a new major version should work; however, it is the user's responsibility to test those changes, and verify that they do not cause problems for their application. The changelog for the balena Supervisor can be found [here](https://github.com/balena-io/balena-supervisor/blob/master/CHANGELOG.md). + +For devices managed by balenaCloud, we reserve the right to upgrade the supervisor when necessary, such as to apply bug fixes. (This does not apply to devices managed by balena On Prem installations, or by self-hosted openBalena instances.) We will make every effort to notify users in advance of such an update, and to respect constraints such as bandwidth. In addition, we will not upgrade between major versions without consulting with users.