Heat¶
This page is the starting point for Heat, the heat role: the containers heat_api, heat_api_cfn and heat_engine,
on the control nodes of the example inventory, selected by the tag heat. A changed heat_domain_admin_password
reaches heat.conf but is never applied in Keystone (roles/heat/templates/heat.conf.j2:12, kolla
docker/heat/heat-api/extend_start.sh:10-14; Component dependencies §3).
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¶
No operation page gives a reconfigure command line for the heat tag. The scenario above describes
kolla-ansible -t <svc> reconfigure for an API service such as keystone, glance, cinder, heat or placement; its command
example is keystone (Reconfigure a single service
§1.1). The stop example of Stop and
destroy uses -t heat.
Impact and risk¶
Dependencies¶
- Dependencies: Component dependencies §3
Evidence¶
- Fact sheet: fact sheet C §5
- Image side: Kolla images
§4 (row
heat-api), Kolla images §5
Before and after a run¶
- Tags §3.1, row
<svc>API service: safe on its own "yes, it is the intended unit; it still runs Keystone registration and DB sync"; batch withANSIBLE_SERIAL. Prerequisites: MariaDB, RabbitMQ, memcached, Keystone (registration), HAProxy VIP. - fact sheet C §5.8: with
serial 0, every heat-engine restarts in the same handler flush on any heat.conf change; a memcached or rabbit
membership change, a password rotation or an
openstack_service_workerschange is enough (site.yml:631-641;roles/heat/templates/heat.conf.j2:12,16,19,46,52,roles/heat/defaults/main.yml:191) CODE. - R8, precautions for a HAProxy config change:
ANSIBLE_SERIAL=1for haproxy changes;--skip-tags haproxywhen you don't intend to change frontends. - R24, precautions for the container stop timeout (60 s in 2023.1: the systemd unit
stops the container with
docker stop -t <docker_graceful_timeout>): drain long operations before restarts; raisedocker_graceful_timeoutif needed (it reaches the unit on the next restart). - Reconfigure a single service
§3,
verification of
-t <svc> reconfigure: before,kolla-ansible -t <svc> genconfig, thenkolla_set_configs --checkin each<svc>container and a diff of/etc/kolla/haproxy/services.d/<svc>*.cfgagainst the previous version; after,openstack endpoint list --service <name>is unchanged for each Keystone service the role registers, e.g.heatandheat-cfnfor heat (roles/heat/defaults/main.yml:214,220), the API answers through the VIP, the container start times show which hosts restarted, anddocker ps --filter name=haproxyshows whether HAProxy restarted.
Known limits and open points¶
- Known bugs and limitations, row
heat:bootstrap_heatcreatesheat_user_domain/heat_domain_adminonly when the domain is absent: a changedheat_domain_admin_passwordreachesheat.confbut never Keystone. Status: CODE (kolladocker/heat/heat-api/extend_start.sh:8-14,roles/heat/tasks/bootstrap_service.yml:22); impact NOT AVAILABLE. - Q14, answered from the source CODE: Heat creates
heat_user_domain/heat_domain_adminonly if the domain is absent, so a changedheat_domain_admin_passwordis never pushed to Keystone. - F15, "What the bootstrap containers run differs per image": Heat's bootstrap container
does not re-apply a changed
heat_domain_admin_passwordto Keystone CODE. - F3, "
docker_graceful_timeoutanddocker_client_timeoutare ignored": an Ussuri finding that no longer holds as written in 2023.1. The role handlers passdocker_common_options, which carriesgraceful_timeout: "{{ docker_graceful_timeout }}"(60 s) andclient_timeout(120 s) (group_vars/all.yml:105,140, 152-153), and the container's systemd unit stops it withdocker stop <name> -t <graceful_timeout>(module_utils/kolla_systemd_worker.py:33). On every restart, a service still running 60 s after SIGTERM is killed with its in-flight work (heat-engine, cinder copies, glance uploads); the 10 s value is only the module default when nograceful_timeoutis passed (module_utils/kolla_docker_worker.py:438-440,462-464) CODE (R24). - F5, "
reconfigure=deploy": a reconfigure re-runs Keystone registration, DB creation/grants and the DB-sync bootstrap containers of most services CODE. - What is not
known, row
"Heat": the sources do not establish whether stack-domain operations fail authentication after a changed
heat_domain_admin_password. - What is not known: the sources do not establish whether xtrace writes one-shot secrets (the heat domain admin password among them) to the container's stderr.
- fact sheet C §5.8,
"Operational notes", four points: heat-engine restarts with stacks in progress (NOT AVAILABLE: upstream heat
behaviour); with serial 0, every heat-engine restarts in the same handler flush on any heat.conf change; on upgrade
the db sync runs while old engines are still active, and all engines restart together after it (2023.1:
config, check-containers, then
bootstrap_service.yml, then the flush of handlers,roles/heat/tasks/upgrade.yml:1-9CODE); Heat does not touch compute hosts. - fact sheet C §8, items 8 and
10: NOT AVAILABLE: heat-engine restart with
CREATE_IN_PROGRESSstacks: final state and recovery steps; how heat behaves afterheat_domain_admin_passwordchanges, whenheat.confgets the new value but Keystone keeps the old one. - Kolla images §6, item 7: a changed
heat_domain_admin_passwordnever reaches Keystone CODE; NOT AVAILABLE whether stack-domain operations then fail authentication.
Service card¶
The rows of the card are explained on the Components page.
| Item | Value |
|---|---|
| Play | site.yml:631 |
| Tags | heat |
| Play host patterns | heat-api, heat-api-cfn, heat-engine |
| Node types in play (example inventory) | control |
| Node types running its containers | control |
| Containers | heat_api, heat_api_cfn, heat_engine |
deploy/reconfigure flow (tasks/) |
register → config → check-containers → clone (if) → bootstrap → flush handlers |
| Task files | bootstrap.yml, bootstrap_service.yml, check-containers.yml, check.yml, clone.yml, config.yml, config_validate.yml, copy-certs.yml, deploy-containers.yml, deploy.yml, loadbalancer.yml, main.yml, precheck.yml, pull.yml, reconfigure.yml, register.yml, stop.yml, upgrade.yml |
| Templates | heat-api-cfn.json.j2, heat-api.json.j2, heat-engine.json.j2, heat.conf.j2, wsgi-heat-api-cfn.conf.j2, wsgi-heat-api.conf.j2 |
| Handlers (definition order) | Restart heat-api container; Restart heat-api-cfn container; Restart heat-engine container |
| Key variables | enable_heat, heat_*_external_fqdn |
| Role dependencies | none |
Related¶
- Reconfigure a single service — what
-t <svc> reconfigureruns for an API service such as heat, with the risks and the verification - Keystone — a changed
heat_domain_admin_passwordreachesheat.confbut never Keystone - Stop and destroy — the
stopcommand line, whose example uses-t heat - R24 — heat-engine is one of the services named for the kill 60 s
(
docker_graceful_timeout) after SIGTERM - Component dependencies §6 — Heat, Horizon and Octavia come after Nova and Neutron in the deployment order
- Components — the other component pages