summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMark Goddard <mark@stackhpc.com>2018-05-15 09:51:49 +0100
committerMark Goddard <mark@stackhpc.com>2018-05-15 09:51:49 +0100
commitc0dc6c3d09995dbf6b34f0fe9d69402fb3397108 (patch)
tree39967fe7952c03a9bd46c972beaae52500440676
parent256ef9619dd23e457f0b69886252cabba4c155a2 (diff)
Update README text links
Synchronises with the README in kayobe, and updates links.
-rw-r--r--README.rst38
1 files changed, 28 insertions, 10 deletions
diff --git a/README.rst b/README.rst
index 8cfde89..b14b533 100644
--- a/README.rst
+++ b/README.rst
@@ -3,16 +3,34 @@ Kayobe Configuration
3==================== 3====================
4 4
5This repository provides configuration for the `kayobe 5This repository provides configuration for the `kayobe
6<https://github.com/stackhpc/kayobe>`_ project. It is intended to encourage 6<https://github.com/openstack/kayobe>`_ project. It is intended to encourage
7version control of site configuration. 7version control of site configuration.
8 8
9Kayobe is an open source tool for automating deployment of Scientific OpenStack 9Kayobe enables deployment of containerised OpenStack to bare metal.
10onto a set of bare metal servers. Kayobe is composed of Ansible playbooks, a
11python module, and makes heavy use of the OpenStack kolla project. Kayobe aims
12to complement the kolla-ansible project, providing an opinionated yet highly
13configurable OpenStack deployment and automation of many operational
14procedures.
15 10
16* Documentation: https://github.com/stackhpc/kayobe/tree/master/doc 11Containers offer a compelling solution for isolating OpenStack services, but
17* Source: https://github.com/stackhpc/kayobe 12running the control plane on an orchestrator such as Kubernetes or Docker
18* Bugs: https://github.com/stackhpc/kayobe/issues 13Swarm adds significant complexity and operational overheads.
14
15The hosts in an OpenStack control plane must somehow be provisioned, but
16deploying a secondary OpenStack cloud to do this seems like overkill.
17
18Kayobe stands on the shoulders of giants:
19
20* OpenStack bifrost discovers and provisions the cloud
21* OpenStack kolla builds container images for OpenStack services
22* OpenStack kolla-ansible delivers painless deployment and upgrade of
23 containerised OpenStack services
24
25To this solid base, kayobe adds:
26
27* Configuration of cloud host OS & flexible networking
28* Management of physical network devices
29* A friendly openstack-like CLI
30
31All this and more, automated from top to bottom using Ansible.
32
33* Documentation: https://kayobe.readthedocs.io/en/latest/
34* Source: https://git.openstack.org/cgit/openstack/kayobe
35* Bugs: https://storyboard.openstack.org/
36* IRC: #openstack-kayobe