Kolla images: start path and one-shot containers¶
This page answers open question Q14 of the Open
questions: what the kolla images do when a container starts, and what the
one-shot containers that Kolla-Ansible starts with KOLLA_BOOTSTRAP, KOLLA_UPGRADE, KOLLA_OSM and similar variables
actually run. It was read from the kolla image repository (openstack/kolla, tag ussuri-eol, commit 9107c5f) and
matched against Kolla-Ansible ussuri-eol (8a94fe9). The images were read, not built or run.
Note
Key answers
- What every container start does:
kolla_startrunskolla_set_configs,kolla_copy_cacertsand the image'skolla_extend_start, then execs the service command (§2.2). kolla_set_configs --checkcompares only theconfig_filesentries ofconfig.json(content, mode, owner) CODE (§3.1). It never comparescommand,permissionsor removed entries (§3.2). Exit codes 0, 1, 2 and 137, and whatkolla_dockerdoes with each: §3.3. Run by hand, it needsdocker exec -u root(§3.4).- What a
COPY_ALWAYSrestart applies: changed or added files, mode and owner changes and a changed command CODE; removals do not apply (§3.5). - One-shot containers: what
KOLLA_BOOTSTRAP,KOLLA_UPGRADE,KOLLA_OSMand the other variables run in each image, and which Kolla-Ansible task sets them (§4). - Per-image start behaviour: the table in §5. The nova-libvirt start path is
passive towards running guests (§5.1); with
enable_neutron_agent_ha, the L3 agent wrapper runsneutron-netns-cleanup --force --agent-type l3on every container start (§5.3). - Day-2 consequences: 19 items (§6). What is not available from the sources: §7.
Citation convention: kolla image paths carry a kolla prefix (kolla docker/base/start.sh:8). Kolla-Ansible paths have
no prefix and are relative to its ansible/ directory (roles/nova/tasks/bootstrap_service.yml:13,
library/kolla_docker.py:543-578, nova.yml:45-61), except tools/.... Ansible source paths carry an ansible 2.9.27
prefix. Evidence labels are those of Conventions and evidence labels:
CODE (a kolla or Ansible path counts as CODE) and NOT AVAILABLE (the sources do not establish it).
1. Scope and method¶
- Read in full CODE: kolla
docker/base(Dockerfile.j2,start.sh,set_configs.py,copy_cacerts.sh,httpd_setup.sh,sudoers,healthcheck_*), and theDockerfile.j2and start scripts of the images in §5: Keystone, Glance, Placement, Cinder, Heat, Horizon, Barbican, Octavia, Manila, Swift, Nova, Neutron, Open vSwitch, OVN, MariaDB, RabbitMQ, memcached, HAProxy, keepalived (withcheck_alive.sh), fluentd, cron, kolla-toolbox, chrony, iscsid and tgtd. Of the other images only theironic-apibootstrap branch (§4) and thebifrost-deployENTRYPOINT/CMD(§2.1) were read, and every Dockerfile was searched forHEALTHCHECK(§2.7) and forENTRYPOINT/CMDoverrides. The rest were not. - Matched to Kolla-Ansible. Each one-shot variable was traced to the task that sets it (§4) CODE.
kolla_set_configs --checkwas read, not run: exit codes 0, 1 and 2 of §3.3 are read from kolladocker/base/set_configs.py; 137 and the exec client error arekolla_dockeroutcomes (library/kolla_docker.py:543-578).- Not covered: behaviour against real services and data, signal delivery, timing. These are NOT AVAILABLE and are listed in §7.
2. Start path common to every image¶
2.1 Image wiring¶
Every kolla image inherits from kolla docker/base/Dockerfile.j2 CODE:
ENTRYPOINT ["dumb-init", "--single-child", "--"]whenuse_dumb_initis on (:433-435; default True, kollakolla/common/config.py:170), andCMD ["kolla_start"](:455). The MariaDB image drops--single-child(§2.6). bifrost-deploy resets both (ENTRYPOINT [],CMD [ "/sbin/init" ], kolladocker/bifrost/bifrost-deploy/Dockerfile.j2:29-30), sobifrost_deploynever runskolla_startorkolla_set_configs.- The base scripts are installed as
kolla_start(start.sh),kolla_set_configs(set_configs.py),kolla_copy_cacerts(copy_cacerts.sh) andkolla_httpd_setup(httpd_setup.sh);sudoersbecomes/etc/sudoers, mode 0440 (:427-431,448). /usr/local/bin/kolla_extend_startis created empty bytouch(:446). An image gets start logic only by overwriting it./var/log/kollagets groupkollaand mode 2775 (:449-451).- Service users are added to group
kolla(kolladocker/macros.j2:50). The basesudoerslets members of that group run two commands as root without a password, keeping their environment:kolla_set_configsandkolla_copy_cacerts(kolladocker/base/sudoers:7,16,19). It also includes/etc/sudoers.d(:21), where many images add entries of their own, e.g. cinder-volume'schown -Randchmod(kolladocker/cinder/cinder-volume/cinder_sudoers:2-5) and mariadb'skolla_security_reset(kolladocker/mariadb/mariadb/mariadb_sudoers:1). Thekolla_set_configsentry restricts no arguments, sosudo kolla_set_configs --checkis allowed. - Kolla-Ansible passes
KOLLA_CONFIG_STRATEGYto every container throughdocker_common_options(group_vars/all.yml:43,162-163; defaultCOPY_ALWAYS).
2.2 kolla_start step by step¶
flowchart TB
D["dumb-init --single-child (PID 1)"] --> KS["kolla_start (errexit, xtrace)"]
KS --> SC["sudo -E kolla_set_configs"]
SC --> ST{"KOLLA_CONFIG_STRATEGY"}
ST -- "COPY_ALWAYS" --> CA["copy + permissions + /run_command (every start)"]
ST -- "COPY_ONCE, first start" --> CO["copy + permissions + /run_command, create /configured"]
ST -- "COPY_ONCE, /configured exists" --> SK["copy nothing, exit 0"]
ST -- "invalid strategy or copy error" --> F1["exit 1 or 2: start aborts"]
CA --> RC["CMD = cat /run_command"]
CO --> RC
SK --> RC
RC --> CC["sudo kolla_copy_cacerts"]
CC --> SE{"KOLLA_SKIP_EXTEND_START set?"}
SE -- "yes" --> EX
SE -- "no" --> XS["source kolla_extend_start (image USER)"]
XS --> OS{"one-shot variable set?"}
OS -- "yes" --> Z["run DB or setup commands, exit 0"]
OS -- "no" --> EX["exec CMD ARGS"]
-
set -o errexit; set -o xtrace(kolladocker/base/start.sh:2-3). Any failing command ends the container, including commands in the sourcedkolla_extend_start. xtrace is on in that script, and in thekolla_<service>_extend_startit sources (§2.5), where some one-shots put a secret on a command line: heat's--password ${HEAT_DOMAIN_ADMIN_PASSWORD}(kolladocker/heat/heat-api/extend_start.sh:12) and the MariaDB root password (kolladocker/mariadb/mariadb/extend_start.sh:23-25) CODE. NOT AVAILABLE (bash semantics, not in these sources) Whether the trace on stderr shows those commands with their variables expanded, and so writes the secret there.kolla_dockerreturns the container's stderr in the task result (library/kolla_docker.py:832-836,840-845,1070). Ansible's default callback prints a failed result,stderrincluded, and an ok or changed one only with-v(ansible 2.9.27lib/ansible/plugins/callback/default.py:94-114,152-153,lib/ansible/plugins/callback/__init__.py:101-123); a task withno_logreaches the callback with its result replaced by acensoredmessage (ansible 2.9.27lib/ansible/executor/task_queue_manager.py:373,lib/ansible/executor/task_result.py:131-139).bootstrap_heatandbootstrap_mariadbset nono_log(roles/heat/tasks/bootstrap_service.yml:2-29,roles/mariadb/tasks/bootstrap_cluster.yml:2-23),upgrade_mariadbdoes (roles/mariadb/tasks/upgrade.yml:26) CODE. -
sudo -E kolla_set_configs(:8) runs as root whatever the imageUSER, copies the configuration (§2.3) and writesconfig.json'scommandto/run_command. CMD=$(cat /run_command)(:9).sudo kolla_copy_cacerts(:13, §2.4), on every start whatever the strategy.- Unless
KOLLA_SKIP_EXTEND_STARTis set,. kolla_extend_start(:15-18). The script is sourced: it runs in the same shell, as the imageUSER, with errexit on. It can setARGSorCMD, orexit. Anexit 0ends the container before the service starts, which is how every one-shot branch in §4 works. The test is${!KOLLA_SKIP_EXTEND_START[@]}, the idiom that kolla's own comments describe as catching "all cases of the ... variable being set, including empty" (kolladocker/keystone/keystone/extend_start.sh:40-42), so any value, even empty orfalse, skips the script and every one-shot branch with it CODE. Kolla-Ansible never sets this variable (grep ofansible/). exec ${CMD} ${ARGS}, unquoted (:20-21). The service replaces the shell and becomes dumb-init's only child.
2.3 kolla_set_configs: copy and permissions¶
Without arguments, kolla_set_configs loads config.json (the KOLLA_CONFIG variable as a JSON string if set,
otherwise KOLLA_CONFIG_FILE, default /var/lib/kolla/config_files/config.json), validates it (command is
required; each config_files entry needs source and dest, plus owner and perm unless preserve_properties)
and applies the strategy (kolla docker/base/set_configs.py:238-253,272-307,388-404) CODE:
COPY_ALWAYS(:391-393): copy and permissions on every start.COPY_ONCE(:394-402): on the first start, copy, permissions andmknod /configured. On any later start of the same containerImmutableConfigis raised with exit code 0: nothing is copied, permissions are not re-applied and/run_commandkeeps its first value.kolla_startcontinues normally.- Unset or any other value:
InvalidConfig, exit 1 (:403-404).
Copy, per config_files entry (ConfigFile.copy, :131-158):
- The source is a glob. A non-optional entry that matches nothing raises
MissingRequiredSource(exit 1). An optional one is skipped silently (:133-139). - A
destending in/meansdest/<basename of source>(:145-146). - Unless
mergeis set, the destination is deleted first, a whole tree for a directory, then parent directories are created (:147-149). No Kolla-Ansibleconfig.jsontemplate usesmerge(grep ofroles/*/templates/*.json.j2). - Directory sources are copied recursively. Every directory and file gets the entry's
ownerandperm(so directories get the file mode), or the source's mode and owner withpreserve_properties(:85-99,115-129). - An
OSErrorduring the copy is logged and re-raised: exit 2 (:150-158,430-432). - Finally
commandis written to/run_command, mode 0644 (:319-329).
Permissions, per permissions entry (handle_permissions, :342-385):
pathis a glob. A path that matches nothing is skipped without a warning (:378).ownerisuser[:group], the group defaulting to the user (:332-339). An unknown user or group raisesKeyError: exit 2 (:349-351,430-432).chownalways,chmodonly ifpermis given. A failing chown or chmod is only logged (:359-376).- With
recurse, the same is applied to every directory and file below, one unconditionalos.chownper entry (:380-385). Several manifests do this on data volumes (§6 item 10).
A failure here (missing required source, bad JSON, unknown user) aborts kolla_start through errexit. The default
restart policy is unless-stopped (group_vars/all.yml:134) CODE. NOT AVAILABLE Whether the container then
restarts in a loop until the input is fixed.
2.4 kolla_copy_cacerts and kolla_httpd_setup¶
kolla_copy_cacertsdeletes everykolla-customca-*file from the system trust store, copies each file of/var/lib/kolla/config_files/ca-certificates/back under that prefix, and runsupdate-ca-certificates(Debian/Ubuntu) orupdate-ca-trust(CentOS/RHEL) (kolladocker/base/copy_cacerts.sh:7-27) CODE. The update command runs only when that directory exists and is not empty (:10-11). NOT AVAILABLE Whether, once the last custom CA is removed, the generated trust bundle in the container layer keeps it until the container is recreated.kolla_httpd_setupacts only when the shell runs as root (whoami, kolladocker/base/httpd_setup.sh:7). It empties/var/run/apache2/(Debian/Ubuntu) or removes/var/run/httpd/*,/run/httpd/*and/tmp/httpd*, so a restarted httpd does not trip on stale run files. On CentOS it also createslocalhost.crtif missing (:10-26). In images that run as a service user (nova-api, barbican-api, octavia-api, manila-api) it does nothing.
2.5 The extend_start chain¶
Most service families layer two scripts CODE. The service base image installs its extend_start.sh as
kolla_extend_start, creates an empty /usr/local/bin/kolla_<service>_extend_start, and its last line sources that
file (e.g. kolla docker/cinder/cinder-base/Dockerfile.j2:73-79, docker/cinder/cinder-base/extend_start.sh:10).
The API image overwrites kolla_<service>_extend_start with the one-shot branches. On those images
kolla_extend_start prepares the log directory (neutron-base also selects the iptables backend,
§5), and the DB commands are in kolla_<service>_extend_start. Keystone,
keystone-fernet, keystone-ssh, horizon, mariadb, rabbitmq, swift-rsyncd, keepalived, chrony, iscsid, fluentd, ovn-base,
nova-libvirt and nova-ssh put everything in kolla_extend_start instead.
2.6 Signals and PID 1¶
- PID 1 is
dumb-init --single-child, andkolla_startexecs the service, so the service is dumb-init's direct child (kolladocker/base/Dockerfile.j2:434,docker/base/start.sh:21) CODE. NOT AVAILABLE (dumb-init semantics, not in these sources) Whether in this mode dumb-init forwardsdocker stop's SIGTERM only to that child. A comment in the mariadb image describes the other mode: without--single-child, "the TERM signal is sent to all subprocesses" (kolladocker/mariadb/mariadb/Dockerfile.j2:67-71). - MariaDB overrides the entrypoint to
dumb-init --without--single-child(kolladocker/mariadb/mariadb/Dockerfile.j2:65-76) CODE. Its comment gives the reason:mysqld_safeignores SIGTERM, and without--single-childTERM also reachesmysqldCODE (for the comment; NOT AVAILABLE: dumb-init and mysqld_safe semantics). - Some Kolla-Ansible commands are shell wrappers that do not
execthe service, so dumb-init's child is bash:neutron-l3-agent-wrapper.sh(roles/neutron/templates/neutron-l3-agent-wrapper.sh.j2:14-18),start-ovsandstart-ovsdb-server(roles/openvswitch/templates/start-ovs.j2:2,start-ovsdb-server.j2:11) andhaproxy_run.sh(roles/haproxy/templates/haproxy_run.sh.j2:7-9) CODE. NOT AVAILABLE Whether the service then gets any SIGTERM before the container stops.kolla_dockerstops containers with the Docker client'sstopand a 10 s timeout (library/kolla_docker.py:871-884,892-904, Repository architecture §6) CODE.
2.7 Healthcheck scripts¶
The base image installs healthcheck_curl (curl --fail, 10 s maximum), healthcheck_filemod,
healthcheck_listen, healthcheck_port and healthcheck_socket when docker_healthchecks is on (kolla
docker/base/Dockerfile.j2:437-444; default True, kolla kolla/common/config.py:253). No kolla Dockerfile has a
HEALTHCHECK instruction, and nothing in Kolla-Ansible ussuri-eol configures a container healthcheck (grep of
ansible/ for healthcheck hits only monasca and swift service settings) CODE. Ussuri containers therefore have no
Docker health status. The mariadb image's own healthcheck_mariadb exits 0 whether the node is synced or not (kolla
docker/mariadb/mariadb/healthcheck_mariadb:10-17).
3. kolla_set_configs --check: what it compares and its exit codes¶
kolla_docker's compare_container runs /usr/local/bin/kolla_set_configs --check inside the running container with
docker exec as root, and its exit code decides config drift (library/kolla_docker.py:244,326-332,543-578;
Repository architecture §4.3). --check loads and
validates config.json like a normal start, then calls ConfigFile.check for each config_files entry (kolla
docker/base/set_configs.py:407-426).
3.1 What is compared¶
For each entry whose source glob matches something (:213-235) CODE:
- File source (
_cmp_file,:160-191): destination missing on a non-optional entry (drift); byte-for-byte content; mode, as the last four octal digits ofst_modeagainst the entry'spermstring; owner user and group names. - Directory source (
_cmp_dir,:193-211): every file below, as above. For subdirectories therelpatharguments are reversed (:197-198), so the mode checked is that of the destination's parent against the fileperm. A directory source that contains a subdirectory therefore reports drift on every run. preserve_propertiesentries carry noperm(:60-65), so the mode test always fails (:175) and they report drift on every run. Example:prometheus_server'sextras/*entry whenever extras exist (roles/prometheus/templates/prometheus-server.json.j2:10-15).
3.2 What is never compared¶
config.json'scommandandpermissions:--checkiterates onlyconfig_files(:407-410). A manifest with"config_files": [], like memcached's, whose settings are all in its command, always returns 0 (roles/memcached/templates/memcached.json.j2:2-3).- Entries removed from
config.json, and optional entries whose source no longer exists (:219-220), even while their old destination is still in the container. - Extra files in a destination directory, and the mode and owner of the destination directories themselves (for
subdirectories
_cmp_dirchecks the mode of a directory above the destination instead, §3.1). A file destination's mode and owner are compared (§3.1).
3.3 Exit codes¶
| Exit code | Raised when | What kolla_docker does |
Day-2 meaning |
|---|---|---|---|
| 0 | Every listed entry matches. Also a manifest with empty config_files, and any difference confined to command, permissions, removed entries or optional entries without a source |
no drift (kolla_docker.py:566-567) |
"No drift" covers the listed files only. A config.json-only change written by genconfig makes neither deploy-containers nor a later run restart the container (§6 item 1) |
| 1 | ConfigFileBadState: a listed file differs in content, mode or owner, or a non-optional destination is missing. Also MissingRequiredSource (a non-optional source matches nothing, set_configs.py:217-218) and InvalidConfig (bad JSON, no command, an entry without owner/perm; :238-253,) |
drift: the handler restarts the container (kolla_docker.py:568-569) |
Usually real drift. For a missing source or an invalid config.json the restarted container then fails in kolla_set_configs at every start (errexit; whether it then restarts in a loop is NOT AVAILABLE, §2.3). preserve_properties entries and directory sources with subdirectories return 1 on every run |
| 2 | Any other exception (set_configs.py:430-432): an optional entry whose source exists but whose destination is not in the container yet (open() raises at :167); a config.json that cannot be opened (:291, e.g. run as a service user); a uid or gid with no passwd or group entry |
raises: the check task fails on that host (kolla_docker.py:575-578,) |
Real drift reported as an error, e.g. a newly rendered nova-compute release file (roles/). The run fails instead of restarting the container. Entries are checked in order and the first difference ends the check (set_configs.py:407-410,), so if an entry listed before the optional one differs, the result is 1 and the restart also copies the new file |
| 137 | the exec was killed because the container exited | drift (kolla_docker.py:570-574) |
the container is unstable; Kolla restarts it |
| none | docker exec fails with a client error (container stopped or restarting) |
drift (kolla_docker.py:552-558) |
a stopped container is restarted by the next run |
Read from main (kolla docker/base/set_configs.py:413-433) CODE: rc 0 for a match, for empty config_files
with a changed command (:407-410), for an optional entry without a source (:219-220), and for a flat directory
with an extra file in the destination (_cmp_dir walks the source only, :193-211); rc 1 for a content, mode or
missing required destination difference (:162-178), a missing required source (:217-218), a
preserve_properties entry (:175), a directory with a subdirectory (:197-198), a missing command (:241-242)
and bad JSON (:294-296); rc 2 for a new optional file (:167) and a missing config.json (:291).
3.4 Running it by hand needs root¶
Kolla-Ansible writes the files in /etc/kolla/<service>/ with mode 0660 into directories with mode 0770, owned by
config_owner_user root (group_vars/all.yml:20-21; e.g. roles/nova/tasks/config.yml:2-9,
roles/keystone/tasks/config.yml:45-50), and mounts them read-only (e.g. roles/nova-cell/defaults/main.yml:284).
In an image with a service USER (e.g. USER nova, kolla docker/nova/nova-compute/Dockerfile.j2:196) a plain
docker exec <c> kolla_set_configs --check cannot open them and exits 2. kolla_docker execs as root
(library/kolla_docker.py:545-549). By hand, use docker exec -u root as the swift reconfigure does
(roles/swift/tasks/reconfigure.yml:47), or sudo kolla_set_configs --check inside the container
(§2.1). The bifrost reconfigure omits -u root (roles/bifrost/tasks/reconfigure.yml:17), but its
check cannot work anyway: it execs into bifrost-deploy, while the container is bifrost_deploy
(roles/bifrost/tasks/start.yml:8), which runs /sbin/init and mounts no config.json (§2.1). No
kolla-ansible command runs that file.
3.5 What a restart applies¶
- A
COPY_ALWAYSrestart (stop and start of the same container,library/kolla_docker.py:892-904) re-copies the listed entries and rewrites/run_command. Changed or added files, mode and owner changes and a changed command apply CODE. Stale files inside a listed directory destination go too, because the destination is deleted first. - Removals do not apply. The destinations of entries dropped from
config.json, and of optional sources that are gone, are never deleted (kolladocker/base/set_configs.py:135-148,310-315). They stay in the container's writable layer until the container is recreated; a destination on a volume survives recreates as well, e.g. nova-compute's SASLauth.conf(roles/nova-cell/templates/nova-compute.json.j2:58-64), left behind whenlibvirt_enable_saslis turned off, is under/var/lib/nova, by default thenova_computevolume (roles/nova-cell/defaults/main.yml:293,group_vars/all.yml:967).--checkdoes not flag them CODE. NOT AVAILABLE Whether Keystone still reads a removed policy file (roles/keystone/templates/keystone.json.j2:30-36) after the restart. - CA certificates are purged and re-added on every start (§2.4), from
/etc/kolla/<svc>/ca-certificates/. A CA deleted fromkolla_certificates_dir/ca/, or left there afterkolla_copy_ca_into_containersis turned off, stays in that directory, because thecopytask never deletes files (roles/service-cert-copy/tasks/main.yml:2-12; the copy action only walks the source tree, ansible 2.9.27lib/ansible/plugins/action/copy.py:485-582) CODE, so it is re-added at every start until it is deleted there by hand. NOT AVAILABLE Whether, once the last custom CA is removed there, the generated trust bundle keeps it (§2.4). COPY_ONCE:/configuredlives in the container layer, so only a recreate re-applies config.kolla_dockeralways recreates underCOPY_ONCE(library/kolla_docker.py:793-801).
4. One-shot containers: what the environment variables run¶
Kolla-Ansible starts one-shot containers with kolla_docker start_container, detach: False,
restart_policy: no, a label such as BOOTSTRAP or UPGRADE, and a variable that selects a branch of the image's
start script. The variables are sent with an empty value (library/kolla_docker.py:758-760) and every branch tests
only whether they are set (${!VAR[@]}). The one-shot runs the whole of kolla_start first: kolla_set_configs
with the config directory mounted into it, kolla_copy_cacerts, then the branch, which ends in exit 0 before the
service command (§2.2) CODE. That directory is the service's own, except for Nova: its
one-shots mount a dedicated nova-api-bootstrap or nova-cell-bootstrap directory whose command is "false"
(roles/nova/defaults/main.yml:116-117, roles/nova-cell/defaults/main.yml:303-304).
| Image | KOLLA_BOOTSTRAP |
KOLLA_UPGRADE / other one-shot variables |
Set by Kolla-Ansible (task, action) | Day-2 note |
|---|---|---|---|---|
| keystone | keystone-manage db_sync, as user keystone (kolla docker/) |
KOLLA_UPGRADE: db_sync --expand, then --migrate (:24-31). KOLLA_FINISH_UPGRADE: db_sync --contract (:36-39) |
bootstrap_keystone, deploy/reconfigure, run_once (roles/). Handlers init_upgrade_database and finish_upgrade_database, upgrade only (roles/) |
Schema sync on every deploy/reconfigure. EXTRA_KEYSTONE_MANAGE_ARGS (:21) is never set by Kolla-Ansible |
| glance-api | glance-manage db_sync, then db_load_metadefs (kolla docker/) |
KOLLA_UPGRADE with GLANCE_DB_EXPAND, GLANCE_DB_MIGRATE or GLANCE_DB_CONTRACT: glance-manage db expand, migrate or contract (:13-27) |
bootstrap_glance, deploy/reconfigure and legacy upgrade (roles/, legacy_upgrade.yml:6). Rolling containers only with glance_enable_rolling_upgrade (default no, group_vars/; rolling_upgrade.yml:29-101) |
glance-manage db_load_metadefs runs on every deploy/reconfigure; whether, without --merge, it only adds namespaces not yet in the DB is NOT AVAILABLE |
| placement-api | placement-manage db sync, then db online_data_migrations (kolla docker/) |
KOLLA_UPGRADE: db sync only (:11-15), never used. KOLLA_OSM: db online_data_migrations (:17-21) |
bootstrap_placement, deploy/reconfigure and upgrade (roles/, deploy.yml:11, reconfigure.yml:2, upgrade.yml:11). KOLLA_OSM after the restart, upgrade only (upgrade.yml:16-34) |
Online data migrations on every deploy/reconfigure, and twice on upgrade |
| cinder-api | cinder-manage db sync (kolla docker/) |
No KOLLA_UPGRADE. KOLLA_OSM: db online_data_migrations, with --max_count only if MAX_NUMBER is set (:11-18) |
bootstrap_cinder, deploy/reconfigure and upgrade (roles/, upgrade.yml:7). KOLLA_OSM without MAX_NUMBER, so unbounded, upgrade only (upgrade.yml:16-34) |
A tag change applied by deploy/reconfigure syncs the schema without the online migrations |
| heat-api | heat-manage db_sync, then, only if heat_user_domain is absent, creates that domain, user heat_domain_admin (password HEAT_DOMAIN_ADMIN_PASSWORD) and its admin role (kolla docker/) |
none; upgrade re-runs the bootstrap | bootstrap_heat with admin OS_* credentials, deploy/reconfigure and upgrade (roles/, upgrade.yml:6) |
Needs a reachable Keystone. A changed heat_domain_admin_password never reaches Keystone (§6 item 7) |
| horizon | manage.py migrate --noinput, after the settings symlinks (kolla docker/) |
none; FORCE_GENERATE is a start-time switch (§5.2) |
bootstrap_horizon only when horizon_backend_database (= enable_murano, group_vars/; roles/, upgrade.yml:10-11) |
Usually never runs |
| barbican-api | barbican-db-manage upgrade (kolla docker/) |
none | bootstrap_barbican, deploy/reconfigure and upgrade (roles/, upgrade.yml:6) |
Schema upgrade on every deploy/reconfigure |
| octavia-api | octavia-db-manage upgrade head (kolla docker/) |
none | bootstrap_octavia, deploy/reconfigure and upgrade (roles/, upgrade.yml:6) |
Schema upgrade on every deploy/reconfigure |
| manila-api | manila-manage db sync (kolla docker/) |
none | bootstrap_manila, deploy/reconfigure and upgrade (roles/, upgrade.yml:6) |
Schema sync on every deploy/reconfigure |
| nova-api | nova-manage api_db sync, db sync, db online_data_migrations (kolla docker/). Unreachable: Kolla-Ansible never sets it for Nova |
KOLLA_UPGRADE: api_db sync, db sync (:16-20). KOLLA_OSM: db online_data_migrations (:22-25) |
nova_api_bootstrap with KOLLA_UPGRADE, run_once, deploy/reconfigure and upgrade (roles/, nova.yml:45-61), again when map_cell0 reports a change (roles/). KOLLA_OSM, upgrade only (nova.yml:230-247) |
db sync targets cell0: the bootstrap nova.conf has [database] = cell0 (roles/). The bootstrap command is "false" (nova-api-bootstrap.json.j2:2), so success relies on the exit 0 |
| nova-conductor | nova-manage db sync --local_cell, db online_data_migrations (kolla docker/). Unreachable |
KOLLA_UPGRADE: db sync --local_cell (:9-12). KOLLA_OSM: db online_data_migrations (:14-17) |
nova_cell_bootstrap with KOLLA_UPGRADE on the first conductor, deploy/reconfigure and upgrade (roles/, nova.yml:81-96). KOLLA_OSM, upgrade only (nova.yml:253-272) |
The same image runs nova_super_conductor (roles/) |
| neutron-server | neutron-db-manage with neutron.conf and ml2_conf.ini, upgrade head for neutron, neutron-dynamic-routing, neutron-fwaas and neutron-vpnaas, whether or not they are enabled (kolla docker/) |
NEUTRON_SFC_BOOTSTRAP: networking-sfc upgrade head (:17-20). KOLLA_UPGRADE with NEUTRON_DB_EXPAND or NEUTRON_DB_CONTRACT: upgrade --expand or --contract for each NEUTRON_ROLLING_UPGRADE_SERVICES entry, without --config-file (:24-40) |
bootstrap_neutron on deploy, or on any action when neutron_enable_rolling_upgrade is off (default on) (roles/, roles/). bootstrap_neutron_sfc whenever enable_neutron_sfc (:24-46). Expand and contract containers in rolling_upgrade.yml:13-33, |
upgrade never migrates neutron-dynamic-routing (§6 item 8) |
| mariadb | mysql_install_db, a temporary mysqld_safe --wsrep-new-cluster --skip-networking --wsrep-on=OFF, kolla_security_reset (root password), grants to root@localhost and root@'%', shutdown (kolla docker/) |
KOLLA_UPGRADE: removes /var/, runs mysql_upgrade over TCP against the running local server (:44-54). BOOTSTRAP_ARGS: appended to mysqld_safe on any start (:56-58) |
bootstrap_mariadb when a new cluster is bootstrapped (roles/), then a handler starts mariadb with BOOTSTRAP_ARGS=--wsrep-new-cluster (handlers/). upgrade_mariadb on every host on upgrade (tasks/). --wsrep-recover and --wsrep-new-cluster in mariadb_recovery (recover_cluster.yml:41,) |
The image forms no cluster itself and has no Galera recovery logic (§5.4) |
| rabbitmq | writes RABBITMQ_CLUSTER_COOKIE to /var/, mode 400; nothing else: no rabbitmqctl, no join, no users (kolla docker/) |
none | <project_name>_bootstrap, only when the volume was just created on that host (roles/) |
A normal start never rewrites the cookie (§6 item 9) |
No one-shot branch exists in: keystone-fernet, keystone-ssh, cinder-volume, cinder-scheduler, cinder-backup, heat-api-cfn, heat-engine, the barbican, octavia and manila worker images, all swift images, nova-scheduler, nova-compute, nova-compute-ironic, nova-libvirt, nova-ssh, the Nova console proxies, every neutron agent, openvswitch, ovn, mariadb-clustercheck, memcached, haproxy, keepalived, fluentd, cron, kolla-toolbox, chrony, iscsid and tgtd CODE. The only DB step in the OVS and OVN images is at start (§5).
Note on ironic (only this branch was read): ironic-api's KOLLA_BOOTSTRAP runs ironic-dbsync upgrade and
online_data_migrations, KOLLA_UPGRADE only upgrade, KOLLA_OSM only online_data_migrations (kolla
docker/ironic/ironic-api/extend_start.sh:5-19). bootstrap_ironic sends KOLLA_UPGRADE unless
ironic_enable_rolling_upgrade (default yes) is turned off (roles/ironic/tasks/bootstrap_service.yml:2-25,
roles/ironic/defaults/main.yml:206).
4.1 One-shots that bypass kolla_start¶
A few one-shots replace the container command with bash -c 'sudo -E kolla_set_configs && ...' CODE. The config
is copied, but kolla_copy_cacerts and kolla_extend_start do not run, and the config.json command is written to
/run_command but never executed. Custom CA certificates are therefore not installed in these containers.
| Container | Image | What runs after kolla_set_configs |
Kolla-Ansible task |
|---|---|---|---|
bootstrap_keystone_fernet |
keystone-fernet | keystone-manage fernet_setup |
roles/ |
nova_api_map_cell0 |
nova-api | nova-manage cell_v2 map_cell0 |
roles/ |
nova_list_cells, cell create and update |
nova-conductor | nova-manage cell_v2 list_cells, create_cell, update_cell |
roles/, create_cells.yml:12, |
mariabackup |
mariadb | /usr/ (§5) |
roles/ |
The keystone-fernet image ships its own kolla_keystone_bootstrap, a fernet_setup wrapper, which Kolla-Ansible does
not use. Its changed detection is inverted: it reports changed when "Key repository is already initialized"
appears (kolla docker/keystone/keystone-fernet/keystone_bootstrap.sh:35-41). In this pairing that is dead code.
discover_hosts is a docker exec into the running nova_conductor, not a one-shot
(roles/nova-cell/tasks/discover_computes.yml:14-18).
5. Per-image start behaviour¶
"Runs as" is the image USER; root when the image and its parents set none. Every row starts with the common path of
§2. "Log dir" means: create /var/log/kolla/<service> if missing and set
mode 755.
| Image | Runs as | What its start script does on every start | Day-2 note |
|---|---|---|---|
| base, openstack-base | root | Nothing: empty kolla_extend_start (kolla docker/) |
No USER in base, openstack-base or nova-base |
| keystone | root | Log dir and keystone.log with owners fixed, kolla_httpd_setup, ARGS=-DFOREGROUND (kolla docker/). The command keystone-startup.sh waits up to 36 × 5 s for fernet key 0, then execs httpd (roles/) |
Stale httpd run files are removed, so a restart is safe |
| keystone-fernet | root | Runs /usr/ if present, then chowns the key directory (kolla docker/). Kolla-Ansible installs that script; it waits up to 10 × 60 s for key 0, then exits 1 (roles/) |
Without key 0 on the node the start waits up to 10 × 60 s and the script exits 1 before the cron command is exec'd (§2.2), so no rotation cron runs there meanwhile CODE; whether the container then restarts is NOT AVAILABLE |
| keystone-ssh | root | Generates any missing SSH host key (rsa, dsa, ecdsa, ed25519); creates /var/ (kolla docker/) |
/etc/ssh is on no volume (roles/): new host keys on every recreate (§6 item 18) |
| glance-api | glance | Log dir (kolla docker/); no httpd step. kolla_set_configs recursively chowns /var/lib/glance and /var/ (roles/) |
With the file backend /var/lib/glance is the image store: one chown per file on every start (§6 item 10) |
| placement-api | root | Log dir and placement-api.log; chown -R only if the top-level owner differs (kolla docker/); kolla_httpd_setup (placement-api/) |
– |
| cinder-api | root | Log dir (kolla docker/); kolla_httpd_setup (cinder-api/) |
– |
| cinder-volume | cinder | Log dir; sudo chown -R cinder:kolla of /var/lib/cinder and /etc/iscsi only if the top-level owner differs, chmod 2775 if needed (kolla docker/) |
Not only on a fresh volume: kolla_set_configs first chowns /var/lib/cinder recursively to cinder:cinder (roles/), so the cinder:kolla test always fails and chown -R walks the cinder volume a second time on every start |
| cinder-scheduler, cinder-backup | cinder | Log dir only (empty kolla_cinder_extend_start, kolla docker/) |
– |
| heat-api, heat-api-cfn, heat-engine | root (APIs), heat (engine) | Log dir (kolla docker/); the two API images run kolla_httpd_setup (heat-api/, heat-api-cfn/) |
– |
| horizon | root | Settings symlinks, plugin files from ENABLE_*, conditional static-asset regeneration, log dir, kolla_httpd_setup (kolla docker/; §5.2) |
Assets are regenerated after a recreate or a settings change (§5.2); how long that start takes is NOT AVAILABLE |
| barbican, octavia and manila images | barbican, octavia, manila (API images) | Log dir (barbican also chowns it, kolla docker/). The API images call kolla_httpd_setup, a no-op as a service user (barbican-api/, octavia-api/, manila-api/) |
Worker images do the log-dir step only |
| swift-rsyncd | swift | sudo find /srv/ (not recursive) and mkdir -p /var/ (kolla docker/) |
Only rsyncd fixes the ownership of the disk mount points |
| swift account, container, object, object-expirer, proxy-server | swift | Nothing of their own | Config and rings are copied only at container start, and the swift role notifies no handler (fact sheet D) |
| nova-base | – | Log dir, then sources kolla_nova_extend_start (kolla docker/) |
Parent of every nova image except nova-libvirt |
| nova-api | nova | nova-base step; kolla_httpd_setup (kolla docker/), a no-op as nova (Dockerfile.j2:71) |
No DB action on a normal start |
| nova-conductor, nova-scheduler | nova | nova-base step only | Also nova_super_conductor. The scheduler SIGHUP comes from Kolla-Ansible (nova.yml:140-156) |
| nova-compute | nova | kolla_set_configs recursively chowns /var/ and /var/lib/nova (roles/); nova-base step; mkdir -p /var/ (kolla docker/) |
/var/lib/nova is the instance datadir: one chown per file on every start (§6 item 10) |
| nova-compute-ironic | nova | nova-base step; permissions only on /var/ (roles/) |
– |
| nova-libvirt | root | /dev/kvm set to 660 root:qemu, xenfs mounted if loaded, log file created (kolla docker/); exec libvirtd --listen |
Passive towards running guests (§5.1) |
| nova-ssh | root | Replaces the nova-base script: generates missing SSH host keys, creates and chowns /var/ (kolla docker/); exec sshd -D |
New host keys on every recreate (§6 item 18) |
| nova-novncproxy, nova-serialproxy, nova-spicehtml5proxy | nova | nova-base step only | – |
| neutron-base | – | Log dir; iptables backend: update-alternatives --set to the -legacy binaries when KOLLA_LEGACY_IPTABLES is "true", otherwise --auto (kolla docker/) |
Only the OVS, linuxbridge and L3 agents get KOLLA_LEGACY_IPTABLES (roles/). Changing neutron_legacy_iptables recreates them; whether rules in the old backend are migrated is NOT AVAILABLE |
| neutron-server | neutron | neutron-base step; no branch taken; exec neutron-server |
– |
| neutron-openvswitch-agent | neutron | neutron-base step; nothing to OVS bridges or flows | NOT AVAILABLE Whether and how the agent resyncs flows after a restart: agent behaviour, not in these sources |
| neutron-dhcp-agent | neutron | neutron-base step; no dnsmasq or namespace handling | NOT AVAILABLE Whether dnsmasq children die with the container and whether qdhcp- namespaces persist on the shared /run/netns |
| neutron-l3-agent | neutron | neutron-base step; the command is Kolla-Ansible's wrapper (§5.3) | Namespace cleanup on every start with enable_neutron_agent_ha (Risk register R6) |
| neutron-metadata-agent (also the OVN metadata agent) | neutron | neutron-base step; recursive chown of /var/, the socket volume shared with the L3 and DHCP agents (roles/) |
Ussuri runs the OVN metadata agent from this image (roles/) |
| neutron-sriov-agent, neutron-linuxbridge-agent | neutron | neutron-base step | – |
| openvswitch-base | root | Log dir, then kolla_openvswitch_extend_start (kolla docker/) |
– |
| openvswitch-db-server | root | mkdir -p /run/; ovsdb-tool create if conf.db is absent (kolla docker/). start-ovsdb-server converts the schema when needed, then runs ovsdb-server without exec (roles/) |
conf.db is on the openvswitch_db volume: bridges and ports survive restart and recreate |
| openvswitch-vswitchd | root | modprobe openvswitch (kolla docker/). start-ovs runs ovs-vswitchd without exec and without flow save or restore (roles/) |
The kernel module stays loaded; whether flows are lost is NOT AVAILABLE (§6 item 13) |
| ovn-base | root | Replaces the OVS script: creates /run/ovn and the log dir (kolla docker/) |
/run/ovn is on no volume |
| ovn-controller | root | ovn-base step; exec ovn-controller (roles/) |
Chassis settings are set by Kolla-Ansible with ovs-vsctl (roles/), not by the image |
| ovn-northd | root | ovn-base step; exec ovn-northd |
Stateless |
| ovn-nb-db-server, ovn-sb-db-server | root | ovn-base step. Kolla-Ansible calls /usr/ (or run_sb_ovsdb) directly, not the image's start-nb-db-server wrapper (roles/, ovn-sb-db.json.j2:2) |
The wrapper's comment says ovn-ctl creates the DB file when absent and updates it when the schema changes (kolla docker/); whether the direct call does so is NOT AVAILABLE |
| mariadb | mysql | kolla_set_configs recursively chowns /var/lib/mysql and /var/ (roles/); log dir; exec mysqld_safe plus BOOTSTRAP_ARGS if set (kolla docker/) |
No Galera recovery in the image (§5.4) |
| mariadb (backup) | mysql | §4.1. backup.sh: mariabackup --backup --stream=xbstream, gzipped into /backup, full or incremental from BACKUP_TYPE (kolla docker/) |
No retention or rotation in the image |
| mariadb-clustercheck | root | No start script. xinetd runs /usr/ as mysql per connection (roles/, xinetd-clustercheck.j2:9-12) |
Stateless. The clustercheck script is not in the kolla source |
| rabbitmq | rabbitmq | Recursive chown of /var/ and /var/ (roles/); log dir (kolla docker/); cookie untouched |
Clustering is classic_config peer discovery (roles/), not the image |
| memcached | memcached | Nothing: no start script, empty config_files, all settings in the command (roles/) |
No volume; whether a restart empties the cache is NOT AVAILABLE (§6 item 14) |
| haproxy | root | No start script. kolla_set_configs replaces haproxy.cfg and the whole services.d/ (roles/); haproxy_run.sh starts haproxy -W -db (haproxy_run.sh.j2:7-9) |
The image's reload helper kolla_ensure_haproxy_latest_config (kolla docker/) is never called: config applies by restart only (Risk register R8) |
| keepalived | root | Removes a stale /run/ (kolla docker/); exec keepalived -nld |
VIP health is check_alive.sh, the haproxy stats socket only (§6 item 15) |
| fluentd | td-agent or fluentd | Sets owner and mode 2775 on /var/log/kolla, the kolla_logs volume every container shares, and chowns /var/, through sudo (kolla docker/); recursive chowns of its log dirs and /var/ (roles/) |
NOT AVAILABLE Whether read positions under /var/ are lost on recreate but kept on a restart |
| cron | root | No start script; copies logrotate.conf, exec crond -s -n or cron -f |
A restart only delays rotation |
| kolla-toolbox | ansible | No start script. When RabbitMQ is enabled, copies the Erlang cookie from passwords.yml (roles/); command sleep infinity |
Gets the current cookie on every start, unlike the brokers (§6 item 9) |
| chrony | root | Removes /var/; log dir owned chrony:chrony (kolla docker/) |
docker restart is safe |
| iscsid | root | Writes /etc/ with a new IQN only if the file is missing (kolla docker/) |
/etc/iscsi is the iscsi_info volume: the IQN is stable (§6 item 19) |
| tgtd | root | No start script, empty config_files; exec tgtd (roles/) |
NOT AVAILABLE Whether the target table survives a restart, or exported targets drop until re-created |
5.1 nova-libvirt: the start path is passive¶
The image is built from base, not nova-base (kolla docker/nova/nova-libvirt/Dockerfile.j2:1), and runs as root
CODE. On every start kolla_set_configs deletes and re-copies only the files listed in
roles/nova-cell/templates/nova-libvirt.json.j2:3-70 (libvirtd.conf, qemu.conf, /etc/libvirt/secrets, Ceph, SASL
and TLS files); the manifest has no permissions block. extend_start.sh then changes /dev/kvm, which is the host's
/dev, mounts xenfs only if lsmod shows it, and creates the log file (kolla
docker/nova/nova-libvirt/extend_start.sh:6-24). Nothing touches cgroups, running QEMU processes, /var/run/libvirt,
/var/lib/libvirt or /etc/libvirt/qemu, and no virtlogd or virtlockd is started. qemu.conf.j2:1-7 and
libvirtd.conf.j2:1-23 set no cgroup option. Whether guests survive a restart is therefore decided by the stop path,
where libvirt placed QEMU, and libvirtd's reconnect on start (Nova deep dive
§5,
Q1). The SASL DB /etc/libvirt/passwd.db is on no volume; only
/etc/libvirt/qemu is (roles/nova-cell/defaults/main.yml:249). It survives a restart and is lost on every recreate,
and the Create libvirt SASL user handler re-creates it (roles/nova-cell/handlers/main.yml:91,111-122).
5.2 horizon: static assets¶
On every start the script copies or removes each plugin's enabled/*.py file according to its ENABLE_* variable;
any change sets FORCE_GENERATE=yes (kolla docker/horizon/extend_start.sh:51-65,339-366) CODE. It runs
manage.py collectstatic --noinput --clear and compress --force only when /var/lib/kolla/.settings.md5sum.txt is
missing, the md5 of local_settings, custom_local_settings and local_settings.d differs from it, or
FORCE_GENERATE is yes; then it stores the new hash (:322-337,368-372). Kolla-Ansible sets FORCE_GENERATE=yes
only with horizon_dev_mode (roles/horizon/defaults/main.yml:36). /var/lib/kolla is not a volume (:90-98), so
the hash file lives in the container layer; only the start script writes it (HASH_PATH, kolla
docker/horizon/extend_start.sh:6,371). A recreate (new image, changed parameters) or a settings change therefore
makes the next start regenerate the assets; a plain restart with unchanged settings does not CODE. NOT AVAILABLE
How long such a start takes.
5.3 neutron-l3-agent: the wrapper¶
The command is Kolla-Ansible's /usr/local/bin/neutron-l3-agent-wrapper.sh
(roles/neutron/templates/neutron-l3-agent.json.j2:2-9) CODE. It sets errexit. With enable_neutron_agent_ha
(default no) it first runs neutron-netns-cleanup --force --agent-type l3 (the wrapper's comment: "Remove all l3
related netns"); it then runs neutron-l3-agent without exec (neutron-l3-agent-wrapper.sh.j2:3-18). The cleanup
runs on every container start: handler restart, recreate, Docker restart policy, reboot. A cleanup failure aborts the
start. NOT AVAILABLE What the command deletes: it is neutron code, which is not in these sources
(F12).
Because the wrapper does not exec the agent, bash stays dumb-init's only child (§2.6) CODE.
NOT AVAILABLE Whether docker stop's SIGTERM then reaches only bash, so that the agent gets no graceful shutdown, and
whether its keepalived, haproxy and radvd children die with the container.
5.4 MariaDB: what the image does not do¶
The image has no Galera recovery logic: no grastate.dat or safe_to_bootstrap handling, no seqno comparison, no
new-cluster decision CODE (kolla docker/mariadb/mariadb/extend_start.sh has none). All of that is in Kolla-Ansible
(roles/mariadb/tasks/recover_cluster.yml, lookup_cluster.yml). A normal start is mysqld_safe with the rendered
galera.cnf, whose gcomm:// lists every MariaDB host, or is empty on a single node
(roles/mariadb/templates/galera.cnf.j2:29). BOOTSTRAP_ARGS is read from the container environment on every start
(extend_start.sh:56-58), and the containers started with --wsrep-new-cluster have restart_policy: no
(roles/mariadb/handlers/main.yml:2-20, recover_cluster.yml:115-127). The mariadb bootstrap, upgrade and
--wsrep-recover one-shots also run the recursive /var/lib/mysql chown of §5, since
they use the same manifest.
6. Day-2 consequences¶
config.json-only changes written bygenconfignever cause a restart. A normal deploy or reconfigure applies them, because the changedconfig.jsontemplate task notifies the restart handler (e.g.roles/memcached/tasks/config.yml:13-26). After a separategenconfig,--checkignorescommandandpermissions, sodeploy-containerssees no drift, and later runs do not restart for them either because the template task is then unchanged. Memcached is the extreme case. The change applies at the next restart for another reason CODE (Predict and inspect a run, Execution flow §4, Write config first, apply in controlled batches §2).- Some containers restart on every deploy/reconfigure. A
preserve_propertiesentry, such as prometheusextras, or a directory source with subdirectories makes--checkexit 1 on every run (§3.1, §3.3) CODE (Tags §3). - A new optional file fails the run.
--checkexits 2 when an optional file is rendered for the first time (e.g. nova-computerelease) and no entry listed before it differs, and the check-containers task fails on that host instead of restarting CODE (Pre-execution checklist, Predict and inspect a run). - A restart does not remove a dropped file. Destinations of entries removed from
config.jsonstay in the container until it is recreated, and on a volume even after that (§3.5);--checkdoes not report them. CA certificate files are purged and re-added on every start, but only from/etc/kolla/<svc>/ca-certificates/, where a CA deleted fromkolla_certificates_dir/ca/stays (thecopytask never deletes, §3.5) and is re-added; whether the generated bundle keeps the last custom CA once it is removed there by hand is not known (§2.4) CODE (bundle and service effect NOT AVAILABLE) (Repository architecture §7). - Nova's online data migrations never run outside
upgrade. Deploy and reconfigure run the Nova bootstrap containers withKOLLA_UPGRADE(api_db sync+db sync,db sync --local_cell); the images'KOLLA_BOOTSTRAPbranches are unreachable (§4) CODE (Nova deep dive §4, Findings F15). - Placement's online data migrations run on every deploy/reconfigure, inside
bootstrap_placement, and twice on upgrade. A tag change applied withdeploytherefore runs them; cinder's bootstrap does not (§4) CODE (Update container images). - A changed
heat_domain_admin_passwordnever reaches Keystone. The bootstrap only creates the user whenheat_user_domainis absent, and a domain left without its user by a partial run is never repaired, whileheat.confgets the new value (roles/heat/templates/heat.conf.j2:12-13) CODE. NOT AVAILABLE Whether stack-domain operations then fail authentication (Known bugs and limitations). - Neutron upgrade gaps. The default rolling
upgradenever migrates neutron-dynamic-routing, which only thedeploybootstrap migrates. Ifhas_offline_migrationsreturns non-zero for any subproject, or itsdocker execfails (ignore_errors), everyneutron_serveris stopped until the final flush: a Neutron API outage (roles/neutron/tasks/rolling_upgrade.yml:43-93) CODE (Known bugs and limitations). - The RabbitMQ cookie is fixed at bootstrap. The image writes
.erlang.cookieonly in the bootstrap container on a new volume. A changedrabbitmq_cluster_cookierecreates the brokers (env compare) but their cookie file keeps the old value, whilekolla_toolboxgets the new one CODE (consequences NOT AVAILABLE) (fact sheet B §2). - Recursive chown on data volumes at every start.
kolla_set_configsmakes onechownper file of the glance image store, of/var/lib/novaon computes, of the MariaDB datadir, of the RabbitMQ mnesia directory and of thecindervolume (twice for cinder-volume, §5), on everyCOPY_ALWAYSstart CODE. NOT AVAILABLE Whether, withenable_shared_var_lib_nova_mnt, the walk also enters the shares still mounted under/var/lib/nova/mnt, and how start time grows with the number of files, especially on NFS-backed trees (fact sheet C, Nova deep dive §5). - nova-libvirt's start path is passive; VM survival is decided on the stop path (§5.1) CODE (for the start path; NOT AVAILABLE for survival) (Nova deep dive §5, Q1).
- The L3 agent wrapper does not
execthe agent. NOT AVAILABLE Whether SIGTERM then reaches only bash, so that the agent is killed without a graceful shutdown. Withenable_neutron_agent_haevery start also runsneutron-netns-cleanup --force --agent-type l3before the agent starts CODE; what that command deletes is NOT AVAILABLE (Risk register R6, Component dependencies §4). - An
openvswitch_vswitchdrestart replaces only the userspace daemon. The kernel module stays loaded andconf.dbkeeps bridges and ports CODE. NOT AVAILABLE Whether the OpenFlow tables are lost and must be reprogrammed by the OVS agent orovn-controller(Risk register R7, Q3). - memcached has no data volume and no persistence option. The container mounts no data volume
(
roles/memcached/defaults/main.yml:37-40) and its command has no persistence option (roles/memcached/templates/memcached.json.j2:2) CODE. NOT AVAILABLE (memcached semantics) Whether every restart therefore empties the cache, with token-cache misses and lost Horizon sessions where they are kept in memcached (Risk register R4). - The VIP follows the HAProxy stats socket only. keepalived's
check_alive.shasks the socket on the sharedhaproxy_socketvolume (kolladocker/keepalived/check_alive.sh:6); withinterval 2,fall 2,rise 10(roles/haproxy/templates/keepalived.conf.j2:1-6) CODE. NOT AVAILABLE (keepalived semantics) Whether an HAProxy restart puts the node in FAULT, and for how long (Risk register R8). - MariaDB has no automatic Galera recovery (§5.4). NOT AVAILABLE
Whether, after all DB containers stopped (power loss, Docker restart on every DB host), they come back as plain
mysqld_safewith the cluster non-primary untilmariadb_recovery. A container left withBOOTSTRAP_ARGS=--wsrep-new-clusterby an interrupted run passes that option tomysqld_safeagain on any manualdocker start(§5.4) CODE; whether that bootstraps a new cluster (split-brain risk) is NOT AVAILABLE (fact sheet B §1, Risk register R18). - No Docker HEALTHCHECK is wired in Ussuri (§2.7).
docker psshows no health status; service health must be checked from outside CODE (Pre-execution checklist item 5, health gates). - SSH host keys of
nova_sshandkeystone_sshchange on every recreate, because/etc/sshis on no volume. The clients setStrictHostKeyChecking noand keep no known-hosts file (UserKnownHostsFile /dev/null,roles/nova-cell/templates/ssh_config.j2:2-3,roles/keystone/templates/ssh_config.j2:2-3) CODE; whether the SSH client then accepts the new keys without failing is NOT AVAILABLE (OpenSSH semantics) (Nova deep dive §6). - The iSCSI initiator name is stable per
iscsi_infovolume across restart and recreate CODE. NOT AVAILABLE Whether removing the volume produces a new IQN at the next start (the start script writes one when the file is missing, §5), and whether that breaks backend ACLs keyed on the old one (Component dependencies §5).
7. What is not available from the sources¶
- dumb-init signal forwarding. Whether
--single-childforwards SIGTERM to the direct child only, and what happens to grandchildren (dnsmasq, keepalived and haproxy under the agents, services behind non-execwrappers). - Whether the runtime kills the container's cgroup when its init exits, and how that applies under
pid_mode: host(nova_libvirt). - QEMU survival across a
nova_libvirtrestart or recreate (Q1): placement inmachine.slicethrough the host D-Bus and systemd-machined, reconnect from the runtime state, the old QEMU binary kept after a recreate (Nova deep dive §5). - Whether OVS flows are lost on an
openvswitch_vswitchdrestart and, if so, how long reprogramming takes (Q3). - Horizon regeneration time after a recreate or a settings change (§5.2).
- Cost of the recursive chown on large trees: glance store, NFS instance directory, MariaDB datadir, RabbitMQ mnesia.
- Upstream semantics of
keystone-manage bootstrap: whether it resets the admin password tokeystone_admin_password, and whether the wrapper, which counts nine "already exists"/"skipping" lines (kolladocker/keystone/keystone/keystone_bootstrap.sh:43-56), then still reports unchanged. ovn-ctlschema creation and upgrade with Kolla-Ansible's direct call, and its hard-coded/usr/share/ovn/scripts/path on distributions that shipovn-ctlelsewhere./var/runas a symlink to/runin the images, which would put libvirt's runtime state on the host/runbind mount. The Dockerfiles do not show it.- Whether a failing
kolla_set_configscauses a restart loop (§2.3) and the CA bundle after the last custom CA is removed (§2.4). - Service-side effects of the one-shot findings: heat stack-domain authentication after a changed
heat_domain_admin_password(§6 item 7); whetherrabbitmq-serverignoresRABBITMQ_CLUSTER_COOKIEand uses only the cookie file (§6 item 9); Galera after a full stop, or a manual start left with--wsrep-new-cluster(§6 item 16).
Related¶
- Open questions (Q14)
- Repository architecture §4.3 (how Kolla-Ansible
uses
--check) - Predict and inspect a run (running
--checkby hand) - Nova deep dive §5 (nova-libvirt restarts)
- Glossary and Components (glossary, service index)
To remember
Lumo: if you keep only 5 things from this page, keep these.
kolla_set_configs --checkcompares only theconfig_filesentries ofconfig.json(content, mode, owner). CODE- The check never compares
command,permissionsor removed entries. - A
COPY_ALWAYSrestart applies changed or added files, mode and owner changes and a changed command; removals do not apply. CODE - A newly rendered optional file whose destination is not yet in the container makes the check exit 2: the check task fails instead of restarting the container.
- Run by hand,
kolla_set_configs --checkneedsdocker exec -u root.
Check yourself
Lumo: 3 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.