README/whitespace fixes

Author: sjpb

ansible/roles/basic_users/README.md

@@ -5,12 +5,13 @@ basic_users
 Setup users on cluster nodes using `/etc/passwd` and manipulating `$HOME`, i.e.
 without requiring LDAP etc. Features:
 - UID/GID is consistent across cluster (and explicitly defined).
-- SSH key generated and propagated to all nodes to allow login between cluster nodes.
+- SSH key generated and propagated to all nodes to allow login between cluster
+  nodes.
 - An "external" SSH key can be added to allow login from elsewhere.
 - Login to the control node is prevented (by default).
 - When deleting users, systemd user sessions are terminated first.
 
-> [!IMPORTANT] This role assumes that `$HOME` for users managed by this role 
+> [!IMPORTANT] This role assumes that `$HOME` for users managed by this role
 (e.g. not `rocky` and other system users) is on a shared filesystem. The export
 of this shared filesystem may be root squashed if its server is in the
 `basic_user` group - see configuration examples below.
@@ -24,9 +25,9 @@ Role Variables
     key creation, should not be set `true`.
   - `ssh_key_comment`: Default is user name.
   - `home`: Normally set automatically.
-  - `uid` should be set, so that the UID/GID is consistent across the cluster
+  - `uid`: Should be set, so that the UID/GID is consistent across the cluster
     (which Slurm requires).
-  - `shell` If *not* set will be `/sbin/nologin` on the `control` node and the
+  - `shell`: If *not* set will be `/sbin/nologin` on the `control` node and the
      default shell on other users. Explicitly setting this defines the shell for
      all nodes.
   - An additional key `public_key` may optionally be specified to define a key to log into the cluster.
@@ -36,14 +37,13 @@ Role Variables
 - `basic_users_groups`: Optional, default empty list. A list of mappings defining information for each group. Mapping keys/values are passed through as parameters to [ansible.builtin.group](https://docs.ansible.com/ansible/latest/collections/ansible/builtin/group_module.html) and default values are as given there.
 - `basic_users_override_sssd`: Optional bool, default false. Whether to disable `sssd` when ensuring users/groups exist with this role. Permits creating local users/groups even if they clash with users provided via sssd (e.g. from LDAP). Ignored if host is not in group `sssd` as well. Note with this option active `sssd` will be stopped and restarted each time this role is run.
 - `basic_users_homedir_host`: Optional inventory hostname defining the host
-  to use to create home directories. If the home directory export is root squashed,
-  this host *must* be the home directory server. Default is the `control` node,
-  for the default appliance NFS-exported home directory configuration.
+  to use to create home directories. If the home directory export is root
+  squashed, this host *must* be the home directory server. Default is the
+  `control` node which is appropriate for the default appliance configuration.
   Not relevant if `create_home` is false for all users.
 - `basic_users_homedir_host_path`: Optional path prefix for home directories on
    the `basic_users_homedir_host`, i.e. on the "server side". Default is
-   `/exports/home`, for the default appliance NFS-exported home directory
-   configuration.
+   `/exports/home` which is appropriate for the default appliance configuration.
 
 Dependencies
 ------------
@@ -69,9 +69,12 @@ basic_users_users:
     state: absent
 ```
 
-Using an external share which does not root squash so this role can create
-directories on it, which is also mounted to the control node (so this role can
-set authorized keys there), create user `Carol`:
+Using an external share which:
+  - does not root squash (so this role can create directories on it)
+  - ismounted to all nodes including the control node (so this role can set
+    authorized keys there),
+
+create user `Carol`:
 
 ```yaml
 basic_users_homedir_host: "{{ ansible_play_hosts | first }}" # doesn't matter which host is used

ansible/roles/basic_users/tasks/main.yml

@@ -87,7 +87,7 @@
         label: "{{ item.name }}"
       when:
         - item.state | default('present') == 'present'
-  
+
     - name: Generate cluster ssh key
       community.crypto.openssh_keypair:
         path: "{{ item.ssh_key_file | default('~/.ssh/' + _ssh_key_type )}}" # NB: ssh_key_file is from ansible.builtin.user