Skip to content

Commit 7604aa4

Browse files
committed
Update README
1 parent 9d83ffb commit 7604aa4

File tree

1 file changed

+23
-12
lines changed

1 file changed

+23
-12
lines changed

README.md

Lines changed: 23 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,27 @@ The minimal image for nodes is a CentOS 7 or RockyLinux 8 GenericCloud image. Th
1010

1111
## Role Variables
1212

13-
`openhpc_release_repo`: Optional. Path to the `ohpc-release` repo to use. Defaults provide v1.3 for Centos 7 and v2 for Centos 8. Or, include this
14-
package in the image.
15-
16-
`openhpc_slurm_service_enabled`: boolean, whether to enable the appropriate slurm service (slurmd/slurmctld)
13+
`openhpc_version`: Optional. OpenHPC version to install. Defaults provide `1.3` for Centos 7 and `2` for RockyLinux/CentOS 8.
14+
15+
`openhpc_extra_repos`: Optional list. Extra Yum repository definitions to configure, following the format of the Ansible
16+
[yum_repository](https://docs.ansible.com/ansible/2.9/modules/yum_repository_module.html) module. Respected keys for
17+
each list element:
18+
* `name`: Required
19+
* `description`: Optional
20+
* `file`: Required
21+
* `baseurl`: Optional
22+
* `metalink`: Optional
23+
* `mirrorlist`: Optional
24+
* `gpgcheck`: Optional
25+
* `gpgkey`: Optional
26+
27+
`openhpc_slurm_service_enabled`: boolean, whether to enable the appropriate slurm service (slurmd/slurmctld).
1728

1829
`openhpc_slurm_service_started`: Optional boolean. Whether to start slurm services. If set to false, all services will be stopped. Defaults to `openhpc_slurm_service_enabled`.
1930

20-
`openhpc_slurm_control_host`: ansible host name of the controller e.g `"{{ groups['cluster_control'] | first }}"`
31+
`openhpc_slurm_control_host`: ansible host name of the controller e.g `"{{ groups['cluster_control'] | first }}"`.
2132

22-
`openhpc_packages`: additional OpenHPC packages to install
33+
`openhpc_packages`: additional OpenHPC packages to install.
2334

2435
`openhpc_enable`:
2536
* `control`: whether to enable control host
@@ -62,7 +73,7 @@ For each group (if used) or partition any nodes in an ansible inventory group `<
6273

6374
`openhpc_job_maxtime`: Maximum job time limit, default `'60-0'` (60 days). See [slurm.conf](https://slurm.schedmd.com/slurm.conf.html) parameter `MaxTime` for format. The default is 60 days. The value should be quoted to avoid Ansible conversions.
6475

65-
`openhpc_cluster_name`: name of the cluster
76+
`openhpc_cluster_name`: name of the cluster.
6677

6778
`openhpc_config`: Optional. Mapping of additional parameters and values for `slurm.conf`. Note these will override any included in `templates/slurm.conf.j2`.
6879

@@ -99,9 +110,9 @@ accounting data such as start and end times. By default no job accounting is con
99110
`jobcomp/filetxt`, `jobcomp/none`, `jobcomp/elasticsearch`.
100111

101112
`openhpc_slurm_job_acct_gather_type`: Mechanism for collecting job accounting data. Can be one
102-
of `jobacct_gather/linux`, `jobacct_gather/cgroup` and `jobacct_gather/none`
113+
of `jobacct_gather/linux`, `jobacct_gather/cgroup` and `jobacct_gather/none`.
103114

104-
`openhpc_slurm_job_acct_gather_frequency`: Sampling period for job accounting (seconds)
115+
`openhpc_slurm_job_acct_gather_frequency`: Sampling period for job accounting (seconds).
105116

106117
`openhpc_slurm_job_comp_loc`: Location to store the job accounting records. Depends on value of
107118
`openhpc_slurm_job_comp_type`, e.g for `jobcomp/filetxt` represents a path on disk.
@@ -111,15 +122,15 @@ accounting data such as start and end times. By default no job accounting is con
111122
The following options affect `slurmdbd.conf`. Please see the slurm [documentation](https://slurm.schedmd.com/slurmdbd.conf.html) for more details.
112123
You will need to configure these variables if you have set `openhpc_enable.database` to `true`.
113124

114-
`openhpc_slurmdbd_port`: Port for slurmdb to listen on, defaults to `6819`
125+
`openhpc_slurmdbd_port`: Port for slurmdb to listen on, defaults to `6819`.
115126

116127
`openhpc_slurmdbd_mysql_host`: Hostname or IP Where mariadb is running, defaults to `openhpc_slurm_control_host`.
117128

118-
`openhpc_slurmdbd_mysql_database`: Database to use for accounting, defaults to `slurm_acct_db`
129+
`openhpc_slurmdbd_mysql_database`: Database to use for accounting, defaults to `slurm_acct_db`.
119130

120131
`openhpc_slurmdbd_mysql_password`: Password for authenticating with the database. You must set this variable.
121132

122-
`openhpc_slurmdbd_mysql_username`: Username for authenticating with the database, defaults to `slurm`
133+
`openhpc_slurmdbd_mysql_username`: Username for authenticating with the database, defaults to `slurm`.
123134

124135
## Example Inventory
125136

0 commit comments

Comments
 (0)