Settings Updater - dibrz/ARMBand GitHub Wiki

Cloudbox now comes with a Settings Updater role, which updates your settings.yml file when updates are made to the default settings file (settings.yml.default).

This allows new features and variable changes to be added directly into your settings file so that Cloudbox continues to function properly.

Few points regarding this:

  • Cloudbox will now come with a settings.yml.default file, in lieu of a standard settings.yml one.

  • Doing a git pull/hard reset will no longer wipe out a one's settings.yml file.

  • When the Cloudbox install/update command is run, any new additions to settings.yml.default (e.g. new variables) will be added into the user's settings.yml, automatically. The install/update will then immediately exit and show this message:

    TASK [settings : Check 'settings-updater.py' run status for new settings] **********************************************************************************************************************************************************
Tuesday 01 May 2018  14:54:42 +0200 (0:00:00.019)       0:00:03.900 ***********
fatal: [localhost]: FAILED! => {"changed": false, "failed": true, "msg": "The script 'settings_updater.py' added new settings. Check `settings-updater.log` for details of new setting names added."}
       to retry, use: --limit @/home/seed/cloudbox/cloudbox.retry

PLAY RECAP *************************************************************************************************************************************************************************************************************************
localhost                  : ok=8    changed=1    unreachable=0    failed=1

  • User can then take a look at settings.yml or the settings_updater.log file to see what was added.

  • After making any necessary changes to the settings.yml file, user can re-run the Cloudbox install/update.