Files

Ronelle Landy bfbd136f4b 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

2025-06-23 06:36:42 -04:00

2.8 KiB

Raw Blame History

Host Maintenance Strategy

Synopsis

display name: Host Maintenance Strategy

goal: cluster_maintaining

watcher.decision_engine.strategy.strategies.host_maintenance.HostMaintenance

Metrics

None

Cluster data model

Default Watcher's Compute cluster data model:

watcher.decision_engine.model.collector.nova.NovaClusterDataModelCollector

Actions

Default Watcher's actions:

action description

migration

watcher.applier.actions.migration.Migrate

change_nova_service_state

watcher.applier.actions.change_nova_service_state.ChangeNovaServiceState

action	description
`migration`	watcher.applier.actions.migration.Migrate
`change_nova_service_state`	watcher.applier.actions.change_nova_service_state.ChangeNovaServiceState

Planner

Default Watcher's planner:

watcher.decision_engine.planner.weight.WeightPlanner

Configuration

Strategy parameters are:

parameter	type	description	required/optional
`maintenance_node`	String	The name of the compute node which needs maintenance.	Required
`backup_node`	String	The name of the compute node which will backup the maintenance node.	Optional

Efficacy Indicator

None

Algorithm

For more information on the Host Maintenance Strategy please refer to: https://specs.openstack.org/openstack/watcher-specs/specs/queens/approved/cluster-maintenance-strategy.html

How to use it ?

Run an audit using Host Maintenance strategy. Executing the actions will move the servers from compute01 host to a host determined by the Nova scheduler service.

$ openstack optimize audit create \
  -g cluster_maintaining -s host_maintenance \
  -p maintenance_node=compute01

Run an audit using Host Maintenance strategy with a backup node specified. Executing the actions will move the servers from compute01 host to compute02 host.

$ openstack optimize audit create \
  -g cluster_maintaining -s host_maintenance \
  -p maintenance_node=compute01 \
  -p backup_node=compute02

Note that after executing this strategy, the maintenance_node will be marked as disabled, with the reason set to watcher_maintaining. To enable the node again:

$ openstack compute service set --enable compute01

External Links

None.

2.8 KiB Raw Blame History