Ansible deployment of the Kolla containers
Go to file
Doug Szumski 2764844ee2 Allow removal of classic queue mirroring for internal RabbitMQ
Backport note: This patch has been updated to retain the existing
behaviour by default. A temporary variable,
rabbitmq_remove_ha_all_policy, has been added which may be set to true
in order to remove the ha-all policy. In order to support changing the
policy without upgrading, the the ha-all policy is removed on deploys,
in addition to upgrades.

When OpenStack is deployed with Kolla-Ansible, by default there
are no durable queues or exchanges created by the OpenStack
services in RabbitMQ. In Rabbit terminology, not being durable
is referred to as `transient`, and this means that the queue
is generally held in memory.

Whether OpenStack services create durable or transient queues is
traditionally controlled by the Oslo Notification config option:
`amqp_durable_queues`. In Kolla-Ansible, this remains set to
the default of `False` in all services. The only `durable`
objects are the `amq*` exchanges which are internal to RabbitMQ.

More recently, Oslo Notification has introduced support for
Quorum queues [7]. These are a successor to durable classic
queues, however it isn't yet clear if they are a good fit for
OpenStack in general [8].

For clustered RabbitMQ deployments, Kolla-Ansible configures all
queues as `replicated` [1]. Replication occurs over all nodes
in the cluster. RabbitMQ refers to this as 'mirroring of classic
queues'.

In summary, this means that a multi-node Kolla-Ansible deployment
will end up with a large number of transient, mirrored queues
and exchanges. However, the RabbitMQ documentation warns against
this, stating that 'For replicated queues, the only reasonable
option is to use durable queues: [2]`. This is discussed
further in the following bug report: [3].

Whilst we could try enabling the `amqp_durable_queues` option
for each service (this is suggested in [4]), there are
a number of complexities with this approach, not limited to:

1) RabbitMQ is planning to remove classic queue mirroring in
   favor of 'Quorum queues' in a forthcoming release [5].
2) Durable queues will be written to disk, which may cause
   performance problems at scale. Note that this includes
   Quorum queues which are always durable.
3) Potential for race conditions and other complexity
   discussed recently on the mailing list under:
   `[ops] [kolla] RabbitMQ High Availability`

The remaining option, proposed here, is to use classic
non-mirrored queues everywhere, and rely on services to recover
if the node hosting a queue or exchange they are using fails.
There is some discussion of this approach in [6]. The downside
of potential message loss needs to be weighed against the real
upsides of increasing the performance of RabbitMQ, and moving
to a configuration which is officially supported and hopefully
more stable. In the future, we can then consider promoting
specific queues to quorum queues, in cases where message loss
can result in failure states which are hard to recover from.

[1] https://www.rabbitmq.com/ha.html
[2] https://www.rabbitmq.com/queues.html
[3] https://github.com/rabbitmq/rabbitmq-server/issues/2045
[4] https://wiki.openstack.org/wiki/Large_Scale_Configuration_Rabbit
[5] https://blog.rabbitmq.com/posts/2021/08/4.0-deprecation-announcements/
[6] https://fuel-ccp.readthedocs.io/en/latest/design/ref_arch_1000_nodes.html#replication
[7] https://bugs.launchpad.net/oslo.messaging/+bug/1942933
[8] https://www.rabbitmq.com/quorum-queues.html#use-cases

Partial-Bug: #1954925
Change-Id: I91d0e23b22319cf3fdb7603f5401d24e3b76a56e
(cherry picked from commit 6bfe1927f0)
(cherry picked from commit 425ead5792)
2022-03-29 09:59:08 +00:00
ansible Allow removal of classic queue mirroring for internal RabbitMQ 2022-03-29 09:59:08 +00:00
contrib Update tacker CLI to openstack CLI in cleanup-tacker 2019-01-16 21:12:48 +08:00
deploy-guide/source Fix pygments style 2020-05-19 20:08:46 +02:00
doc libvirt: support SASL authentication 2022-03-12 17:00:18 +00:00
etc/kolla libvirt: support SASL authentication 2022-03-12 17:00:18 +00:00
kolla_ansible Merge "Use jinja2.pass_context instead of contextfilter" into stable/victoria 2022-03-28 17:09:37 +00:00
releasenotes Allow removal of classic queue mirroring for internal RabbitMQ 2022-03-29 09:59:08 +00:00
roles Fix permission denied errors with ping on c8s 2022-01-18 09:06:50 +00:00
specs Adding support for multiple globals files 2020-06-18 17:33:51 +00:00
tests [CI] Check fluentd errors 2022-02-15 10:51:21 +00:00
tools Fix missing Ansible version in the error message 2021-10-28 16:15:44 +00:00
zuul.d Revert "[CI] [to-revert] Avoid upgrades on CentOS Stream 8" 2022-01-22 14:38:35 +00:00
.ansible-lint CI: Fix new ansible-lint failures 2022-02-15 10:49:42 +00:00
.gitignore Ignore .vscode/ in Git 2020-04-10 15:55:42 +02:00
.gitreview Update .gitreview for stable/victoria 2020-11-05 10:11:59 +00:00
.stestr.conf Add custom filters for checking services 2019-09-16 12:48:52 +00:00
.yamllint Fix CI failures 2019-10-15 13:27:55 +01:00
CONTRIBUTING.rst [Community goal] Update the contributor guide 2020-05-20 17:55:57 +02:00
LICENSE Add ASL license 2014-09-20 17:29:35 -07:00
README.rst Remove the congress roles since it has been retired 2020-06-20 01:51:03 +00:00
bindep.txt CI: Remove dbus from bindep and playbooks 2020-02-20 16:50:43 +00:00
requirements.txt Cleanup py27 support 2020-04-26 12:16:44 +02:00
setup.cfg Add py38 package metadata 2020-07-15 15:05:58 +08:00
setup.py Cleanup py27 support 2020-04-26 12:16:44 +02:00
test-requirements.txt CI: pin ansible-lint to <6 2022-03-16 13:38:47 +00:00
tox.ini CI: fix kolla-ansible installation after cryptography 3.4 release 2021-02-15 13:58:32 +00:00

README.rst

Kolla-Ansible

image

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:

To provide production-ready containers and deployment tools for operating
OpenStack clouds.

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.

Getting Started

Learn about Kolla-Ansible by reading the documentation online Kolla-Ansible.

Get started by reading the Developer Quickstart.

OpenStack services

Kolla-Ansible deploys containers for the following OpenStack projects:

Infrastructure components

Kolla-Ansible deploys containers for the following infrastructure components:

Directories

  • ansible - Contains Ansible playbooks to deploy OpenStack services and infrastructure components in Docker containers.
  • contrib - Contains demos scenarios for Heat, Magnum and Tacker and a development environment for Vagrant
  • doc - Contains documentation.
  • 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.
  • kolla_ansible - Contains password generation script.
  • releasenotes - Contains releasenote of all features added in Kolla-Ansible.
  • specs - Contains the Kolla-Ansible communities key arguments about architectural shifts in the code base.
  • tests - Contains functional testing tools.
  • tools - Contains tools for interacting with Kolla-Ansible.
  • zuul.d - Contains project gate job definitions.

Getting Involved

Need a feature? Find a bug? Let us know! Contributions are much appreciated and should follow the standard Gerrit workflow.

  • We communicate using the #openstack-kolla irc channel.
  • File bugs, blueprints, track releases, etc on Launchpad.
  • Attend weekly meetings.
  • Contribute code.

Contributors

Check out who's contributing code and contributing reviews.

Notices

Docker and the Docker logo are trademarks or registered trademarks of Docker, Inc. in the United States and/or other countries. Docker, Inc. and other parties may also have trademark rights in other terms used herein.