aboutsummaryrefslogtreecommitdiff
path: root/doc/source/reference
AgeCommit message (Collapse)AuthorFilesLines
2026-10-15Remove Disable Getting Started panel Grafana tasksAlex Welsh1-0/+3
Since Grafana 13.2, the api/user/helpflags/1 endpoint has been removed [1]. This means the "Disable Getting Started panel" deployment task fails with 404 when a custom home dashboard is added. The best alternative I can find is to set default_home_dashboard_path in grafana.ini, which disables the panel anyway [2] [1] https://github.com/grafana/grafana/pull/124916 [2] https://github.com/grafana/grafana/pull/28750 Change-Id: I78b8657b6ca94d81e3becbba9d5a476d9427658f Signed-off-by: Alex Welsh <alex@stackhpc.com> Closes-Bug: #2166048 (cherry picked from commit c8e7b85b2707f762b2560ad8bed9d107a30ff521) Signed-off-by: Bartosz Bezak <bartosz@stackhpc.com>
2026-06-29Tune libvirtd connection limits for OpenStackMichael Still1-0/+23
The libvirt daemon ships with max_workers=20 and max_client_requests=5. Those defaults suit a multi-tenant host serving many mutually distrustful clients, where the per-client request cap protects the daemon from any single client monopolising it. Under Kolla-Ansible, nova-compute is effectively the sole privileged client of libvirtd, so the cap of 5 concurrent requests per client becomes the binding constraint rather than a safety net. When several instances build at once -- as they do during the tempest run of the upgrade jobs -- nova-compute's concurrent libvirt RPCs (instance defineXML calls plus the resource-tracker periodic) exceed five. Further requests queue, the connection's keepalive responses are starved, and after keepalive_interval (5s) x keepalive_count (5) = 25s libvirtd closes the connection. nova then sees "Cannot recv data: Input/output error" mid-defineXML, the build is rescheduled, and once all hosts are exhausted the instance is left in ERROR. This presents as flaky upgrade-job failures. Example failure, on the voting kolla-ansible-debian-bookworm-upgrade job (stable/2025.2): https://zuul.opendev.org/t/openstack/build/73ff5a97567d4e05b1774170e0f4aada with primary/logs/kolla/libvirt/libvirtd.txt showing libvirt's own recommendation to tune this parameter: warning : Client hit max requests limit 5. This may result in keep-alive timeouts. Consider tuning the max_client_requests server parameter ... error : connection closed due to keepalive timeout Raise the per-client cap to 20 -- comfortably above the handful of concurrent builds plus periodics seen in practice -- and the worker pool to 50 so that lifting the per-client limit does not starve other connections such as live migration, health checks and periodic tasks. Both values are exposed as variables (libvirt_max_client_requests and libvirt_max_workers) so operators can tune them further. This is not a Kolla-specific workaround -- the stock libvirtd.conf comment warns that setting max_client_requests too low "may cause keepalive timeouts", and since 2022 libvirtd emits the runtime warning quoted above. As Daniel Berrange explained when he added that warning, the keepalive packets "are subject to the 'max_client_requests' limit just like any API calls", so a client that saturates the limit can have its connection dropped: https://lists.libvirt.org/archives/list/devel@lists.libvirt.org/message/5NIJPA7SJVY55VSK7RTEDEHKWOZYJKT6/ Red Hat documents the same tuning for libvirt hosts under load in its knowledge base, notably "Too many active clients are dropping the connection" at https://access.redhat.com/solutions/28146. Assisted-By: Claude Opus 4.8 (1M context, medium effort) Partial-Bug: 2158515 Change-Id: I131c3d4d57dc73ca4dd421cc8f28465248c9830e (cherry picked from commit 5acd2f91d22213ef04bd6988a2a0261982b0cf05) Signed-off-by: Michael Still <mikal@stillhq.com>
2026-06-19docs: warn about password resets in ceph RGW docBertrand Lanson1-0/+9
Keeping this value to true with external RGW as object storage endpoints can cause outages that are annoying to recover from. We should warn operators about this. Change-Id: I37965382bed6b9762782ec3f9ec3103143d738cc Signed-off-by: Bertrand Lanson <bertrand.lanson@infomaniak.com> (cherry picked from commit 8510b763fec5fbfdcd677177809c682eb69e97dc)
2026-04-24Merge "Fix for Prometheus documentation" into stable/2025.120.4.0Zuul1-1/+1
2026-04-10[stable-2025.1] valkey: Add ansible roleMichal Nasiadka1-4/+6
This is a non-trivial backport of Valkey deployment that is required for migration to Rocky Linux 10 before upgrading to Flamingo/Gazpacho. Additional subcommand and playbook to migrate from Redis to Valkey will be added in a follow-up. Cephadm bits backported from I51823808c4e4ac08ae8f080aacf6a3759589571d Co-Authored-By: Bartosz Bezak <bartosz@stackhpc.com> Change-Id: I613d471e5f1e6d563d3853761d8432cba60f3c4c Signed-off-by: Michal Nasiadka <mnasiadka@gmail.com> Signed-off-by: Bartosz Bezak <bartosz@stackhpc.com>
2026-04-07Remove deleted mod_auth_openidc optionPierre Riteau1-3/+3
The option OIDCTokenBindingPolicy was deleted from mod_auth_openidc [1]. Remove it from our documentation. SSO with Keycloak was successfully tested without it. Keep documentation about keystone_federation_oidc_additional_options by using OIDCOutgoingProxy instead. [1] https://github.com/OpenIDC/mod_auth_openidc/commit/f9a52507acee0817b9cc91ec194bcea894f77ee0 Change-Id: Icfe4ef0f6070a97c4e43f691643169e71cc2772a Signed-off-by: Pierre Riteau <pierre@stackhpc.com> (cherry picked from commit 2e9f2caaf8a8eb19563a1085e6a23d778b279dbc)
2026-03-18Fix for Prometheus documentationRafal Lewandowski1-1/+1
Closes-Bug: #2102239 Change-Id: Ia8e551c62fc5d2d775098026d5d85611b81934fc Signed-off-by: Rafal Lewandowski <rafal@stackhpc.com> (cherry picked from commit ef7b06716dbd7de439d6504331c9c77481c047c2)
2025-10-08ovn-db: Add OVN_NB_DB and OVN_SB_DB env variablesMichal Nasiadka1-0/+7
It will make running ovn-nbctl and ovn-sbctl working on all nodes irrespective of their cluster role. Excerpt from ovn-nbctl: --db database The OVSDB database remote to contact. If the OVN_NB_DB en‐ vironment variable is set, its value is used as the de‐ fault. Otherwise, the default is unix:/ovnnb_db.sock, but this default is unlikely to be useful outside of single-ma‐ chine OVN test environments. Closes-Bug: #2116313 Change-Id: I85f7bfd0aaa6f2d426ddb28950acbbca9d385aac Signed-off-by: Michal Nasiadka <mnasiadka@gmail.com> (cherry picked from commit bdd98eca87890666f66b8b3d920f7ce0948ace44)
2025-07-29Update RabbitMQ documentation for EpoxySeunghun Lee1-36/+50
This section is outdated and using unrelated information from Caracal release. Change-Id: I84ca463c948f1db1b3f2f0178a352337bee57c4a Signed-off-by: Seunghun Lee <seunghun@stackhpc.com>
2025-05-08Merge "Add Pure Storage FlashBlade as Manila backend"Zuul2-0/+287
2025-05-05Merge "Run ML2/OVS agents processes in separate containers"Zuul1-0/+15
2025-04-30Run ML2/OVS agents processes in separate containersMichal Nasiadka1-0/+15
It's an experimental feature, disabled by default (but enabled by default in our CI). It's based on TripleO ,,version'' that was their fix for the linked bug. Closes-Bug: #1891469 Depends-On: https://review.opendev.org/c/openstack/kolla/+/946215 Change-Id: Iaa1e687152db8351bc0e9b10e66f412860ac13a5
2025-04-29Docs: update RabbitMQ HA instructionsMatt Crees1-5/+6
``kolla-ansible genconfig`` includes some tasks [1] that require containers to still be running. Move the config generation to be done before containers are stopped. Also make it clearer that containers should not be restarted with the new config until after RabbitMQ state has been reset. 1. https://github.com/openstack/kolla-ansible/blob/master/ansible/roles/octavia/tasks/get_resources_info.yml#L2 Change-Id: I1d4fc32e5963a8e8fa4a8fc7c467cadf0f26fd5f
2025-04-28Add Pure Storage FlashBlade as Manila backendSimon Dodsley2-0/+287
Follow existing patterns to add support for the Pure Storage FlashBlade NFS Manila driver. Change-Id: I5ed40748439111e5986d6bf44ecb6b9fe7478dc9
2025-04-09Upgrade RabbitMQ docs for the Epoxy releaseMatt Crees1-15/+15
Updates the HA section to account for the change to quorum queues and streams by default. Also adds a note to the SLURP section as it's not needed for Epoxy. Change-Id: Id4a3b4f3934622572c8493678f109fa67ccfdec6
2025-03-27Merge "add lightbits driver support"Zuul3-0/+37
2025-03-24Merge "Remove Swift role"Zuul3-331/+0
2025-03-21Remove Swift roleMichal Nasiadka3-331/+0
Since Swift is broken and since deprecation nobody did pick up the work to make it working - let's remove swift role and associated integrations/CI scripts. Change-Id: I08e92aaeea644053fd25f80ce1f276a495cebbfc
2025-03-20ovn: Add support for OVN SB RelayMichal Nasiadka1-0/+27
Add support for deploying OVN SB relays [1]. This is enabled by default to improve large scale scenarios. Default mechanism deploys one relay group per 50 ovn-controller hosts and uses random but idempotent method to choose a relay for a given host. neutron-server and Octavia will connect directly to SB cluster, not via the relays. kolla-ansible check subcommand does not support ,,iterated'' containers for now - but will be introduced in a subsequent patch. [1]: https://docs.ovn.org/en/latest/tutorials/ovn-ovsdb-relay.html Co-Authored-By: Krzysztof Tomaszewski <ktomaszewski@cloudferro.com> Depends-On: https://review.opendev.org/c/openstack/kolla/+/928898 Change-Id: Id7d6973668d8b2b194913b533f8cb756c6708536
2025-03-12add lightbits driver supportyuval3-0/+37
Change-Id: I50c5a1443c5d2012388debed20b96274bc69e7e7
2025-02-28Merge "[Pure Storage] Update Pure reference page in documentation"Zuul1-2/+7
2025-02-28Merge "prometheus: Support overriding address of scrape targets"Zuul1-0/+13
2025-02-21prometheus: Support overriding address of scrape targetsMark Goddard1-0/+13
In many cases we use the kolla_address filter to look up the IP address of the current host or another host on a particular network interface. This filter uses the host's facts to determine the IP, meaning that we must have gathered facts for the host, even if it is outside of a requested --limit. This is a limitation, since it requires that all hosts must be reachable, even if we are not directly configuring them. Most instances of this cross-host fact referencing involve a controller, since they host clustered services. The only instance found to affect compute nodes is in the prometheus role, where Prometheus server needs to know the IP address of all targets in its scrape configs. If we are able to specify the address of the scrape targets as a static variable such as a host variable, then facts would not be required for compute nodes outside of the --limit. Removing the requirement to have facts for all compute nodes has benefits for performance (gathering facts for all hosts can take a long time) and fault tolerance (we can operate when some compute hosts are unreachable). This change modifies the kolla_address filter to accept an optional override_var argument which can be used to specify the name of a host variable that may override the returned IP address. This is used in the Prometheus server configuration to allow specifying the IP address used by Prometheus server when collecting metrics from exporter using a 'prometheus_target_address' host variable. If specified, this takes precedence over the API interface address currently used. This makes it possible to statically override prometheus_target_address and avoid the cross-host fact reference. This is not a complete solution because it is not yet possible to skip the cross-host fact gathering step. Partial-Bug: #2041860 Change-Id: I207ca56362de00d8ec578333eab9e1a72e7bcd19
2025-02-19docs: Correct typo in variable nameamithkotu1-2/+2
This commit addresses a typo in the documentation where the variable "neutron_physical_network" was incorrectly used. The correct variable name is "neutron_physical_networks", which reflects the actual value used in the code. Closes-Bug: #2088062 Change-Id: I5d4a7895d54aebcf0612e72d315defeda37bb178
2025-02-03[Pure Storage] Update Pure reference page in documentationSimon Dodsley1-2/+7
From the release of 2024.2 (Dalmatian) the SDK required by the Pure Cinder driver changes from ``purestorage`` to ``py-pure-client``. This patch updates the Pure documentation to reflect this change. Change-Id: I7092f3b7ca00019822b8d8f6f425fbb13db9d8ae
2025-01-22docs: fix link to Cinder HA pagePierre Riteau1-1/+3
Fix URL by switching from KOLLA_OPENSTACK_RELEASE to OPENSTACK_RELEASE introduced in [1]. This replaces `master` by `latest` in the URL. The link was also not rendered correctly because of a syntax error. [1] https://review.opendev.org/c/openstack/kolla-ansible/+/937440 Change-Id: Ie8c90ff5c8682aec07e851909bc820cba7602bec
2025-01-22Merge "docs: minor fixes to external Ceph guide"Zuul1-8/+6
2024-12-18Docs update - kolla-ansible cli parametersJakub Darmach2-3/+3
With rewrite of kolla-ansible CLI to Python in I9749b320d4f5eeec601a055b597dfa7d8fb97ce2 the order of parameters have to be: `kolla-ansible <action> <arguments>` Change-Id: I1bd4a7f96f77c34fb46ca21f37023dddf73e8f05 Closes-bug: 2087920
2024-12-05docs: minor fixes to external Ceph guidePierre Riteau1-8/+6
When a path is broken into two separate lines, the generated HTML includes an incorrect space character in the middle of the path. We need to ignore doc8 linting on this file as this change breaks the max line length check. I tried using ``ignore-path-errors`` to exclude only D001 for this file, but doc8 does not like a relative path for this option [1]. [1] https://github.com/PyCQA/doc8/issues/162 Change-Id: I1cf0b7a6b7506a68876bce2de5080718280a47be
2024-11-27Merge "Skyline: use an external object store (Swift) in the dashboard"Zuul1-0/+15
2024-11-25Enhance Ceph Integration for Multiple ClustersMichal Arbet1-75/+124
This patch enhances Kolla-Ansible's existing support for multiple Ceph clusters by improving the management of custom users, pools, and cluster names. It aligns the Ceph integration more closely with the official Ceph user management guidelines [1]. Keyrings now follow the format `$cluster.client.$user.keyring`, and configurations are easier to handle when multiple Ceph clusters are in use, especially in environments with multiple availability zones. Previously, workarounds were needed for keyrings and config files, which this patch eliminates, providing a cleaner and more structured configuration approach which follows the Ceph best practices. The default Kolla setup remains unaffected by these changes, ensuring backward compatibility. Updated documentation and examples are included. [1] https://docs.ceph.com/en/latest/rados/operations/user-management/#keyring-management Change-Id: I2593b6df737b384f1a5fba22f69e851c575990b4
2024-10-28Rewrite kolla-ansible CLI to python19.0.0.0rc1Roman Krček1-3/+7
Moving the CLI to python allows for easier maintenance and larger feature-set. This patch introduces a few breaking changes! The changes stem the nature of the cliff package. - the order of parameters must be kolla-ansible <action> <arguments> - mariadb_backup and mariadb_recovery now are mariadb-backup and mariadb-recovery Closes-bug: #1589020 Signed-off-by: Roman Krček <roman.krcek@tietoevry.com> Change-Id: I9749b320d4f5eeec601a055b597dfa7d8fb97ce2
2024-10-25Merge "cinder: Add prechecks and docs for HA/clustering"Zuul1-0/+17
2024-10-25cinder: Add prechecks and docs for HA/clusteringMichal Nasiadka1-0/+17
Change-Id: I33a3ec11b0cdef94b08cd7551008284755824cb7
2024-10-25cinder: Drop Hitachi HNAS NFS driver supportMichal Nasiadka3-215/+0
It has been removed in I23867aa98f68298beb5db4558c66c1ffd4e7d6f1 Change-Id: I12d287b9f7f1e5ddf754b7f2ca1dee39778e710e
2024-10-03Merge "Add configuration for NTP server in Ironic Inspector DHCP server"Zuul1-0/+10
2024-09-23Add configuration for NTP server in Ironic Inspector DHCP serverMaksim Malchuk1-0/+10
Followup on Ib69fc0017b3bfbc8da4dfd4301710fbf88be661a. This change adds the ability to provide the NTP (time source) server for multiple DHCP ranges in the Ironic Inspector DHCP server. Change-Id: I4bbfef3a391b8582ae73cbe06138715b43584dec Signed-off-by: Maksim Malchuk <maksim.malchuk@gmail.com>
2024-09-19Merge "Add a precheck to catch RMQ SLURP upgrades"Zuul1-1/+2
2024-09-18Merge "Fix octavia-interface timeout"Zuul1-0/+18
2024-09-18Merge "Fix typo in RabbitMQ versions pinning"Zuul1-1/+1
2024-09-18Fix typo in RabbitMQ versions pinningMatt Crees1-1/+1
We don't use dots in the image name Change-Id: I29172448c14a1ca9a5fa23abe701366f875959e0
2024-09-11Be clear that rabbitmq-upgrade is not idempotentMatt Crees1-0/+3
This isn't obvious from reading of the docs, let's make sure users are aware. Change-Id: I0da1ad16bfab00bed7e935cca118551a6c5860c6
2024-09-04Merge "harden haproxy TLS configuration"Zuul1-0/+5
2024-08-30harden haproxy TLS configurationSven Kieske1-0/+5
harden the TLS default config according to the mozilla "modern" recommendation: https://ssl-config.mozilla.org/#server=haproxy&version=2.1&config=modern&openssl=1.1.1k&guideline=5.7 if you want to revert to the old settings, set: kolla_haproxy_ssl_settings: "legacy" in globals.yaml alternatively you can also set it to "intermediate" for a middle ground between security and accessibility. this also adjusts the glance and neutron tls proxy ssl settings in their dedicated haproxy config templates to use the same mechanism. also add some haproxy related docs to the TLS guide and cross reference it from the haproxy-guide. Closes-Bug: #2060787 Signed-off-by: Sven Kieske <kieske@osism.tech> Change-Id: I311c374b34f22c78cc5bcf91e5ce3924c62568b6
2024-08-29Add a precheck to catch RMQ SLURP upgradesMatt Crees1-1/+2
Given we bump the RabbitMQ version each release, there is a manual upgrade to an intermediary RabbitMQ version needed before a skip-level upgrade can be performed. Change-Id: Id8a5ebe19a50ebdc59d12667889472c803b8d7c8
2024-08-22Merge "Add command to upgrade to a target version of RMQ"Zuul1-0/+44
2024-08-22Merge "Add NVMe-TCP Cinder driver support for Pure Storage"Zuul2-0/+17
2024-08-21Merge "Add support for customising Neutron physical network names"Zuul1-5/+36
2024-08-20Add NVMe-TCP Cinder driver support for Pure StorageSimon Dodsley2-0/+17
From OpenStack 2023.2 (Bobcat) the Pure Storage Cinder driver supports NVMe-TCP as a dataplane protocol. This patch adds support for this new driver type. Change-Id: I3c0ad7652a03388ab2eafa173c644a55b0405cc6
2024-08-12Add command to upgrade to a target version of RMQMatt Crees1-0/+44
Required before a SLURP upgrade Change-Id: I09a45d26a6075554b204e007f64122f23de5f53c
generated by cgit v1.2.3 (git 2.39.1) at 2026-11-07 04:24:49 +0000