From 1a3987372c857f8ca5e4ecd9c4be7b617df0e758 Mon Sep 17 00:00:00 2001 From: "Dr. Jens Harbott" Date: Sat, 10 Jan 2026 13:40:08 +0100 Subject: 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. Further changes: - Make the wording respect both Docker and Podman as container engines - Update outdated information - Add a release note stating the same Signed-off-by: Dr. Jens Harbott Change-Id: Ia04afe6387f94e33ca087dcf9d369ef22b8e8f28 --- README.rst | 70 +++++++++------------- kolla/common/config.py | 3 - .../notes/image-purpose-1884e00f993e09d0.yaml | 7 +++ 3 files changed, 36 insertions(+), 44 deletions(-) create mode 100644 releasenotes/notes/image-purpose-1884e00f993e09d0.yaml diff --git a/README.rst b/README.rst index 87b904a01..eb2845c4d 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 `__. +The Kolla project is a member of the OpenStack `Governance +`__. 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 `__ containers, +Kolla provides tools to create containers that can be run under either +`Docker `__ or `Podman `, as well as `Ansible `__ playbooks to deploy OpenStack on baremetal or virtual machine to meet Kolla's mission. @@ -39,26 +40,29 @@ Quickstart `__ -are built by the Kolla project maintainers. A detailed process for -contributing to the images can be found in the `image building -guide `__. +======================== ====================================================== +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 publish images in the Quay.io `openstack.kolla` namespace for every tagged release. You can view the available images on `Quay.io `__. +.. 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 ------------------ @@ -83,10 +87,10 @@ Kolla provides images to deploy the following OpenStack projects: - `Manila `__ - `Masakari `__ - `Mistral `__ -- `Monasca `__ - `Neutron `__ - `Nova `__ - `Octavia `__ +- `Placement `__ - Skyline (`APIServer `__ and `Console `__) - `Tacker `__ - `Trove `__ @@ -101,32 +105,27 @@ Kolla provides images to deploy the following infrastructure components: - `Collectd `__, `InfluxDB `__, and `Grafana `__ for performance monitoring. -- `Corosync `__ and - `Pacemaker `__ for HAcluster. -- `Elasticsearch `__ and - `Kibana `__ to search, analyze, - and visualize log messages. - `Cron `__ for log rotation. - `Etcd `__ a distributed key value store that provides a reliable way to store data across a cluster of machines. - `Fluentd `__ as an open source data collector for unified logging layer. - `Gnocchi `__ a time-series storage database. +- `Corosync `__ and + `Pacemaker `__ for HAcluster. - `HAProxy `__ and `Keepalived `__ for high availability of services and their endpoints. -- `Kafka `__ a distributed streaming - platform. - `MariaDB and Galera Cluster `__ for highly available MySQL databases. - `Memcached `__ a distributed memory object caching system. -- `Open vSwitch `__ for use with Neutron. - MariaDB Backup A tool which provides a method of performing a hot backup of your MySQL data while the system is running. +- `Open vSwitch `__ for use with Neutron. +- `Opensearch `__ to search, analyze, + and visualize log messages. - `Prometheus `__ an open-source systems monitoring and alerting toolkit originally built at SoundCloud. -- `Qdrouterd `__ as a - direct messaging back end for communication between services. - `RabbitMQ `__ as a broker messaging back end for communication between services. - `Valkey Sentinel `__ provides high availability for valkey @@ -134,9 +133,6 @@ Kolla provides images to deploy the following infrastructure components: provider for clients. - `Telegraf `__ as a plugin-driven server agent for collecting & reporting metrics. -- `ZooKeeper `__ as a centralized service for maintaining - configuration information, naming, providing distributed synchronization, and providing - group services. Directories =========== @@ -171,14 +167,6 @@ workflow `__. `__. - Contribute `code `__. -Contributors -============ - -Check out who is `contributing -code `__ and -`contributing -reviews `__. - Notices ======= diff --git a/kolla/common/config.py b/kolla/common/config.py index 682f1fe0b..a4208df6a 100644 --- a/kolla/common/config.py +++ b/kolla/common/config.py @@ -63,7 +63,6 @@ _PROFILE_OPTS = [ 'openvswitch', 'proxysql', 'rabbitmq', - 'storm', 'tgtd', 'valkey', ], @@ -91,7 +90,6 @@ _PROFILE_OPTS = [ 'gnocchi', 'influxdb', 'ironic', - 'kafka', 'kuryr', 'magnum', 'manila', @@ -102,7 +100,6 @@ _PROFILE_OPTS = [ 'telegraf', 'trove', 'valkey', - 'zookeeper', 'zun', ], help='Aux Images'), diff --git a/releasenotes/notes/image-purpose-1884e00f993e09d0.yaml b/releasenotes/notes/image-purpose-1884e00f993e09d0.yaml new file mode 100644 index 000000000..0296e9e1b --- /dev/null +++ b/releasenotes/notes/image-purpose-1884e00f993e09d0.yaml @@ -0,0 +1,7 @@ +--- +prelude: > + The Kolla project publishes images to quay.io. + These are however only intended for demonstration and testing purposes. + 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. -- cgit v1.2.3