David TARDIVEL 3de2d368c0 Add strategy template doc

Developer should provide a detailled documentation about his strategy
algorithm to make it even easier to use by a Watcher end user.
I propose in this changeset a template for strategy documentation.
you will find also a example with basic consolidation strategy.

Change-Id: I66da1a33b87a94b508dd23ac7dce4cae6f4e068b

2016-10-13 15:30:11 +00:00

2.5 KiB

Raw Blame History

Basic Offline Server Consolidation

Synopsis

display name: basic

goal: server_consolidation

watcher.decision_engine.strategy.strategies.basic_consolidation

Requirements

Metrics

The basic strategy requires the following metrics:

metric	service name	plugins	comment
`compute.node.cpu.percent` `cpu_util`	ceilometer ceilometer	none 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.default.DefaultPlanner

Configuration

Strategy parameter is:

parameter	type	default Value	description
`migration_attempts`	Number	0	Maximum number of combinations to be tried by the strategy while searching for potential candidates. To remove the limit, set it to 0

Efficacy Indicator

watcher.decision_engine.goal.efficacy.specs.ServerConsolidation.get_global_efficacy_indicator

How to use it ?

$ openstack optimize audittemplate create \
  at1 server_consolidation --strategy basic

$ openstack optimize audit create -a at1 -p migration_attempts=4

External Links

None.

2.5 KiB Raw Blame History