Skip to content

Commit

Permalink
Fix 'Users and Groups' configuration documentation (#530)
Browse files Browse the repository at this point in the history
Few of the 'User and Groups' configurations in cloud-config have no effect on
already existing users. This was not documented earlier.

This change set adds that information to documentation.

Signed-off-by: Shreenidhi Shedi <sshedi@vmware.com>
  • Loading branch information
sshedi authored Aug 13, 2020
1 parent 6ac71fd commit 4fb7eab
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 0 deletions.
7 changes: 7 additions & 0 deletions cloudinit/config/cc_users_groups.py
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,13 @@
If specifying a sudo rule for a user, ensure that the syntax for the rule
is valid, as it is not checked by cloud-init.
.. note::
Most of these configuration options will not be honored if the user
already exists. Following options are the exceptions and they are
applicable on already-existing users:
- 'plain_text_passwd', 'hashed_passwd', 'lock_passwd', 'sudo',
'ssh_authorized_keys', 'ssh_redirect_user'.
**Internal name:** ``cc_users_groups``
**Module frequency:** per instance
Expand Down
5 changes: 5 additions & 0 deletions doc/examples/cloud-config-user-groups.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,11 @@ groups:
- cloud-users

# Add users to the system. Users are added after groups are added.
# Note: Most of these configuration options will not be honored if the user
# already exists. Following options are the exceptions and they are
# applicable on already-existing users:
# - 'plain_text_passwd', 'hashed_passwd', 'lock_passwd', 'sudo',
# 'ssh_authorized_keys', 'ssh_redirect_user'.
users:
- default
- name: foobar
Expand Down
1 change: 1 addition & 0 deletions tools/.github-cla-signers
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ matthewruffell
nishigori
onitake
smoser
sshedi
TheRealFalcon
tomponline
tsanghan

0 comments on commit 4fb7eab

Please sign in to comment.