Glossary¶
Lumo
You do not need to learn this page by heart. On every other page, the first time one of these terms appears it is underlined: hover it or tap it to see its meaning here, and where it is defined.
The terms the study uses, with the place where each is defined.
| Term | Meaning in this study | Defined in |
|---|---|---|
| loop-notify | When any item of a looped task changes, Ansible notifies the handlers of every executed (non-skipped) item. Kolla's config.yml and check-containers.yml loop over <role>_services, so a change that concerns one container restarts every container of that role on that host CODE. |
Tags §2.4; as a finding: Findings (F1) |
common_run |
The per-host fact that guards the common role: common executes in the first play in which a host appears and is skipped in all later plays CODE. |
Repository architecture §5.1 |
COPY_ALWAYS / COPY_ONCE (config_strategy) |
COPY_ALWAYS, the default: kolla_set_configs copies the config and applies permissions on every container start. COPY_ONCE: only on the first start of a container, so only a recreate re-applies config CODE. |
Kolla images §2.3, Kolla images §3.5; Repository architecture §7 (item 4) |
| one-shot container | A container that Kolla-Ansible starts with kolla_docker start_container, detach: False, restart_policy: no and a variable that selects a branch of the image's start script; the branch ends in exit 0 before the service command CODE. In the command sections of the Operations pages, "One-shot" means bootstrap containers that run regardless of drift. |
Kolla images §4; the convention of the command sections is in Operations |
| drift | What compare_container detects: a changed image or container parameter, or kolla_set_configs --check exiting 1. |
Operations, "Drift"; mechanism: Repository architecture §4.3 |
| restart vs recreate | The restart handler calls recreate_or_restart_container: recreate (stop → rm → create → start) when the image or parameters differ, otherwise restart (stop → start). Both are full stop/start cycles. |
Repository architecture §4.3 |
flush_handlers |
meta: flush_handlers is where the notified restart handlers run: at the end of most deploy.yml, or else at the end of the play. haproxy deliberately defers to the end of its play. |
Execution flow §1 (row "Handler flush points"), Execution flow §3 (step 6) |
serial / batch (kolla_serial, ANSIBLE_SERIAL) |
serial splits a play into batches; each batch completes the whole play, handlers included, before the next starts. For reconfigure and upgrade the wrapper sets kolla_serial from ANSIBLE_SERIAL; for deploy, pass -e kolla_serial=N yourself. |
Execution flow §5, Execution flow §1; Repository architecture §2 |
run_once / delegate_to |
run_once: the task runs once per play, or once per batch when kolla_serial > 0 CODE. delegate_to: the step runs on another host; groups['<grp>'][0] is the target of almost every run_once/delegate_to bootstrap step, including for hosts outside --limit. |
Tags §2.5; Repository architecture §8; Reconfigure a single service §2 (row "Actions on hosts outside --limit") |
genconfig |
The CLI command for kolla_action=config: it writes the config, compares no container, and all container restarts are skipped (one exception, the nova-hyperv handlers, is described in Pre-execution checklist). |
Execution flow §4 (row genconfig); Repository architecture §2 |
deploy-containers |
Runs only check-containers.yml and the handlers it notifies: no config is written, and no bootstrap, Keystone registration or haproxy play runs. |
Execution flow §4 (row deploy-containers); Write config first, apply in controlled batches §1.1 |
KOLLA_BOOTSTRAP / KOLLA_UPGRADE / KOLLA_OSM |
Variables, sent with an empty value, that select a one-shot branch of an image's start script. What each one runs differs per image CODE. | Kolla images §4 |
| CODE / NOT AVAILABLE | The two evidence labels: shown by the sources, with a path:line citation nearby; or not established by the sources. The fact sheets use FACT and NOT AVAILABLE for the same two levels. |
Conventions and evidence labels |
kolla_action |
The extra-var that the wrapper passes with a sub-command (-e kolla_action=<action>); every role's tasks/main.yml is a dynamic include_tasks: "{{ kolla_action }}.yml". |
Repository architecture §2, Repository architecture §4.1 |
compare_container |
The kolla_docker action run by check-containers.yml: it compares the container's definition and runs kolla_set_configs --check inside the running container. |
Repository architecture §4.3 |
kolla_set_configs --check |
The in-container check whose exit code decides config drift. It compares only the config_files entries of config.json CODE. |
Kolla images §3; by hand: Predict and inspect a run |
config.json (config_files, command, permissions) |
The manifest that tells kolla_set_configs which files to copy from /var/ to their final location, and names the command to start. |
Repository architecture §7 (item 4); Kolla images §2.3 |
| global inputs | enable_* flags, group membership and passwords, which are rendered into per-host files on every host. |
Component dependencies §5; Why a small change creates a large workload |
| waves, forks | A task on H hosts needs ⌈H/F⌉ waves, where F is the number of forks. | Compute scaling §1, Compute scaling §4.1 |
| scope legend D, Ctl, C, C×S, H, Cond | How often a task runs: once per deployment, per controller, per compute, per compute and container, per host, or only when a condition holds. | Compute scaling §3 |
| Rn, Fn, Qn | Risk numbers R1–R25, finding numbers F1–F15 and open-question numbers Q1–Q14. Each risk, finding and question is a section with its own anchor, so links to them land on the item. | Risk register; Findings; Open questions |
Related¶
- Conventions and evidence labels — the two evidence labels and the operation impact classes
- Find it fast — typical operator questions and the section that answers them
- Tag index — from a tag to its component page
- Components — one page per component, with its service card
- What is not known — everything marked NOT AVAILABLE, by topic
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.