openstack
/
tenks
Code Issues Proposed changes

Add more substance to README

This commit is contained in:
Will Miller 2018-09-21 16:14:54 +01:00
parent 7fe0942a03
commit d1228ca350
1 changed files with 21 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.rst
View File

@ -2,7 +2,25 @@ Tenks
=====
Tenks is a utility that manages virtual bare metal clusters for development and
testing purposes.
testing purposes. It offers:
Refer to the documentation in ``doc/`` for installation instructions,
configuration guidance and other information.
* Declarative definition of clusters using Ansible's familiar YAML
syntax
* Automated creation and deletion of virtualised bare metal nodes across any
number of hypervisors
* In-built management of Open vSwitch bridges for physical networks
* Registration of nodes and ports with OpenStack Ironic, and creation of
OpenStack Nova flavors
* Simple cluster reconfiguration and tear-down
To get started with Tenks, see the documentation (linked below).
* Free software: Apache license
* Documentation: https://tenks.readthedocs.io/
* Source: https://github.com/stackhpc/tenks/
* Bugs: https://github.com/stackhpc/tenks/issues
* Known issues/limitations: refer to the documentation.