Update Host Maintenance strategy documentation

Add clarifications to the documentation to reflect
the actual strategy usage, including:
 - updating parameter descriptions
 - extending the 'How to Use' section

Closes-Bug: #2111810
Change-Id: Ifd2876056cd8819c50658fb9f213246dc1546d42
This commit is contained in:
Ronelle Landy
2025-05-27 10:17:46 -04:00
parent fe8d8c8839
commit bfbd136f4b
2 changed files with 43 additions and 21 deletions

View File

@@ -27,16 +27,18 @@ LOG = log.getLogger(__name__)
class HostMaintenance(base.HostMaintenanceBaseStrategy):
"""[PoC]Host Maintenance
"""Host Maintenance
*Description*
It is a migration strategy for one compute node maintenance,
without having the user's application been interrupted.
If given one backup node, the strategy will firstly
If given one backup node (where backup node is the
destination node for migration), the strategy will firstly
migrate all instances from the maintenance node to
the backup node. If the backup node is not provided,
it will migrate all instances, relying on nova-scheduler.
The maintenance node will then be disabled.
*Requirements*
@@ -44,11 +46,14 @@ class HostMaintenance(base.HostMaintenanceBaseStrategy):
*Limitations*
- This is a proof of concept that is not meant to be used in production
- It migrates all instances from one host to other hosts. It's better to
execute such strategy when load is not heavy, and use this algorithm
with `ONESHOT` audit.
- It assumes that cold and live migrations are possible.
.. note::
It migrates all instances from one host to other hosts.
It is recommended to use this strategy in a planned maintenance
window where the load is low to minimize impact on the workloads,
and use this algorithm with `ONESHOT` audit.
"""
INSTANCE_MIGRATION = "migrate"