diff --git a/README.rst b/README.rst index 4470912939..0572172ba2 100644 --- a/README.rst +++ b/README.rst @@ -7,12 +7,14 @@ Team and repository tags .. Change things from this point on -============== -Kolla Overview -============== +====================== +Kolla-Ansible Overview +====================== -The Kolla project is a member of the OpenStack `Big Tent -Governance `__. +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: @@ -21,9 +23,6 @@ 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 @@ -32,32 +31,16 @@ configuration to suit the operator's exact requirements. Getting Started =============== -Learn about Kolla by reading the documentation online -`docs.openstack.org `__. +Learn about Kolla-Ansible 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 +Quickstart `__. OpenStack services ------------------ -Kolla provides images to deploy the following OpenStack projects: +Kolla-Ansible deploys containers for the following OpenStack projects: - `Aodh `__ - `Barbican `__ @@ -67,13 +50,11 @@ Kolla provides images to deploy the following OpenStack projects: - `CloudKitty `__ - `Congress `__ - `Designate `__ -- `Freezer `__ - `Glance `__ - `Gnocchi `__ - `Heat `__ - `Horizon `__ - `Ironic `__ -- `Karbor `__ - `Keystone `__ - `Kuryr `__ - `Magnum `__ @@ -99,7 +80,7 @@ Kolla provides images to deploy the following OpenStack projects: Infrastructure components ------------------------- -Kolla provides images to deploy the following infrastructure components: +Kolla-Ansible deploys containers for the following infrastructure components: - `Ceph `__ implementation for Cinder, Glance and Nova - `collectd `__, @@ -124,18 +105,17 @@ Kolla provides images to deploy the following infrastructure components: Directories =========== -- ``ansible`` - Contains Ansible playbooks to deploy Kolla in Docker - containers. +- ``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 - ``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 +- ``tools`` - Contains tools for interacting with Kolla-Ansible. +- ``specs`` - Contains the Kolla-Ansible communities key arguments about architectural shifts in the code base. Getting Involved @@ -150,7 +130,7 @@ workflow `__. `Launchpad `__. - Attend weekly `meetings `__. -- Contribute `code `__. +- Contribute `code `__. Contributors ============