-
Notifications
You must be signed in to change notification settings - Fork 105
/
schedulerinputparams.rst
172 lines (155 loc) · 39.3 KB
/
schedulerinputparams.rst
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
Input parameters for the cluster
-------------------------------------
These parameters are located in ``input/omnia_config.yml``, ``input/security_config.yml`` and [optional] ``input/storage_config.yml``.
.. caution:: Do not remove or comment any lines in the ``input/omnia_config.yml``, ``input/security_config.yml`` and [optional] ``input/storage_config.yml`` file.
**omnia_config.yml**
.. csv-table:: Parameters
:file: ../../Tables/scheduler.csv
:header-rows: 1
:keepspace:
**security_config.yml**
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Details |
+============================+=================================================================================================================================================================================================================================================================+
| freeipa_required | Boolean indicating whether FreeIPA is required or not. |
| ``boolean`` | |
| Optional | Choices: |
| | |
| | * ``true`` <- Default |
| | * ``false`` |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| realm_name | Sets the intended realm name. |
| ``string`` | |
| Optional | **Default values**: ``OMNIA.TEST`` |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| directory_manager_password | Password authenticating admin level access to the Directory for system management tasks. It will be added to the instance of directory server created for IPA.Required Length: 8 characters. The password must not contain -,, ‘,” |
| ``string`` | |
| Optional | |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| kerberos_admin_password | “admin” user password for the IPA server on RockyOS. |
| ``string`` | |
| Optional | |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ldap_required | Boolean indicating whether ldap client is required or not. |
| ``boolean`` | |
| Optional | Choices: |
| | |
| | * ``false`` <- Default |
| | * ``true`` |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| domain_name | Sets the intended domain name. |
| ``string`` | |
| Optional | **Default values**: ``omnia.test`` |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ldap_server_ip | LDAP server IP. Required if ``ldap_required`` is true. There should be an explicit LDAP server running on this IP. |
| ``string`` | |
| Optional | |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ldap_connection_type | For a TLS connection, provide a valid certification path. For an SSL connection, ensure port 636 is open. |
| ``string`` | |
| Optional | **Default values**: ``TLS`` |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ldap_ca_cert_path | This variable accepts Server Certificate Path. Make sure certificate is present in the path provided. The certificate should have .pem or .crt extension. This variable is mandatory if connection type is TLS. |
| ``string`` | |
| Optional | **Default values**: ``/etc/openldap/certs/omnialdap.pem`` |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| user_home_dir | This variable accepts the user home directory path for ldap configuration. If nfs mount is created for user home, make sure you provide the LDAP users mount home directory path. |
| ``string`` | |
| Optional | **Default values**: ``/home`` |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ldap_bind_username | If LDAP server is configured with bind dn then bind dn user to be provided. If this value is not provided (when bind is configured in server) then ldap authentication fails. Omnia does not validate this input. Ensure that it is valid and proper. |
| ``string`` | |
| Optional | **Default values**: ``admin`` |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ldap_bind_password | If LDAP server is configured with bind dn then bind dn password to be provided. If this value is not provided (when bind is configured in server) then ldap authentication fails. Omnia does not validate this input. Ensure that it is valid and proper. |
| ``string`` | |
| Optional | |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| enable_secure_login_node | Boolean value deciding whether security features are enabled on the Login Node. |
| ``boolean`` | |
| Optional | Choices: |
| | |
| | * ``false`` <- Default |
| | * ``true`` |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
**storage_config.yml**
+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Details |
+=================================+======================================================================================================================================================================================================================================================+
| nfs_client_params | If NFS client services are to be deployed, enter the configuration required here in JSON format. The server_ip provided should have an explicit NFS server running. If left blank, no NFS configuration takes place. Possible values include: |
| ``JSON list`` | 1. Single NFS file system: A single filesystem from a single NFS server is mounted. |
| Optional | |
| | Sample value: ``- { server_ip: xx.xx.xx.xx, server_share_path: “/mnt/share”, client_share_path: “/mnt/client”, client_mount_options: “nosuid,rw,sync,hard,intr” }`` |
| | 2. Multiple Mount NFS file system: Multiple filesystems from a single NFS server are mounted. |
| | Sample values: |
| | ``- { server_ip: xx.xx.xx.xx, server_share_path: “/mnt/server1”, client_share_path: “/mnt/client1”, client_mount_options: “nosuid,rw,sync,hard,intr” }`` |
| | ``- { server_ip: xx.xx.xx.xx, server_share_path: “/mnt/server2”, client_share_path: “/mnt/client2”, client_mount_options: “nosuid,rw,sync,hard,intr” }`` |
| | 3. Multiple NFS file systems: Multiple filesystems are mounted from multiple servers. |
| | Sample Values: ``- { server_ip: zz.zz.zz.zz, server_share_path: “/mnt/share1”, client_share_path: “/mnt/client1”, client_mount_options: “nosuid,rw,sync,hard,intr”}`` |
| | ``- { server_ip: xx.xx.xx.xx, server_share_path: “/mnt/share2”, client_share_path: “/mnt/client2”, client_mount_options: “nosuid,rw,sync,hard,intr”}`` |
| | ``- { server_ip: yy.yy.yy.yy, server_share_path: “/mnt/share3”, client_share_path: “/mnt/client3”, client_mount_options: “nosuid,rw,sync,hard,intr”}`` |
| | |
| | |
| | **Default value**: ``{ server_ip: , server_share_path: , client_share_path: , client_mount_options: }`` |
+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| beegfs_support | This variable is used to install beegfs-client on compute and manager nodes |
| ``boolean`` | |
| Optional | Choices: |
| | |
| | * ``false`` <- Default |
| | |
| | * ``true`` |
+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| beegfs_rdma_support | This variable is used if user has RDMA-capable network hardware (e.g., InfiniBand) |
| ``boolean`` | |
| Optional | Choices: |
| | |
| | * ``false`` <- Default |
| | |
| | * ``true`` |
+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| beegfs_ofed_kernel_modules_path | The path where separate OFED kernel modules are installed. |
| ``string`` | |
| Optional | **Default value**: ``"/usr/src/ofa_kernel/default/include"`` |
+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| beegfs_mgmt_server | BeeGFS management server IP. Note: The provided IP should have an explicit BeeGFS management server running . |
| ``string`` | |
| Required | |
+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| beegfs_mounts | Beegfs-client file system mount location. If ``storage_yml`` is being used to change the BeeGFS mounts location, set beegfs_unmount_client to true |
| ``string`` | **Default value**: "/mnt/beegfs" |
| Optional | |
+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| beegfs_unmount_client | Changing this value to true will unmount running instance of BeeGFS client and should only be used when decommisioning BeeGFS, changing the mount location or changing the BeeGFS version. |
| ``boolean`` | |
| Optional | Choices: |
| | |
| | * ``false`` <- Default |
| | |
| | * ``true`` |
+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| beegfs_client_version | Beegfs client version needed on compute and manager nodes. |
| ``string`` | |
| Optional | **Default value**: 7.2.6 |
+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| beegfs_version_change | Use this variable to change the BeeGFS version on the target nodes. |
| ``boolean`` | |
| Optional | Choices: |
| | |
| | * ``false`` <- Default |
| | |
| | * ``true`` |
+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| beegfs_secret_storage_filepath | * The filepath (including the filename) where the ``connauthfile`` is placed. |
| ``string`` | * Required for Beegfs version >= 7.2.7 |
| Required | |
| | |
| | **Default values**: ``/home/connauthfile`` |
+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Click here for more information on `FreeIPA, LDAP <Authentication.html>`_, `BeeGFS <BeeGFS.html>`_ or, `NFS <NFS.html>`_.
.. note::
The ``input/omnia_config.yml`` file is encrypted on the first run of the provision tool:
To view the encrypted parameters: ::
ansible-vault view omnia_config.yml --vault-password-file .omnia_vault_key
To edit the encrypted parameters: ::
ansible-vault edit omnia_config.yml --vault-password-file .omnia_vault_key