Merge pull request #11 from lwilson/issue-9-document-setup

Issue 9 document setup

README.md

@@ -4,7 +4,7 @@
 Omnia (Latin: all or everything) is a deployment tool to turn Dell EMC PowerEdge servers with factory-installed OS images into a functioning Slurm/Kubernetes cluster.
 
 ## Installing Omnia
-To install Omnia, see [INSTALL](INSTALL.md)
+To install Omnia, see [INSTALL](docs/INSTALL.md)
 
 ## Contributing
 To contribute to the Omnia project, see [CONTRIBUTING](CONTRIBUTING.md)

docs/PREINSTALL.md

@@ -0,0 +1,18 @@
+# Pre-Installation Preparation
+
+## Assumptions
+Omnia assumes that prior to installation:
+* Systems have a base operating system (currently CentOS 7 or 8)
+* Network(s) has been cabled and nodes can reach the internet
+* SSH Keys for `root` have been installed on all nodes to allow for password-less SSH
+* Ansible is installed on the master node
+```
+yum install ansible
+```
+
+## Example system designs
+Omnia can configure systems which use Ethernet- or Infiniband-based fabric to connect the compute servers.
+
+![Example system configuration with Ethernet fabric](images/example-system-ethernet.png)
+
+![Example system configuration with Infiniband fabric](images/example-system-infiniband.png)