Improve README file
* add missing infrastructure component images * sync missing statement with projects.yaml file (governance repo) * improve syntax Change-Id: Ie1716e7482c11b9de243b6ee04d04f1039dcf784
This commit is contained in:
Christian Berendt
parent
73dd4f6cd8
commit
25f0794657
87
README.rst
87
README.rst
@ -1,17 +1,20 @@
|
||||
==============
|
||||
Kolla Overview
|
||||
==============
|
||||
|
||||
The Kolla project is a member of the OpenStack `Big Tent
|
||||
Governance <http://governance.openstack.org/reference/projects/index.html>`__.
|
||||
|
||||
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 <http://docker.com/>`__ containers and
|
||||
`Ansible <http://ansible.com/>`__ 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 <http://docs.openstack.org/developer/kolla/quickstart.html>`__.
|
||||
|
||||
Docker images
|
||||
=============
|
||||
|
||||
The `Docker images <https://docs.docker.com/userguide/dockerimages/>`__
|
||||
are built by the Kolla project maintainers. A detailed process for
|
||||
contributing to the images can be found in the `image building
|
||||
guide <http://docs.openstack.org/developer/kolla/image-building.html>`__.
|
||||
|
||||
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
|
||||
<https://hub.docker.com/u/kolla/>`__ or with the Docker CLI::
|
||||
|
||||
$ sudo docker search kolla
|
||||
|
||||
OpenStack services
|
||||
------------------
|
||||
|
||||
Kolla provides images to deploy the following OpenStack projects:
|
||||
|
||||
- `Aodh <http://docs.openstack.org/developer/aodh/>`__
|
||||
@ -57,55 +79,48 @@ Kolla provides images to deploy the following OpenStack projects:
|
||||
- `Watcher <http://docs.openstack.org/developer/watcher/>`__
|
||||
- `Zaqar <http://docs.openstack.org/developer/zaqar/>`__
|
||||
|
||||
As well as these infrastructure components:
|
||||
Infrastructure components
|
||||
-------------------------
|
||||
|
||||
Kolla provides images to deploy the following infrastructure components:
|
||||
|
||||
- `Ceph <http://ceph.com/>`__ implementation for Cinder, Glance and Nova
|
||||
- `Openvswitch <http://openvswitch.org/>`__ and Linuxbridge backends for Neutron
|
||||
- `MongoDB <https://www.mongodb.org/>`__ as a database backend for Ceilometer
|
||||
and Gnocchi
|
||||
- `RabbitMQ <https://www.rabbitmq.com/>`__ as a messaging backend for
|
||||
communication between services.
|
||||
- `collectd <https://collectd.org>`__,
|
||||
`InfluxDB <https://influxdata.com/time-series-platform/influxdb/>`__, and
|
||||
`Grafana <http://grafana.org>`__ for performance monitoring.
|
||||
- `Elasticsearch <https://www.elastic.co/de/products/elasticsearch>`__ and
|
||||
`Kibana <https://www.elastic.co/de/products/kibana>`__ to search, analyze,
|
||||
and visualize log messages.
|
||||
- `HAProxy <http://www.haproxy.org/>`__ and
|
||||
`Keepalived <http://www.keepalived.org/>`__ for high availability of services
|
||||
and their endpoints.
|
||||
- `MariaDB and Galera <https://mariadb.com/kb/en/mariadb/galera-cluster/>`__ for
|
||||
highly available MySQL databases
|
||||
- `Heka <http://hekad.readthedocs.org/>`__ A distributed and
|
||||
scalable logging system for openstack services.
|
||||
|
||||
Docker Images
|
||||
=============
|
||||
|
||||
The `Docker images <https://docs.docker.com/userguide/dockerimages/>`__
|
||||
are built by the Kolla project maintainers. A detailed process for
|
||||
contributing to the images can be found in the `image building
|
||||
guide <http://docs.openstack.org/developer/kolla/image-building.html>`__.
|
||||
|
||||
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
|
||||
<https://hub.docker.com/u/kolla/>`__ or with the Docker CLI::
|
||||
|
||||
$ sudo docker search kolla
|
||||
scalable logging system for OpenStack services.
|
||||
- `MariaDB and Galera Cluster <https://mariadb.com/kb/en/mariadb/galera-cluster/>`__
|
||||
for highly available MySQL databases
|
||||
- `MongoDB <https://www.mongodb.org/>`__ as a database backend for Ceilometer
|
||||
and Gnocchi
|
||||
- `Open vSwitch <http://openvswitch.org/>`__ and Linuxbridge backends for Neutron
|
||||
- `RabbitMQ <https://www.rabbitmq.com/>`__ 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
|
||||
================
|
||||
|
||||
Loading…
Reference in New Issue
Block a user