Doc on how to implement a custom Watcher planner
This documentation describes step-by-step the process for implementing a new planner in Watcher. Change-Id: I8addba53de69be93730924a58107687020c19c74 Closes-Bug: #1533739
This commit is contained in:
@@ -50,11 +50,13 @@ class BasePlanner(object):
|
||||
def schedule(self, context, audit_uuid, solution):
|
||||
"""The planner receives a solution to schedule
|
||||
|
||||
:param solution: the solution given by the strategy to
|
||||
:param solution: A solution provided by a strategy for scheduling
|
||||
:type solution: :py:class:`~.BaseSolution` subclass instance
|
||||
:param audit_uuid: the audit uuid
|
||||
:return: ActionPlan ordered sequence of change requests
|
||||
such that all security, dependency, and performance
|
||||
requirements are met.
|
||||
:type audit_uuid: str
|
||||
:return: Action plan with an ordered sequence of actions such that all
|
||||
security, dependency, and performance requirements are met.
|
||||
:rtype: :py:class:`watcher.objects.action_plan.ActionPlan` instance
|
||||
"""
|
||||
# example: directed acyclic graph
|
||||
raise NotImplementedError()
|
||||
|
||||
Reference in New Issue
Block a user