Some examples in documentation incorrectly contain dashes vs underscores

[ubuntu-server-builder]

This bug was originally filed in Launchpad as LP: #1531582

Launchpad details

affected_projects = []
assignee = jgrimm
assignee_name = Jon Grimm
date_closed = 2017-09-23T02:13:30.051995+00:00
date_created = 2016-01-06T18:54:38.257894+00:00
date_fix_committed = 2017-09-23T02:13:30.051995+00:00
date_fix_released = 2017-09-23T02:13:30.051995+00:00
id = 1531582
importance = low
is_complete = True
lp_url = https://bugs.launchpad.net/cloud-init/+bug/1531582
milestone = None
owner = smatzek
owner_name = Samuel Matzek
private = False
status = fix_released
submitter = smatzek
submitter_name = Samuel Matzek
tags = ['bitesize']
duplicates = []

Launchpad user Samuel Matzek(smatzek) wrote on 2016-01-06T18:54:38.257894+00:00

I know of two examples in the documentation that contain dashes in config keys when they need to be underscores to function at runtime.

Following the examples in this case can lead to a lot of wasted time and the dash vs underscore difference can be easy to miss, even when looking at the code to see why things aren't working.

The two locations that have caused problems are:
http://bazaar.launchpad.net/~cloud-init-dev/cloud-init/trunk/view/head:/doc/examples/cloud-config-resolv-conf.txt

In this example manage-resolv-conf should be manage_resolv_conf since that is what the module is really looking for.

and
http://bazaar.launchpad.net/~cloud-init-dev/cloud-init/trunk/view/head:/doc/examples/cloud-config-user-groups.txt

This user/groups example has 3 occurrences of lock-passwd that should be lock_passwd
This particular one is very frustrating when you hit it because when you hit it you're usually trying to set lock_passwd to False because you have some need to log into the account using a password but when you specify anything on lock-passwd the value of lock_passwd still defaults to True and locks you out.

[ubuntu-server-builder]

Launchpad user Jon Grimm(jgrimm) wrote on 2017-04-03T20:00:19.963126+00:00

Looks like lock-passwd has been fixed, but manage-resolve-conf has not in the current sources.

[ubuntu-server-builder]

Launchpad user Scott Moser(smoser) wrote on 2017-09-23T02:13:31.680647+00:00

This bug is believed to be fixed in cloud-init in 17.1. If this is still a problem for you, please make a comment and set the state back to New

Thank you.