233864ff32
The publishing docs expect the documentation to be present in the /doc directory not the /docs directory. If the documentation is in the /docs directory, according to fungi the docs won't be published properly. Change-Id: I718fec7e69d298a5cb2376ca4e2455e12169566e Partially-Implements: blueprint kola-tox-doc
107 lines
3.5 KiB
ReStructuredText
107 lines
3.5 KiB
ReStructuredText
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.
|
|
|
|
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
|
|
===============
|
|
|
|
Please get started by reading the `Developer
|
|
Quickstart <https://github.com/stackforge/kolla/blob/master/doc/dev-quickstart.rst>`__
|
|
followed by the `Ansible Deployment
|
|
Guide <https://github.com/stackforge/kolla/blob/master/doc/ansible-deployment.rst>`__.
|
|
|
|
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 <https://github.com/stackforge/kolla/blob/master/doc/image-building.rst>`__.
|
|
Images reside in the Docker Hub `Kollaglue
|
|
repo <https://registry.hub.docker.com/repos/kollaglue/>`__.
|
|
|
|
The Kolla developers build images in the kollaglue namespace for the
|
|
following services 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
|
|
|
|
::
|
|
|
|
$ sudo docker search kollaglue
|
|
|
|
A list of the upstream built docker images will be shown.
|
|
|
|
Directories
|
|
===========
|
|
|
|
- ansible - Contains Anible playbooks to deploy Kolla in Docker
|
|
containers.
|
|
- compose - Contains the docker-compose files serving as a compose
|
|
reference. Note compose support is removed from Kolla. These are for
|
|
community members which want to use Kolla container content without
|
|
Ansible.
|
|
- demos - Contains a few demos to use with Kolla.
|
|
- devenv - Contains an OpenStack-Heat based development environment.
|
|
- 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.
|
|
- docker - Contains jinja2 templates for the docker build system.
|
|
- 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.
|
|
- vagrant - Contains a vagrant VirtualBox-based development
|
|
environment.
|
|
|
|
Getting Involved
|
|
================
|
|
|
|
Need a feature? Find a bug? Let us know! Contributions are much
|
|
appreciated and should follow the standard `Gerrit
|
|
workflow <https://wiki.openstack.org/wiki/Gerrit_Workflow>`__.
|
|
|
|
- We communicate using the #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://github.com/stackforge/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>`__.
|