kayobe/README.rst
Mark Goddard 64f502fe85 Update README & CONTRIBUTING for OpenStack process
Kayobe is to become an OpenStack-related project, and as such will use
Gerrit for code reviews and Storyboard for issue and feature tracking.
The README and CONTRIBUTING documents have been updated to reflect that,
and a standard OpenStack HACKING document has been added.

Change-Id: Id03bcb5183bfbf6e84bb4d9c22f85d9418b6b4fc
Story: #2001637
Task: #6644
2018-03-13 14:14:26 +00:00

60 lines
2.3 KiB
ReStructuredText

======
Kayobe
======
Kayobe enables deployment of containerised OpenStack to bare metal.
Containers offer a compelling solution for isolating OpenStack services, but
running the control plane on an orchestrator such as Kubernetes or Docker
Swarm adds significant complexity and operational overheads.
The hosts in an OpenStack control plane must somehow be provisioned, but
deploying a secondary OpenStack cloud to do this seems like overkill.
Kayobe stands on the shoulders of giants:
* OpenStack bifrost discovers and provisions the cloud
* OpenStack kolla builds container images for OpenStack services
* OpenStack kolla-ansible delivers painless deployment and upgrade of
containerised OpenStack services
To this solid base, kayobe adds:
* Configuration of cloud host OS & flexible networking
* Management of physical network devices
* A friendly openstack-like CLI
All this and more, automated from top to bottom using Ansible.
* Free software: Apache license
* Documentation: https://kayobe.readthedocs.io/en/latest/
* Source: https://git.openstack.org/cgit/openstack/kayobe
* Bugs: https://storyboard.openstack.org/
* IRC: #openstack-kayobe
Features
--------
* Heavily automated using Ansible
* *kayobe* Command Line Interface (CLI) for cloud operators
* Deployment of a *seed* VM used to manage the OpenStack control plane
* Configuration of physical network infrastructure
* Discovery, introspection and provisioning of control plane hardware using
`OpenStack bifrost <https://docs.openstack.org/developer/bifrost/>`_
* Deployment of an OpenStack control plane using `OpenStack kolla-ansible
<https://docs.openstack.org/developer/kolla-ansible/>`_
* Discovery, introspection and provisioning of bare metal compute hosts
using `OpenStack ironic <https://docs.openstack.org/developer/ironic/>`_ and
`ironic inspector <https://docs.openstack.org/developer/ironic-inspector/>`_
* Virtualised compute using `OpenStack nova
<https://docs.openstack.org/developer/nova/>`_
* Containerised workloads on bare metal using `OpenStack magnum
<https://docs.openstack.org/developer/magnum/>`_
* Big data on bare metal using `OpenStack sahara
<https://docs.openstack.org/developer/sahara/>`_
In the near future we aim to add support for the following:
* Control plane and workload monitoring and log aggregation using `OpenStack
monasca <https://wiki.openstack.org/wiki/Monasca>`_