Merge ~ffledgling/cloud-init:doc-fix into cloud-init:master

Proposed by Anhad Jai Singh on 2016-12-09
Status: Merged
Merged at revision: 39fb5a0240597112af8162c6c3365288450a7a77
Proposed branch: ~ffledgling/cloud-init:doc-fix
Merge into: cloud-init:master
Diff against target: 76 lines (+9/-9)
3 files modified
doc/examples/cloud-config-gluster.txt (+2/-2)
doc/examples/cloud-config-mount-points.txt (+4/-4)
doc/examples/cloud-config.txt (+3/-3)
Reviewer Review Type Date Requested Status
cloud-init commiters 2016-12-09 Pending
Review via email: mp+312917@code.launchpad.net

Description of the change

    Change `nobootwait` to `nofail` in docs

    `nobootwait` is an ubuntu specific extension to the mount syntax that is
    not supported by other non-derivative linux operating systems.

    `nobootwait` support appears to have been dropped Ubuntu 16.04 onwards,
    based on http://manpages.ubuntu.com/manpages/xenial/man5/fstab.5.html.
    Last Ubuntu version with mention of `nobootwait` appears to be 15.10,
    based on http://manpages.ubuntu.com/manpages/wily/man5/fstab.5.html.

    All examples using `nobootwait` were updated to use the standard
    `nofail`, which gives the expected behaviour of not failing to boot in
    case a volume is missing. There are likely subtle differences in semantics
    between `nobootwait` and `nofail`, but it is the best (only?) substitute
    that gives behaviour similar to the defunct `nobootwait` option.

To post a comment you must log in.
Anhad Jai Singh (ffledgling) wrote :

In addition to tests, there are tests (namely: tests/data/merge_sources/source8-1.yaml, tests/data/merge_sources/expected8.yaml) and some code (config?) files (namely: cloudinit/config/cc_mounts.py) that use nobootwait as well, but I haven't modified them because I'm not entirely clear about the scope of those changes. If those need to be changed as well, please let me know.

Anhad Jai Singh (ffledgling) wrote :

In addition to docs*

Scott Moser (smoser) wrote :

Hi, thanks for the change here.
Could we at least suggest that if your system is using upstart (Ubuntu 14.04) then 'nobootwait' is the best option for you. But if you are using systemd or sysvinit then nofail is all you have.

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1diff --git a/doc/examples/cloud-config-gluster.txt b/doc/examples/cloud-config-gluster.txt
2index f8183e7..cb97912 100644
3--- a/doc/examples/cloud-config-gluster.txt
4+++ b/doc/examples/cloud-config-gluster.txt
5@@ -1,6 +1,6 @@
6 #cloud-config
7 # vim: syntax=yaml
8-# Mounts volfile exported by glusterfsd running on
9+# Mounts volfile exported by glusterfsd running on
10 # "volfile-server-hostname" onto the local mount point '/mnt/data'
11 #
12 # In reality, replace 'volfile-server-hostname' with one of your nodes
13@@ -10,7 +10,7 @@ packages:
14 - glusterfs-client
15
16 mounts:
17- - [ 'volfile-server-hostname:6996', /mnt/data, glusterfs, "defaults,nobootwait", "0", "2" ]
18+ - [ 'volfile-server-hostname:6996', /mnt/data, glusterfs, "defaults,nofail", "0", "2" ]
19
20 runcmd:
21 - [ modprobe, fuse ]
22diff --git a/doc/examples/cloud-config-mount-points.txt b/doc/examples/cloud-config-mount-points.txt
23index aa676c2..5a6c24f 100644
24--- a/doc/examples/cloud-config-mount-points.txt
25+++ b/doc/examples/cloud-config-mount-points.txt
26@@ -23,19 +23,19 @@
27 # - if an entry does not have all 6 fields, they will be filled in
28 # with values from 'mount_default_fields' below.
29 #
30-# Note, that you should set 'nobootwait' (see man fstab) for volumes that may
31-# not be attached at instance boot (or reboot)
32+# Note, that you should set 'nofail' (see man fstab) for volumes that may not
33+# be attached at instance boot (or reboot).
34 #
35 mounts:
36 - [ ephemeral0, /mnt, auto, "defaults,noexec" ]
37 - [ sdc, /opt/data ]
38- - [ xvdh, /opt/data, "auto", "defaults,nobootwait", "0", "0" ]
39+ - [ xvdh, /opt/data, "auto", "defaults,nofail", "0", "0" ]
40 - [ dd, /dev/zero ]
41
42 # mount_default_fields
43 # These values are used to fill in any entries in 'mounts' that are not
44 # complete. This must be an array, and must have 7 fields.
45-mount_default_fields: [ None, None, "auto", "defaults,nobootwait", "0", "2" ]
46+mount_default_fields: [ None, None, "auto", "defaults,nofail", "0", "2" ]
47
48
49 # swap can also be set up by the 'mounts' module
50diff --git a/doc/examples/cloud-config.txt b/doc/examples/cloud-config.txt
51index 190029e..c5f84b1 100644
52--- a/doc/examples/cloud-config.txt
53+++ b/doc/examples/cloud-config.txt
54@@ -46,19 +46,19 @@ packages:
55 # - if an entry does not have all 6 fields, they will be filled in
56 # with values from 'mount_default_fields' below.
57 #
58-# Note, that you should set 'nobootwait' (see man fstab) for volumes that may
59+# Note, that you should set 'nofail' (see man fstab) for volumes that may
60 # not be attached at instance boot (or reboot)
61 #
62 mounts:
63 - [ ephemeral0, /mnt, auto, "defaults,noexec" ]
64 - [ sdc, /opt/data ]
65- - [ xvdh, /opt/data, "auto", "defaults,nobootwait", "0", "0" ]
66+ - [ xvdh, /opt/data, "auto", "defaults,nofail", "0", "0" ]
67 - [ dd, /dev/zero ]
68
69 # mount_default_fields
70 # These values are used to fill in any entries in 'mounts' that are not
71 # complete. This must be an array, and must have 7 fields.
72-mount_default_fields: [ None, None, "auto", "defaults,nobootwait", "0", "2" ]
73+mount_default_fields: [ None, None, "auto", "defaults,nofail", "0", "2" ]
74
75 # add each entry to ~/.ssh/authorized_keys for the configured user or the
76 # first user defined in the user definition directive.

Subscribers

People subscribed via source and target branches