Some examples in documentation incorrectly contain dashes vs underscores
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
cloud-init |
Fix Released
|
Low
|
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:
http://
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.
Related branches
- Server Team CI bot: Approve (continuous-integration)
- cloud-init Commiters: Pending requested
-
Diff: 16 lines (+2/-2)1 file modifieddoc/examples/cloud-config-resolv-conf.txt (+2/-2)
Looks like lock-passwd has been fixed, but manage-resolve-conf has not in the current sources.