c4a30153f1
This patch set adds API microversion support along with the first API microversion: start/end time for CONTINUOUS audits. APIImpact Implements: blueprint api-microversioning Depends-On: I6bb838d777b2c7aa799a70485980e5dc87838456 Change-Id: I17309d80b637f02bc5e6d33294472e02add88f86
607 lines
23 KiB
Python
607 lines
23 KiB
Python
# -*- encoding: utf-8 -*-
|
|
# Copyright 2013 Red Hat, Inc.
|
|
# All Rights Reserved.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
# implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
"""
|
|
An :ref:`Action Plan <action_plan_definition>` specifies a flow of
|
|
:ref:`Actions <action_definition>` that should be executed in order to satisfy
|
|
a given :ref:`Goal <goal_definition>`. It also contains an estimated
|
|
:ref:`global efficacy <efficacy_definition>` alongside a set of
|
|
:ref:`efficacy indicators <efficacy_indicator_definition>`.
|
|
|
|
An :ref:`Action Plan <action_plan_definition>` is generated by Watcher when an
|
|
:ref:`Audit <audit_definition>` is successful which implies that the
|
|
:ref:`Strategy <strategy_definition>`
|
|
which was used has found a :ref:`Solution <solution_definition>` to achieve the
|
|
:ref:`Goal <goal_definition>` of this :ref:`Audit <audit_definition>`.
|
|
|
|
In the default implementation of Watcher, an action plan is composed of
|
|
a list of successive :ref:`Actions <action_definition>` (i.e., a Workflow of
|
|
:ref:`Actions <action_definition>` belonging to a unique branch).
|
|
|
|
However, Watcher provides abstract interfaces for many of its components,
|
|
allowing other implementations to generate and handle more complex :ref:`Action
|
|
Plan(s) <action_plan_definition>` composed of two types of Action Item(s):
|
|
|
|
- simple :ref:`Actions <action_definition>`: atomic tasks, which means it
|
|
can not be split into smaller tasks or commands from an OpenStack point of
|
|
view.
|
|
- composite Actions: which are composed of several simple
|
|
:ref:`Actions <action_definition>`
|
|
ordered in sequential and/or parallel flows.
|
|
|
|
An :ref:`Action Plan <action_plan_definition>` may be described using
|
|
standard workflow model description formats such as
|
|
`Business Process Model and Notation 2.0 (BPMN 2.0)
|
|
<http://www.omg.org/spec/BPMN/2.0/>`_ or `Unified Modeling Language (UML)
|
|
<http://www.uml.org/>`_.
|
|
|
|
To see the life-cycle and description of
|
|
:ref:`Action Plan <action_plan_definition>` states, visit :ref:`the Action Plan
|
|
state machine <action_plan_state_machine>`.
|
|
"""
|
|
|
|
import datetime
|
|
|
|
from oslo_log import log
|
|
import pecan
|
|
from pecan import rest
|
|
import wsme
|
|
from wsme import types as wtypes
|
|
import wsmeext.pecan as wsme_pecan
|
|
|
|
from watcher._i18n import _
|
|
from watcher.api.controllers import base
|
|
from watcher.api.controllers import link
|
|
from watcher.api.controllers.v1 import collection
|
|
from watcher.api.controllers.v1 import efficacy_indicator as efficacyindicator
|
|
from watcher.api.controllers.v1 import types
|
|
from watcher.api.controllers.v1 import utils as api_utils
|
|
from watcher.applier import rpcapi
|
|
from watcher.common import exception
|
|
from watcher.common import policy
|
|
from watcher.common import utils
|
|
from watcher import objects
|
|
from watcher.objects import action_plan as ap_objects
|
|
|
|
LOG = log.getLogger(__name__)
|
|
|
|
|
|
def hide_fields_in_newer_versions(obj):
|
|
"""This method hides fields that were added in newer API versions.
|
|
|
|
Certain node fields were introduced at certain API versions.
|
|
These fields are only made available when the request's API version
|
|
matches or exceeds the versions when these fields were introduced.
|
|
"""
|
|
pass
|
|
|
|
|
|
class ActionPlanPatchType(types.JsonPatchType):
|
|
|
|
@staticmethod
|
|
def _validate_state(patch):
|
|
serialized_patch = {'path': patch.path, 'op': patch.op}
|
|
if patch.value is not wsme.Unset:
|
|
serialized_patch['value'] = patch.value
|
|
# todo: use state machines to handle state transitions
|
|
state_value = patch.value
|
|
if state_value and not hasattr(ap_objects.State, state_value):
|
|
msg = _("Invalid state: %(state)s")
|
|
raise exception.PatchError(
|
|
patch=serialized_patch, reason=msg % dict(state=state_value))
|
|
|
|
@staticmethod
|
|
def validate(patch):
|
|
if patch.path == "/state":
|
|
ActionPlanPatchType._validate_state(patch)
|
|
return types.JsonPatchType.validate(patch)
|
|
|
|
@staticmethod
|
|
def internal_attrs():
|
|
return types.JsonPatchType.internal_attrs()
|
|
|
|
@staticmethod
|
|
def mandatory_attrs():
|
|
return ["audit_id", "state"]
|
|
|
|
|
|
class ActionPlan(base.APIBase):
|
|
"""API representation of a action plan.
|
|
|
|
This class enforces type checking and value constraints, and converts
|
|
between the internal object model and the API representation of an
|
|
action plan.
|
|
"""
|
|
|
|
_audit_uuid = None
|
|
_strategy_uuid = None
|
|
_strategy_name = None
|
|
_efficacy_indicators = None
|
|
|
|
def _get_audit_uuid(self):
|
|
return self._audit_uuid
|
|
|
|
def _set_audit_uuid(self, value):
|
|
if value == wtypes.Unset:
|
|
self._audit_uuid = wtypes.Unset
|
|
elif value and self._audit_uuid != value:
|
|
try:
|
|
audit = objects.Audit.get(pecan.request.context, value)
|
|
self._audit_uuid = audit.uuid
|
|
self.audit_id = audit.id
|
|
except exception.AuditNotFound:
|
|
self._audit_uuid = None
|
|
|
|
def _get_efficacy_indicators(self):
|
|
if self._efficacy_indicators is None:
|
|
self._set_efficacy_indicators(wtypes.Unset)
|
|
return self._efficacy_indicators
|
|
|
|
def _set_efficacy_indicators(self, value):
|
|
efficacy_indicators = []
|
|
if value == wtypes.Unset and not self._efficacy_indicators:
|
|
try:
|
|
_efficacy_indicators = objects.EfficacyIndicator.list(
|
|
pecan.request.context,
|
|
filters={"action_plan_uuid": self.uuid})
|
|
|
|
for indicator in _efficacy_indicators:
|
|
efficacy_indicator = efficacyindicator.EfficacyIndicator(
|
|
context=pecan.request.context,
|
|
name=indicator.name,
|
|
description=indicator.description,
|
|
unit=indicator.unit,
|
|
value=indicator.value,
|
|
)
|
|
efficacy_indicators.append(efficacy_indicator.as_dict())
|
|
self._efficacy_indicators = efficacy_indicators
|
|
except exception.EfficacyIndicatorNotFound as exc:
|
|
LOG.exception(exc)
|
|
elif value and self._efficacy_indicators != value:
|
|
self._efficacy_indicators = value
|
|
|
|
def _get_strategy(self, value):
|
|
if value == wtypes.Unset:
|
|
return None
|
|
strategy = None
|
|
try:
|
|
if utils.is_uuid_like(value) or utils.is_int_like(value):
|
|
strategy = objects.Strategy.get(
|
|
pecan.request.context, value)
|
|
else:
|
|
strategy = objects.Strategy.get_by_name(
|
|
pecan.request.context, value)
|
|
except exception.StrategyNotFound:
|
|
pass
|
|
if strategy:
|
|
self.strategy_id = strategy.id
|
|
return strategy
|
|
|
|
def _get_strategy_uuid(self):
|
|
return self._strategy_uuid
|
|
|
|
def _set_strategy_uuid(self, value):
|
|
if value and self._strategy_uuid != value:
|
|
self._strategy_uuid = None
|
|
strategy = self._get_strategy(value)
|
|
if strategy:
|
|
self._strategy_uuid = strategy.uuid
|
|
|
|
def _get_strategy_name(self):
|
|
return self._strategy_name
|
|
|
|
def _set_strategy_name(self, value):
|
|
if value and self._strategy_name != value:
|
|
self._strategy_name = None
|
|
strategy = self._get_strategy(value)
|
|
if strategy:
|
|
self._strategy_name = strategy.name
|
|
|
|
uuid = wtypes.wsattr(types.uuid, readonly=True)
|
|
"""Unique UUID for this action plan"""
|
|
|
|
audit_uuid = wsme.wsproperty(types.uuid, _get_audit_uuid, _set_audit_uuid,
|
|
mandatory=True)
|
|
"""The UUID of the audit this port belongs to"""
|
|
|
|
strategy_uuid = wsme.wsproperty(
|
|
wtypes.text, _get_strategy_uuid, _set_strategy_uuid, mandatory=False)
|
|
"""Strategy UUID the action plan refers to"""
|
|
|
|
strategy_name = wsme.wsproperty(
|
|
wtypes.text, _get_strategy_name, _set_strategy_name, mandatory=False)
|
|
"""The name of the strategy this action plan refers to"""
|
|
|
|
efficacy_indicators = wsme.wsproperty(
|
|
types.jsontype, _get_efficacy_indicators, _set_efficacy_indicators,
|
|
mandatory=True)
|
|
"""The list of efficacy indicators associated to this action plan"""
|
|
|
|
global_efficacy = wtypes.wsattr(types.jsontype, readonly=True)
|
|
"""The global efficacy of this action plan"""
|
|
|
|
state = wtypes.text
|
|
"""This action plan state"""
|
|
|
|
links = wsme.wsattr([link.Link], readonly=True)
|
|
"""A list containing a self link and associated action links"""
|
|
|
|
hostname = wsme.wsattr(wtypes.text, mandatory=False)
|
|
"""Hostname the actionplan is running on"""
|
|
|
|
def __init__(self, **kwargs):
|
|
super(ActionPlan, self).__init__()
|
|
self.fields = []
|
|
fields = list(objects.ActionPlan.fields)
|
|
for field in fields:
|
|
# Skip fields we do not expose.
|
|
if not hasattr(self, field):
|
|
continue
|
|
self.fields.append(field)
|
|
setattr(self, field, kwargs.get(field, wtypes.Unset))
|
|
|
|
self.fields.append('audit_uuid')
|
|
self.fields.append('efficacy_indicators')
|
|
|
|
setattr(self, 'audit_uuid', kwargs.get('audit_id', wtypes.Unset))
|
|
fields.append('strategy_uuid')
|
|
setattr(self, 'strategy_uuid', kwargs.get('strategy_id', wtypes.Unset))
|
|
fields.append('strategy_name')
|
|
setattr(self, 'strategy_name', kwargs.get('strategy_id', wtypes.Unset))
|
|
|
|
@staticmethod
|
|
def _convert_with_links(action_plan, url, expand=True):
|
|
if not expand:
|
|
action_plan.unset_fields_except(
|
|
['uuid', 'state', 'efficacy_indicators', 'global_efficacy',
|
|
'updated_at', 'audit_uuid', 'strategy_uuid', 'strategy_name'])
|
|
|
|
action_plan.links = [
|
|
link.Link.make_link(
|
|
'self', url,
|
|
'action_plans', action_plan.uuid),
|
|
link.Link.make_link(
|
|
'bookmark', url,
|
|
'action_plans', action_plan.uuid,
|
|
bookmark=True)]
|
|
return action_plan
|
|
|
|
@classmethod
|
|
def convert_with_links(cls, rpc_action_plan, expand=True):
|
|
action_plan = ActionPlan(**rpc_action_plan.as_dict())
|
|
hide_fields_in_newer_versions(action_plan)
|
|
return cls._convert_with_links(action_plan, pecan.request.host_url,
|
|
expand)
|
|
|
|
@classmethod
|
|
def sample(cls, expand=True):
|
|
sample = cls(uuid='9ef4d84c-41e8-4418-9220-ce55be0436af',
|
|
state='ONGOING',
|
|
created_at=datetime.datetime.utcnow(),
|
|
deleted_at=None,
|
|
updated_at=datetime.datetime.utcnow())
|
|
sample._audit_uuid = 'abcee106-14d3-4515-b744-5a26885cf6f6'
|
|
sample._efficacy_indicators = [{'description': 'Test indicator',
|
|
'name': 'test_indicator',
|
|
'unit': '%'}]
|
|
sample._global_efficacy = {'description': 'Global efficacy',
|
|
'name': 'test_global_efficacy',
|
|
'unit': '%'}
|
|
return cls._convert_with_links(sample, 'http://localhost:9322', expand)
|
|
|
|
|
|
class ActionPlanCollection(collection.Collection):
|
|
"""API representation of a collection of action_plans."""
|
|
|
|
action_plans = [ActionPlan]
|
|
"""A list containing action_plans objects"""
|
|
|
|
def __init__(self, **kwargs):
|
|
self._type = 'action_plans'
|
|
|
|
@staticmethod
|
|
def convert_with_links(rpc_action_plans, limit, url=None, expand=False,
|
|
**kwargs):
|
|
ap_collection = ActionPlanCollection()
|
|
ap_collection.action_plans = [ActionPlan.convert_with_links(
|
|
p, expand) for p in rpc_action_plans]
|
|
ap_collection.next = ap_collection.get_next(limit, url=url, **kwargs)
|
|
return ap_collection
|
|
|
|
@classmethod
|
|
def sample(cls):
|
|
sample = cls()
|
|
sample.action_plans = [ActionPlan.sample(expand=False)]
|
|
return sample
|
|
|
|
|
|
class ActionPlansController(rest.RestController):
|
|
"""REST controller for Actions."""
|
|
|
|
def __init__(self):
|
|
super(ActionPlansController, self).__init__()
|
|
self.applier_client = rpcapi.ApplierAPI()
|
|
|
|
from_actionsPlans = False
|
|
"""A flag to indicate if the requests to this controller are coming
|
|
from the top-level resource ActionPlan."""
|
|
|
|
_custom_actions = {
|
|
'start': ['POST'],
|
|
'detail': ['GET']
|
|
}
|
|
|
|
def _get_action_plans_collection(self, marker, limit,
|
|
sort_key, sort_dir, expand=False,
|
|
resource_url=None, audit_uuid=None,
|
|
strategy=None):
|
|
additional_fields = ['audit_uuid', 'strategy_uuid', 'strategy_name']
|
|
|
|
api_utils.validate_sort_key(
|
|
sort_key, list(objects.ActionPlan.fields) + additional_fields)
|
|
limit = api_utils.validate_limit(limit)
|
|
api_utils.validate_sort_dir(sort_dir)
|
|
|
|
marker_obj = None
|
|
if marker:
|
|
marker_obj = objects.ActionPlan.get_by_uuid(
|
|
pecan.request.context, marker)
|
|
|
|
filters = {}
|
|
if audit_uuid:
|
|
filters['audit_uuid'] = audit_uuid
|
|
|
|
if strategy:
|
|
if utils.is_uuid_like(strategy):
|
|
filters['strategy_uuid'] = strategy
|
|
else:
|
|
filters['strategy_name'] = strategy
|
|
|
|
need_api_sort = api_utils.check_need_api_sort(sort_key,
|
|
additional_fields)
|
|
sort_db_key = (sort_key if not need_api_sort
|
|
else None)
|
|
|
|
action_plans = objects.ActionPlan.list(
|
|
pecan.request.context,
|
|
limit,
|
|
marker_obj, sort_key=sort_db_key,
|
|
sort_dir=sort_dir, filters=filters)
|
|
|
|
action_plans_collection = ActionPlanCollection.convert_with_links(
|
|
action_plans, limit, url=resource_url, expand=expand,
|
|
sort_key=sort_key, sort_dir=sort_dir)
|
|
|
|
if need_api_sort:
|
|
api_utils.make_api_sort(action_plans_collection.action_plans,
|
|
sort_key, sort_dir)
|
|
|
|
return action_plans_collection
|
|
|
|
@wsme_pecan.wsexpose(ActionPlanCollection, types.uuid, int, wtypes.text,
|
|
wtypes.text, types.uuid, wtypes.text)
|
|
def get_all(self, marker=None, limit=None,
|
|
sort_key='id', sort_dir='asc', audit_uuid=None, strategy=None):
|
|
"""Retrieve a list of action plans.
|
|
|
|
:param marker: pagination marker for large data sets.
|
|
:param limit: maximum number of resources to return in a single result.
|
|
:param sort_key: column to sort results by. Default: id.
|
|
:param sort_dir: direction to sort. "asc" or "desc". Default: asc.
|
|
:param audit_uuid: Optional UUID of an audit, to get only actions
|
|
for that audit.
|
|
:param strategy: strategy UUID or name to filter by
|
|
"""
|
|
context = pecan.request.context
|
|
policy.enforce(context, 'action_plan:get_all',
|
|
action='action_plan:get_all')
|
|
|
|
return self._get_action_plans_collection(
|
|
marker, limit, sort_key, sort_dir,
|
|
audit_uuid=audit_uuid, strategy=strategy)
|
|
|
|
@wsme_pecan.wsexpose(ActionPlanCollection, types.uuid, int, wtypes.text,
|
|
wtypes.text, types.uuid, wtypes.text)
|
|
def detail(self, marker=None, limit=None,
|
|
sort_key='id', sort_dir='asc', audit_uuid=None, strategy=None):
|
|
"""Retrieve a list of action_plans with detail.
|
|
|
|
:param marker: pagination marker for large data sets.
|
|
:param limit: maximum number of resources to return in a single result.
|
|
:param sort_key: column to sort results by. Default: id.
|
|
:param sort_dir: direction to sort. "asc" or "desc". Default: asc.
|
|
:param audit_uuid: Optional UUID of an audit, to get only actions
|
|
for that audit.
|
|
:param strategy: strategy UUID or name to filter by
|
|
"""
|
|
context = pecan.request.context
|
|
policy.enforce(context, 'action_plan:detail',
|
|
action='action_plan:detail')
|
|
|
|
# NOTE(lucasagomes): /detail should only work agaist collections
|
|
parent = pecan.request.path.split('/')[:-1][-1]
|
|
if parent != "action_plans":
|
|
raise exception.HTTPNotFound
|
|
|
|
expand = True
|
|
resource_url = '/'.join(['action_plans', 'detail'])
|
|
return self._get_action_plans_collection(
|
|
marker, limit, sort_key, sort_dir, expand,
|
|
resource_url, audit_uuid=audit_uuid, strategy=strategy)
|
|
|
|
@wsme_pecan.wsexpose(ActionPlan, types.uuid)
|
|
def get_one(self, action_plan_uuid):
|
|
"""Retrieve information about the given action plan.
|
|
|
|
:param action_plan_uuid: UUID of a action plan.
|
|
"""
|
|
if self.from_actionsPlans:
|
|
raise exception.OperationNotPermitted
|
|
|
|
context = pecan.request.context
|
|
action_plan = api_utils.get_resource('ActionPlan', action_plan_uuid)
|
|
policy.enforce(
|
|
context, 'action_plan:get', action_plan, action='action_plan:get')
|
|
|
|
return ActionPlan.convert_with_links(action_plan)
|
|
|
|
@wsme_pecan.wsexpose(None, types.uuid, status_code=204)
|
|
def delete(self, action_plan_uuid):
|
|
"""Delete an action plan.
|
|
|
|
:param action_plan_uuid: UUID of a action.
|
|
"""
|
|
context = pecan.request.context
|
|
action_plan = api_utils.get_resource(
|
|
'ActionPlan', action_plan_uuid, eager=True)
|
|
policy.enforce(context, 'action_plan:delete', action_plan,
|
|
action='action_plan:delete')
|
|
|
|
allowed_states = (ap_objects.State.SUCCEEDED,
|
|
ap_objects.State.RECOMMENDED,
|
|
ap_objects.State.FAILED,
|
|
ap_objects.State.SUPERSEDED,
|
|
ap_objects.State.CANCELLED)
|
|
if action_plan.state not in allowed_states:
|
|
raise exception.DeleteError(
|
|
state=action_plan.state)
|
|
|
|
action_plan.soft_delete()
|
|
|
|
@wsme.validate(types.uuid, [ActionPlanPatchType])
|
|
@wsme_pecan.wsexpose(ActionPlan, types.uuid,
|
|
body=[ActionPlanPatchType])
|
|
def patch(self, action_plan_uuid, patch):
|
|
"""Update an existing action plan.
|
|
|
|
:param action_plan_uuid: UUID of a action plan.
|
|
:param patch: a json PATCH document to apply to this action plan.
|
|
"""
|
|
if self.from_actionsPlans:
|
|
raise exception.OperationNotPermitted
|
|
|
|
context = pecan.request.context
|
|
action_plan_to_update = api_utils.get_resource(
|
|
'ActionPlan', action_plan_uuid, eager=True)
|
|
policy.enforce(context, 'action_plan:update', action_plan_to_update,
|
|
action='action_plan:update')
|
|
|
|
try:
|
|
action_plan_dict = action_plan_to_update.as_dict()
|
|
action_plan = ActionPlan(**api_utils.apply_jsonpatch(
|
|
action_plan_dict, patch))
|
|
except api_utils.JSONPATCH_EXCEPTIONS as e:
|
|
raise exception.PatchError(patch=patch, reason=e)
|
|
|
|
launch_action_plan = False
|
|
cancel_action_plan = False
|
|
|
|
# transitions that are allowed via PATCH
|
|
allowed_patch_transitions = [
|
|
(ap_objects.State.RECOMMENDED,
|
|
ap_objects.State.PENDING),
|
|
(ap_objects.State.RECOMMENDED,
|
|
ap_objects.State.CANCELLED),
|
|
(ap_objects.State.ONGOING,
|
|
ap_objects.State.CANCELLING),
|
|
(ap_objects.State.PENDING,
|
|
ap_objects.State.CANCELLED),
|
|
]
|
|
|
|
# todo: improve this in blueprint watcher-api-validation
|
|
if hasattr(action_plan, 'state'):
|
|
transition = (action_plan_to_update.state, action_plan.state)
|
|
if transition not in allowed_patch_transitions:
|
|
error_message = _("State transition not allowed: "
|
|
"(%(initial_state)s -> %(new_state)s)")
|
|
raise exception.PatchError(
|
|
patch=patch,
|
|
reason=error_message % dict(
|
|
initial_state=action_plan_to_update.state,
|
|
new_state=action_plan.state))
|
|
|
|
if action_plan.state == ap_objects.State.PENDING:
|
|
launch_action_plan = True
|
|
if action_plan.state == ap_objects.State.CANCELLED:
|
|
cancel_action_plan = True
|
|
|
|
# Update only the fields that have changed
|
|
for field in objects.ActionPlan.fields:
|
|
try:
|
|
patch_val = getattr(action_plan, field)
|
|
except AttributeError:
|
|
# Ignore fields that aren't exposed in the API
|
|
continue
|
|
if patch_val == wtypes.Unset:
|
|
patch_val = None
|
|
if action_plan_to_update[field] != patch_val:
|
|
action_plan_to_update[field] = patch_val
|
|
|
|
if (field == 'state' and
|
|
patch_val == objects.action_plan.State.PENDING):
|
|
launch_action_plan = True
|
|
|
|
action_plan_to_update.save()
|
|
|
|
# NOTE: if action plan is cancelled from pending or recommended
|
|
# state update action state here only
|
|
if cancel_action_plan:
|
|
filters = {'action_plan_uuid': action_plan.uuid}
|
|
actions = objects.Action.list(pecan.request.context,
|
|
filters=filters, eager=True)
|
|
for a in actions:
|
|
a.state = objects.action.State.CANCELLED
|
|
a.save()
|
|
|
|
if launch_action_plan:
|
|
self.applier_client.launch_action_plan(pecan.request.context,
|
|
action_plan.uuid)
|
|
|
|
action_plan_to_update = objects.ActionPlan.get_by_uuid(
|
|
pecan.request.context,
|
|
action_plan_uuid)
|
|
return ActionPlan.convert_with_links(action_plan_to_update)
|
|
|
|
@wsme_pecan.wsexpose(ActionPlan, types.uuid)
|
|
def start(self, action_plan_uuid, **kwargs):
|
|
"""Start an action_plan
|
|
|
|
:param action_plan_uuid: UUID of an action_plan.
|
|
"""
|
|
|
|
action_plan_to_start = api_utils.get_resource(
|
|
'ActionPlan', action_plan_uuid, eager=True)
|
|
context = pecan.request.context
|
|
|
|
policy.enforce(context, 'action_plan:start', action_plan_to_start,
|
|
action='action_plan:start')
|
|
|
|
if action_plan_to_start['state'] != \
|
|
objects.action_plan.State.RECOMMENDED:
|
|
raise exception.StartError(
|
|
state=action_plan_to_start.state)
|
|
|
|
action_plan_to_start['state'] = objects.action_plan.State.PENDING
|
|
action_plan_to_start.save()
|
|
|
|
self.applier_client.launch_action_plan(pecan.request.context,
|
|
action_plan_uuid)
|
|
action_plan_to_start = objects.ActionPlan.get_by_uuid(
|
|
pecan.request.context, action_plan_uuid)
|
|
|
|
return ActionPlan.convert_with_links(action_plan_to_start)
|