From 45ba6ea4a8f66cfd0e92d2ab1cc60b045fb849a5 Mon Sep 17 00:00:00 2001 From: Ruben Barkow Date: Thu, 20 Oct 2016 08:59:39 +0200 Subject: [PATCH] Docs: autoupdater explanation enhanced --- docs/features/autoupdater.rst | 25 ++++++++++++++----------- 1 file changed, 14 insertions(+), 11 deletions(-) diff --git a/docs/features/autoupdater.rst b/docs/features/autoupdater.rst index 8c4ca73f..588b14a6 100644 --- a/docs/features/autoupdater.rst +++ b/docs/features/autoupdater.rst @@ -11,14 +11,19 @@ during development), but it can be enabled by setting the variable GLUON_BRANCH to override the default branch set in the set in the site configuration. A manifest file for the updater can be generated with `make manifest`. A signing script (using -ecdsautils) can by found in the `contrib` directory. When creating the manifest, ``GLUON_PRIORITY`` can -be set on the command line, or it can be taken from the ``site.mk``. +``ecdsautils``) can by found in the `contrib` directory. When creating the manifest, the +``PRIORITY`` value may be defined by setting ``GLUON_PRIORITY`` on the command line or in ``site.mk``. -The priority defines the maximum number of days that may pass between releasing an update and installation -of the images. The update probability will start at 0 after the release time mentioned in the manifest -and then slowly rise to 1 up to the point when the number of days given by the priority has passed. +``GLUON_PRIORITY`` defines the maximum number of days that may pass between releasing an update and installation +of the images. The update probability will start at 0 after the release time declared in the manifest file +by the variable DATE and then slowly rise up to 1 when ``GLUON_PRIORITY`` days have passed. The autoupdater checks +for updates hourly (at a random minute of the hour), but usually only updates during its run between +4am and 5am, except when the whole ``GLUON_PRIORITY`` days and another 24 hours have passed. -The priority may be an integer or a decimal fraction. +``GLUON_PRIORITY`` may be an integer or a decimal fraction. + +Automated nightly builds +------------------------ A fully automated nightly build could use the following commands: @@ -70,11 +75,9 @@ These commands can be used on a node: # Force update check, even when the updater is disabled autoupdater -f - + :: - # If fallback is true the updater will perform an update only if - # the timespan given by the priority and another 24h have passed + # If fallback is true the updater will perform an update only if the timespan + # PRIORITY days from the manifest and another 24h have passed autoupdater --fallback - -