Some examples in documentation incorrectly contain dashes vs underscores

Bug #1531582 reported by Samuel Matzek
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Fix Released
Jon Grimm

Bug Description

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:

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


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.

Tags: bitesize

Related branches

Jon Grimm (jgrimm)
tags: added: bitesize
Revision history for this message
Jon Grimm (jgrimm) wrote :

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

Changed in cloud-init:
status: New → In Progress
importance: Undecided → Low
assignee: nobody → Jon Grimm (jgrimm)
Revision history for this message
Scott Moser (smoser) wrote : Fixed in Cloud-init 17.1

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.

Changed in cloud-init:
status: In Progress → Fix Released
Revision history for this message
James Falcon (falcojr) wrote :
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.