Skip to content

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 2023.1-eol, commit de82941) and matched against Kolla-Ansible 2023.1-eol (4891a21). The images were read, not built or run.

Note

Key answers

  • What every container start does: kolla_start runs kolla_set_configs, kolla_copy_cacerts and the image's kolla_extend_start, then execs the service command (§2.2). In 2023.1 it runs with errexit, pipefail and nounset.
  • kolla_set_configs --check compares only the config_files entries of config.json (content, mode, owner) CODE (§3.1). It never compares command, permissions or removed entries (§3.2). Exit codes 0, 1, 2 and 137, and what kolla_docker does with each: §3.3. A newly rendered optional file is now drift (exit 1), not an error. Run by hand, it needs docker exec -u root (§3.4).
  • What a COPY_ALWAYS restart applies: changed or added files, mode and owner changes and a changed command CODE. New in 2023.1, kolla_set_configs records the state of each destination at the container's first start and, at every later start, deletes or restores those destinations before copying: most removals now apply too, with exceptions (§3.5).
  • One-shot containers: what KOLLA_BOOTSTRAP, KOLLA_UPGRADE, KOLLA_OSM and 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 runs neutron-netns-cleanup --force --agent-type l3 on 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:11). Kolla-Ansible paths have no prefix and are relative to its ansible/ directory (roles/nova/tasks/bootstrap_service.yml:11, module_utils/kolla_docker_worker.py:155-190, nova.yml:45-61), except tools/.... Ansible source paths carry an ansible-core 2.14.18 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 the Dockerfile.j2 and start scripts of the images in §5: Keystone, Glance, Placement, Cinder, Heat, Horizon, Barbican, Octavia, Manila, Swift, Nova, Neutron, Open vSwitch, OVN, MariaDB (server and clustercheck), RabbitMQ, memcached, HAProxy, keepalived (with check_alive.sh), fluentd, cron, kolla-toolbox, iscsid and tgtd. The chrony image and role of Ussuri do not exist in 2023.1 (no docker/chrony in kolla, no roles/chrony in Kolla-Ansible). Of the other images only the ironic-api bootstrap branch (§4) and the bifrost-deploy ENTRYPOINT/CMD (§2.1) were read, and every Dockerfile was searched for HEALTHCHECK (§2.7) and for ENTRYPOINT/CMD overrides. The rest were not.
  • Matched to Kolla-Ansible. Each one-shot variable was traced to the task that sets it (§4) CODE. In 2023.1 kolla_docker drives long-running containers through systemd units (module_utils/kolla_systemd_worker.py:20-74); this page cites that path where it changes what a start or stop does.
  • kolla_set_configs --check was read, not run: exit codes 0, 1 and 2 of §3.3 are read from kolla docker/base/set_configs.py; 137 and the exec client error are kolla_docker outcomes (module_utils/kolla_docker_worker.py:155-190).
  • 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", "--"] when use_dumb_init is on (:352-354; default True, kolla kolla/common/config.py:151), and CMD ["kolla_start"] (:382). The MariaDB server image drops --single-child (§2.6). bifrost-deploy resets both (ENTRYPOINT [], CMD [ "/sbin/init" ], kolla docker/bifrost/bifrost-deploy/Dockerfile.j2:29-30), so bifrost_deploy never runs kolla_start or kolla_set_configs.
  • The base scripts are installed as kolla_start (start.sh), kolla_set_configs (set_configs.py), kolla_copy_cacerts (copy_cacerts.sh) and kolla_httpd_setup (httpd_setup.sh); sudoers becomes /etc/sudoers, mode 0440 (:346-350,366-368).
  • /usr/local/bin/kolla_extend_start is created empty by touch (:365). An image gets start logic only by overwriting it.
  • /var/log/kolla gets group kolla and mode 2775 (:369-371).
  • Service users are added to group kolla (kolla docker/macros.j2:50). The base sudoers lets members of that group run two commands as root without a password, keeping their environment: kolla_set_configs and kolla_copy_cacerts (kolla docker/base/sudoers:7,18,21). New in 2023.1, it sets a secure_path that puts /var/lib/kolla/venv/bin first (:9). It also includes /etc/sudoers.d (:23), where many images add entries of their own, e.g. cinder-volume's chown -R and chmod (kolla docker/cinder/cinder-volume/cinder_sudoers:2-5) and mariadb's kolla_security_reset (kolla docker/mariadb/mariadb-server/mariadb_sudoers:1). The kolla_set_configs entry restricts no arguments, so sudo kolla_set_configs --check is allowed.
  • Kolla-Ansible passes KOLLA_CONFIG_STRATEGY to every container through docker_common_options (group_vars/all.yml:43,143-149; default COPY_ALWAYS).

2.2 kolla_start step by step

flowchart TB
  D["dumb-init --single-child (PID 1)"] --> KS["kolla_start (errexit, pipefail, nounset, xtrace)"]
  KS --> SC["sudo -E kolla_set_configs"]
  SC --> ST{"KOLLA_CONFIG_STRATEGY"}
  ST -- "COPY_ALWAYS" --> CA["restore defaults + copy + permissions + /run_command (every start)"]
  ST -- "COPY_ONCE, first start" --> CO["restore defaults + 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"]
  1. set -o errexit; set -o pipefail; set -o nounset; set -o xtrace (kolla docker/base/start.sh:3-6). Any failing command ends the container, including commands in the sourced kolla_extend_start; pipefail and nounset are new in 2023.1, so a failing command inside a pipeline, or a reference to an unset variable, also ends it. The 2023.1 start scripts give defaults to the variables Kolla-Ansible does not always set (e.g. kolla docker/keystone/keystone/extend_start.sh:21, docker/neutron/neutron-base/extend_start.sh:19-22, docker/horizon/extend_start.sh:5) CODE. xtrace is on in that script, and in the kolla_<service>_extend_start it sources (§2.5), where one-shots put a secret on a command line: heat's --password ${HEAT_DOMAIN_ADMIN_PASSWORD} (kolla docker/heat/heat-api/extend_start.sh:12) and the MariaDB upgrade mysql_upgrade ... --password="${DB_ROOT_PASSWORD}" (kolla docker/mariadb/mariadb-server/extend_start.sh:55). The MariaDB bootstrap now turns xtrace off around its root-password commands (set +o xtrace ... set -o xtrace, :24-28) CODE. NOT AVAILABLE (bash semantics, not in these sources) Whether the trace on stderr shows the remaining commands with their variables expanded, and so writes the secret there.

    kolla_docker returns the container's stderr in the task result when it waits for the container (module_utils/kolla_docker_worker.py:412-434, library/kolla_docker.py:408-412). Ansible's default callback prints a failed result, stderr included, and an ok or changed one only with -v (ansible-core 2.14.18 lib/ansible/plugins/callback/default.py:50-68,73-106, lib/ansible/plugins/callback/__init__.py:200-202); a task with no_log reaches the callback with its result replaced by a censored message (ansible-core 2.14.18 lib/ansible/executor/task_queue_manager.py:436, lib/ansible/executor/task_result.py:131-139). bootstrap_heat sets no no_log (roles/heat/tasks/bootstrap_service.yml:2-30); upgrade_mariadb does (roles/mariadb/tasks/post-upgrade.yml:2-24) CODE.

  2. sudo -E kolla_set_configs (:11) runs as root whatever the image USER, copies the configuration (§2.3) and writes config.json's command to /run_command.

  3. CMD=$(cat /run_command) and ARGS="" (:12-13).
  4. sudo kolla_copy_cacerts (:16, §2.4), on every start whatever the strategy.
  5. Unless KOLLA_SKIP_EXTEND_START is set, . kolla_extend_start (:18-21). The script is sourced: it runs in the same shell, as the image USER, with errexit on. It can set ARGS or CMD, or exit. An exit 0 ends 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" (kolla docker/keystone/keystone/extend_start.sh:41-42), so any value, even empty or false, skips the script and every one-shot branch with it CODE. Kolla-Ansible never sets this variable (grep of ansible/).
  6. echo "Running command: ...", then exec ${CMD} ${ARGS}, unquoted (:23-24). 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 /var/lib/kolla/config_files/config.json (the Ussuri KOLLA_CONFIG and KOLLA_CONFIG_FILE overrides are gone in 2023.1), 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:245-260,279-299,535-553) CODE:

  • COPY_ALWAYS (:538-541): defaults handling, copy and permissions on every start.
  • COPY_ONCE (:542-551): on the first start, defaults handling, copy, permissions and mknod /configured. On any later start of the same container ImmutableConfig is raised with exit code 0: nothing is copied, permissions are not re-applied and /run_command keeps its first value. kolla_start continues normally.
  • Unset or any other value: InvalidConfig, exit 1 (:552-553).

Defaults handling (handle_defaults, new in 2023.1, :389-532), before the copy:

  • The state lives in /etc/kolla/defaults/state, a JSON file in the container layer (:32-33,429-434,437-449).
  • Restore (remove_or_restore_configs, :452-474): for every destination recorded in the state, the file or tree is deleted if it did not exist when it was recorded, or copied back from its saved original under /etc/kolla/defaults/ if it did.
  • Record (backup_configs, :477-513): every config_files entry not yet in the state is added, but only if its source path exists as written (os.path.exists, so a glob source such as extras/* is never recorded, and an optional entry is recorded only once its source exists). A destination that exists at that moment, from the image or from a volume, is first saved under /etc/kolla/defaults/<dest>; one that does not exist is recorded as absent. A destination already in the state is never re-recorded.

Copy, per config_files entry (ConfigFile.copy, :136-163):

  • The source is a glob. A non-optional entry that matches nothing raises MissingRequiredSource (exit 1). An optional one is skipped silently (:138-144).
  • A dest ending in / means dest/<basename of source> (:150-151).
  • Unless merge is set, the destination is deleted first, a whole tree for a directory, then parent directories are created (:152-154). In 2023.1 two Kolla-Ansible manifests use merge: Keystone's OIDC metadata and certificate directories (roles/keystone/templates/keystone.json.j2:56-70) and nova-libvirt's /etc/libvirt/secrets (roles/nova-cell/templates/nova-libvirt.json.j2:46-52) (grep of roles/*/templates/*.json.j2).
  • Directory sources are copied recursively. Every directory and file gets the entry's owner and perm (so directories get the file mode, plus the execute bit wherever the read bit is set, new in 2023.1), or the source's mode and owner with preserve_properties (:78-103,119-134,364-371).
  • An OSError during the copy is logged and re-raised: exit 2 (:155-163,579-581).
  • Finally command is written to /run_command, mode 0644 (:311-321).

Permissions, per permissions entry (handle_permissions, :334-386):

  • path is a glob. A path that matches nothing is skipped without a warning (:379).
  • owner is user[:group], the group defaulting to the user (:324-331). An unknown user or group raises KeyError: exit 2 (:341-343,579-581).
  • chown always, chmod only if perm is given. A failing chown or chmod is only logged (:351-377).
  • With recurse, the same is applied to every directory and file below, one unconditional os.chown per entry (:381-386). 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 container then exits non-zero. In 2023.1 the default unless-stopped policy (group_vars/all.yml:117) is not given to Docker (module_utils/kolla_docker_worker.py:286-321 sets no restart policy) but written into the container's systemd unit as Restart=always, with RestartSec 11 s, StartLimitIntervalSec 120 and StartLimitBurst 10 from docker_client_timeout 120 and docker_restart_policy_retry 10 (module_utils/kolla_systemd_worker.py:20-74, group_vars/all.yml:105,120,150-153) CODE. NOT AVAILABLE (systemd semantics) Whether the unit then restarts the container in a loop until the input is fixed, or stops after the start limit is reached.

2.4 kolla_copy_cacerts and kolla_httpd_setup

  • kolla_copy_cacerts deletes every kolla-customca-* file from the system trust store, copies each file of /var/lib/kolla/config_files/ca-certificates/ back under that prefix, and runs update-ca-certificates (Debian family, /etc/debian_version) or update-ca-trust (Red Hat family, /etc/redhat-release) (kolla docker/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_setup acts on httpd only when the shell runs as root (whoami, kolla docker/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/Rocky it also writes a /server-status handler limited to local requests (99-server-status.conf) and creates localhost.crt if missing (:10-40). Whatever the user, it then sets LANG=C.UTF-8 and sources the distribution's locale file if present (:43-51). In images that run as a service user (barbican-api, manila-api) the httpd part does nothing. nova-api and octavia-api, which ran as a service user in Ussuri, have no USER in 2023.1 and run it as root (§5).

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:41,50-51, 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-server, mariadb-clustercheck, rabbitmq, swift-rsyncd, keepalived, iscsid, fluentd, cron, kolla-toolbox, ovn-base, nova-libvirt and nova-ssh put everything in kolla_extend_start instead (mariadb-clustercheck, cron and kolla-toolbox have a start script only since 2023.1).

2.6 Signals and PID 1

  • PID 1 is dumb-init --single-child, and kolla_start execs the service, so the service is dumb-init's direct child (kolla docker/base/Dockerfile.j2:353, docker/base/start.sh:24) CODE. NOT AVAILABLE (dumb-init semantics, not in these sources) Whether in this mode dumb-init forwards docker 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" (kolla docker/mariadb/mariadb-server/Dockerfile.j2:64-68).
  • MariaDB overrides the entrypoint to dumb-init -- without --single-child (kolla docker/mariadb/mariadb-server/Dockerfile.j2:64-71) CODE. Its comment gives the reason: mysqld_safe ignores SIGTERM, and without --single-child TERM also reaches mysqld CODE (for the comment; NOT AVAILABLE: dumb-init and mysqld_safe semantics).
  • Some Kolla-Ansible commands are shell wrappers that do not exec the service, so dumb-init's child is bash: neutron-l3-agent-wrapper.sh (roles/neutron/templates/neutron-l3-agent-wrapper.sh.j2:13-16), start-ovs and start-ovsdb-server (roles/openvswitch/templates/start-ovs.j2:2, start-ovsdb-server.j2:11) and haproxy_run.sh (roles/loadbalancer/templates/haproxy/haproxy_run.sh.j2:7-9) CODE. NOT AVAILABLE Whether the service then gets any SIGTERM before the container stops. A long-running container is stopped through its systemd unit, whose ExecStop is docker stop <name> -t <graceful_timeout>, docker_graceful_timeout 60 s by default; kolla_docker calls the Docker client's stop directly only for a container without a unit file, such as a one-shot (module_utils/kolla_systemd_worker.py:31-36, module_utils/kolla_docker_worker.py:436-452,460-480, group_vars/all.yml:140,152, 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:356-363, docker/base/healthcheck_curl:2,8-12; default True, kolla kolla/common/config.py:237). No kolla Dockerfile has a HEALTHCHECK instruction (grep of docker/) CODE.

Unlike Ussuri, Kolla-Ansible 2023.1 wires Docker healthchecks itself: enable_container_healthchecks defaults to yes with interval 30 s, timeout 30 s, 3 retries and a 5 s start period (group_vars/all.yml:171-177); service definitions carry a healthcheck dict, e.g. memcached's healthcheck_listen memcached <port> (roles/memcached/defaults/main.yml:10,32-43) and MariaDB's /usr/bin/clustercheck (roles/mariadb/defaults/main.yml:100-107). kolla_docker passes it at container creation and compares it, so a changed healthcheck recreates the container (module_utils/kolla_docker_worker.py:349-351, module_utils/kolla_container_worker.py:89,479-525) CODE. No Kolla-Ansible task or handler reads the resulting health status (grep of roles/*/tasks, roles/*/handlers, library/, module_utils/ for healthy) CODE. NOT AVAILABLE (Docker semantics) What Docker does with an unhealthy container beyond reporting it. The mariadb image's own healthcheck_mariadb now exits 1 when the node is not synced (kolla docker/mariadb/mariadb-server/healthcheck_mariadb:10-19); Kolla-Ansible does not use it.


3. kolla_set_configs --check: what it compares and its exit codes

kolla_docker's compare_container reports drift when the container is missing or differs, when the systemd unit file would change, or when /usr/local/bin/kolla_set_configs --check, run inside the running container with docker exec as root, says so (module_utils/kolla_container_worker.py:20,59-66, module_utils/kolla_docker_worker.py:155-190; 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:556-575). It does no defaults handling.

3.1 What is compared

For each entry whose source glob matches something (:220-242) CODE:

  • File source (_cmp_file, :165-198): destination missing (drift), for optional entries too: the Ussuri exemption of optional entries is gone (:166-169); byte-for-byte content; mode, as the last four octal digits of st_mode against the entry's perm string; owner user and group names.
  • Directory source (_cmp_dir, :200-218): every file below, as above. For subdirectories the relpath arguments are reversed (:204-205), so the mode checked is that of the destination's parent against the file perm. A directory source that contains a subdirectory therefore reports drift on every run.
  • preserve_properties entries carry no perm (:64-72), so the mode test always fails (:182) and they report drift on every run. Example: prometheus_server's extras/* entry whenever extras exist (roles/prometheus/templates/prometheus-server.json.j2:10-15).

3.2 What is never compared

  • config.json's command and permissions: --check iterates only config_files (:556-559). 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 (:226-227), 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_dir checks 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 (module_utils/kolla_docker_worker.py:178-179) "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 destination is missing, optional entries included (e.g. a newly rendered nova-compute release file, roles/nova-cell/templates/nova-compute.json.j2:52-57). Also MissingRequiredSource (a non-optional source matches nothing, set_configs.py:224-225) and InvalidConfig (bad JSON, no command, an entry without owner/perm; :245-260,286-290) drift: the handler restarts the container (module_utils/kolla_docker_worker.py:180-181) Usually real drift; the restart copies the new file. For a missing source or an invalid config.json the restarted container then fails in kolla_set_configs at every start (errexit; what systemd then does 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:579-581): a config.json that cannot be opened (:285, outside the try, e.g. run as a service user); a uid or gid with no passwd or group entry (:188,193) raises: the check task fails on that host (module_utils/kolla_docker_worker.py:187-190, library/kolla_docker.py:410-412) An environment problem, not drift. Entries are checked in order and the first difference ends the check (set_configs.py:556-559,576-578)
137 the exec was killed because the container exited drift (module_utils/kolla_docker_worker.py:182-186) the container is unstable; Kolla restarts it
none docker exec fails with a client error (container stopped or restarting) drift (module_utils/kolla_docker_worker.py:164-170) a stopped container is restarted by the next run

Read from main (kolla docker/base/set_configs.py:562-582) CODE: rc 0 for a match, for empty config_files with a changed command (:556-559), for an optional entry without a source (:226-227), and for a flat directory with an extra file in the destination (_cmp_dir walks the source only, :200-218); rc 1 for a content, mode or missing destination difference, optional or not (:166-197), a missing required source (:224-225), a preserve_properties entry (:182), a directory with a subdirectory (:204-205), a missing command (:248-249) and bad JSON (:286-290); rc 2 for a missing or unreadable config.json (:285).

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:416). In an image with a service USER (e.g. USER nova, kolla docker/nova/nova-compute/Dockerfile.j2:116) a plain docker exec <c> kolla_set_configs --check cannot open them and exits 2. kolla_docker execs as root (module_utils/kolla_docker_worker.py:157-161). 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: the bifrost role includes <kolla_action>.yml (roles/bifrost/tasks/main.yml:2) and is reached only through deploy-bifrost (tools/kolla-ansible:480).

3.5 What a restart applies

  • A COPY_ALWAYS restart (systemd RestartUnit of the same container, or stop and start for a unit-less one-shot, module_utils/kolla_docker_worker.py:460-480) 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 (except for merge entries, §2.3).
  • Removals now apply in most cases (new in 2023.1). Before copying, every start deletes each recorded destination that did not exist at the container's first start, and restores each one that did (from the image or a volume) to that original (kolla docker/base/set_configs.py:452-474,516-532,538-541) CODE. So the destination of an entry dropped from config.json, or of an optional source that is gone, is removed (or reset to the original) at the next start, provided it was recorded. Exceptions CODE:

    • Glob sources are never recorded (:502), so their destinations still stay, e.g. prometheus extras/* (roles/prometheus/templates/prometheus-server.json.j2:10-15).
    • The state and the saved originals are in /etc/kolla/defaults, in the container layer (:32-33). A recreate starts a new state. A destination on a volume that already holds a file at the new container's first start is saved as the "original" and restored on later starts. Example: nova-compute's SASL auth.conf (roles/nova-cell/templates/nova-compute.json.j2:58-64) is under /var/lib/nova, the nova_compute volume when the libvirt container is used (roles/nova-cell/defaults/main.yml:379, group_vars/all.yml:731,1032). Turned off by libvirt_enable_sasl after a restart-only history, it is deleted at the next start; turned off after the container was recreated while SASL was on, the copy found on the volume at that recreate is restored instead.
    • Under COPY_ONCE nothing happens after the first start (§2.3).

    --check still does not flag dropped entries (§3.2), so only a restart for another reason applies the removal. NOT AVAILABLE Whether Keystone still reads a removed policy file (roles/keystone/templates/keystone.json.j2:31-37) when the restart has not happened.

  • CA certificates are purged and re-added on every start (§2.4), from /etc/kolla/<svc>/ca-certificates/. A CA deleted from kolla_certificates_dir/ca/, or left there after kolla_copy_ca_into_containers is turned off, stays in that directory, because the copy task never deletes files (roles/service-cert-copy/tasks/main.yml:2-12; the copy action only walks the source tree, ansible-core 2.14.18 lib/ansible/plugins/action/copy.py:485-599) 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: /configured lives in the container layer, so only a recreate re-applies config. kolla_docker always recreates under COPY_ONCE (module_utils/kolla_docker_worker.py:374-382).

4. One-shot containers: what the environment variables run

Kolla-Ansible starts one-shot containers with kolla_docker start_container, detach: False, restart_policy: oneshot, a label such as BOOTSTRAP or UPGRADE, and a variable that selects a branch of the image's start script. A oneshot container gets no systemd unit and is started with the Docker client directly; the module waits for it and returns its rc, stdout and stderr (module_utils/kolla_docker_worker.py:355-360,400-434). The variables are sent with an empty value (module_utils/kolla_docker_worker.py:330-332) 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 bootstrap and online-migration one-shots mount a dedicated nova-api-bootstrap or nova-cell-bootstrap directory whose command is "false" (roles/nova/defaults/main.yml:181-182, roles/nova-cell/defaults/main.yml:435-436, roles/nova/templates/nova-api-bootstrap.json.j2:2).

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/keystone/keystone/extend_start.sh:43-46) KOLLA_UPGRADE: db_sync --expand, then --migrate (:24-31). KOLLA_FINISH_UPGRADE: db_sync --contract (:36-39) bootstrap_keystone, deploy/reconfigure, run_once (roles/keystone/tasks/bootstrap_service.yml:33-50). Handlers init_upgrade_database and finish_upgrade_database, upgrade only (roles/keystone/handlers/main.yml:5-27,77-98) 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/glance/glance-api/extend_start.sh:5-9) 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/glance/tasks/bootstrap_service.yml:19-37, legacy_upgrade.yml:6). Rolling containers only with glance_enable_rolling_upgrade (default no, group_vars/all.yml:912; roles/glance/tasks/upgrade.yml:2-6, roles/glance/tasks/rolling_upgrade.yml:30-102) 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/placement/placement-api/extend_start.sh:5-9) KOLLA_UPGRADE: db sync only (:12-15), never used. KOLLA_OSM: db online_data_migrations (:18-21) bootstrap_placement, deploy/reconfigure and upgrade (roles/placement/tasks/bootstrap_service.yml:2-20, deploy.yml:11, reconfigure.yml:2, upgrade.yml:11). KOLLA_OSM after the restart, upgrade only (roles/placement/tasks/upgrade.yml:16-34) Online data migrations on every deploy/reconfigure, and twice on upgrade
cinder-api cinder-manage db sync (kolla docker/cinder/cinder-api/extend_start.sh:6-9) No KOLLA_UPGRADE. KOLLA_OSM: db online_data_migrations, unbounded: the Ussuri MAX_NUMBER/--max_count option is gone (:11-14) bootstrap_cinder, deploy/reconfigure and upgrade (roles/cinder/tasks/bootstrap_service.yml:2-20, upgrade.yml:7). KOLLA_OSM, upgrade only (roles/cinder/tasks/upgrade.yml:26-44) 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/heat/heat-api/extend_start.sh:5-17) none; upgrade re-runs the bootstrap bootstrap_heat with admin OS_* credentials, deploy/reconfigure and upgrade (roles/heat/tasks/bootstrap_service.yml:10-22, 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/horizon/extend_start.sh:12-30) none; FORCE_GENERATE is a start-time switch (§5.2) bootstrap_horizon only when horizon_backend_database (= enable_murano, group_vars/all.yml:1052; roles/horizon/tasks/deploy.yml:10-11, upgrade.yml:10-11) Usually never runs
barbican-api barbican-db-manage upgrade (kolla docker/barbican/barbican-api/extend_start.sh:5-8) none bootstrap_barbican, deploy/reconfigure and upgrade (roles/barbican/tasks/bootstrap_service.yml:2-20, upgrade.yml:6) Schema upgrade on every deploy/reconfigure
octavia-api octavia-db-manage upgrade head (kolla docker/octavia/octavia-api/extend_start.sh:5-8) none bootstrap_octavia, deploy/reconfigure and upgrade (roles/octavia/tasks/bootstrap_service.yml:2-20, upgrade.yml:6) Schema upgrade on every deploy/reconfigure
manila-api manila-manage db sync (kolla docker/manila/manila-api/extend_start.sh:6-9) none bootstrap_manila, deploy/reconfigure and upgrade (roles/manila/tasks/bootstrap_service.yml:2-20, upgrade.yml:6) Schema sync on every deploy/reconfigure
nova-api nova-manage api_db sync, db sync --local_cell, db online_data_migrations (kolla docker/nova/nova-api/extend_start.sh:9-14). Unreachable: Kolla-Ansible never sets it for Nova KOLLA_UPGRADE: api_db sync, db sync --local_cell (:16-20). KOLLA_OSM: db online_data_migrations (:22-25). New: KOLLA_UPGRADE_CHECK: nova-status upgrade check, exiting with its code (:27-30) nova_api_bootstrap with KOLLA_UPGRADE, run_once, deploy/reconfigure and upgrade (roles/nova/tasks/bootstrap_service.yml:2-21, nova.yml:45-61), again when map_cell0 reports a change (roles/nova/tasks/map_cell0.yml:66-67). KOLLA_OSM, upgrade only (nova.yml:230-247, roles/nova/tasks/online_data_migrations.yml:2-20). nova_upgrade_checks with KOLLA_UPGRADE_CHECK and the normal nova-api config, upgrade only; the run fails unless rc is 0 or 1 (roles/nova/tasks/upgrade.yml:10-40) db sync --local_cell targets cell0: the bootstrap nova.conf has [database] = cell0 (roles/nova/templates/nova.conf.j2:93-94, roles/nova/tasks/config_bootstrap.yml:22-33). 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/nova/nova-conductor/extend_start.sh:3-7). 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-cell/tasks/bootstrap_service.yml:2-21, nova.yml:81-96). KOLLA_OSM, upgrade only (nova.yml:253-272) The same image runs nova_super_conductor (roles/nova/defaults/main.yml:50-53,106)
neutron-server neutron-db-manage --subproject neutron upgrade head, then upgrade head for each NEUTRON_BOOTSTRAP_SERVICES entry (kolla docker/neutron/neutron-server/extend_start.sh:5-13); no --config-file KOLLA_UPGRADE with NEUTRON_DB_EXPAND or NEUTRON_DB_CONTRACT: upgrade --expand or --contract for neutron, then for each NEUTRON_ROLLING_UPGRADE_SERVICES entry (:17-34). The Ussuri NEUTRON_SFC_BOOTSTRAP branch is gone bootstrap_neutron on every deploy/reconfigure, and on upgrade only when neutron_enable_rolling_upgrade is off (default yes) (roles/neutron/tasks/bootstrap_service.yml:2-21, deploy.yml:20, bootstrap.yml:38, legacy_upgrade.yml:13, upgrade.yml:4-8, roles/neutron/defaults/main.yml:710). Both lists are the enabled neutron_subprojects: networking-sfc, neutron-dynamic-routing, neutron-vpnaas, vmware-nsx (roles/neutron/defaults/main.yml:656-664,705,711). Expand and contract containers in rolling_upgrade.yml:13-33,65-86 Only enabled subprojects are migrated, on deploy and on upgrade alike (§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; both steps' output is appended to mariadb-bootstrap.log (kolla docker/mariadb/mariadb-server/extend_start.sh:5-29,40-44) KOLLA_UPGRADE: removes /var/lib/mysql/.pki, runs mysql_upgrade over TCP against the running local server (:47-57). BOOTSTRAP_ARGS: appended to mysqld_safe on any start (:59-61) bootstrap_mariadb when a new cluster is bootstrapped (roles/mariadb/tasks/bootstrap_cluster.yml:2-23), then a handler starts mariadb with BOOTSTRAP_ARGS=--wsrep-new-cluster (roles/mariadb/handlers/main.yml:2-20). upgrade_mariadb on every MariaDB host, upgrade only, after the restarts (roles/mariadb/tasks/post-upgrade.yml:2-24, mariadb.yml:68-72); roles/mariadb/tasks/upgrade.yml now only imports deploy.yml. --wsrep-recover and --wsrep-new-cluster in mariadb_recovery (roles/mariadb/tasks/recover_cluster.yml:36,120) The image forms no cluster itself and has no Galera recovery logic (§5.4)
rabbitmq writes RABBITMQ_CLUSTER_COOKIE to /var/lib/rabbitmq/.erlang.cookie, mode 400; nothing else: no rabbitmqctl, no join, no users (kolla docker/rabbitmq/rabbitmq/extend_start.sh:7-18; the image moved from docker/rabbitmq/, and Kolla-Ansible uses rabbitmq, roles/rabbitmq/defaults/main.yml:52) none <project_name>_bootstrap, only when the volume was just created on that host (roles/rabbitmq/tasks/bootstrap.yml:10-26) 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, iscsid and tgtd (grep of their start scripts for ${!...[@]}) 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:286).

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/keystone/tasks/bootstrap_service.yml:52-75
nova_api_map_cell0 nova-api nova-manage cell_v2 map_cell0 roles/nova/tasks/map_cell0.yml:3-22
nova_list_cells, cell create and update nova-conductor nova-manage cell_v2 list_cells, create_cell, update_cell roles/nova-cell/tasks/get_cell_settings.yml:8, create_cells.yml:12,38
mariabackup mariadb-server, the image of the running mariadb container when known /usr/local/bin/kolla_mariadb_backup.sh (§5); the container is removed on exit roles/mariadb/tasks/backup.yml:2-35

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/base/Dockerfile.j2:365) 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/keystone/keystone/extend_start.sh:3-19,48-50). The command keystone-startup.sh waits up to 36 × 5 s for fernet key 0, then execs httpd (roles/keystone/templates/keystone-startup.sh.j2:9-24) Stale httpd run files are removed, so a restart is safe
keystone-fernet root Runs /usr/bin/fernet-node-sync.sh if present, then chowns the key directory (kolla docker/keystone/keystone-fernet/extend_start.sh:6-12). Kolla-Ansible installs that script; it waits up to 10 × 60 s for key 0, then exits 1 (roles/keystone/templates/fernet-node-sync.sh.j2:15-28) 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; what systemd then does is NOT AVAILABLE (§2.3)
keystone-ssh root Generates any missing SSH host key (rsa, dsa, ecdsa, ed25519); creates /var/lib/keystone/.ssh (kolla docker/keystone/keystone-ssh/extend_start.sh:3-16) /etc/ssh is on no volume (roles/keystone/defaults/main.yml:46-51): new host keys on every recreate (§6 item 18)
glance-api glance Log dir (kolla docker/glance/glance-base/extend_start.sh:3-8); no httpd step. kolla_set_configs recursively chowns /var/lib/glance and /var/log/kolla/glance (roles/glance/templates/glance-api.json.j2:53-64) 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/placement/placement-base/extend_start.sh:3-13); kolla_httpd_setup (placement-api/extend_start.sh:23) –
cinder-api root Log dir (kolla docker/cinder/cinder-base/extend_start.sh:3-8); kolla_httpd_setup (cinder-api/extend_start.sh:16) –
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/cinder/cinder-volume/extend_start.sh:3-14) Not only on a fresh volume: kolla_set_configs first chowns /var/lib/cinder recursively to cinder:cinder (roles/cinder/templates/cinder-volume.json.j2:38-43), 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/cinder/cinder-base/Dockerfile.j2:50) –
heat-api, heat-api-cfn, heat-engine root (APIs), heat (engine) Log dir (kolla docker/heat/heat-base/extend_start.sh:3-8); the two API images run kolla_httpd_setup (heat-api/extend_start.sh:19, heat-api-cfn/extend_start.sh:3) –
horizon root Settings symlinks, plugin files from ENABLE_*, conditional static-asset regeneration, log dir, secret-key-store owner, kolla_httpd_setup (kolla docker/horizon/extend_start.sh:12-23,32-309; §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, manila (all images); octavia workers; octavia-api root Log dir (barbican chowns it, kolla docker/barbican/barbican-base/extend_start.sh:4-13; octavia chowns it recursively when the owner differs, docker/octavia/octavia-base/extend_start.sh:5-15). The API images call kolla_httpd_setup (barbican-api/extend_start.sh:10, octavia-api/extend_start.sh:10, manila-api/extend_start.sh:11): a no-op for httpd as a service user (barbican-api/Dockerfile.j2:17, manila-api/Dockerfile.j2:24); octavia-api sets no USER in 2023.1 (octavia-api/Dockerfile.j2:1-29), so it runs the httpd cleanup as root Worker images do the log-dir step only
swift-rsyncd swift sudo find /srv/node/ -maxdepth 1 -type d -execdir chown swift:swift {} + (not recursive) and mkdir -p /var/lib/swift/lock (kolla docker/swift/swift-rsyncd/extend_start.sh:3-4) 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/nova/nova-base/extend_start.sh:3-10) Parent of every nova image except nova-libvirt
nova-api root nova-base step; kolla_httpd_setup (kolla docker/nova/nova-api/extend_start.sh:32), which now acts: the 2023.1 Dockerfile sets no USER (docker/nova/nova-api/Dockerfile.j2:1-18), where Ussuri had USER nova 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, roles/nova/tasks/refresh_scheduler_cell_cache.yml:4-10)
nova-compute nova kolla_set_configs recursively chowns /var/log/kolla/nova and /var/lib/nova (roles/nova-cell/templates/nova-compute.json.j2:78-89); nova-base step; mkdir -p /var/lib/nova/instances (kolla docker/nova/nova-compute/extend_start.sh:3-5) /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/log/kolla/nova (roles/nova-cell/templates/nova-compute-ironic.json.j2:23-29) –
nova-libvirt root xenfs mounted if loaded, log file created (kolla docker/nova/nova-libvirt/extend_start.sh:3-16); exec libvirtd --listen. The Ussuri /dev/kvm chown/chmod is gone from the image; Kolla-Ansible installs a host udev rule instead (§5.1) Passive towards running guests (§5.1)
nova-ssh root Replaces the nova-base script: generates missing SSH host keys, creates and chowns /var/lib/nova/.ssh (kolla docker/nova/nova-ssh/extend_start.sh:3-16); 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, skipped on CentOS and Rocky and when update-alternatives --display iptables fails: update-alternatives --set to the -legacy binaries when KOLLA_LEGACY_IPTABLES is "true", otherwise --auto (unset counts as false) (kolla docker/neutron/neutron-base/extend_start.sh:3-34) Only the OVS, linuxbridge and L3 agents get KOLLA_LEGACY_IPTABLES (roles/neutron/defaults/main.yml:31,55,83). 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/lib/neutron/kolla, the socket volume shared with the L3 and DHCP agents (roles/neutron/templates/neutron-metadata-agent.json.j2:29-33) 2023.1 runs the OVN metadata agent from this image (roles/neutron/defaults/main.yml:292)
neutron-sriov-agent, neutron-linuxbridge-agent neutron neutron-base step –
openvswitch-base root Log dir, then kolla_openvswitch_extend_start (kolla docker/openvswitch/openvswitch-base/extend_start.sh:3-10) –
openvswitch-db-server root mkdir -p /run/openvswitch; ovsdb-tool create if conf.db is absent (kolla docker/openvswitch/openvswitch-db-server/extend_start.sh:3-6). start-ovsdb-server converts the schema when needed, then runs ovsdb-server without exec (roles/openvswitch/templates/start-ovsdb-server.j2:5-11) conf.db is on the openvswitch_db volume: bridges and ports survive restart and recreate
openvswitch-vswitchd root modprobe openvswitch (kolla docker/openvswitch/openvswitch-vswitchd/extend_start.sh:3). start-ovs runs ovs-vswitchd without exec and without flow save or restore (roles/openvswitch/templates/start-ovs.j2:2) 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/ovn/ovn-base/extend_start.sh:3-11) /run/ovn is on no volume
ovn-controller root ovn-base step; exec ovn-controller (roles/ovn-controller/templates/ovn-controller.json.j2:2) Chassis settings and br-int are set by Kolla-Ansible through kolla_toolbox (openvswitch_bridge, openvswitch_db; roles/ovn-controller/tasks/setup-ovs.yml:2-40), not by the image. The Ussuri ovn role is split into ovn-controller and ovn-db
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/share/ovn/scripts/ovn-ctl run_nb_ovsdb (or run_sb_ovsdb) directly, not the image's start-nb-db-server wrapper (roles/ovn-db/templates/ovn-nb-db.json.j2:2, ovn-sb-db.json.j2:2, roles/ovn-db/defaults/main.yml:79-80,88-89) The wrapper's comment says ovn-ctl creates the DB file when absent and updates it when the schema changes (kolla docker/ovn/ovn-nb-db-server/start_nb_db_server.sh:9-12); whether the direct call does so is NOT AVAILABLE
mariadb mysql kolla_set_configs recursively chowns /var/log/kolla/mariadb and /var/lib/mysql (roles/mariadb/templates/mariadb.json.j2:12-23); log dir; exec mysqld_safe plus BOOTSTRAP_ARGS if set (kolla docker/mariadb/mariadb-server/extend_start.sh:31-37,59-61) 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/mariadb/mariadb-server/backup.sh:7-56) No retention or rotation in the image
mariadb-clustercheck root Log dir (kolla docker/mariadb/mariadb-clustercheck/extend_start.sh:3-11, new in 2023.1). The command is socat, listening on the clustercheck port and running clustercheck per connection (roles/mariadb/templates/mariadb-clustercheck.json.j2:2); the Ussuri xinetd setup is gone Stateless. The clustercheck script is not in the kolla source: it is downloaded from a Fedora package repository at build time (kolla docker/mariadb/mariadb-base/Dockerfile.j2:27-33)
rabbitmq rabbitmq Recursive chown of /var/lib/rabbitmq and /var/log/kolla/<project_name> (roles/rabbitmq/templates/rabbitmq.json.j2:53-64); log dir (kolla docker/rabbitmq/rabbitmq/extend_start.sh:20-26); cookie untouched Clustering is classic_config peer discovery (roles/rabbitmq/templates/rabbitmq.conf.j2:18-20), not the image
memcached memcached Nothing: no start script, empty config_files, all settings in the command (roles/memcached/templates/memcached.json.j2:2-3) 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/loadbalancer/templates/haproxy/haproxy.json.j2:11-21); haproxy_run.sh starts haproxy -W -db (roles/loadbalancer/templates/haproxy/haproxy_run.sh.j2:7-9) The image's reload helper kolla_ensure_haproxy_latest_config (kolla docker/haproxy/haproxy/ensure_latest_config.sh:5-14) is never called (grep of ansible/): config applies by restart only (Risk register R8)
keepalived root Removes a stale /run/keepalived.pid (kolla docker/keepalived/extend_start.sh:3-6); exec keepalived -nld VIP health is check_alive.sh, which now runs the scripts Kolla-Ansible puts in /checks (§6 item 15)
fluentd td-agent Sets owner and mode 2775 on /var/log/kolla, the kolla_logs volume every container shares, and chowns /var/lib/<binary>, through sudo (kolla docker/fluentd/extend_start.sh:9-28); recursive chowns of its log dirs and /var/lib/fluentd/data (roles/common/templates/fluentd.json.j2:16-34) NOT AVAILABLE Whether read positions under /var/run/<binary>/ are lost on recreate but kept on a restart
cron root New in 2023.1: moves the logrotate cron file to /etc/cron.<KOLLA_LOGROTATE_SCHEDULE>/ when the schedule is hourly, daily, weekly or monthly (kolla docker/cron/extend_start.sh:3-21; Kolla-Ansible sets cron_logrotate_schedule, default daily, roles/common/defaults/main.yml:30,132); copies logrotate.conf, exec crond -s -n or cron -f (roles/common/templates/cron.json.j2:1-7) A restart only delays rotation
kolla-toolbox ansible New in 2023.1: creates /var/log/kolla/ansible.log, owner ansible:kolla, mode 664 (kolla docker/kolla-toolbox/extend_start.sh:3-13). When RabbitMQ is enabled, copies the Erlang cookie from passwords.yml (roles/common/templates/kolla-toolbox.json.j2:4-9); command sleep infinity Gets the current cookie on every start, unlike the brokers (§6 item 9)
chrony – Gone in 2023.1: no docker/chrony image in kolla and no chrony role in Kolla-Ansible (ls of kolla docker/ and of roles/) –
iscsid root Writes /etc/iscsi/initiatorname.iscsi with a new IQN only if the file is missing (kolla docker/iscsid/extend_start.sh:3-7) /etc/iscsi is the iscsi_info volume (roles/iscsi/defaults/main.yml:48): the IQN is stable (§6 item 19)
tgtd root No start script, empty config_files; exec tgtd (roles/iscsi/templates/tgtd.json.j2:2-3) 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, TLS files, Ceph and SASL files), except /etc/libvirt/secrets, which is merged rather than deleted first (:46-52); before that, the defaults handling of §2.3 deletes or restores each recorded destination. The manifest has no permissions block. extend_start.sh then mounts xenfs only if lsmod shows it and creates the log file (kolla docker/nova/nova-libvirt/extend_start.sh:3-16). The 2023.1 image no longer touches /dev/kvm: Kolla-Ansible writes a host udev rule (KERNEL=="kvm", group qemu_user_gid, mode 0660) and, on Ubuntu, masks qemu-kvm.service (roles/nova-cell/tasks/config-host.yml:30-53, roles/nova-cell/templates/99-kolla-kvm.rules.j2:4). 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-27 set no cgroup option. The container is deployed only while enable_nova_libvirt_container is true (default: nova_compute_virt_type is kvm or qemu, group_vars/all.yml:731). 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:381). 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:96,131-141). NOT AVAILABLE Whether the image ships /etc/libvirt/secrets; if it does not, the defaults handling deletes the merged directory at every start before re-copying it, which makes merge moot.

5.2 horizon: static assets

On every start the script copies or removes each plugin's enabled/*.py file according to its ENABLE_* variable (unset counts as no); any change sets FORCE_GENERATE=yes (kolla docker/horizon/extend_start.sh:32-46,267-287) 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 (:248-265,289-293). Kolla-Ansible sets FORCE_GENERATE=yes only with horizon_dev_mode (roles/horizon/defaults/main.yml:30). /var/lib/kolla is not a volume (:122-129), so the hash file lives in the container layer; only the start script writes it (HASH_PATH, kolla docker/horizon/extend_start.sh:6,292). 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, group_vars/all.yml:721) 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-16). The cleanup runs on every container start: handler restart, recreate, systemd restart, 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-server/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 host of the MariaDB shard group, 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:59-61), and the containers started with --wsrep-new-cluster have restart_policy: oneshot, so they get no systemd unit (roles/mariadb/handlers/main.yml:2-20, roles/mariadb/tasks/recover_cluster.yml:113-129, module_utils/kolla_docker_worker.py:355-360,400-403). 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

  1. config.json-only changes written by genconfig never cause a restart. A normal deploy or reconfigure applies them, because the changed config.json template task notifies the restart handler (e.g. roles/memcached/tasks/config.yml:13-26). After a separate genconfig, --check ignores command and permissions, so deploy-containers sees 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).
  2. Some containers restart on every deploy/reconfigure. A preserve_properties entry, such as prometheus extras, or a directory source with subdirectories makes --check exit 1 on every run (§3.1, §3.3) CODE (Tags §3).
  3. A new optional file is drift, no longer a failure. In 2023.1 --check exits 1 when an optional file is rendered for the first time (e.g. nova-compute release), and the container is restarted with the new file; in Ussuri the same case exited 2 and failed the check-containers task (kolla docker/base/set_configs.py:166-169) CODE (Pre-execution checklist, Predict and inspect a run).
  4. A restart now removes most dropped files. Destinations of entries removed from config.json are deleted, or reset to the original found at the container's first start, at the next start; glob sources are not covered, and a file found on a volume when the container was created is restored rather than deleted (§3.5). --check does not report them, so the removal waits for a restart. CA certificate files are purged and re-added on every start, but only from /etc/kolla/<svc>/ca-certificates/, where a CA deleted from kolla_certificates_dir/ca/ stays (the copy task 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).
  5. Nova's online data migrations never run outside upgrade. Deploy and reconfigure run the Nova bootstrap containers with KOLLA_UPGRADE (api_db sync + db sync --local_cell, db sync --local_cell); the images' KOLLA_BOOTSTRAP branches are unreachable (§4) CODE. Upgrade also runs nova-status upgrade check first and stops on a result other than 0 or 1 (roles/nova/tasks/upgrade.yml:10-40) CODE (Nova deep dive §4, Findings F15).
  6. Placement's online data migrations run on every deploy/reconfigure, inside bootstrap_placement, and twice on upgrade. A tag change applied with deploy therefore runs them; cinder's bootstrap does not (§4) CODE (Update container images).
  7. A changed heat_domain_admin_password never reaches Keystone. The bootstrap only creates the user when heat_user_domain is absent, and a domain left without its user by a partial run is never repaired, while heat.conf gets the new value (roles/heat/templates/heat.conf.j2:11-12) CODE. NOT AVAILABLE Whether stack-domain operations then fail authentication (Known bugs and limitations).
  8. Neutron upgrade gaps. The Ussuri gap on neutron-dynamic-routing is closed: deploy and the rolling upgrade both migrate neutron plus every enabled subproject (§4) CODE. The contract step still has two traps: if has_offline_migrations returns non-zero for any enabled subproject, or its docker exec fails (ignore_errors), every neutron_server is stopped until the final flush, a Neutron API outage; and the check loops over the enabled subprojects only, never neutron itself, so with no subproject enabled no server is ever stopped before upgrade --contract (roles/neutron/tasks/rolling_upgrade.yml:38-89) CODE. NOT AVAILABLE Whether a neutron contract migration is then safe against running servers (Known bugs and limitations).
  9. The RabbitMQ cookie is fixed at bootstrap. The image writes .erlang.cookie only in the bootstrap container on a new volume. A changed rabbitmq_cluster_cookie recreates the brokers (env compare, roles/rabbitmq/defaults/main.yml:13-15, module_utils/kolla_container_worker.py:85) but their cookie file keeps the old value, while kolla_toolbox gets the new one CODE (consequences NOT AVAILABLE) (fact sheet B §2).
  10. Recursive chown on data volumes at every start. kolla_set_configs makes one chown per file of the glance image store, of /var/lib/nova on computes, of the MariaDB datadir, of the RabbitMQ mnesia directory and of the cinder volume (twice for cinder-volume, §5), on every COPY_ALWAYS start CODE. NOT AVAILABLE Whether, with enable_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).
  11. 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).
  12. The L3 agent wrapper does not exec the agent. NOT AVAILABLE Whether SIGTERM then reaches only bash, so that the agent is killed without a graceful shutdown. With enable_neutron_agent_ha every start also runs neutron-netns-cleanup --force --agent-type l3 before the agent starts CODE; what that command deletes is NOT AVAILABLE (Risk register R6, Component dependencies §4).
  13. An openvswitch_vswitchd restart replaces only the userspace daemon. The kernel module stays loaded and conf.db keeps bridges and ports CODE. NOT AVAILABLE Whether the OpenFlow tables are lost and must be reprogrammed by the OVS agent or ovn-controller (Risk register R7, Q3).
  14. memcached has no data volume and no persistence option. The container mounts no data volume (roles/memcached/defaults/main.yml:45-48) 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).
  15. The VIP follows the HAProxy stats socket, and the ProxySQL admin socket when ProxySQL is enabled. keepalived's check_alive.sh runs every script under /checks and fails if one fails, falling back to the HAProxy socket when there is none (kolla docker/keepalived/check_alive.sh:9-38). Kolla-Ansible puts there one script per enabled load-balancer service on the host, check_alive_haproxy.sh and check_alive_proxysql.sh, each a show info on the service's socket (roles/loadbalancer/tasks/config.yml:74-105, roles/loadbalancer/templates/keepalived/check_alive_haproxy.sh.j2:6, check_alive_proxysql.sh.j2:6, keepalived.json.j2:11-12); with interval 2, fall 2, rise 10 when keepalived_track_script_enabled (default True) (roles/loadbalancer/templates/keepalived/keepalived.conf.j2:1-8, roles/loadbalancer/defaults/main.yml:152) CODE. NOT AVAILABLE (keepalived semantics) Whether an HAProxy or ProxySQL restart puts the node in FAULT, and for how long (Risk register R8).
  16. 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_safe with the cluster non-primary until mariadb_recovery. A container left with BOOTSTRAP_ARGS=--wsrep-new-cluster by an interrupted run passes that option to mysqld_safe again on any manual docker start (§5.4) CODE; whether that bootstraps a new cluster (split-brain risk) is NOT AVAILABLE (fact sheet B §1, Risk register R18).
  17. Docker healthchecks are wired in 2023.1, but nothing waits on them (§2.7). With the default enable_container_healthchecks: yes, docker ps shows a health status for the services that define a test; no Kolla-Ansible task gates on it, so service health must still be checked from outside CODE (Pre-execution checklist item 5, health gates).
  18. SSH host keys of nova_ssh and keystone_ssh change on every recreate, because /etc/ssh is on no volume. The clients set StrictHostKeyChecking no and 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).
  19. The iSCSI initiator name is stable per iscsi_info volume 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-child forwards SIGTERM to the direct child only, and what happens to grandchildren (dnsmasq, keepalived and haproxy under the agents, services behind non-exec wrappers).
  • 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_libvirt restart or recreate (Q1): placement in machine.slice through 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_vswitchd restart 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 to keystone_admin_password. The 2023.1 wrapper, which Kolla-Ansible runs with docker exec keystone kolla_keystone_bootstrap (roles/keystone/tasks/register.yml:5), counts eight "already exists"/"skipping" patterns but reports unchanged only when the count is nine (kolla docker/keystone/keystone/keystone_bootstrap.sh:51-63; the admin-endpoint pattern was dropped); whether any output line matches twice, so that it can ever report unchanged, depends on keystone's output.
  • ovn-ctl schema creation and upgrade with Kolla-Ansible's direct call, and its hard-coded /usr/share/ovn/scripts/ path on distributions that ship ovn-ctl elsewhere.
  • /var/run as a symlink to /run in the images, which would put libvirt's runtime state on the host /run bind mount. The Dockerfiles do not show it.
  • Whether a failing kolla_set_configs causes a restart loop under the container's systemd unit (§2.3), what Docker does with an unhealthy container (§2.7), 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); whether rabbitmq-server ignores RABBITMQ_CLUSTER_COOKIE and uses only the cookie file (§6 item 9); a neutron contract migration against running servers (§6 item 8); Galera after a full stop, or a manual start left with --wsrep-new-cluster (§6 item 16).

To remember

Lumo: if you keep only 5 things from this page, keep these.

  • kolla_set_configs --check compares only the config_files entries of config.json (content, mode, owner). CODE
  • The check never compares command, permissions or removed entries.
  • A COPY_ALWAYS restart applies changed or added files, mode and owner changes and a changed command. CODE
  • A newly rendered optional file is now drift (exit 1), not an error.
  • Run by hand, kolla_set_configs --check needs docker 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.

1. What does every container start run before the service command?
Show the answer

Answer: kolla_set_configs, kolla_copy_cacerts and the image's kolla_extend_start. kolla_start runs these three steps, then execs the service command. Read the section.

2. What does kolla_set_configs --check compare?
Show the answer

Answer: Only the config_files entries of config.json (content, mode, owner). It never compares command, permissions or removed entries CODE. Read the section.

3. A file is removed from the configuration of a COPY_ALWAYS container. Does a restart remove it?
Show the answer

Answer: Most removals now apply, with exceptions. New in 2023.1, kolla_set_configs records the state of each destination at the first start and deletes or restores it at every later start. Read the section.