@@ -8,17 +8,18 @@ Kolla Overview
88.. Change things from this point on
99
1010
11- The Kolla project is a member of the OpenStack `Big Tent
12- Governance <https://governance.openstack.org/tc/reference/projects/index.html> `__.
11+ The Kolla project is a member of the OpenStack `Governance
12+ <https://governance.openstack.org/tc/reference/projects/index.html> `__.
1313
1414Kolla's mission statement is:
1515
1616::
1717
18- To provide production-ready containers and deployment tools for operating
19- OpenStack clouds.
18+ To provide tools to create production-ready containers and
19+ to provide deployment tools for operating OpenStack clouds.
2020
21- Kolla provides `Docker <https://docker.com/ >`__ containers,
21+ Kolla provides tools to create containers that can be run under either
22+ `Docker <https://docker.com/ >`__ or `Podman <https://podman.io/> `, as well as
2223`Ansible <https://ansible.com/ >`__ playbooks to deploy OpenStack on baremetal
2324or virtual machine to meet Kolla's mission.
2425
@@ -39,29 +40,28 @@ Quickstart <https://docs.openstack.org/kolla-ansible/latest/user/quickstart.html
3940The Kolla Repository
4041====================
4142
42- The Kolla repository is one of three deliverables of the OpenStack Kolla
43- project. The three deliverables that make up the Kolla project are:
44-
45- ================ =========================================================
46- Deliverable Repository
47- ================ =========================================================
48- kolla https://opendev.org/openstack/kolla
49- kolla-ansible https://opendev.org/openstack/kolla-ansible
50- kayobe https://opendev.org/openstack/kayobe
51- ================ =========================================================
52-
53- The `Docker images <https://docs.docker.com/storage/storagedriver/ >`__
54- are built by the Kolla project maintainers. A detailed process for
55- contributing to the images can be found in the `image building
56- guide <https://docs.openstack.org/kolla/latest/admin/image-building.html> `__.
57-
58- The Kolla developers build images in the `kolla ` namespace for every tagged
59- release.
60-
61- You can view the available images on `Docker Hub
62- <https://hub.docker.com/u/kolla/> `__ or with the Docker CLI::
63-
64- $ sudo docker search kolla
43+ The Kolla repository is one of four deliverables of the OpenStack Kolla
44+ project. The four deliverables that make up the Kolla project are:
45+
46+ ======================== ======================================================
47+ Deliverable Repository
48+ ======================== ======================================================
49+ kolla https://opendev.org/openstack/kolla
50+ kolla-ansible https://opendev.org/openstack/kolla-ansible
51+ ansible-collection-kolla https://opendev.org/openstack/ansible-collection-kolla
52+ kayobe https://opendev.org/openstack/kayobe
53+ ======================== ======================================================
54+
55+ The Kolla developers publish images in the Quay.io `openstack.kolla ` namespace
56+ for every tagged release. You can view the available images on `Quay.io
57+ <https://quay.io/organization/openstack.kolla> `__.
58+
59+ .. warning ::
60+ Kolla(-ansible) defaults to using these images in order to ease testing and
61+ demonstration setups, but they are not intended to be used beyond this.
62+ In particular, they do not undergo any security scrutiny. If you intend to
63+ deploy Kolla for production purposes, you are advised to create and curate your
64+ own set of images using the ``kolla `` tool.
6565
6666OpenStack services
6767------------------
@@ -87,10 +87,10 @@ Kolla provides images to deploy the following OpenStack projects:
8787- `Manila <https://docs.openstack.org/manila/latest/ >`__
8888- `Masakari <https://docs.openstack.org/masakari/latest/ >`__
8989- `Mistral <https://docs.openstack.org/mistral/latest/ >`__
90- - `Monasca <https://docs.openstack.org/monasca-api/latest/ >`__
9190- `Neutron <https://docs.openstack.org/neutron/latest/ >`__
9291- `Nova <https://docs.openstack.org/nova/latest/ >`__
9392- `Octavia <https://docs.openstack.org/octavia/latest/ >`__
93+ - `Placement <https://docs.openstack.org/placement/latest/ >`__
9494- Skyline (`APIServer <https://docs.openstack.org/skyline-apiserver/latest/ >`__ and `Console <https://docs.openstack.org/skyline-console/latest/ >`__)
9595- `Tacker <https://docs.openstack.org/tacker/latest/ >`__
9696- `Trove <https://docs.openstack.org/trove/latest/ >`__
@@ -103,44 +103,35 @@ Infrastructure components
103103Kolla provides images to deploy the following infrastructure components:
104104
105105- `Collectd <https://collectd.org >`__,
106- `InfluxDB <https://influxdata.com/time-series-platform/influxdb/ >`__, and
107106 `Grafana <https://grafana.com >`__ for performance monitoring.
108- - `Corosync <https://clusterlabs.org/corosync.html >`__ and
109- `Pacemaker <https://clusterlabs.org/pacemaker >`__ for HAcluster.
110- - `Elasticsearch <https://www.elastic.co/de/products/elasticsearch >`__ and
111- `Kibana <https://www.elastic.co/products/kibana >`__ to search, analyze,
112- and visualize log messages.
113107- `Cron <https://cron-job.org >`__ for log rotation.
114108- `Etcd <https://etcd.io/ >`__ a distributed key value store that provides
115109 a reliable way to store data across a cluster of machines.
116110- `Fluentd <https://www.fluentd.org/ >`__ as an open source data collector
117111 for unified logging layer.
118112- `Gnocchi <https://gnocchi.xyz/ >`__ a time-series storage database.
113+ - `Corosync <https://clusterlabs.org/corosync.html >`__ and
114+ `Pacemaker <https://clusterlabs.org/pacemaker >`__ for HAcluster.
119115- `HAProxy <https://www.haproxy.org/ >`__ and
120116 `Keepalived <https://www.keepalived.org/ >`__ for high availability of services
121117 and their endpoints.
122- - `Kafka <https://kafka.apache.org/documentation/ >`__ a distributed streaming
123- platform.
124118- `MariaDB and Galera Cluster <https://mariadb.com/kb/en/library/galera-cluster/ >`__
125119 for highly available MySQL databases.
126120- `Memcached <https://www.memcached.org/ >`__ a distributed memory object caching system.
127- - `Open vSwitch <https://www.openvswitch.org/ >`__ for use with Neutron.
128121- MariaDB Backup A tool which provides a method of performing a hot backup of your MySQL data while the
129122 system is running.
123+ - `Open vSwitch <https://www.openvswitch.org/ >`__ for use with Neutron.
124+ - `Opensearch <https://opensearch.org/ >`__ to search, analyze,
125+ and visualize log messages.
130126- `Prometheus <https://prometheus.io/ >`__ an open-source systems monitoring
131127 and alerting toolkit originally built at SoundCloud.
132- - `Qdrouterd <https://qpid.apache.org/components/dispatch-router/index.html >`__ as a
133- direct messaging back end for communication between services.
134128- `RabbitMQ <https://www.rabbitmq.com/ >`__ as a broker messaging back end for
135129 communication between services.
136130- `Valkey Sentinel <https://valkey.io/topics/sentinel >`__ provides high availability for valkey
137131 along with collateral tasks such as monitoring, notification and acts as configuration
138132 provider for clients.
139133- `Telegraf <https://www.docs.influxdata.com/telegraf/ >`__ as a plugin-driven server
140134 agent for collecting & reporting metrics.
141- - `ZooKeeper <https://zookeeper.apache.org/ >`__ as a centralized service for maintaining
142- configuration information, naming, providing distributed synchronization, and providing
143- group services.
144135
145136Directories
146137===========
@@ -175,14 +166,6 @@ workflow <https://docs.openstack.org/infra/manual/developers.html>`__.
175166 <https://docs.openstack.org/kolla/latest/contributor/meeting.html> `__.
176167- Contribute `code <https://opendev.org/openstack/kolla >`__.
177168
178- Contributors
179- ============
180-
181- Check out who is `contributing
182- code <https://stackalytics.io/?module=kolla-group&metric=commits> `__ and
183- `contributing
184- reviews <https://stackalytics.io/?module=kolla-group&metric=marks> `__.
185-
186169Notices
187170=======
188171
0 commit comments