Merge pull request #103 from jsteel44/readme

GetSysStatus should also be set

Author: JohnGarbutt

dac-ansible/README.md

@@ -1,7 +1,8 @@
 # Install data-acc Development Environment with Ansible
 
-Install data-acc demo with Ansible. It creates a bunch of OpenStack VMs, then
-uses Ansible to install a development data-acc environment.
+Install data-acc demo with Ansible. There is a script to create OpenStack VMs
+but you can skip OpenStack steps and use your own Ansible inventory file if
+preferred.
 
 ## Setup
 

docs/index.md

@@ -75,7 +75,7 @@ please see: https://github.com/RSE-Cambridge/data-acc
 
 ### Slurm Integration Testing
 
-Currently we are targeting testing at Slurm 18.08.x
+Currently we are targeting testing at Slurm 19.05.x
 
 The packing is based on:
 https://github.com/giovtorres/slurm-docker-cluster

docs/install.md

@@ -5,6 +5,12 @@ While there is an work in progress
 this document looks at the manual setup of the data-acc
 components.
 
+## Requirements
+
+* Slurm 18.08.x or newer. 19.05.x is currently being tested
+* etcd 3.3.x or newer
+* Shared home directory between DAC, compute and login nodes
+
 ## DACD and DACCTL
 
 Both software components are built statically.
@@ -47,18 +53,16 @@ WantedBy=multi-user.target
 
 The configuration in `/etc/dacd/dacd.conf` is covered in more detail below.
 
-On the Slurm master node, the `dacctl` binary is used as a command line too.
-Below you can see the Slurm configuration GetSysState can be modified to
-point to the location where you installed the binary.
+On the Slurm master node, the `dacctl` binary needs to be accessible.
+Below you can see the Slurm configuration options GetSysState and GetSysStatus,
+both of which need to be modified to point to the location of the dacctl binary.
 
 ## etcd and TLS config
 
 You need to install an etcd cluster.
 It can be installed as required via EPEL or from
 [the repository](https://www.github.com/coreos/etcd)
 
-We recommend you run the last 3.3.x release of etcd.
-
 To secure the communication with etcd, TLS certificates should be used.
 
 For more details please see the etcd docs, such as this page:
@@ -150,6 +154,7 @@ OtherTimeout=300
 DefaultPool=default
  
 GetSysState=/usr/local/bin/dacctl
+GetSysStatus=/usr/local/bin/dacctl
 ```
 
 ## SSH and Service Accounts