From 6aa5a2f7eee1dad32410e36bb388b9e67d854b80 Mon Sep 17 00:00:00 2001 From: Will Miller Date: Thu, 23 Aug 2018 13:04:48 +0000 Subject: [PATCH] Add basis for README Also fix requirements.yml --- README.md | 17 +++++++++++++++++ requirements.yml | 4 ++-- 2 files changed, 19 insertions(+), 2 deletions(-) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..e2c9857 --- /dev/null +++ b/README.md @@ -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`. diff --git a/requirements.yml b/requirements.yml index 1c954d3..f37b2e0 100644 --- a/requirements.yml +++ b/requirements.yml @@ -1,3 +1,3 @@ --- -src: stackhpc.libvirt-host -src: stackhpc.libvirt-vm +- src: stackhpc.libvirt-host +- src: stackhpc.libvirt-vm