You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+2-1Lines changed: 2 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,7 +31,7 @@ It requires an OpenStack cloud, and an Ansible "deploy host" with access to that
31
31
32
32
Before starting ensure that:
33
33
- You have root access on the deploy host.
34
-
- You can create instances from the [latest Slurm appliance image](https://github.com/stackhpc/ansible-slurm-appliance/releases), which already contains the required packages. This is built and tested in StackHPC's CI. Although you can use a Rocky Linux 9 GenericCloud instead, it is not recommended.
34
+
- You can create instances from the [latest Slurm appliance image](https://github.com/stackhpc/ansible-slurm-appliance/releases), which already contains the required packages. This is built and tested in StackHPC's CI.
35
35
- You have an SSH keypair defined in OpenStack, with the private key available on the deploy host.
36
36
- Created instances have access to internet (note proxies can be setup through the appliance if necessary).
37
37
- Created instances have accurate/synchronised time (for VM instances this is usually provided by the hypervisor; if not or for bare metal instances it may be necessary to configure a time service via the appliance).
@@ -49,6 +49,7 @@ These instructions assume the deployment host is running Rocky Linux 8:
Copy file name to clipboardExpand all lines: ansible/roles/basic_users/README.md
+30-22Lines changed: 30 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,44 +11,52 @@ without requiring LDAP etc. Features:
11
11
- Login to the control node is prevented (by default).
12
12
- When deleting users, systemd user sessions are terminated first.
13
13
14
-
> [!IMPORTANT]This role assumes that `$HOME` for users managed by this role
15
-
(e.g. not `rocky` and other system users) is on a shared filesystem. The export
16
-
of this shared filesystem may be root squashed if its server is in the
17
-
`basic_user` group - see configuration examples below.
14
+
> [!IMPORTANT]The defaults for this role assumes that `$HOME` for users
15
+
managed by this role (e.g. not `rocky` and other system users) is on a shared
16
+
filesystem. The export of this shared filesystem may be root squashed if its
17
+
server is in the `basic_user` group - see configuration examples below.
18
18
19
19
Role Variables
20
20
--------------
21
21
22
-
-`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:
23
-
-`create_home` and `generate_ssh_key`: Normally set automatically. Can be
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.
22
+
-`basic_users_homedir_server`: Optional inventory hostname in the `basic_users`
23
+
group defining the host to use to create home directories. If the home
24
+
directory export is root squashed, this host *must* be the home directory
25
+
server. Default is the `control` node which is appropriate for the default
26
+
appliance configuration. Not relevant if `create_home` is false for all users.
27
+
-`basic_users_homedir_server_path`: Optional path prefix for home directories on
28
+
the `basic_users_homedir_server`, i.e. on the "server side". Default is
29
+
`/exports/home` which is appropriate for the default appliance configuration.
30
+
-`basic_users_homedir_client`: Optional inventory hostname in the `basic_users`
31
+
group defining the host to use to create ssh keys etc in home directories.
32
+
This should be a host mounting the home directories. Default is the first
33
+
node in the `login` group which is appropriate for the default appliance
34
+
configuration.
35
+
-`basic_users_users`: Optional, default empty list. A list of mappings defining
36
+
information for each user. In general, mapping keys/values are passed through
37
+
as parameters to [ansible.builtin.user](https://docs.ansible.com/ansible/latest/collections/ansible/builtin/user_module.html)
38
+
and default values are as given there, with the following differences:
39
+
-`generate_ssh_key`: Default is `true`, and the generated key is added to
40
+
the user's authorized keys.
27
41
-`ssh_key_comment`: Default is user name.
28
42
-`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.
43
+
`basic_users_homedir_server_path`. Can be overriden for users with
44
+
non-standard home directory paths.
31
45
-`uid`: Should be set, so that the UID/GID is consistent across the cluster
32
46
(which Slurm requires).
33
47
-`shell`: If *not* set will be `/sbin/nologin` on the `control` node to
34
48
prevent users logging in to this node, and the default shell on other
35
49
nodes. Explicitly setting this defines the shell for all nodes and if the
36
50
shared home directories are mounted on the control node will allow the
37
51
user to log in to the control node.
38
-
- An additional key `public_key` may optionally be specified to define a key to log into the cluster.
39
-
- An additional key `sudo` may optionally be specified giving a string (possibly multiline) defining sudo rules to be templated.
40
-
-`ssh_key_type` defaults to `ed25519` instead of the `ansible.builtin.user` default of `rsa`.
52
+
-`public_key`: Optional, define a key to log into the cluster with.
53
+
-`sudo`: Optional, a (possibly multiline) string defining sudo rules for the
54
+
user.
55
+
-`ssh_key_type` defaults to `ed25519` instead of the `ansible.builtin.user`
56
+
default of `rsa`.
41
57
- Any other keys may present for other purposes (i.e. not used by this role).
42
58
-`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.
43
59
-`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.
44
-
-`basic_users_homedir_host`: Optional inventory hostname defining the host
45
-
to use to create home directories. If the home directory export is root
46
-
squashed, this host *must* be the home directory server. Default is the
47
-
`control` node which is appropriate for the default appliance configuration.
48
-
Not relevant if `create_home` is false for all users.
49
-
-`basic_users_homedir_host_path`: Optional path prefix for home directories on
50
-
the `basic_users_homedir_host`, i.e. on the "server side". Default is
51
-
`/exports/home` which is appropriate for the default appliance configuration.
0 commit comments