From ca140639c6a2b5f9f5a2e69b5611bb3902b78c18 Mon Sep 17 00:00:00 2001 From: Christina Wang Date: Mon, 27 Jun 2022 07:32:06 -0700 Subject: [PATCH] Specify that Supervisor will not restore previous lock status from user containers There is no functionality which 1) stores the filesystem lock status when toggling override to on, and 2) restore the system to that status when toggling override to off. Change-type: patch Signed-off-by: Christina Wang --- docs/update-locking.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/update-locking.md b/docs/update-locking.md index 04b19636..edc75778 100644 --- a/docs/update-locking.md +++ b/docs/update-locking.md @@ -86,9 +86,11 @@ The update lock can be overridden in case you need to force an update, for insta To do this the device or fleet must have `BALENA_SUPERVISOR_OVERRIDE_LOCK` configuration variable set to "1". -The easiest way to do this is to use the 'Override the update lock ...' toggle in the [Fleet or Device Configuration][device-configuration] page. Go to the configuration page of the device or fleet, locate the 'Override the update lock ...' item, click the activate button, and set the toggle to enabled. Disable the toggle afterwards in order to restore the update locks. +The easiest way to do this is to use the 'Override the update lock ...' toggle in the [Fleet or Device Configuration][device-configuration] page. Go to the configuration page of the device or fleet, locate the 'Override the update lock ...' item, click the activate button, and set the toggle to enabled. After disabling the toggle, update locks may be set again and will be respected. -Also, you can programatically do this by hitting the `/v1/update` endpoint of the [supervisor HTTP API][supervisor-api], with `{ "force": true }` as body. +Also, you can programatically override locks one time by querying the `/v1/update` endpoint of the [supervisor HTTP API][supervisor-api], with `{ "force": true }` as body. Note that this will not set the lock override config var. + +Please note that setting the override is a one-time action. Locks set previously are deleted upon setting the config var, and will need to be recreated. [device-configuration]:/learn/manage/configuration/#managing-device-configuration-variables