improve documentation on strategy

Bug #1623486 reported by David TARDIVEL
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
watcher
Fix Released
High
Susanne Balle

Bug Description

I tried to use the strategy workload_stabilization, but I think some documentation is missing to explain how to use it basically and/or in advanced mode.

I think we should propose a strategy documentation template with required section such as:

. Main purpose
. Metrics required (name, description, how to collect them ...)
. (opt) Parameters full description
. Algorithm main specification
. External links (publication, blogs, ...)
...

description: updated
Revision history for this message
Alexander Chadin (joker946) wrote :

+1 It will be very useful since almost all watcher strategies contain pretty hard algorithm inside.

Revision history for this message
Alexander Chadin (joker946) wrote :

BTW I think it should be done by strategy authors, not one contributor.

Changed in watcher:
status: New → Triaged
Changed in watcher:
milestone: none → ocata-1
importance: Undecided → High
Changed in watcher:
assignee: nobody → David TARDIVEL (david-tardivel)
Changed in watcher:
status: Triaged → In Progress
Changed in watcher:
status: In Progress → Fix Committed
status: Fix Committed → Fix Released
Changed in watcher:
status: Fix Released → Triaged
status: Triaged → In Progress
milestone: ocata-1 → ocata-2
assignee: David TARDIVEL (david-tardivel) → nobody
assignee: nobody → Susanne Balle (susanne-balle)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to watcher (master)

Reviewed: https://review.openstack.org/397411
Committed: https://git.openstack.org/cgit/openstack/watcher/commit/?id=5e9ba463ee3335c0d7fe3d10651db401fdd2559a
Submitter: Jenkins
Branch: master

commit 5e9ba463ee3335c0d7fe3d10651db401fdd2559a
Author: Susanne Balle <email address hidden>
Date: Mon Nov 14 18:31:45 2016 -0500

    Documentation for Outlet Temperature Based Strategy
    Fixed outstanding comments

    Closes-Bug: #1623486

    Change-Id: I2d327f472749c0e5a8b184eb426abebd757cc4f7

Changed in watcher:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to watcher (master)

Fix proposed to branch: master
Review: https://review.openstack.org/404960

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Fix proposed to branch: master
Review: https://review.openstack.org/404972

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to watcher (master)

Reviewed: https://review.openstack.org/404972
Committed: https://git.openstack.org/cgit/openstack/watcher/commit/?id=25d84ba662f21f1cb15f12783ef45c23cb145a70
Submitter: Jenkins
Branch: master

commit 25d84ba662f21f1cb15f12783ef45c23cb145a70
Author: Susanne Balle <email address hidden>
Date: Wed Nov 30 16:17:17 2016 -0500

    Documentation for Workload Balance Migration Strategy
    Fixed comments and added the doc primitive call

    Closes-Bug: #1623486

    Change-Id: I704536530c576de702434008aa30a7fbbaddff25

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Reviewed: https://review.openstack.org/404960
Committed: https://git.openstack.org/cgit/openstack/watcher/commit/?id=40a46c66638d7ea61860f62e3004de92e7601561
Submitter: Jenkins
Branch: master

commit 40a46c66638d7ea61860f62e3004de92e7601561
Author: Susanne Balle <email address hidden>
Date: Wed Nov 30 15:42:27 2016 -0500

    Documentation for Uniform Airflow Migration Strategy
    Fixed issues

    Closes-Bug: #1623486
    Change-Id: If303283949ef39a26c91bbff7b4664e81687d169

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/watcher 0.33.0

This issue was fixed in the openstack/watcher 0.33.0 release.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.