doc: change 'nobootwait' to 'nofail' in docs

'nobootwait' is an upstart specific extension to the mount syntax that is
not supported by other mount systems.  As Ubuntu 16.04 moved from upstart
to systemd, support for 'nobootwait' was lost.

All examples using 'nobootwait' are updated to use the standard 'nofail',
which gives the expected behaviour of not failing to boot in case a volume
is missing. There are subtle differences in semantics between
'nobootwait' and 'nofail', but it is the best substitute that gives
behaviour similar to the upstart specific option.

6 files changed, 21 insertions, 13 deletions

diff --git a/cloudinit/config/cc_mounts.py b/cloudinit/config/cc_mounts.py
index 0c796b18..5cb2ca8a 100644
--- a/cloudinit/config/cc_mounts.py
+++ b/cloudinit/config/cc_mounts.py
@@ -42,6 +42,14 @@ values. It defaults to::
 
     mount_default_fields: [none, none, "auto", "defaults,nobootwait", "0", "2"]
 
+On a systemd booted system that default is the mostly equivalent::
+
+    mount_default_fields: [none, none, "auto",
+       "defaults,nofail,x-systemd.requires=cloud-init.service", "0", "2"]
+
+Note that `nobootwait` is an upstart specific boot option that somewhat
+equates to the more standard `nofail`.
+
 Swap files can be configured by setting the path to the swap file to create
 with ``filename``, the size of the swap file with ``size`` maximum size of
 the swap file if using an ``size: auto`` with ``maxsize``. By default no
@@ -58,8 +66,8 @@ swap file is created.
     mounts:
         - [ /dev/ephemeral0, /mnt, auto, "defaults,noexec" ]
         - [ sdc, /opt/data ]
-        - [ xvdh, /opt/data, "auto", "defaults,nobootwait", "0", "0" ]
-    mount_default_fields: [None, None, "auto", "nefaults,nobootwait", "0", "2"]
+        - [ xvdh, /opt/data, "auto", "defaults,nofail", "0", "0" ]
+    mount_default_fields: [None, None, "auto", "defaults,nofail", "0", "2"]
     swap:
         filename: <file>
         size: <"auto"/size in bytes>
diff --git a/doc/examples/cloud-config-gluster.txt b/doc/examples/cloud-config-gluster.txt
index f8183e77..cb979123 100644
--- a/doc/examples/cloud-config-gluster.txt
+++ b/doc/examples/cloud-config-gluster.txt
@@ -1,6 +1,6 @@
 #cloud-config
 # vim: syntax=yaml
-# Mounts volfile exported by glusterfsd running on 
+# Mounts volfile exported by glusterfsd running on
 # "volfile-server-hostname" onto the local mount point '/mnt/data'
 #
 # In reality, replace 'volfile-server-hostname' with one of your nodes
@@ -10,7 +10,7 @@ packages:
  - glusterfs-client
 
 mounts:
- - [ 'volfile-server-hostname:6996', /mnt/data, glusterfs, "defaults,nobootwait", "0", "2" ]
+ - [ 'volfile-server-hostname:6996', /mnt/data, glusterfs, "defaults,nofail", "0", "2" ]
 
 runcmd:
  - [ modprobe, fuse ]
diff --git a/doc/examples/cloud-config-mount-points.txt b/doc/examples/cloud-config-mount-points.txt
index aa676c24..5a6c24f5 100644
--- a/doc/examples/cloud-config-mount-points.txt
+++ b/doc/examples/cloud-config-mount-points.txt
@@ -23,19 +23,19 @@
 # - if an entry does not have all 6 fields, they will be filled in
 #   with values from 'mount_default_fields' below.
 #
-# Note, that you should set 'nobootwait' (see man fstab) for volumes that may
-# not be attached at instance boot (or reboot)
+# Note, that you should set 'nofail' (see man fstab) for volumes that may not
+# be attached at instance boot (or reboot).
 #
 mounts:
  - [ ephemeral0, /mnt, auto, "defaults,noexec" ]
  - [ sdc, /opt/data ]
- - [ xvdh, /opt/data, "auto", "defaults,nobootwait", "0", "0" ]
+ - [ xvdh, /opt/data, "auto", "defaults,nofail", "0", "0" ]
  - [ dd, /dev/zero ]
 
 # mount_default_fields
 # These values are used to fill in any entries in 'mounts' that are not
 # complete.  This must be an array, and must have 7 fields.
-mount_default_fields: [ None, None, "auto", "defaults,nobootwait", "0", "2" ]
+mount_default_fields: [ None, None, "auto", "defaults,nofail", "0", "2" ]
 
 
 # swap can also be set up by the 'mounts' module
diff --git a/doc/examples/cloud-config.txt b/doc/examples/cloud-config.txt
index 190029e4..c5f84b13 100644
--- a/doc/examples/cloud-config.txt
+++ b/doc/examples/cloud-config.txt
@@ -46,19 +46,19 @@ packages:
 # - if an entry does not have all 6 fields, they will be filled in
 #   with values from 'mount_default_fields' below.
 #
-# Note, that you should set 'nobootwait' (see man fstab) for volumes that may
+# Note, that you should set 'nofail' (see man fstab) for volumes that may
 # not be attached at instance boot (or reboot)
 #
 mounts:
  - [ ephemeral0, /mnt, auto, "defaults,noexec" ]
  - [ sdc, /opt/data ]
- - [ xvdh, /opt/data, "auto", "defaults,nobootwait", "0", "0" ]
+ - [ xvdh, /opt/data, "auto", "defaults,nofail", "0", "0" ]
  - [ dd, /dev/zero ]
 
 # mount_default_fields
 # These values are used to fill in any entries in 'mounts' that are not
 # complete.  This must be an array, and must have 7 fields.
-mount_default_fields: [ None, None, "auto", "defaults,nobootwait", "0", "2" ]
+mount_default_fields: [ None, None, "auto", "defaults,nofail", "0", "2" ]
 
 # add each entry to ~/.ssh/authorized_keys for the configured user or the
 # first user defined in the user definition directive.
diff --git a/tests/data/merge_sources/expected8.yaml b/tests/data/merge_sources/expected8.yaml
index 69ca562d..360e38f0 100644
--- a/tests/data/merge_sources/expected8.yaml
+++ b/tests/data/merge_sources/expected8.yaml
@@ -3,5 +3,5 @@
 mounts:
  - [ ephemeral22, /mnt, auto, "defaults,noexec" ]
  - [ sdc, /opt/data ]
- - [ xvdh, /opt/data, "auto", "defaults,nobootwait", "0", "0" ]
+ - [ xvdh, /opt/data, "auto", "defaults,nofail", "0", "0" ]
  - [ dd, /dev/zero ]
diff --git a/tests/data/merge_sources/source8-1.yaml b/tests/data/merge_sources/source8-1.yaml
index 5ea51c2c..1ac1b0dd 100644
--- a/tests/data/merge_sources/source8-1.yaml
+++ b/tests/data/merge_sources/source8-1.yaml
@@ -3,5 +3,5 @@
 mounts:
  - [ ephemeral0, /mnt, auto, "defaults,noexec" ]
  - [ sdc, /opt/data ]
- - [ xvdh, /opt/data, "auto", "defaults,nobootwait", "0", "0" ]
+ - [ xvdh, /opt/data, "auto", "defaults,nofail", "0", "0" ]
  - [ dd, /dev/zero ]