aboutsummaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorDr. Jens Harbott <harbott@osism.tech>2026-01-10 13:40:08 +0100
committerDr. Jens Harbott <harbott@osism.tech>2026-01-22 14:25:57 +0100
commit2265b7c18fdb24cd7e8eeccca23c9e49a48e7bdb (patch)
treeb94d64b599eb5ffaaeccd2115a30249ab27e966f /README.rst
parent75e0f75522b7cf10d1d59c49b7e6734f7f09e619 (diff)
downloadkolla-2265b7c18fdb24cd7e8eeccca23c9e49a48e7bdb.tar.gz
kolla-2265b7c18fdb24cd7e8eeccca23c9e49a48e7bdb.zip
Update README with new mission statement
We have said for a long time that the images that the project produces are only meant for testing purposes, amend the documentation to be more explicit about it. - Add a release note stating the same stable-only: Dropped the further updates to the README Signed-off-by: Dr. Jens Harbott <harbott@osism.tech> Change-Id: Ia04afe6387f94e33ca087dcf9d369ef22b8e8f28 (cherry picked from commit 1a3987372c857f8ca5e4ecd9c4be7b617df0e758)
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst50
1 files changed, 23 insertions, 27 deletions
diff --git a/README.rst b/README.rst
index 4af919296..a883857a5 100644
--- a/README.rst
+++ b/README.rst
@@ -8,17 +8,18 @@ Kolla Overview
.. Change things from this point on
-The Kolla project is a member of the OpenStack `Big Tent
-Governance <https://governance.openstack.org/tc/reference/projects/index.html>`__.
+The Kolla project is a member of the OpenStack `Governance
+<https://governance.openstack.org/tc/reference/projects/index.html>`__.
Kolla's mission statement is:
::
- To provide production-ready containers and deployment tools for operating
- OpenStack clouds.
+ To provide tools to create production-ready containers and
+ to provide deployment tools for operating OpenStack clouds.
-Kolla provides `Docker <https://docker.com/>`__ containers,
+Kolla provides tools to create containers that can be run under either
+`Docker <https://docker.com/>`__ or `Podman <https://podman.io/>`, as well as
`Ansible <https://ansible.com/>`__ playbooks to deploy OpenStack on baremetal
or virtual machine to meet Kolla's mission.
@@ -39,21 +40,17 @@ Quickstart <https://docs.openstack.org/kolla-ansible/latest/user/quickstart.html
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:
+The Kolla repository is one of four deliverables of the OpenStack Kolla
+project. The four deliverables that make up the Kolla project are:
-================ =========================================================
-Deliverable Repository
-================ =========================================================
-kolla https://opendev.org/openstack/kolla
-kolla-ansible https://opendev.org/openstack/kolla-ansible
-kayobe https://opendev.org/openstack/kayobe
-================ =========================================================
-
-The `Docker images <https://docs.docker.com/storage/storagedriver/>`__
-are built by the Kolla project maintainers. A detailed process for
-contributing to the images can be found in the `image building
-guide <https://docs.openstack.org/kolla/latest/admin/image-building.html>`__.
+======================== ======================================================
+Deliverable Repository
+======================== ======================================================
+kolla https://opendev.org/openstack/kolla
+kolla-ansible https://opendev.org/openstack/kolla-ansible
+ansible-collection-kolla https://opendev.org/openstack/ansible-collection-kolla
+kayobe https://opendev.org/openstack/kayobe
+======================== ======================================================
The Kolla developers build images in the `kolla` namespace for every tagged
release.
@@ -63,6 +60,13 @@ You can view the available images on `Docker Hub
$ sudo docker search kolla
+.. warning::
+ Kolla(-ansible) defaults to using these images in order to ease testing and
+ demonstration setups, but they are not intended to be used beyond this.
+ In particular, they do not undergo any security scrutiny. If you intend to
+ deploy Kolla for production purposes, you are advised to create and curate your
+ own set of images using the ``kolla`` tool.
+
OpenStack services
------------------
@@ -175,14 +179,6 @@ workflow <https://docs.openstack.org/infra/manual/developers.html>`__.
<https://docs.openstack.org/kolla/latest/contributor/meeting.html>`__.
- Contribute `code <https://opendev.org/openstack/kolla>`__.
-Contributors
-============
-
-Check out who is `contributing
-code <https://stackalytics.io/?module=kolla-group&metric=commits>`__ and
-`contributing
-reviews <https://stackalytics.io/?module=kolla-group&metric=marks>`__.
-
Notices
=======