summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMatt Fischer <matt@mattfischer.com>2016-05-17 20:55:32 +0000
committerMatt Fischer <matt@mattfischer.com>2016-05-17 20:55:32 +0000
commitea4bc2c603a9d964a918e01d00e39a851e979830 (patch)
treeabd151a96c2553a3a26bde469138606ee0d0c829 /doc
parent78cbc764486060928541b9dee6ce5779e622d1fa (diff)
downloadvyos-cloud-init-ea4bc2c603a9d964a918e01d00e39a851e979830.tar.gz
vyos-cloud-init-ea4bc2c603a9d964a918e01d00e39a851e979830.zip
Document improvements for runcmd/bootcmd
Note that runcmd runs only on first boot. Note that strings need to be quoted, not escaped. Switch bootcmd list text to use - not * like everything else.
Diffstat (limited to 'doc')
-rw-r--r--doc/examples/cloud-config-boot-cmds.txt6
-rw-r--r--doc/examples/cloud-config-run-cmds.txt3
2 files changed, 5 insertions, 4 deletions
diff --git a/doc/examples/cloud-config-boot-cmds.txt b/doc/examples/cloud-config-boot-cmds.txt
index b281d327..3e59755d 100644
--- a/doc/examples/cloud-config-boot-cmds.txt
+++ b/doc/examples/cloud-config-boot-cmds.txt
@@ -7,9 +7,9 @@
# bootcmd should really only be used for things that could not be
# done later in the boot process. bootcmd is very much like
# boothook, but possibly with more friendly.
-# * bootcmd will run on every boot
-# * the INSTANCE_ID variable will be set to the current instance id.
-# * you can use 'cloud-init-boot-per' command to help only run once
+# - bootcmd will run on every boot
+# - the INSTANCE_ID variable will be set to the current instance id.
+# - you can use 'cloud-init-boot-per' command to help only run once
bootcmd:
- echo 192.168.1.130 us.archive.ubuntu.com > /etc/hosts
- [ cloud-init-per, once, mymkfs, mkfs, /dev/vdb ]
diff --git a/doc/examples/cloud-config-run-cmds.txt b/doc/examples/cloud-config-run-cmds.txt
index 61b3bd63..3bb06864 100644
--- a/doc/examples/cloud-config-run-cmds.txt
+++ b/doc/examples/cloud-config-run-cmds.txt
@@ -5,12 +5,13 @@
# runcmd contains a list of either lists or a string
# each item will be executed in order at rc.local like level with
# output to the console
+# - runcmd only runs during the first boot
# - if the item is a list, the items will be properly executed as if
# passed to execve(3) (with the first arg as the command).
# - if the item is a string, it will be simply written to the file and
# will be interpreted by 'sh'
#
-# Note, that the list has to be proper yaml, so you have to escape
+# Note, that the list has to be proper yaml, so you have to quote
# any characters yaml would eat (':' can be problematic)
runcmd:
- [ ls, -l, / ]