Document healthcheck and container build issues

Because healthchecks are provided via packaging in the build process,
you cannot update the image yaml files and make healthcheck changes in a
single commit. They need a level of coordination to not break things.

Change-Id: Id2d6690d883def2c067af14b03a4502e259d3c2f
This commit is contained in:
Alex Schultz 2021-01-08 10:31:12 -07:00
parent 21fd04f038
commit aa226d4dd9
1 changed files with 9 additions and 0 deletions

View File

@ -16,3 +16,12 @@ want to run scripts without installing to that file, you can set the
$ ./heat-api
{"versions": [{"status": "CURRENT", "id": "v1.0", "links": [{"href": "http://192.168.24.1:8004/v1/", "rel": "self"}]}]}
300 192.168.24.1:8004 0.002 seconds
# Notes about changing healthchecks
Because healthchecks are provided via a package when building containers,
you cannot rename or remove a health check in combination with a change to a,
file in tripleo-common/container-images/. Changes need to be backwards and
forwards compatible when updating healthchecks. You may also need to land
a new healthcheck first and update the container build process in a subsequent
change that lands later.