docs: add create_hostname_file to all hostname user-data examples #4727

catmsred · 2024-01-02T20:46:51Z

If a cloud or user sets create_hostname_file to false (as GCP does) the examples in our docs for setting the hostname will not work. This change updates those examples to also set create_hostname_file to true.

Proposed Commit Message

docs: add create_hostname_file to all hostname user-data examples
    
If a cloud or user sets create_hostname_file to false (as GCP does)
the examples in our docs for setting the hostname will not work.
This change updates those examples to also set create_hostname_file
to true.

Additional Context

See #4330 for details on create_hostname_file key.

Test Steps

This is left as a WIP because I want to go through and follow each of the changed examples to ensure they still work with the new key included.

Checklist

My code follows the process laid out in the documentation
I have updated or added any unit tests accordingly (N/A)
I have updated or added any documentation accordingly

Merge type

Squash merge using "Proposed Commit Message"
Rebase and merge unique commits. Requires commit messages per-commit each referencing the pull request number (#<PR_NUM>)

holmanb

Thanks @catmsred for this PR. I like the direction of it. I just noticed the WIP tag, but I had already started reviewing so I'll leave what I started below.

Think we want to add this to the modules examples?

holmanb · 2024-01-03T00:49:34Z

doc/rtd/reference/base_config_reference.rst

@@ -287,6 +287,9 @@ On an Ubuntu system, :file:`/etc/cloud/cloud.cfg` should look similar to:
    # This will cause the set+update hostname module to not operate (if true)
    preserve_hostname: false

+    # This will create the hostname file (e.g. /etc/hostname) if it does not already exist (if true)
+    create_hostname_file: false


Why add this?

On an Ubuntu system, :file:/etc/cloud/cloud.cfg should look similar to:

This will only be true on GCE, right?

Good point -- will fix! And yes, I think it would be good to add to the modules examples for set and update hostname. Thanks!

TheRealFalcon · 2024-01-08T17:54:35Z

doc/rtd/reference/datasources/nocloud.rst

@@ -216,6 +216,7 @@ Example ``meta-data``
      broadcast 192.168.1.255
      gateway 192.168.1.254
    hostname: myhost
+    create_hostname_file: true


create_hostname_file isn't valid here. This is meta data, not user data

TheRealFalcon · 2024-01-08T17:55:28Z

doc/rtd/reference/datasources/vmware.rst

@@ -338,6 +338,7 @@ this datasource using the GuestInfo keys transport:

       instance-id: cloud-vm
       local-hostname: cloud-vm
+       create_hostname_file: true


This key is not valid here. We instead add it to the user data in the block below this one.

cloudinit/config/cc_set_hostname.py

TheRealFalcon · 2024-01-08T18:04:23Z

doc/rtd/tutorial/qemu-script.sh

@@ -22,6 +22,7 @@ EOF
 cat << EOF > meta-data
 instance-id: someid/somehostname
 local-hostname: jammy
+create_hostname_file: true


Since this is a tutorial, I think we can remove this line (and probably the line above it) to avoid over-complicating things.

@holmanb , what do you think? Also...where is this file even used/referenced?

Since this is a tutorial, I think we can remove this line (and probably the line above it) to avoid over-complicating things.

+1 works for me

Also...where is this file even used/referenced?

This file is referenced from the Qemu tutorial debugging page.

TheRealFalcon · 2024-01-08T18:06:40Z

doc/rtd/tutorial/qemu.rst

@@ -144,6 +144,7 @@ Now let's run the following command, which creates a file named
    $ cat << EOF > meta-data
    instance-id: someid/somehostname
    local-hostname: jammy
+    create_hostname_file: true


Same here. This would go into user data, not meta data. Though...I'm not sure it's worth mentioning hostnames at all.

TheRealFalcon

LGTM!

@catmsred , I'm assuming this is no longer WIP? If so, it's usually best to remove WIP from the title.

catmsred · 2024-01-24T14:53:39Z

I don't consider it still a WIP but I would like @s-makin to finish her review before it's merged

holmanb

I know that this touches some docs files, but the changes appear code / config related, so I don't think a review from @s-makin is really required (though it would be welcome). Since there hasn't been any response from @s-makin do you mind if we go ahead with a merge on this one @catmsred?

catmsred · 2024-02-05T14:56:08Z

@holmanb I don't think anyone has validated the NoCloud reference example change starting from the beginning of the example, but if you're okay with merging that I'm fine with it too.

s-makin

Just a few nits. The tutorial still runs fine, so no problems there, but I did have problems getting tox - doc to run. Some sort of a problem with the pyspelling module?

s-makin · 2024-01-26T11:20:47Z

cloudinit/config/cc_set_hostname.py

+        dedent(
+            """\
+            # On a machine without an ``/etc/hostname`` file, don't create it
+            # In most clouds, this will results in a DHCP configured hostname


Suggested change

# In most clouds, this will results in a DHCP configured hostname

# In most clouds, this will result in a DHCP-configured hostname

s-makin · 2024-01-26T11:21:37Z

cloudinit/config/cc_update_hostname.py

+        dedent(
+            """\
+        # On a machine without an ``/etc/hostname`` file, don't create it
+        # In most clouds, this will results in a DHCP configured hostname


Suggested change

# In most clouds, this will results in a DHCP configured hostname

# In most clouds, this will result in a DHCP-configured hostname

cloudinit/config/cc_update_hostname.py

cloudinit/config/cc_set_hostname.py

If a cloud or user sets create_hostname_file to false (as GCP does) the examples in our docs for setting the hostname will not work. This change updates those examples to also set create_hostname_file to true.

Co-authored-by: James Falcon <therealfalcon@gmail.com>

) If a cloud or user sets create_hostname_file to false (as GCP does) the examples in our docs for setting the hostname will not work. This change updates those examples to also set create_hostname_file to true.

holmanb reviewed Jan 3, 2024

View reviewed changes

catmsred force-pushed the docs/update_metadata_hostname branch 2 times, most recently from bff03b9 to b136c51 Compare January 3, 2024 19:44

TheRealFalcon requested changes Jan 8, 2024

View reviewed changes

blackboxsw added the documentation This Pull Request changes documentation label Jan 9, 2024

github-actions bot removed the documentation This Pull Request changes documentation label Jan 18, 2024

catmsred force-pushed the docs/update_metadata_hostname branch 2 times, most recently from 0d5d178 to dc56887 Compare January 23, 2024 16:37

catmsred requested review from TheRealFalcon and holmanb January 23, 2024 18:57

TheRealFalcon approved these changes Jan 23, 2024

View reviewed changes

catmsred changed the title ~~[WIP] docs: add create_hostname_file to all hostname user-data examples~~ docs: add create_hostname_file to all hostname user-data examples Jan 24, 2024

catmsred requested a review from s-makin January 25, 2024 18:42

holmanb approved these changes Feb 5, 2024

View reviewed changes

s-makin reviewed Feb 7, 2024

View reviewed changes

catmsred and others added 4 commits February 7, 2024 08:56

docs: add create_hostname_file to all hostname user-data examples

5945f3e

If a cloud or user sets create_hostname_file to false (as GCP does) the examples in our docs for setting the hostname will not work. This change updates those examples to also set create_hostname_file to true.

docs: add create_hostname_file key to module reference examples

b5e160b

Update cloudinit/config/cc_set_hostname.py

7276f0f

Co-authored-by: James Falcon <therealfalcon@gmail.com>

docs: fix docs updates based on TheRealFalcon's comments

38ba64e

catmsred force-pushed the docs/update_metadata_hostname branch from dc56887 to 38ba64e Compare February 7, 2024 13:59

catmsred requested a review from s-makin February 7, 2024 14:02

s-makin approved these changes Feb 7, 2024

View reviewed changes

TheRealFalcon merged commit cb08cab into canonical:main Feb 9, 2024
29 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: add create_hostname_file to all hostname user-data examples #4727

docs: add create_hostname_file to all hostname user-data examples #4727

catmsred commented Jan 2, 2024

holmanb left a comment

holmanb Jan 3, 2024

catmsred Jan 3, 2024

TheRealFalcon Jan 8, 2024

TheRealFalcon Jan 8, 2024

TheRealFalcon Jan 8, 2024

holmanb Jan 22, 2024

TheRealFalcon Jan 8, 2024

TheRealFalcon left a comment

catmsred commented Jan 24, 2024

holmanb left a comment

catmsred commented Feb 5, 2024

s-makin left a comment

s-makin Jan 26, 2024

s-makin Jan 26, 2024

	# In most clouds, this will results in a DHCP configured hostname
	# In most clouds, this will result in a DHCP-configured hostname

docs: add create_hostname_file to all hostname user-data examples #4727

docs: add create_hostname_file to all hostname user-data examples #4727

Conversation

catmsred commented Jan 2, 2024

Proposed Commit Message

Additional Context

Test Steps

Checklist

Merge type

holmanb left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TheRealFalcon left a comment

Choose a reason for hiding this comment

catmsred commented Jan 24, 2024

holmanb left a comment

Choose a reason for hiding this comment

catmsred commented Feb 5, 2024

s-makin left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment