summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorScott Moser <smoser@ubuntu.com>2011-08-03 13:40:07 -0400
committerScott Moser <smoser@ubuntu.com>2011-08-03 13:40:07 -0400
commite7ca2cf5c38e8d94dd154b3b65b575c63a488ce2 (patch)
treeec630edcd90820a652245a8c48a3285b44d0deef /doc
parenteec6618bea0ab204ce02e8c122e9960ac034595b (diff)
downloadvyos-cloud-init-e7ca2cf5c38e8d94dd154b3b65b575c63a488ce2.tar.gz
vyos-cloud-init-e7ca2cf5c38e8d94dd154b3b65b575c63a488ce2.zip
cloudinit/util.py: fix syntax error
Diffstat (limited to 'doc')
-rw-r--r--doc/examples/cloud-config.txt52
1 files changed, 43 insertions, 9 deletions
diff --git a/doc/examples/cloud-config.txt b/doc/examples/cloud-config.txt
index edf58067..3374cf15 100644
--- a/doc/examples/cloud-config.txt
+++ b/doc/examples/cloud-config.txt
@@ -311,10 +311,49 @@ rsyslog:
# set to 'False' to disable
resize_rootfs: True
-# if hostname is set, cloud-init will set the system hostname
-# appropriately to its value
-# if not set, it will set hostname from the cloud metadata
-# default: None
+## hostname and /etc/hosts management
+# cloud-init will do its best to set up a sane hostname and corresponding
+# entries in /etc/hosts.
+#
+# if you do nothing, you should get the system generally correctly
+# configured.
+# * /etc/hostname contain the hostname (not fqdn)
+# * an entry in /etc/hosts for with both hostname and fqdn
+# that are obtained from the metadata service
+# * On each boot, the above will again be set
+# * cloud-init generally "owns" the 127.0.1.1 entry. The
+# rest of the file will not be modified
+#
+# You can change the above behavior with the following config variables:
+# Remember that these can be set in cloud-config via user-data,
+# /etc/cloud/cloud.cfg or any file in /etc/cloud/cloud.cfg.d/
+#
+# hostname:
+# this option will be used wherever the 'hostname' is needed
+# simply substitute it in the description above.
+# ** If you wish to set your hostname, set it here **
+# default: 'hostname' as returned by the metadata service
+# on EC2, the hostname portion of 'local-hostname' is used
+# which is something like 'ip-10-244-170-199'
+#
+# fqdn:
+# this option will be used wherever 'fqdn' is needed.
+# simply substitue it in the description above.
+# default: fqdn as returned by the metadata service. on EC2 'hostname'
+# is used, so this is like: ip-10-244-170-199.ec2.internal
+#
+# manage_etc_hosts:
+# default: false
+# Setting this config variable to 'true' will mean that on every
+# boot, /etc/hosts will be re-written from /etc/cloud/templates/hosts.tmpl
+# The strings '$hostname' and '$fqdn' are replaced in the template
+# with the appropriate values.
+#
+# preserve_hostname:
+# default: False
+# If this option is set to True, then /etc/hostname will never updated
+# The default behavior is to update it if it has not been modified by
+# the user.
# final_message
# default: cloud-init boot finished at $TIMESTAMP. Up $UPTIME seconds
@@ -423,11 +462,6 @@ ssh_pwauth: True
# default is False
manual_cache_clean: False
-# if you wish to have /etc/hosts written from /etc/cloud/templates/hosts.tmpl
-# on a per-always basis (to account for ebs stop/start), then set
-# manage_etc_hosts to True. The default is 'False'
-manage_etc_hosts: False
-
# When cloud-init is finished running including having run
# cloud_init_modules, then it will run this command. The default
# is to emit an upstart signal as shown below. If the value is a