Merge pull request #34 from lwilson/devel

Updating documentation to match playbook names and directory structure

docs/INSTALL.md

@@ -1,55 +1,65 @@
-Dancing to the beat of a different drum.
+# Installing Omnia
 
-# Short Version:
+## TL;DR
 
+### Kubernetes
 Install Kubernetes and all dependencies
 ```
-ansible-playbook -i host_inventory_file build-kubernetes-cluster.yml
+ansible-playbook -i host_inventory_file kubernetes/kubernetes.yml
 ```
 
-Initialize K8S cluster
+Initialize K8s cluster
 ```
-ansible-playbook -i host_inventory_file build-kubernetes-cluster.yml --tags "init"
+ansible-playbook -i host_inventory_file kubernetes/kubernetes.yml --tags "init"
+```
+### Slurm
+```
+ansible-playbook -i host_inventory_file slurm/slurm.yml
 ```
-
-
-# What this does:
 
 ## Build/Install
+Omnia is a collection of [Ansible](https://www.ansible.com/) playbooks which perform:
+* Installation of [Slurm](https://slurm.schedmd.com/) and/or [Kubernetes](https://kubernetes.io/) on servers already provisioned with a standard [CentOS](https://www.centos.org/) image.
+* Installation of auxiliary scripts for administrator functions such as moving nodes between Slurm and Kubernetes personalities.
 
-### Add additional repositories:
-
-- Kubernetes (Google)
-- El Repo (nvidia drivers)
-- Nvidia (nvidia-docker)
-- EPEL (Extra Packages for Enterprise Linux)
-
-### Install common packages
- - gcc
- - python-pip
- - docker
- - kubelet
- - kubeadm
- - kubectl
- - nvidia-detect
- - kmod-nvidia
- - nvidia-x11-drv
- - nvidia-container-runtime
- - ksonnet (CLI framework for K8S configs)
-
-### Enable GPU Device Plugins (nvidia-container-runtime-hook)
-
-### Modify kubeadm config to allow GPUs as schedulable resource 
+### Kubernetes
 
-### Start and enable services
- - Docker
- - Kubelet
+* Add additional repositories:
+    - Kubernetes (Google)
+    - El Repo (nvidia drivers)
+    - Nvidia (nvidia-docker)
+    - EPEL (Extra Packages for Enterprise Linux)
+* Install common packages
+    - gcc
+    - python-pip
+    - docker
+    - kubelet
+    - kubeadm
+    - kubectl
+    - nvidia-detect
+    - kmod-nvidia
+    - nvidia-x11-drv
+    - nvidia-container-runtime
+    - ksonnet (CLI framework for K8S configs)
+* Enable GPU Device Plugins (nvidia-container-runtime-hook)
+* Modify kubeadm config to allow GPUs as schedulable resource 
+* Start and enable services
+    - Docker
+    - Kubelet
+* Initialize Cluster
+    * Head/master
+        - Start K8S pass startup token to compute/slaves
+        - Initialize networking (Currently using WeaveNet)
+        - Setup K8S Dashboard
+        - Create dynamic/persistent volumes
+    * Compute/slaves
+        - Join k8s cluster
 
-## Initialize Cluster
-### Head/master
-- Start K8S pass startup token to compute/slaves
-- Initialize networking (Currently using WeaveNet)
--Setup K8S Dashboard
-- Create dynamic/persistent volumes
-### Compute/slaves
-- Join k8s cluster
+### Slurm
+* Download and build Slurm source
+* Install necessary dependencies
+    - Python3
+    - munge
+    - MariaDB
+    - MariaDB development libraries
+* Build Slurm configuration files