From 8ba8e59c4b3fb8e0001142f34db87b380b3353db Mon Sep 17 00:00:00 2001 From: Steven Dake Date: Fri, 14 Aug 2015 21:32:09 -0700 Subject: [PATCH] Update readme to match current state Kolla has been through alot of change in the Liberty development cycle. Modify the README.md to specify our current direction. Change-Id: I67d304b206312f5915085dd99d0201b1df44f7ec --- README.md | 92 +++++++++++++++++++++++++++++++++---------------------- 1 file changed, 56 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index fb85c1192a..c7e1ce0c53 100644 --- a/README.md +++ b/README.md @@ -1,52 +1,59 @@ Kolla Overview ============== -The Kolla project is part of the OpenStack [TripleO][] effort, focused -on deploying OpenStack services using [Docker][] containers. The initial -system [spec][] provides additional details of Kolla and the use cases -it addresses. +The Kolla project is a member of the OpenStack [Big Tent Governance][]. +Kolla's mission statement is: -[TripleO]: https://wiki.openstack.org/wiki/TripleO + Kolla provides 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. + +[Big Tent Governance]: http://governance.openstack.org/reference/projects/index.html [Docker]: http://docker.com/ -[spec]: https://github.com/stackforge/kolla/blob/master/specs/containerize-openstack.rst +[Ansible]: http://ansible.com/ Getting Started =============== -Deployment on bare metal is a complex topic which is beyond the scope of -the project at this time. An environment to simplify the deployment of a -single or multi-node Kolla cluster is required for development purposes. -As a result, a [Heat template][] has been created for deploying a Kolla -cluster to an existing OpenStack cloud. +Please get started by reading the [Developer Quickstart][] followed by the +[Ansible Deployment Guide][]. -[Heat template]: (https://github.com/stackforge/kolla/blob/master/devenv/README.md) +[Developer Quickstart]: https://github.com/stackforge/kolla/blob/master/docs/dev-quickstart.md +[Ansible Deployment guide]: https://github.com/stackforge/kolla/blob/master/docs/ansible-deployment.md] Docker Images ------------- -The [Docker images][] are built by the Kolla project maintainers. A detailed -process for contributing to the images can be found [here][]. Images reside -in the Docker Hub [Kollaglue repo][]. +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][]. Images reside in the Docker Hub [Kollaglue repo][]. -[here]: https://github.com/stackforge/kolla/blob/master/docs/image-building.md +[image building guide]: https://github.com/stackforge/kolla/blob/master/docs/image-building.md [Docker images]: https://docs.docker.com/userguide/dockerimages/ [Kollaglue repo]: https://registry.hub.docker.com/repos/kollaglue/ The Kolla developers build images in the kollaglue namespace for the following -services: -* Glance -* Heat -* Keystone -* Mariadb -* Nova -* Rabbitmq -* Neutron -* Mongodb +services for every tagged release and implement Ansible deployment for them: + * Ceilometer +* Cinder +* Glance +* Haproxy +* Heat * Horizon -* Zaqar -* Magnum -* Gnocchi +* Keepalived +* Keystone +* Mariadb + galera +* Mongodb +* Neutron (linuxbridge or neutron) +* Nova +* Openvswitch +* Rabbitmq ``` $ sudo docker search kollaglue @@ -56,12 +63,24 @@ A list of the upstream built docker images will be shown. Directories =========== -* docker - contains artifacts for use with docker build to build appropriate - images -* compose - contains the docker-compose files defining the container sets -* tools - contains different tools for interacting with Kolla -* devenv - A collection of tools and resources for managing a Kolla - development environment. +* 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. +* docker - Contains a normal Dockerfile based set of artifacts for building + docker. This is planned for removal when docker_templates is completed. +* docs - 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_templates - 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 ================ @@ -82,6 +101,7 @@ and should follow the standard [Gerrit workflow][]. Contributors ============ -Check out who's [contributing][]. +Check out who's [contributing code][] and [contributing reviews][]. -[contributing]: https://github.com/stackforge/kolla/graphs/contributors +[contributing code]: http://stackalytics.com/?module=kolla-group&metric=commits +[contributing reviews]: http://stackalytics.com/?module=kolla-group&metric=marks