Add more substance to README
This commit is contained in:
parent
7fe0942a03
commit
d1228ca350
24
README.rst
24
README.rst
|
@ -2,7 +2,25 @@ Tenks
|
||||||
=====
|
=====
|
||||||
|
|
||||||
Tenks is a utility that manages virtual bare metal clusters for development and
|
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,
|
* Declarative definition of clusters using Ansible's familiar YAML
|
||||||
configuration guidance and other information.
|
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.
|
||||||
|
|
Loading…
Reference in New Issue