Skip to content
Snippets Groups Projects
README.rst 6.65 KiB
Newer Older
========================
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-Ansible Overview
======================
James Labocki's avatar
James Labocki committed

The Kolla-Ansible is a deliverable project separated from Kolla project.

Kolla-Ansible deploys OpenStack services and infrastructure components
in Docker containers.
Kolla's mission statement is:
James Labocki's avatar
James Labocki committed

Christian Berendt's avatar
Christian Berendt committed
    To provide production-ready containers and deployment tools for operating
    OpenStack clouds.
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.
James Labocki's avatar
James Labocki committed

Getting Started
Steven Dake's avatar
Steven Dake committed
===============
James Labocki's avatar
James Labocki committed

Learn about Kolla-Ansible by reading the documentation online
`docs.openstack.org <http://docs.openstack.org/developer/kolla-ansible/>`__.
Steven Dake's avatar
Steven Dake committed
Get started by reading the `Developer
Quickstart <http://docs.openstack.org/developer/kolla-ansible/quickstart.html>`__.
Christian Berendt's avatar
Christian Berendt committed

OpenStack services
------------------

Kolla-Ansible deploys containers for 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/>`__
MD NADEEM's avatar
MD NADEEM committed
- `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/>`__
- `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/>`__
- `Octavia <http://docs.openstack.org/developer/octavia/>`__
- `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/>`__
caoyuan's avatar
caoyuan committed
- `Zaqar <http://docs.openstack.org/developer/zaqar/>`__
- `Zun <http://wiki.openstack.org/wiki/zun>`__
Christian Berendt's avatar
Christian Berendt committed
Infrastructure components
-------------------------

Kolla-Ansible deploys containers for the following infrastructure components:
- `Ceph <http://ceph.com/>`__ implementation for Cinder, Glance and Nova.
- `Collectd <https://collectd.org/>`__,
  `Telegraf <https://docs.influxdata.com/telegraf/>`__,
Christian Berendt's avatar
Christian Berendt committed
  `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.
- `Etcd <https://coreos.com/etcd/>`__ a distributed reliable key-value store.
- `Fluentd <https://www.fluentd.org/>`__ as an open source data collector
caoyuan's avatar
caoyuan committed
  for unified logging layer.
- `Gnocchi <http://gnocchi.xyz/>`__ A time-series storage database.
- `HAProxy <http://www.haproxy.org/>`__ and
  `Keepalived <http://www.keepalived.org/>`__ for high availability of services
  and their endpoints.
caoyuan's avatar
caoyuan committed
- `Kafka <http://kafka.apache.org/documentation/>`__ A distributed streaming
  platform.
Christian Berendt's avatar
Christian Berendt committed
- `MariaDB and Galera Cluster <https://mariadb.com/kb/en/mariadb/galera-cluster/>`__
  for highly available MySQL databases.
- `Memcached <https://memcached.org/>`__ a distributed memory object caching system.
Christian Berendt's avatar
Christian Berendt committed
- `MongoDB <https://www.mongodb.org/>`__ as a database backend for Ceilometer
  and Gnocchi.
- `Open vSwitch <http://openvswitch.org/>`__ and Linuxbridge backends for Neutron.
Christian Berendt's avatar
Christian Berendt committed
- `RabbitMQ <https://www.rabbitmq.com/>`__ as a messaging backend for
  communication between services.
Steven Dake's avatar
Steven Dake committed

Directories
===========
Steven Dake's avatar
Steven Dake committed

-  ``ansible`` - Contains Ansible playbooks to deploy OpenStack services and
   infrastructure components in Docker containers.
-  ``contrib`` - Contains demos scenarios for Heat and Murano and a development
   environment for Vagrant
Christian Berendt's avatar
Christian Berendt committed
-  ``doc`` - Contains documentation.
-  ``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.
-  ``specs`` - Contains the Kolla-Ansible communities key arguments about
   architectural shifts in the code base.
zhuzeyu's avatar
zhuzeyu committed
-  ``tests`` - Contains functional testing tools.
-  ``tools`` - Contains tools for interacting with Kolla-Ansible.
Steven Dake's avatar
Steven Dake committed

Getting Involved
================
Steven Dake's avatar
Steven Dake committed

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>`__.
Mauricio Lima's avatar
Mauricio Lima committed
-  We communicate using the #openstack-kolla irc channel.
-  File bugs, blueprints, track releases, etc on
   `Launchpad <https://launchpad.net/kolla-ansible>`__.
-  Attend weekly
   `meetings <https://wiki.openstack.org/wiki/Meetings/Kolla>`__.
-  Contribute `code <https://git.openstack.org/openstack/kolla-ansible>`__.
Contributors
============
Steven Dake's avatar
Steven Dake committed

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.