Skip to content

Commit 8256826

Browse files
committed
address wording comments from PR
1 parent 9705e56 commit 8256826

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

ansible/roles/basic_users/README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,20 @@ Role Variables
2121

2222
- `basic_users_users`: Optional, default empty list. A list of mappings defining information for each user. In general, mapping keys/values are passed through as parameters to [ansible.builtin.user](https://docs.ansible.com/ansible/latest/collections/ansible/builtin/user_module.html) and default values are as given there. However:
2323
- `create_home` and `generate_ssh_key`: Normally set automatically. Can be
24-
set `false` if necessary to disable home directory creation or cluster ssh
25-
key creation, should not be set `true`.
24+
set `false` if necessary to disable home directory creation/cluster ssh
25+
key creation. Should not be set `true` to avoid trying to modify home
26+
directories from multiple nodes simultaneously.
2627
- `ssh_key_comment`: Default is user name.
27-
- `home`: Normally set automatically.
28+
- `home`: Set automatically based on the user name and
29+
`basic_users_homedir_host_path`. Can be overriden if required for e.g.
30+
users with non-standard home directory paths.
2831
- `uid`: Should be set, so that the UID/GID is consistent across the cluster
2932
(which Slurm requires).
30-
- `shell`: If *not* set will be `/sbin/nologin` on the `control` node and the
31-
default shell on other users. Explicitly setting this defines the shell for
32-
all nodes.
33+
- `shell`: If *not* set will be `/sbin/nologin` on the `control` node to
34+
prevent users logging in to this node, and the default shell on other
35+
nodes. Explicitly setting this defines the shell for all nodes and if the
36+
shared home directories are mounted on the control node will allow the
37+
user to log in to the control node.
3338
- An additional key `public_key` may optionally be specified to define a key to log into the cluster.
3439
- An additional key `sudo` may optionally be specified giving a string (possibly multiline) defining sudo rules to be templated.
3540
- `ssh_key_type` defaults to `ed25519` instead of the `ansible.builtin.user` default of `rsa`.

0 commit comments

Comments
 (0)