summaryrefslogtreecommitdiff
path: root/doc/userdata.txt
diff options
context:
space:
mode:
authorScott Moser <smoser@ubuntu.com>2010-06-18 00:49:01 -0400
committerScott Moser <smoser@ubuntu.com>2010-06-18 00:49:01 -0400
commitce74a2bbbd75bd6c3cd3f8cea89b6a1aa428c030 (patch)
tree5f4824f654e80be595844f3d5c17e54550835f0d /doc/userdata.txt
parent122903f98be12d649e99e78a41f3835dd57c70b1 (diff)
downloadvyos-cloud-init-ce74a2bbbd75bd6c3cd3f8cea89b6a1aa428c030.tar.gz
vyos-cloud-init-ce74a2bbbd75bd6c3cd3f8cea89b6a1aa428c030.zip
doc: add mention of cloud-boothook to documentation
Diffstat (limited to 'doc/userdata.txt')
-rw-r--r--doc/userdata.txt12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/userdata.txt b/doc/userdata.txt
index a1873424..00c16b25 100644
--- a/doc/userdata.txt
+++ b/doc/userdata.txt
@@ -48,6 +48,18 @@ finds. However, certain types of user-data are handled specially.
Content is placed into a file in /etc/init, and will be consumed
by upstart as any other upstart job.
+ * Cloud Boothook
+ begins with #cloud-boothook or Content-Type: text/cloud-boothook
+
+ This content is "boothook" data. It is stored in a file under
+ /var/lib/cloud and then executed immediately.
+
+ This is the earliest "hook" available. Note, that there is no
+ mechanism provided for running only once. The boothook must take
+ care of this itself. It is provided with the instance id in the
+ environment variable "INSTANCE_ID". This could be made use of to
+ provide a 'once-per-instance'
+
=== Examples ===
There are examples in the examples subdirectory.
Additionally, the 'tools' directory contains 'write-mime-multipart',