A Goal is a human readable, observable and measurable
end result having one objective to be achieved.
Here are some examples of Goals:
- minimize the energy consumption
- minimize the number of compute nodes (consolidation)
- balance the workload among compute nodes
- minimize the license cost (some softwares have a licensing model which is
based on the number of sockets or cores where the software is deployed)
- find the most appropriate moment for a planned maintenance on a
given group of host (which may be an entire availability zone):
power supply replacement, cooling system replacement, hardware
modification, ...
-
class watcher.api.controllers.v1.goal.Goal(**kwargs)[source]
Bases: watcher.api.controllers.base.APIBase
API representation of a goal.
This class enforces type checking and value constraints, and converts
between the internal object model and the API representation of a goal.
-
classmethod convert_with_links(goal, expand=True)[source]
-
classmethod sample(expand=True)[source]
-
class watcher.api.controllers.v1.goal.GoalCollection(**kwargs)[source]
Bases: watcher.api.controllers.v1.collection.Collection
API representation of a collection of goals.
-
static convert_with_links(goals, limit, url=None, expand=False, **kwargs)[source]
-
classmethod sample()[source]
-
class watcher.api.controllers.v1.goal.GoalsController[source]
Bases: pecan.rest.RestController
REST controller for Goals.
-
detail(*args, **kwargs)[source]
Retrieve a list of goals with detail.
Parameters: |
- marker – pagination marker for large data sets.
- limit – maximum number of resources to return in a single result.
- sort_key – column to sort results by. Default: id.
- sort_dir – direction to sort. “asc” or “desc”. Default: asc.
|
-
get_all(*args, **kwargs)[source]
Retrieve a list of goals.
Parameters: |
- marker – pagination marker for large data sets.
- limit – maximum number of resources to return in a single result.
- sort_key – column to sort results by. Default: id.
- sort_dir – direction to sort. “asc” or “desc”. Default: asc.
|
-
get_one(*args, **kwargs)[source]
Retrieve information about the given goal.
Parameters: | goal – UUID or name of the goal. |