diff options
| author | Matt Crees <mattc@stackhpc.com> | 2023-09-01 10:18:54 +0100 |
|---|---|---|
| committer | Matt Crees <mattc@stackhpc.com> | 2023-09-01 09:28:33 +0000 |
| commit | ec40b9de283deecb845f4a519809144f8b19de4c (patch) | |
| tree | a3d7f8accd7d11546fbc2f42f0a98def21cd62e5 | |
| parent | c8625600a5245e464bc5ef012cb6e60fed14690a (diff) | |
| download | kolla-ec40b9de283deecb845f4a519809144f8b19de4c.tar.gz kolla-ec40b9de283deecb845f4a519809144f8b19de4c.zip | |
Document KOLLA_UPGRADE_CHECK environment variable
Adds docs for the KOLLA_UPGRADE_CHECK variable, introduced here:
https://review.opendev.org/c/openstack/kolla/+/878744
This feature currently hard-codes the Nova upgrade check, but should be
extended in the future to support the other services that have upgrade
checks. (Placement, for example:
https://docs.openstack.org/placement/latest/cli/placement-status.html)
The docs reflect this intention.
Change-Id: I0e9d482b1b26d3e4deddbf6d4a6c83bd8e021269
| -rw-r--r-- | doc/source/admin/kolla_api.rst | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/source/admin/kolla_api.rst b/doc/source/admin/kolla_api.rst index 775dcad9c..74dc58d79 100644 --- a/doc/source/admin/kolla_api.rst +++ b/doc/source/admin/kolla_api.rst @@ -135,6 +135,10 @@ behavior at runtime: code defined in the images ``extend_start.sh`` scripts. Not set by default. * **KOLLA_UPGRADE**: if set, and supported by the image, runs the upgrade code defined in the images ``extend_start.sh`` scripts. Not set by default. +* **KOLLA_UPGRADE_CHECK**: if set, and supported by the image, runs the + ``<service>-status upgrade check`` command, defined in the images + ``extend_start.sh`` scripts. Currently, this is hard-coded to just + ``nova-status upgrade check``. Not set by default. * **KOLLA_OSM**: if set, and supported by the image, runs the online database migration code defined in the images ``extend_start.sh`` scripts. Not set by default. |