Update example config with inline documentation (#545)

Signed-off-by: Ettore Di Giacinto <edigiacinto@suse.com>
rancher · Aug 23, 2021 · b02acb8 · b02acb8
1 parent 6c3b89e
commit b02acb8
Showing 1 changed file with 15 additions and 2 deletions.
diff --git a/examples/standard/files/etc/cos/config b/examples/standard/files/etc/cos/config
@@ -1,4 +1,17 @@
+# cOS configuration file
+# This file allows to tweak cOS configuration such as: default upgrade/recovery image and GRUB menu entry
+
+# Disable/enable image verification during upgrades ( default: true )
 VERIFY=false
-UPGRADE_IMAGE="quay.io/mudler/cos-test:cos-standard"
+
+# Disable/enable upgrades via release channels instead of container images. ( default: true )
 CHANNEL_UPGRADES=false
-RECOVERY_IMAGE="quay.io/mudler/cos-test:cos-standard"
+
+# Default container image used for upgrades. ( defaults to system/cos with channel CHANNEL_UPGRADES enabled )
+UPGRADE_IMAGE="quay.io/mudler/cos-test:cos-standard"
+
+# Default recovery image to use when upgrading the recovery partition.  ( defaults to system/cos with channel CHANNEL_UPGRADES enabled )
+RECOVERY_IMAGE="quay.io/mudler/cos-test:cos-standard"
+
+# GRUB entry to display on boot. ( defaults: cOS )
+GRUB_ENTRY_NAME="example"