5bfae58176
Changed occurences of 'docker' to 'Docker' to be in accordance with Docker Inc's trademark guidelines found here: https://www.docker.com/trademark-guidelines This was done due to a pending change that will append Docker Inc's trademark notice in the kolla docs TrivialFix Change-Id: Ie3f385897bfa604986bd99329c0f4b961d3c8552
169 lines
6.9 KiB
ReStructuredText
169 lines
6.9 KiB
ReStructuredText
========================
|
|
Team and repository tags
|
|
========================
|
|
|
|
.. image:: http://governance.openstack.org/badges/kolla-ansible.svg
|
|
:target: http://governance.openstack.org/reference/tags/index.html
|
|
|
|
.. Change things from this point on
|
|
|
|
==============
|
|
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:
|
|
|
|
::
|
|
|
|
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
|
|
configuration to suit the operator's exact requirements.
|
|
|
|
Getting Started
|
|
===============
|
|
|
|
Learn about Kolla by reading the documentation online
|
|
`docs.openstack.org <http://docs.openstack.org/developer/kolla/>`__.
|
|
|
|
Get started by reading the `Developer
|
|
Quickstart <http://docs.openstack.org/developer/kolla/quickstart.html>`__.
|
|
|
|
Docker images
|
|
=============
|
|
|
|
The `Docker images <https://docs.docker.com/engine/tutorials/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/>`__
|
|
- `Barbican <http://docs.openstack.org/developer/barbican/>`__
|
|
- `Bifrost <http://docs.openstack.org/developer/bifrost/>`__
|
|
- `Ceilometer <http://docs.openstack.org/developer/ceilometer/>`__
|
|
- `Cinder <http://docs.openstack.org/developer/cinder/>`__
|
|
- `CloudKitty <http://docs.openstack.org/developer/cloudkitty/>`__
|
|
- `Congress <http://docs.openstack.org/developer/congress/>`__
|
|
- `Designate <http://docs.openstack.org/developer/designate/>`__
|
|
- `Freezer <https://wiki.openstack.org/wiki/Freezer-docs>`__
|
|
- `Glance <http://docs.openstack.org/developer/glance/>`__
|
|
- `Gnocchi <http://docs.openstack.org/developer/gnocchi/>`__
|
|
- `Heat <http://docs.openstack.org/developer/heat/>`__
|
|
- `Horizon <http://docs.openstack.org/developer/horizon/>`__
|
|
- `Ironic <http://docs.openstack.org/developer/ironic/>`__
|
|
- `Karbor <http://docs.openstack.org/developer/karbor/>`__
|
|
- `Keystone <http://docs.openstack.org/developer/keystone/>`__
|
|
- `Kuryr <http://docs.openstack.org/developer/kuryr/>`__
|
|
- `Magnum <http://docs.openstack.org/developer/magnum/>`__
|
|
- `Manila <http://docs.openstack.org/developer/manila/>`__
|
|
- `Mistral <http://docs.openstack.org/developer/mistral/>`__
|
|
- `Murano <http://docs.openstack.org/developer/murano/>`__
|
|
- `Neutron <http://docs.openstack.org/developer/neutron/>`__
|
|
- `Nova <http://docs.openstack.org/developer/nova/>`__
|
|
- `Panko <http://docs.openstack.org/developer/panko/>`__
|
|
- `Rally <http://docs.openstack.org/developer/rally/>`__
|
|
- `Sahara <http://docs.openstack.org/developer/sahara/>`__
|
|
- `Searchlight <http://docs.openstack.org/developer/searchlight/>`__
|
|
- `Senlin <http://docs.openstack.org/developer/senlin/>`__
|
|
- `Solum <http://docs.openstack.org/developer/solum/>`__
|
|
- `Swift <http://docs.openstack.org/developer/swift/>`__
|
|
- `Tacker <http://docs.openstack.org/developer/tacker/>`__
|
|
- `Tempest <http://docs.openstack.org/developer/tempest/>`__
|
|
- `Trove <http://docs.openstack.org/developer/trove/>`__
|
|
- `Vmtp <http://vmtp.readthedocs.io/en/latest/>`__
|
|
- `Watcher <http://docs.openstack.org/developer/watcher/>`__
|
|
- `Zaqar <http://docs.openstack.org/developer/zaqar/>`__
|
|
|
|
Infrastructure components
|
|
-------------------------
|
|
|
|
Kolla provides images to deploy the following infrastructure components:
|
|
|
|
- `Ceph <http://ceph.com/>`__ implementation for Cinder, Glance and Nova
|
|
- `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.
|
|
- `Heka <http://hekad.readthedocs.org/>`__ A distributed and
|
|
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
|
|
containers.
|
|
- ``contrib`` - Contains demos scenarios for Heat and Murano and a development
|
|
environment for Vagrant
|
|
- ``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.
|
|
- ``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.
|
|
|
|
Getting Involved
|
|
================
|
|
|
|
Need a feature? Find a bug? Let us know! Contributions are much
|
|
appreciated and should follow the standard `Gerrit
|
|
workflow <http://docs.openstack.org/infra/manual/developers.html>`__.
|
|
|
|
- We communicate using the #openstack-kolla irc channel.
|
|
- File bugs, blueprints, track releases, etc on
|
|
`Launchpad <https://launchpad.net/kolla>`__.
|
|
- Attend weekly
|
|
`meetings <https://wiki.openstack.org/wiki/Meetings/Kolla>`__.
|
|
- Contribute `code <https://git.openstack.org/openstack/kolla>`__.
|
|
|
|
Contributors
|
|
============
|
|
|
|
Check out who's `contributing
|
|
code <http://stackalytics.com/?module=kolla-group&metric=commits>`__ and
|
|
`contributing
|
|
reviews <http://stackalytics.com/?module=kolla-group&metric=marks>`__.
|
|
|
|
Notices
|
|
=======
|
|
|
|
Docker and the Docker logo are trademarks or registered trademarks of
|
|
Docker, Inc. in the United States and/or other countries. Docker, Inc.
|
|
and other parties may also have trademark rights in other terms used herein.
|