kolla-ansible/README.rst
Christian Berendt 25f0794657 Improve README file
* add missing infrastructure component images
* sync missing statement with projects.yaml file (governance repo)
* improve syntax

Change-Id: Ie1716e7482c11b9de243b6ee04d04f1039dcf784
2016-09-12 09:51:54 +02:00

5.9 KiB

Kolla Overview

The Kolla project is a member of the OpenStack Big Tent Governance.

Kolla's mission statement is:

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 configuration to suit the operator's exact requirements.

Getting Started

Learn about Kolla by reading the documentation online docs.openstack.org.

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:

Infrastructure components

Kolla provides images to deploy the following infrastructure components:

Directories

  • 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 environment.
  • 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.

  • We communicate using the #openstack-kolla irc channel.
  • File bugs, blueprints, track releases, etc on Launchpad.
  • Attend weekly meetings.
  • Contribute code.

Contributors

Check out who's contributing code and contributing reviews.