Add basis for README

Also fix requirements.yml
This commit is contained in:
Will Miller 2018-08-23 13:04:48 +00:00
parent 56fb19d4c1
commit 6aa5a2f7ee
2 changed files with 19 additions and 2 deletions

17
README.md Normal file
View File

@ -0,0 +1,17 @@
Tenks
=====
Tenks is a utility that manages virtual bare metal clusters for development and
testing purposes.
Getting Started
---------------
Tenks has dependencies on Ansible roles that are hosted by Ansible Galaxy.
Given that your virtualenv of choice is active and Ansible is installed inside
it, Tenks' role dependencies can be installed by `ansible-galaxy install
--role-file=requirements.yml --roles-path=ansible/roles/`.
Currently, Tenks does not have a CLI or wrapper. A virtual cluster can be
deployed by configuring the variables defined in `group_vars/*` as necessary,
then calling `ansible-playbook -i ansible/inventory deploy.yml`.

View File

@ -1,3 +1,3 @@
---
src: stackhpc.libvirt-host
src: stackhpc.libvirt-vm
- src: stackhpc.libvirt-host
- src: stackhpc.libvirt-vm