Reconfigure a single service¶
Impact Restarts on drift
What kolla-ansible -t <svc> reconfigure does in 2024.1 for one API service, with keystone as the command example:
after the gather-facts and group_by plays, which run on all hosts, the loadbalancer play runs on the loadbalancer hosts
(the service's frontend, and a staged HAProxy restart if the rendered frontend changed) and the service play on the
service hosts (the service's containers, all of which restart on every drifted host). As in 2023.1, common is its
own play, tagged common only, so a service tag does not run it. The page also says what a narrow tag touches
besides the service, and what changes on the first 2024.1 run of a cloud deployed by 2023.1.
The scenario sections are written for the assumed deployment; the page uses the conventions of the command sections, the definition of drift and the notion of code guarantees and environment dependence.
Note
Key answers
- What restarts (§1.1): on each host where any container of the service
drifted, all its containers; all such hosts in parallel, unless
ANSIBLE_SERIALis set. HAProxy restarts only if the service's rendered frontend changed, backups first and the VIP holder last (§3). - First 2024.1 run on a 2023.1 cloud: a service that
kolla-ansible upgradehas not reached drifts on every host: its image tag changes, and the reconfigure skips the role's upgrade tasks; the systemd unit text changed (F16); quorum queues are on by default in every service that talks to RabbitMQ (F17). Upgrade it first. For keystone the frontend text changes too (§3). - Keep HAProxy out:
--skip-tags haproxy(§1.2). genconfigfirst: it re-rendersservices.dtoo, so a later-t <svc>run no longer restarts HAProxy for that change (§3).
Warning
R8: a changed services.d/<svc>*.cfg restarts HAProxy on every loadbalancer host
(backups together, then the VIP holder) — see §1.2 and
§3.
1. Commands¶
1.1 Reconfigure a single service¶
kolla-ansible -i multinode -t keystone reconfigure
reconfigure sets kolla_action=reconfigure and kolla_serial (tools/kolla-ansible:529-531).
- Scope:
- loadbalancer play: keystone frontend only, on the loadbalancer hosts (
site.yml:105-120; keystone includesite.yml:203-207, inside a block that runs only whenenable_haproxyis set andkolla_actionisdeploy,reconfigure,upgradeorconfig,site.yml:324-326); - keystone play (
site.yml:483-495): config, check-containers, bootstrap (db sync), a handler flush (restarts happen here), Fernet key distribution, Keystone registration, and identity-provider registration whenenable_keystone_federationis true (roles/keystone/tasks/deploy.yml:2-21;reconfigure.ymlonly importsdeploy.yml). Still holds in 2024.1: there is nocheck.ymlin the role.commondoes not run: it is its own play, taggedcommononly (site.yml:88-103). Unlike glance, placement, cinder, heat and neutron, which register first (e.g.roles/glance/tasks/deploy.yml:2), keystone registers last. - Changed in 2024.1: keystone's registration no longer passes a list of roles to create
(
roles/keystone/tasks/register.yml:14-19; 2023.1 passedkeystone_ks_roles, which no longer exists), and theadminendpoint is no longer listed for removal (roles/keystone/defaults/main.yml:200-202).
- loadbalancer play: keystone frontend only, on the loadbalancer hosts (
- Restarts:
- haproxy, on all loadbalancer hosts, only if the frontend changed (staged, see §3);
- per host (loop-notify): on each keystone host where any keystone container drifted, all keystone containers of
that host restart (
keystone,keystone_sshandkeystone_fernet, all threeenabled: trueunconditionally,roles/keystone/defaults/main.yml:6, :34, :47;roles/keystone/tasks/check-containers.yml:2-17). Hosts without drift do not restart. Drifted hosts restart in parallel, unlessANSIBLE_SERIALis set (default 0,tools/kolla-ansible:296, :531; the keystone play readsserial: '{{ kolla_serial|default("0") }}',site.yml:486), so without it a change common to all hosts (globals,keystone.conf, a new image) restarts keystone on all keystone hosts at once.
- One-shot: the
bootstrap_keystonedb sync container, once (run_once,roles/keystone/tasks/bootstrap_service.yml:33-50); the Fernet bootstrap container only when no host runskeystone_fernet(:52-75). Fernet keys are re-distributed (roles/keystone/tasks/deploy.yml:15). - Impact: if restarted, keystone restarts on all drifted hosts at once; NOT AVAILABLE whether authentication fails meanwhile, and for how long (Risk register R19).
1.2 Avoid touching HAProxy during a service run¶
kolla-ansible -i multinode -t nova --skip-tags haproxy reconfigure
--skip-tags haproxydrops the whole loadbalancer play, including the per-service frontend includes:haproxyis a play tag (site.yml:115-118), inherited by every task of the play (Tags §2.1).- Use it when frontends are not meant to change. Otherwise a changed
services.d/<svc>*.cfgrestarts HAProxy on all loadbalancer hosts.
2. Execute a service-specific tag: implicit effects¶
Even with a narrow tag, the code guarantees that the run also touches:
| Implicit effect | Mechanism | Evidence |
|---|---|---|
| HAProxy frontends of the service, on all loadbalancer hosts, and a HAProxy restart if the rendered frontend changed | loadbalancer play includes <svc>/ under the same tag; that file imports loadbalancer-config with tags: always, which imports haproxy-config (and proxysql-config when enable_proxysql); handlers ignore tags. New in 2024.1: with haproxy_single_external_frontend (default false), the service's block of external-frontend-map is also written and also notifies the restart |
site.yml:105-326, roles/, roles/, roles/, group_vars/; fact sheet A §1.9; Tags §2.2–2.3 |
common on every host of the service play: still not in 2024.1 |
No role has a meta/ directory (no meta dependency on common); common is a separate play on the cron, fluentd, kolla-logs and kolla-toolbox groups with tags: common, so it runs only under -t common or a run without tags |
site.yml:88-103, roles/; Tags §2.1 |
| Keystone registration (services, endpoints, projects, users, roles of those users, grants) | register.yml imports service-ks-register from deploy.yml, which reconfigure.yml imports |
roles/, roles/ |
DB creation/grants and DB schema sync for most services, Neutron included (its bootstrap_neutron container has no when, Reconfigure Neutron §2) |
bootstrap.yml imported by deploy.yml |
CODE 12 one-shot container runs on a no-change redeploy of this service set (cell0 mapped; MariaDB, RabbitMQ and Fernet keys already bootstrapped): 8 DB-sync bootstraps (keystone, glance, placement, nova API, nova cell, neutron, cinder, heat) + map_cell0 + list_cells for cell0 (roles/) + 2× list_cells, counted from each role's bootstrap_service.yml (roles/, roles/, roles/, roles/, roles/, roles/; nova: Reconfigure Nova §1.1, Tags §3) |
| RabbitMQ user/vhost (nova-cell only) | service-rabbitmq, imported from nova-cell/ |
roles/, roles/ |
Global MariaDB variable toggle (-t glance) |
log_bin_trust_function_creators 1→0 around the glance DB sync, unless use_preconfigured_databases |
roles/; fact sheet C §1 |
Fernet key redistribution (-t keystone) |
distribute_fernet.yml |
roles/; fact sheet B §3.6 (re-run on reconfigure: §3.7) |
Actions on hosts outside --limit |
delegate_to to groups[...][0]: Neutron DB bootstrap on neutron-server[0], cell discovery on conductor[0], RabbitMQ user creation on the first host of the cell's RPC (and notify) group |
roles/, bootstrap_service.yml:20-21; roles/, wait_discover_computes.yml:43; roles/, roles/; Add a compute node §2 |
SIGHUP to every nova-scheduler (-t nova/nova-api) |
refresh play, on deploy and reconfigure |
nova.yml:152-172 |
What a service tag does not do: it never touches MariaDB, RabbitMQ or memcached containers (other plays), and it
never touches OVS (unless -t openvswitch), nor the common containers (fluentd, kolla_toolbox, cron). Under
-t haproxy or a no-tag run, the loadbalancer role's containers (HAProxy, keepalived, ProxySQL when enabled and, new
in 2024.1, haproxy_ssh when enable_letsencrypt is set, roles/loadbalancer/defaults/main.yml:30-32) are also
checked; a service tag touches only its frontend file (and, with the single external frontend, its block of the map).
CODE -t haproxy reconfigure on an unchanged cloud: the loadbalancer role on the 2 loadbalancer hosts
(site.yml:105-120, inventory/multinode:84-85); common does not run (its play is tagged common only,
site.yml:88-103). Changed in 2024.1: the play holds 39 frontend include_role tasks, not 44 (freezer, murano,
sahara, senlin, solum and vitrage are gone; letsencrypt is new). All 39 are evaluated; 12 run (placement's, which has
no when, and the 11 whose condition is true for this service set: cinder, glance, heat, horizon, keystone, mariadb,
memcached, neutron, nova, nova-cell, rabbitmq) and the other 27 are skipped by their when
(site.yml:122-323; defaults in group_vars/all.yml). Restarts follow only a task that reports changed (Tags
§2.4); NOT AVAILABLE whether
any task does on an unchanged cloud.
3. Sequence, impact, risks and verification of -t <svc> reconfigure¶
For an API service such as keystone, glance, cinder, heat or placement:
- The gather-facts and group_by plays run on all hosts (
tags: always,site.yml:2-75). - loadbalancer play, on the loadbalancer hosts: only the
<svc>include runs and rendersservices.d/<svc>*.cfg. The loadbalancer role's own tasks carry only the play tags (haproxy,keepalived,loadbalancer), not the<svc>tag, so they are skipped CODE (site.yml:115-120; Tags §2.3). If that file changed, HAProxy restarts on every loadbalancer host, staged CODE: the hosts are grouped by whether they hold the VIP (roles/loadbalancer/handlers/main.yml:9-34); HAProxy stops and starts on all backups together and the play waits forhaproxy_monitor_port(:54-68,:90-118); then it stops and starts on the VIP holder and waits again (:179-193,:224-252) (R8; HAProxy + Keepalived). Corrected in 2024.1: the 2023.1 page said "on all loadbalancer hosts at once"; the handlers stage it, and this order is unchanged from 2023.1 apart from the module rename. Whether the VIP moves meanwhile is NOT AVAILABLE. - Service play, on the service hosts: Keystone registration (
run_once) → config → check-containers → DB/user creation and the DB-sync container on the first host → flush (e.g.roles/glance/tasks/deploy.yml:2-15; placement runs its clone step before config,roles/placement/tasks/deploy.yml:2-14). Every drifted host restarts all of the service's containers (loop-notify), all such hosts in parallel unlessANSIBLE_SERIALis set. Keystone is the exception: it registers last (§1.1).
First 2024.1 run on a cloud deployed by 2023.1 CODE:
- If
kolla-ansible upgradehas not reached the service, its image changes:openstack_releasedefaults to2024.1(group_vars/all.yml:679-681), the check compares the image (module_utils/kolla_container_worker.py:75), and the handler recreates the container on the 2024.1 image (module_utils/kolla_docker_worker.py:353-361), through the deploy path, without the role's upgrade tasks (e.g.roles/keystone/tasks/upgrade.yml:23-31). Upgrade it first. - Every container whose unit no 2024.1 run has recreated or restarted yet drifts:
compare_containeralso compares the systemd unit text (module_utils/kolla_container_worker.py:58-65,module_utils/kolla_systemd_worker.py:154-167), and the 2024.1 unit template differs from the one 2023.1 wrote; with Docker only the start-limit line differs (F16). Akolla-ansible upgradethat recreated the service's containers already wrote the new units. The services that talk to RabbitMQ also renderrabbit_quorum_queue = trueby default (group_vars/all.yml:268; e.g.roles/keystone/templates/keystone.conf.j2:77-78,roles/glance/templates/glance-api.conf.j2:139-140,roles/cinder/templates/cinder.conf.j2:90-91,roles/heat/templates/heat.conf.j2:89-90; F17). So the first run on a service not yet upgraded restarts it on all its hosts at once, unlessANSIBLE_SERIALis set. -
For keystone, the
balanceline of both frontends is now writtenbalance roundrobininstead ofbalance "roundrobin"(roles/keystone/defaults/main.yml:20, :30), and the template copies it as is (roles/haproxy-config/templates/haproxy_single_service_split.cfg.j2:77-79): the renderedservices.d/keystone.cfgchanges and HAProxy restarts. With TLS on, every frontend'sbindline also gainsalpn h2,http/1.1(haproxy_enable_http2: "yes",group_vars/all.yml:920-921; template:2-5). Whether the frontends of the other services render differently is NOT AVAILABLE (not rendered here); the diff of the verification below shows it. -
Interruption: the service API is unavailable while its containers restart on all drifted hosts at once. A config drift goes through a systemd
RestartUnitof the container's unit, a container drift (image, volumes) through a stop, remove and start (module_utils/kolla_docker_worker.py:341-363,:415-431,:439-459;module_utils/kolla_systemd_worker.py:106-125). Either way the stop is the unit'sExecStop=/usr/bin/<engine> stop <name> -t <graceful_timeout>(module_utils/kolla_systemd_worker.py:32), withdocker_graceful_timeout, 60 s by default, passed throughdocker_common_options(group_vars/all.yml:139, :151): up to 60 s between SIGTERM and SIGKILL, then the start. Add the HAProxy restart window if the frontend changed. - VM impact: these services restart none of the containers that Tags
§3.1 traces to running VMs
CODE; any other effect on VMs is NOT AVAILABLE. In-flight glance or cinder transfers are SIGKILLed if still
running
docker_graceful_timeout(60 s by default) after SIGTERM (R24). Of the tags in Tags §3.1, the ones that can restart those containers arenova,nova-cell,neutron,openvswitch,ovn(withovn-controllerandovn-db,site.yml:653, :669),iscsiandbaremetal(run bybootstrap-serversthroughopenstack.kolla.baremetal,kolla-host.yml:4-14, notreconfigure; Docker restart, R14) CODE; what those restarts do to running VMs is NOT AVAILABLE. Running on computes is not the test:commonruns on every compute (inventory/multinode:49-54, :202-213) but restarts only fluentd, kolla_toolbox and cron (roles/common/defaults/main.yml:4, :13, :25).chronystill has no role or play. - Risks: R8 (HAProxy restart), R19 (Keystone),
R20 (glance file backend), R23 (
--limiton a large inventory), R24 (SIGKILL afterdocker_graceful_timeout). - Verification:
- before: copy
/etc/kolla/haproxy/services.d/<svc>*.cfgfrom a loadbalancer host, runkolla-ansible -t <svc> genconfig, thendocker exec -u root <c> /usr/local/bin/kolla_set_configs --check; echo $?in each<svc>container (without-u rootit exits 2 in images that run as a service user, e.g. glance-api; Kolla images §3.4) and diff the frontend against the copy; - caveat on
genconfigCODE:genconfigruns withkolla_action=config(tools/kolla-ansible:557-559), for which the loadbalancer block also runs (site.yml:326) and writesservices.d/<svc>*.cfg(roles/haproxy-config/tasks/main.yml:2-23), while every loadbalancer restart handler is skipped (roles/loadbalancer/handlers/main.yml:16-17and the same condition on each handler). In the following-t <svc> reconfigurethe template task finds the file already written and notifies nothing, and the loadbalancer check-containers task, which would see the difference throughkolla_set_configs --check(roles/loadbalancer/tasks/check-containers.yml:2-18;services.d/is copied into the container,roles/loadbalancer/templates/haproxy/haproxy.json.j2:17-18), does not run under a service tag. So the new frontend reaches HAProxy only through a-t haproxy reconfigure(or a run without tags). The service containers are not affected: their check-containers task does run; - after:
openstack endpoint list --service <name>is unchanged for each Keystone service the role registers (eachnamein<svc>_ks_services, e.g.cinderv3only for cinder (roles/cinder/defaults/main.yml:335-341),heatandheat-cfnfor heat (roles/heat/defaults/main.yml:218-230)), the API answers through the VIP, the container start times show which hosts restarted, anddocker ps --filter name=haproxyshows whether HAProxy restarted (kolla_container_enginedefaults todocker,group_vars/all.yml:92; with Podman, usepodman).
- before: copy
Related¶
- Risk register — the risks this page names: R8 (HAProxy
restart), R19 (Keystone), R20 (glance file backend),
R23 (
--limiton a large inventory), R24 (SIGKILL afterdocker_graceful_timeout) and R14 (Docker restart bybootstrap-servers) - Technical findings — F16 (the changed systemd unit template) and F17 (quorum queues on by default), the two causes of drift on the first 2024.1 run
- Keystone — service card and where to look for the service of the §1.1 example
- HAProxy + Keepalived — service card and where to look for HAProxy, including the staged restart order and the loadbalancer play under a service tag
- Pre-execution checklist — the checks before every production run
- Predict and inspect a run —
genconfigand the exit codes ofkolla_set_configs --check, used in the verification of §3 - Tags §2 — the semantics behind the implicit effects: tag inheritance, handlers that ignore tags, the haproxy play, loop-notify
- Command quick lookup by tag — hosts touched, possible restarts and one-shot containers per tag
To remember
Lumo: if you keep only 5 things from this page, keep these.
- A changed
services.d/<svc>*.cfgrestarts HAProxy on every loadbalancer host, the backups together and then the VIP holder; add--skip-tags haproxywhen frontends are not meant to change. - On each drifted host all the service's containers restart, all such hosts in parallel unless
ANSIBLE_SERIALis set: without it, a change common to all hosts restarts the service on all its hosts at once. - A service that
kolla-ansible upgradehas not reached drifts on every host on its first 2024.1 reconfigure: its image tag changes (and the reconfigure skips the role's upgrade tasks), its systemd unit text changed (F16) and quorum queues are on by default (F17). Upgrade it first. - The service API is unavailable while its containers restart, with up to
docker_graceful_timeout(60 s by default) between SIGTERM and SIGKILL. genconfigalso re-rendersservices.d: copy the file first, and after it a-t <svc>run no longer notifies the HAProxy restart.
What would you do?
Lumo: a situation you could meet on a real platform, and three ways to react. Pick the one you would choose: I will tell you what this page says about it. Nothing is recorded.
Check yourself
Lumo: 4 quick questions to check the main ideas of this page. Choose an answer to see the explanation and the section that gives the evidence. Your score counts your first choices and stays in this browser only.
Lumo: ready for the next step? Take your time: you can come back to this page whenever you need it.
Lumo: nicely done! One more page on your journey.