From 3a61c93590e3b99871d1a66d20468ad4831e8ba5 Mon Sep 17 00:00:00 2001 From: Nate Coraor Date: Wed, 30 Jan 2019 00:08:53 -0500 Subject: [PATCH] Make README trueish --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3debeb2..fc5aa5b 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Install and configure Slurm Role Variables -------------- -All variables are optional. If nothing is set, the role will install the Slurm client programs, munge, and create a `slurm.conf`. See the [defaults][defaults] and [example playbook](#example-playbook) for examples. +All variables are optional. If nothing is set, the role will install the Slurm client programs, munge, and create a `slurm.conf` with a single `localhost` node and `debug` partition. See the [defaults](defaults/main.yml) and [example playbook](#example-playbook) for examples. For the various roles a slurm node can play, you can either set group names, or add values to a list, `slurm_roles`. @@ -14,6 +14,16 @@ For the various roles a slurm node can play, you can either set group names, or - group slurmexechosts or `slurm_roles: ['exec']` - group slurmdbdservers or `slurm_roles: ['dbd']` +General config options for slurm.conf go in `slurm_config`, a hash. Keys are slurm config option names. + +Partitions and nodes go in `slurm_partitions` and `slurm_nodes`, lists of hashes. The only required key in the hash is +`name`, which becomes the `PartitionName` or `NodeName` for that line. All other keys/values are placed on to the line +of that partition or node. + +Set `slurm_upgrade` true to upgrade. + +You can use `slurm_user` (a hash) and `slurm_create_user` (a bool) to pre-create a Slurm user (so that uids match). See + Dependencies ------------ @@ -26,7 +36,6 @@ Example Playbook - name: Slurm all in One hosts: all vars: - slurm_user: {} slurm_roles: ['controller', 'exec', 'dbd'] roles: - galaxyproject.slurm