docs: add create_hostname_file key to module reference examples

canonical · Jan 3, 2024 · b136c51 · b136c51
1 parent 0e3d02a
commit b136c51
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/cloudinit/config/cc_set_hostname.py b/cloudinit/config/cc_set_hostname.py
@@ -60,10 +60,19 @@
         dedent(
             """\
             hostname: myhost
+            ceate_hostname_file: true
             fqdn: myhost.example.com
             prefer_fqdn_over_hostname: true
             """
         ),
+        dedent(
+            """\
+            # On a machine without an ``/etc/hostname`` file, don't create it
+            # In most clouds, this will results in a DHCP configured hostname
+            # provided by the cloud
+            create_hostname_file: false
+            """
+        ),
     ],
     "activate_by_schema_keys": [],
 }

diff --git a/cloudinit/config/cc_update_hostname.py b/cloudinit/config/cc_update_hostname.py
@@ -65,6 +65,7 @@
         fqdn: external.fqdn.me
         hostname: myhost
         prefer_fqdn_over_hostname: true
+        create_hostname_file: true
         """
         ),
         dedent(
@@ -74,6 +75,14 @@
         prefer_fqdn_over_hostname: false
         """
         ),
+        dedent(
+            """\
+        # On a machine without an ``/etc/hostname`` file, don't create it
+        # In most clouds, this will results in a DHCP configured hostname
+        # provided by the cloud
+        create_hostname_file: false
+        """
+        ),
     ],
     "frequency": PER_ALWAYS,
     "activate_by_schema_keys": [],