summaryrefslogtreecommitdiff
path: root/cloudinit
diff options
context:
space:
mode:
authorChad Smith <chad.smith@canonical.com>2018-06-19 16:47:58 -0600
committerChad Smith <chad.smith@canonical.com>2018-06-19 16:47:58 -0600
commita670eb816c8bd73262f29f3821b64b59ae09da94 (patch)
treeae367c6a6ce29b680dacbbe5d41852654e1ac6a5 /cloudinit
parent4d69fb44a5607e16843537be26758893f2dd79be (diff)
downloadvyos-cloud-init-a670eb816c8bd73262f29f3821b64b59ae09da94.tar.gz
vyos-cloud-init-a670eb816c8bd73262f29f3821b64b59ae09da94.zip
docs: represent sudo:false in docs for user_groups config module
Diffstat (limited to 'cloudinit')
-rw-r--r--cloudinit/config/cc_users_groups.py8
1 files changed, 6 insertions, 2 deletions
diff --git a/cloudinit/config/cc_users_groups.py b/cloudinit/config/cc_users_groups.py
index b215e95a..c95bdaad 100644
--- a/cloudinit/config/cc_users_groups.py
+++ b/cloudinit/config/cc_users_groups.py
@@ -54,8 +54,9 @@ config keys for an entry in ``users`` are as follows:
- ``ssh_authorized_keys``: Optional. List of ssh keys to add to user's
authkeys file. Default: none
- ``ssh_import_id``: Optional. SSH id to import for user. Default: none
- - ``sudo``: Optional. Sudo rule to use, or list of sudo rules to use.
- Default: none.
+ - ``sudo``: Optional. Sudo rule to use, list of sudo rules to use or False.
+ Default: none. An absence of sudo key, or a value of none or false
+ will result in no sudo rules being written for the user.
- ``system``: Optional. Create user as system user with no home directory.
Default: false
- ``uid``: Optional. The user's ID. Default: The next available value.
@@ -82,6 +83,9 @@ config keys for an entry in ``users`` are as follows:
users:
- default
+ # User explicitly omitted from sudo permission; also default behavior.
+ - name: <some_restricted_user>
+ sudo: false
- name: <username>
expiredate: <date>
gecos: <comment>