From 25f07946573a34ac2fc26a13ceb85a1405ae536d Mon Sep 17 00:00:00 2001 From: Christian Berendt Date: Tue, 6 Sep 2016 10:31:25 +0200 Subject: [PATCH] Improve README file * add missing infrastructure component images * sync missing statement with projects.yaml file (governance repo) * improve syntax Change-Id: Ie1716e7482c11b9de243b6ee04d04f1039dcf784 --- README.rst | 87 ++++++++++++++++++++++++++++++++---------------------- 1 file changed, 51 insertions(+), 36 deletions(-) diff --git a/README.rst b/README.rst index ee0251def0..b4484d7404 100644 --- a/README.rst +++ b/README.rst @@ -1,17 +1,20 @@ +============== Kolla Overview ============== The Kolla project is a member of the OpenStack `Big Tent Governance `__. + Kolla's mission statement is: :: - Kolla provides production-ready containers and deployment tools for - operating OpenStack clouds. + To provide production-ready containers and deployment tools for operating + OpenStack clouds. Kolla provides `Docker `__ containers and `Ansible `__ playbooks to meet Kolla's mission. + Kolla is highly opinionated out of the box, but allows for complete customization. This permits operators with little experience to deploy OpenStack quickly and as experience grows modify the OpenStack @@ -26,6 +29,25 @@ Learn about Kolla by reading the documentation online Get started by reading the `Developer Quickstart `__. +Docker images +============= + +The `Docker images `__ +are built by the Kolla project maintainers. A detailed process for +contributing to the images can be found in the `image building +guide `__. + +The Kolla developers build images in the `kolla` namespace for every tagged +release and implement an Ansible roles for many but not all of them. + +You can view the available images on `Docker Hub +`__ or with the Docker CLI:: + + $ sudo docker search kolla + +OpenStack services +------------------ + Kolla provides images to deploy the following OpenStack projects: - `Aodh `__ @@ -57,55 +79,48 @@ Kolla provides images to deploy the following OpenStack projects: - `Watcher `__ - `Zaqar `__ -As well as these infrastructure components: +Infrastructure components +------------------------- + +Kolla provides images to deploy the following infrastructure components: - `Ceph `__ implementation for Cinder, Glance and Nova -- `Openvswitch `__ and Linuxbridge backends for Neutron -- `MongoDB `__ as a database backend for Ceilometer - and Gnocchi -- `RabbitMQ `__ as a messaging backend for - communication between services. +- `collectd `__, + `InfluxDB `__, and + `Grafana `__ for performance monitoring. +- `Elasticsearch `__ and + `Kibana `__ to search, analyze, + and visualize log messages. - `HAProxy `__ and `Keepalived `__ for high availability of services and their endpoints. -- `MariaDB and Galera `__ for - highly available MySQL databases - `Heka `__ A distributed and - scalable logging system for openstack services. - -Docker Images -============= - -The `Docker images `__ -are built by the Kolla project maintainers. A detailed process for -contributing to the images can be found in the `image building -guide `__. - -The Kolla developers build images in the `kolla` namespace for every tagged -release and implement an Ansible deployment for many but not all of them. - -You can view the available images on `Docker Hub -`__ or with the Docker CLI:: - - $ sudo docker search kolla + scalable logging system for OpenStack services. +- `MariaDB and Galera Cluster `__ + for highly available MySQL databases +- `MongoDB `__ as a database backend for Ceilometer + and Gnocchi +- `Open vSwitch `__ and Linuxbridge backends for Neutron +- `RabbitMQ `__ as a messaging backend for + communication between services. Directories =========== -- ansible - Contains Ansible playbooks to deploy Kolla in Docker +- ``ansible`` - Contains Ansible playbooks to deploy Kolla in Docker containers. -- demos - Contains a few demos to use with Kolla. -- dev/vagrant - Contains a vagrant VirtualBox/Libvirt based development +- ``demos`` - Contains a few demos to use with Kolla. +- ``dev/vagrant`` - Contains a vagrant VirtualBox/Libvirt based development environment. -- doc - Contains documentation. -- etc - Contains a reference etc directory structure which requires +- ``doc`` - Contains documentation. +- ``docker`` - Contains jinja2 templates for the docker build system. +- ``etc`` - Contains a reference etc directory structure which requires configuration of a small number of configuration variables to achieve a working All-in-One (AIO) deployment. -- docker - Contains jinja2 templates for the docker build system. -- tools - Contains tools for interacting with Kolla. -- specs - Contains the Kolla communities key arguments about +- ``tests`` - Contains functional testing tools. +- ``tools`` - Contains tools for interacting with Kolla. +- ``specs`` - Contains the Kolla communities key arguments about architectural shifts in the code base. -- tests - Contains functional testing tools. Getting Involved ================