From 1314ca04fcfa2a1013106900b67898f46ac3693d Mon Sep 17 00:00:00 2001 From: Steven Dake Date: Fri, 18 Nov 2016 07:42:11 -0500 Subject: Clean up README.rst in docker repo Specify more clearly the repo split Change-Id: Id9105bcab921deee86962c055c37b5156fcc2190 --- README.rst | 39 +++++++++++++++++++++++++-------------- 1 file changed, 25 insertions(+), 14 deletions(-) diff --git a/README.rst b/README.rst index d15d26a3d..6c54e3603 100644 --- a/README.rst +++ b/README.rst @@ -21,13 +21,15 @@ 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 provides `Docker `__ containers, +`Ansible `__ playbooks to deploy OpenStack on baremetal +or virtual machine, and Kubernetes templates to deploy OpenStack on Kubernetes +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. +Kolla has out of the box defaults for a working basic deployment, and also +implements complete customization. This model permits operators with minimal +experience to deploy OpenStack quickly and as the operator's experience grows +modify the OpenStack configuration to suit the operator's exact requirements. Getting Started =============== @@ -38,8 +40,19 @@ Learn about Kolla by reading the documentation online Get started by reading the `Developer Quickstart `__. -Docker images -============= +The Kolla Repository +==================== + +The Kolla repository is one of three deliverables of the OpenStack Kolla +project. The three deliverables that make up the Kolla project are: + +=============== ===================================================== +Deliverable Repository +=============== ===================================================== +kolla https://git.openstack.org/openstack/kolla +kolla-ansible https://git.openstack.org/openstack/kolla-ansible +kolla-kubernetes https://git.openstack.org/openstack/kolla-kubernetes +=============== ===================================================== The `Docker images `__ are built by the Kolla project maintainers. A detailed process for @@ -47,7 +60,7 @@ 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. +release. You can view the available images on `Docker Hub `__ or with the Docker CLI:: @@ -123,17 +136,15 @@ Kolla provides images to deploy the following infrastructure components: 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 + 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. +- ``tools`` - Contains tools for interacting with the kolla repository. - ``specs`` - Contains the Kolla communities key arguments about architectural shifts in the code base. @@ -154,7 +165,7 @@ workflow `__. Contributors ============ -Check out who's `contributing +Check out who is `contributing code `__ and `contributing reviews `__. -- cgit v1.2.3