164 lines
5.0 KiB
Python
164 lines
5.0 KiB
Python
# Copyright 2015 - Alcatel-lucent, Inc.
|
|
#
|
|
# 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.
|
|
|
|
import datetime
|
|
import traceback
|
|
|
|
from oslo_config import cfg
|
|
from oslo_log import log as logging
|
|
from oslo_service import periodic_task
|
|
from oslo_service import threadgroup
|
|
|
|
from mistral import context as auth_ctx
|
|
from mistral.db.v2 import api as db_api
|
|
from mistral.workflow import states
|
|
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
CONF = cfg.CONF
|
|
|
|
|
|
class ExecutionExpirationPolicy(periodic_task.PeriodicTasks):
|
|
"""Expiration Policy task.
|
|
|
|
This task will run every 'evaluation_interval' and will remove old
|
|
executions (expired execution). The time interval is configurable
|
|
In the 'mistral.cfg' and also the expiration time (both in minutes).
|
|
By default the interval set to 'None' so this task will be disabled.
|
|
"""
|
|
|
|
def __init__(self, conf):
|
|
super(ExecutionExpirationPolicy, self).__init__(conf)
|
|
|
|
interval = CONF.execution_expiration_policy.evaluation_interval
|
|
ot = CONF.execution_expiration_policy.older_than
|
|
mfe = CONF.execution_expiration_policy.max_finished_executions
|
|
|
|
if interval and ((ot and ot >= 1) or (mfe and mfe >= 1)):
|
|
_periodic_task = periodic_task.periodic_task(
|
|
spacing=interval * 60,
|
|
run_immediately=True
|
|
|
|
)
|
|
self.add_periodic_task(
|
|
_periodic_task(run_execution_expiration_policy)
|
|
)
|
|
else:
|
|
LOG.debug("Expiration policy disabled. Evaluation_interval "
|
|
"is not configured or both older_than and "
|
|
"max_finished_executions < '1'.")
|
|
|
|
|
|
def _delete_executions(batch_size, expiration_time,
|
|
max_finished_executions):
|
|
_delete_until_depleted(
|
|
lambda: db_api.get_expired_executions(
|
|
expiration_time,
|
|
batch_size
|
|
)
|
|
)
|
|
_delete_until_depleted(
|
|
lambda: db_api.get_superfluous_executions(
|
|
max_finished_executions,
|
|
batch_size
|
|
)
|
|
)
|
|
|
|
|
|
def _delete_until_depleted(fetch_func):
|
|
while True:
|
|
with db_api.transaction():
|
|
execs = fetch_func()
|
|
if not execs:
|
|
break
|
|
_delete(execs)
|
|
|
|
|
|
def _delete(executions):
|
|
for execution in executions:
|
|
try:
|
|
# Setup project_id for _secure_query delete execution.
|
|
# TODO(tuan_luong): Manipulation with auth_ctx should be
|
|
# out of db transaction scope.
|
|
ctx = auth_ctx.MistralContext(
|
|
user_id=None,
|
|
project_id=execution.project_id,
|
|
auth_token=None,
|
|
is_admin=True
|
|
)
|
|
auth_ctx.set_ctx(ctx)
|
|
|
|
LOG.debug(
|
|
'Delete execution id : %s from date : %s '
|
|
'according to expiration policy',
|
|
execution.id,
|
|
execution.updated_at
|
|
)
|
|
db_api.delete_workflow_execution(execution.id)
|
|
except Exception as e:
|
|
msg = ("Failed to delete [execution_id=%s]\n %s"
|
|
% (execution.id, traceback.format_exc(e)))
|
|
LOG.warning(msg)
|
|
finally:
|
|
auth_ctx.set_ctx(None)
|
|
|
|
|
|
def run_execution_expiration_policy(self, ctx):
|
|
LOG.debug("Starting expiration policy.")
|
|
|
|
older_than = CONF.execution_expiration_policy.older_than
|
|
exp_time = (datetime.datetime.utcnow()
|
|
- datetime.timedelta(minutes=older_than))
|
|
|
|
batch_size = CONF.execution_expiration_policy.batch_size
|
|
max_executions = CONF.execution_expiration_policy.max_finished_executions
|
|
|
|
# The default value of batch size is 0
|
|
# If it is not set, size of batch will be the size
|
|
# of total number of expired executions.
|
|
_delete_executions(batch_size, exp_time, max_executions)
|
|
|
|
|
|
def _check_ignored_states_config():
|
|
ignored_states = CONF.execution_expiration_policy.ignored_states
|
|
|
|
for state in ignored_states:
|
|
if state not in states.TERMINAL_STATES:
|
|
raise ValueError(
|
|
'{} is not a terminal state. The valid states are [{}]'
|
|
.format(state, states.TERMINAL_STATES))
|
|
|
|
|
|
def setup():
|
|
tg = threadgroup.ThreadGroup()
|
|
pt = ExecutionExpirationPolicy(CONF)
|
|
|
|
_check_ignored_states_config()
|
|
|
|
ctx = auth_ctx.MistralContext(
|
|
user_id=None,
|
|
project_id=None,
|
|
auth_token=None,
|
|
is_admin=True
|
|
)
|
|
|
|
tg.add_dynamic_timer(
|
|
pt.run_periodic_tasks,
|
|
initial_delay=None,
|
|
periodic_interval_max=1,
|
|
context=ctx
|
|
)
|
|
|
|
return tg
|