Merge "improve strategy doc"

watcher/decision_engine/strategy/strategies/saving_energy.py

@@ -31,6 +31,8 @@ LOG = log.getLogger(__name__)
 class SavingEnergy(base.SavingEnergyBaseStrategy):
     """Saving Energy Strategy
 
+    *Description*
+
     Saving Energy Strategy together with VM Workload Consolidation Strategy
     can perform the Dynamic Power Management (DPM) functionality, which tries
     to save power by dynamically consolidating workloads even further during
@@ -51,6 +53,8 @@ class SavingEnergy(base.SavingEnergyBaseStrategy):
     the given number and there are spare unused nodes(in poweroff state),
     randomly select some nodes(unused,poweroff) and power on them.
 
+    *Requirements*
+
     In this policy, in order to calculate the min_free_hosts_num,
     users must provide two parameters:
 
@@ -64,6 +68,14 @@ class SavingEnergy(base.SavingEnergyBaseStrategy):
       The nodes with VMs refer to those nodes with VMs running on it.
 
     Then choose the larger one as the final min_free_hosts_num.
+
+    *Limitations*
+
+    * at least 2 physical compute hosts
+
+    *Spec URL*
+
+    http://specs.openstack.org/openstack/watcher-specs/specs/pike/implemented/energy-saving-strategy.html
     """
 
     def __init__(self, config, osc=None):

watcher/decision_engine/strategy/strategies/storage_capacity_balance.py

@@ -41,6 +41,15 @@ class StorageCapacityBalance(base.WorkloadStabilizationBaseStrategy):
 
     * You must have at least 2 cinder volume pools to run
       this strategy.
+
+    *Limitations*
+
+    * Volume migration depends on the storage device.
+      It may take a long time.
+
+    *Spec URL*
+
+    http://specs.openstack.org/openstack/watcher-specs/specs/queens/implemented/storage-capacity-balance.html
     """
 
     def __init__(self, config, osc=None):