Common: fluentd, cron, kolla_toolbox¶
This page is the starting point for the common role: the containers fluentd, kolla_toolbox and cron, on the
compute, control, monitoring, network and storage nodes of the example inventory. In 2023.1 the role is no meta
dependency of any other role (no roles/*/meta directory): it runs only in its own play, "Apply role common", on the
groups cron, fluentd, kolla-logs and kolla-toolbox, with the play tag common (site.yml:86-97). -t common
therefore runs it, and a service tag such as -t nova does not CODE. The lists below say where the study covers how
to operate it, its impact, its dependencies and the evidence, what to check around a run and what stays open; the
service card follows them.
Where to look¶
Operate¶
- Scenario: Apply
commonchanges (fluentd, cron, kolla_toolbox) - Command: Apply
commonchanges (fluentd, cron, kolla_toolbox) §1.1:kolla-ansible -i multinode -t common reconfigure, optionally with--limit
Impact and risk¶
- What the tag executes (
common): Tags §3 and Tags §3.1, rowscommon; why the tag now reaches the included tasks: Tags §2.1 - Risks: R2; R25 does not apply to 2023.1 (the risk register keeps the entry and says why)
Dependencies¶
- Dependencies: Component dependencies §1, Component dependencies §2 (row "Fluentd"), Component dependencies §5
Evidence¶
- Fact sheet: – (see Repository architecture
§5.1, which also records that the
common_runguard is gone) - Image side: Kolla images §5 (rows
fluentd,cron,kolla-toolbox) - Also: Apply
commonchanges (fluentd, cron, kolla_toolbox); handlers: Tags §5
Before and after a run¶
- Pre-execution checklist, step 7 (scope):
-t commonruns the common role in its own play, and service tags no longer run it (site.yml:86-97,roles/common/tasks/main.yml:2). - R2, precautions: treat
enable_*changes as fleet-wide changes for thecommonplay; roll out with--limitbatches orANSIBLE_SERIAL(the play hasserial: kolla_serial,site.yml:93). - Apply
commonchanges (fluentd, cron, kolla_toolbox) §4, verification: before,genconfig, thenkolla_set_configs --checkin each offluentd,cronandkolla_toolbox(1 in any of them = all three will restart, by loop-notify); the check does not cover image or volume changes. After,docker psshows fresh start times,docker logs fluentdhas no parse errors and logs still reach the configured output. - Tags §3.1, row
common: config files that can change:config.json,td-agent.conf, the cron logrotate config and the kolla_toolbox files, on every host ofcommonCODE (roles/common/tasks/config.yml); safe on its own: "yes; the way to push common config fleet-wide".
Known limits and open points¶
- F2, "
-t commonis a no-op": does not hold in 2023.1. The tagcommonis on the play (site.yml:94-95), and the tasks of the dynamic include inroles/common/tasks/main.yml:2inherit it through their parent block (ansible-core 2.14.18lib/ansible/plugins/strategy/__init__.py:819-820,lib/ansible/playbook/block.py:355-363) CODE (Applycommonchanges §2). The reverse surprise is new: a tagged service run no longer applies pendingcommonchanges, which wait for an untagged run or-t common. - F1, "Loop-notify amplification": still holds.
Check common containersloops overcommon_serviceswithnotify: "Restart {{ item.key }} container"(roles/common/tasks/check-containers.yml:2-17), and ansible-core 2.14.18 notifies every handler of a changed looped result (lib/ansible/plugins/strategy/__init__.py:614-631): a change for one container restarts all three on that host CODE. - Q10 compares Ansible 2.8.20 and 2.9.27 and does not cover ansible-core 2.14.18; for 2023.1, F1 and F2 are settled by the code cited in the two items above.
- F6, "Global inputs are rendered into per-host files": for
common, theenable_*flags of the OpenStack services (fluentd_input_openstack_services,roles/common/defaults/main.yml:138-202) and the logrotate services list end up intd-agent.confandlogrotate.confon every common host CODE. - What is not known: the sources do not
establish whether restarts that touch none of the containers the study traces to running VMs (the
commoncontainers, the control-plane services) affect running VMs, APIs or traffic another way. - What is not known,
row "fluentd": the sources do not establish whether the tail read positions (in
/var/run/td-agent/, on no volume,roles/common/templates/conf/input/00-global.conf.j2:12) survive a config-only restart, and whether they are lost on a recreate. - Kolla images §6, item 9: a changed
rabbitmq_cluster_cookierecreates the brokers but their cookie file keeps the old value, whilekolla_toolboxgets the new one CODE (consequences NOT AVAILABLE).
Service card¶
The rows of the card are explained in How to read a service card.
| Item | Value |
|---|---|
| Play | site.yml:86 |
| Tags | common |
| Play host patterns | cron, fluentd, kolla-logs, kolla-toolbox |
| Node types in play (example inventory) | compute, control, monitoring, network, storage |
| Node types running its containers | compute, control, monitoring, network, storage |
| Containers | fluentd, kolla_toolbox, cron |
deploy/reconfigure flow (tasks/) |
config → check-containers → bootstrap → flush handlers |
| Task files | bootstrap.yml, check-containers.yml, check.yml, config.yml, config_validate.yml, copy-certs.yml, deploy-containers.yml, deploy.yml, main.yml, precheck.yml, pull.yml, reconfigure.yml, stop.yml, upgrade.yml |
| Templates | admin-openrc.sh.j2, clouds.yaml.j2, conf/, conf/, conf/, conf/, conf/, conf/, conf/, conf/, conf/, conf/, conf/, conf/, conf/, conf/, conf/, conf/, cron-logrotate-ansible.conf.j2, cron-logrotate-aodh.conf.j2, cron-logrotate-barbican.conf.j2, cron-logrotate-blazar.conf.j2, cron-logrotate-ceilometer.conf.j2, cron-logrotate-cinder.conf.j2, cron-logrotate-cloudkitty.conf.j2 … (+56) |
| Handlers (definition order) | Restart fluentd container; Restart kolla-toolbox container; Initializing toolbox container using normal user; Restart cron container |
| Key variables | enable_fluentd, enable_* (all, via td-agent/, elasticsearch_address, enable_monasca |
| Role dependencies | none |
Related¶
- Apply
commonchanges (fluentd, cron, kolla_toolbox) — the commands that pushcommonchanges, what restarts and how to verify - Chrony —
-t chrony, the Ussuri way to pushcommonchanges; no chrony role or play in 2023.1 - Tags §2.1 — the tag semantics that make
-t commonwork in 2023.1 - Repository architecture §5.1 —
the
common_runguard (gone in 2023.1) and the globalfluentdandcronconfigs - Why a small change creates a large workload —
enable_<new service>: yeschanges fluentd/logrotate on every host - Components — the other component pages