distcloud/distributedcloud/dcorch/cmd/manage.py
Tee Ngo 7f156476f9 Prevent unlimited growth of dcorch database
In this commit:
  - completed orch request is soft deleted right away.
  - failed orch requests that have not been soft deleted
    are soft deleted at the end of the next audit cycle.
  - prior to a sync run, if the managed subcloud has any
    queued, in-progress, and/or failed requests, its
    sync status will be set to out-of-sync.
  - a cron job that runs 20 minutes in the first hour
    daily (another commit in stx-puppet repo) will purge
    all soft deleted orch requests that are 3 days old,
    their orch jobs and resources.

Tests:
  - Identity and platform config changes with and
    without proxy.
  - Database inspection after config changes and after
    soak.
  - Purge of large number of orch requests, orch jobs
    and resources.

Story: 2007267
Task: 39044
Change-Id: If5c75b9af3e1e20c010308919cb6be8f11575546
Signed-off-by: Tee Ngo <tee.ngo@windriver.com>
2020-04-30 10:55:12 -04:00

97 lines
2.8 KiB
Python

# 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.
"""
CLI interface for dc-dcorch management.
"""
import sys
from oslo_config import cfg
from oslo_log import log as logging
from dcorch.common import config
from dcorch.common import context
from dcorch.common.i18n import _
from dcorch.db import api
from dcorch import version
config.register_options()
CONF = cfg.CONF
def do_db_version():
"""Print database's current migration level."""
print(api.db_version(api.get_engine()))
def do_db_sync():
"""Place a database under migration control and upgrade.
DB is created first if necessary.
"""
api.db_sync(api.get_engine(), CONF.command.version)
def do_db_clean():
"""Purge deleted orch requests, related jobs and resources."""
age_in_days = CONF.command.age_in_days
if age_in_days < 0:
sys.exit(_("Must supply a non-negative value for age."))
ctxt = context.get_admin_context()
api.purge_deleted_records(ctxt, age_in_days)
def add_command_parsers(subparsers):
parser = subparsers.add_parser('db_version')
parser.set_defaults(func=do_db_version)
parser = subparsers.add_parser('db_sync')
parser.set_defaults(func=do_db_sync)
parser.add_argument('version', nargs='?')
parser.add_argument('current_version', nargs='?')
parser = subparsers.add_parser('db_clean')
parser.set_defaults(func=do_db_clean)
parser.add_argument('age_in_days', type=int,
default=1)
command_opt = cfg.SubCommandOpt('command',
title='Commands',
help='Show available commands.',
handler=add_command_parsers)
def main():
logging.register_options(CONF)
logging.setup(CONF, 'dcorch-manage')
CONF.register_cli_opt(command_opt)
try:
default_config_files = cfg.find_config_files('dcorch',
'dcorch-engine')
CONF(sys.argv[1:], project='dcorch', prog='dcorch-manage',
version=version.version_info.version_string(),
default_config_files=default_config_files)
except RuntimeError as e:
sys.exit("ERROR: %s" % e)
try:
CONF.command.func()
except Exception as e:
sys.exit("ERROR: %s" % e)
if __name__ == '__main__':
main()