From 116f5bfc7448480fad4153434faa6b4d03005c21 Mon Sep 17 00:00:00 2001 From: David Moreau Simard Date: Tue, 17 Nov 2015 16:24:36 -0500 Subject: [PATCH] Improve README with list of supported projects and components Change-Id: Ieb1b9bcdbb7db4732bd69ef4a2378cf4030680ba --- README.rst | 61 +++++++++++++++++++++++++++++++++--------------------- 1 file changed, 37 insertions(+), 24 deletions(-) diff --git a/README.rst b/README.rst index 4863f91f4d..953714d309 100644 --- a/README.rst +++ b/README.rst @@ -26,41 +26,54 @@ The learn about Kolla, you can find the documentation online on You can get started by reading the `Developer Quickstart `__. +Kolla provides images to deploy the following OpenStack projects: + +- `Ceilometer `__ +- `Cinder `__ +- `Designate `__ +- `Glance `__ +- `Gnocchi `__ +- `Heat `__ +- `Horizon `__ +- `Ironic `__ +- `Keystone `__ +- `Magnum `__ +- `Murano `__ +- `Nova `__ +- `Neutron `__ +- `Swift `__ +- `Zaqar `__ + +As well as these 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. +- `HAProxy `__ and + `Keepalived `__ for high availability of services + and their endpoints. +- `MariaDB and Galera `__ for + highly available MySQL databases + 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 `__. -Images reside in the Docker Hub `Kollaglue -repo `__. -The Kolla developers build images in the kollaglue namespace for the -following services for every tagged release and implement Ansible -deployment for them: +The Kolla developers build images in the `kollaglue` namespace for every tagged +release and implement Ansible deployment for them. -- Ceilometer -- Cinder -- Glance -- Haproxy -- Heat -- Horizon -- Keepalived -- Keystone -- Mariadb + galera -- Mongodb -- Neutron (linuxbridge or neutron) -- Nova -- Openvswitch -- Rabbitmq - -:: +You can view the available images on `Docker Hub +`__ or with the Docker CLI:: $ sudo docker search kollaglue -A list of the upstream built docker images will be shown. - Directories ===========