Skip to content

Memcached

This page is the starting point for memcached, the memcached role: one container, memcached, on the control nodes of the example inventory (inventory/multinode:116-117), selected by the tags memcached and memcache (site.yml:402-414). As in 2023.1, no role has a common dependency: common is its own play, tagged common only (site.yml:88-103), and no role under ansible/roles/ has a meta/ directory, so memcached is not an exception (Tags §1, row "Role-level tags") CODE. The role is unchanged since 2023.1 except for the module rename (kolla_docker → kolla_container) 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

Impact and risk

  • What the tag executes (memcached / memcache): Tags §3 and Tags §3.1, rows memcached / memcache
  • Sequence CODE: deploy and reconfigure run config.yml (config directory and config.json) then check-containers.yml, with no flush, so the restart handler runs at the end of the play (roles/memcached/tasks/deploy.yml:2-4, reconfigure.yml:2); upgrade runs the same two files (roles/memcached/tasks/upgrade.yml:2-4). The handler is skipped when kolla_action is config (roles/memcached/handlers/main.yml:2-15).
  • Risks: R4

Dependencies

  • Dependencies: Component dependencies §1, Component dependencies §2
  • Who reads the membership CODE: the templates or defaults of 27 roles loop over groups['memcached'] (33 in 2023.1; freezer, murano, sahara, senlin, solum and vitrage are gone). Example: memcached_servers in neutron.conf (roles/neutron/templates/neutron.conf.j2:123), which is rendered for the Open vSwitch agent too (roles/neutron/tasks/config.yml:87-122).

Evidence

  • Fact sheet: fact sheet A §3
  • Image side: Kolla images §5 (row memcached). The kolla docker/memcached directory is identical to 2023.1's: a memcached user, the memcached package, no start script (kolla docker/memcached/Dockerfile.j2:10-18) CODE.

Before and after a run

  • Tags §3.1, row memcached / memcache: safe on its own "yes, off-peak"; prerequisites: none.
  • R4, precautions for a change of memcached membership: plan as a dataplane change, like R3/R5: batch with --limit or ANSIBLE_SERIAL, network nodes one at a time; low-traffic window.
  • The config.json blind spot CODE. Every memcached setting is in the command of its config.json, and its config_files list is empty: listen address api_interface_address, memcached_port, memcached_connection_limit and memcached_max_memory (roles/memcached/templates/memcached.json.j2:1-4; defaults roles/memcached/defaults/main.yml:54-57, group_vars/all.yml:493). kolla_set_configs --check iterates only config_files (kolla docker/base/set_configs.py:556-559), so for memcached it always exits 0 (F14, Kolla images §3.2). What follows for a change of one of these settings:
    1. A normal deploy/reconfigure applies it: the config.json template task reports changed and notifies Restart memcached container (roles/memcached/tasks/config.yml:13-26). With COPY_ALWAYS, the restart runs kolla_set_configs again, which writes the new command to /run_command, and kolla_start executes it (kolla docker/base/set_configs.py:302-316, :535-541, docker/base/start.sh:11-12, :24).
    2. After a separate genconfig (kolla_action=config), the file is written but the handler is skipped (roles/memcached/handlers/main.yml:14-15). deploy-containers then finds no drift, and a later deploy or reconfigure does not restart either, because the template task is now unchanged. The new command applies only at the next restart for another reason (Kolla images §6, item 1; Predict and inspect a run, row "See what will restart").
    3. What the check does see: the image, the volumes, the dimensions and the healthcheck, which are container parameters compared by compare_container (roles/memcached/tasks/check-containers.yml:2-17, module_utils/kolla_container_worker.py:58-89), plus the systemd unit text. The healthcheck is healthcheck_listen memcached <memcached_port> (roles/memcached/defaults/main.yml:36-43), so a port change also changes a compared parameter; a change of the connection limit or of the memory size does not.
  • First 2024.1 check of a container that 2023.1 created CODE: the systemd unit text changed (F16), so a memcached container that no 2024.1 run has recreated or restarted yet is restarted at its first 2024.1 deploy/reconfigure, on all memcached hosts at once (the play's serial, below).

Known limits and open points

  • Known bugs and limitations, row kolla images: kolla_set_configs --check compares only config_files entries (F14): changes confined to config.json (command, permissions; all of memcached's settings) are never detected. Still holds in 2024.1: kolla's docker/base/set_configs.py is identical to 2023.1's CODE.
  • F6, "Global inputs are rendered into per-host files": enable_* flags, RabbitMQ/memcached membership, service passwords and the external FQDN end up in compute-side files CODE.
  • What is not known, row "memcached": the sources do not establish whether cached tokens are lost when the membership changes or the container restarts, and the effect on auth latency and Horizon sessions.
  • fact sheet A §3.8, "Operationally notable", four items. Checked against 2024.1 CODE: all memcached instances restart at once (the play's serial is kolla_serial, default 0, site.yml:407; the play's new max_fail_percentage defaults to 100, site.yml:408-411, and so never stops it early); adding or removing a memcached host is expensive (27 roles loop over groups['memcached'] in their templates or defaults, R4); tag aliases differ: only -t memcached selects the memcached include of the loadbalancer play (site.yml:233-237), and that include renders a frontend only with enable_haproxy_memcached (default no, group_vars/all.yml:737, roles/memcached/defaults/main.yml:11-13), so with defaults the two tags differ in nothing visible; "memcached has no common dependency" is not specific to memcached (no role has one, see above).
  • Kolla images §6, item 14: memcached has no data volume and no persistence option (roles/memcached/defaults/main.yml:45-48, roles/memcached/templates/memcached.json.j2:2) CODE; whether every restart therefore empties the cache is NOT AVAILABLE (memcached semantics).

Service card

The rows of the card are explained in How to read a service card.

Item Value
Play site.yml:402
Tags memcache, memcached
Play host patterns memcached
Node types in play (example inventory) control
Node types running its containers control
Containers memcached
deploy/reconfigure flow (tasks/deploy.yml) config → check-containers
Task files check-containers.yml, check.yml, config.yml, config_validate.yml, deploy-containers.yml, deploy.yml, loadbalancer.yml, main.yml, precheck.yml, pull.yml, reconfigure.yml, stop.yml, upgrade.yml
Templates memcached.json.j2
Handlers (definition order) Restart memcached container
Key variables enable_memcached, memcached_port
Role dependencies none
  • Change control-plane membership — a memcached-only change does not touch nova-compute but still restarts the neutron agents on computes
  • Component dependencies §1 — the templates of 27 roles loop over groups['memcached'] (R4)
  • Keystone — memcached is its token cache
  • Horizon — it keeps its sessions in memcached when horizon_backend_database is false (the default, group_vars/all.yml:1141) and the memcached group is not empty (roles/horizon/templates/_9998-kolla-settings.py.j2:19-22; 2023.1's local_settings.j2 no longer exists)
  • Predict and inspect a run — kolla_set_configs --check and its exit codes
  • Components — the other component pages