diff options
| author | sshedi <53473811+sshedi@users.noreply.github.com> | 2020-08-13 23:02:09 +0530 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-08-13 13:32:09 -0400 |
| commit | 4fb7eab7989b8eb80b4451ea325311c5dc97e3bc (patch) | |
| tree | e7e38ea2d44eb371b77d9c61978e4d085c420a84 | |
| parent | 6ac71fdf22db43269cf9b068517290b937ec31b5 (diff) | |
| download | vyos-cloud-init-4fb7eab7989b8eb80b4451ea325311c5dc97e3bc.tar.gz vyos-cloud-init-4fb7eab7989b8eb80b4451ea325311c5dc97e3bc.zip | |
Fix 'Users and Groups' configuration documentation (#530)
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>
| -rw-r--r-- | cloudinit/config/cc_users_groups.py | 7 | ||||
| -rw-r--r-- | doc/examples/cloud-config-user-groups.txt | 5 | ||||
| -rw-r--r-- | tools/.github-cla-signers | 1 |
3 files changed, 13 insertions, 0 deletions
diff --git a/cloudinit/config/cc_users_groups.py b/cloudinit/config/cc_users_groups.py index 13764e60..426498a3 100644 --- a/cloudinit/config/cc_users_groups.py +++ b/cloudinit/config/cc_users_groups.py @@ -78,6 +78,13 @@ config keys for an entry in ``users`` are as follows: 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 diff --git a/doc/examples/cloud-config-user-groups.txt b/doc/examples/cloud-config-user-groups.txt index aa14a6dd..b593cdd1 100644 --- a/doc/examples/cloud-config-user-groups.txt +++ b/doc/examples/cloud-config-user-groups.txt @@ -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 diff --git a/tools/.github-cla-signers b/tools/.github-cla-signers index fcaf752b..50473bf7 100644 --- a/tools/.github-cla-signers +++ b/tools/.github-cla-signers @@ -14,6 +14,7 @@ matthewruffell nishigori onitake smoser +sshedi TheRealFalcon tomponline tsanghan |