mirror of
https://github.com/ansible/awx.git
synced 2026-03-04 02:01:01 -03:30
271383d018
* Add dispatcherctl command * Add tests for dispatcherctl command * Exit early if sqlite3 * Switch to dispatcherd mgmt cmd * Move unwanted command options to run_dispatcher * Add test for new stuff * Update the SOS report status command * make docs always reference new command * Consistently error if given config file
89 lines
3.5 KiB
Python
89 lines
3.5 KiB
Python
import argparse
|
|
import inspect
|
|
import logging
|
|
import os
|
|
import sys
|
|
|
|
import yaml
|
|
|
|
from django.core.management.base import BaseCommand, CommandError
|
|
from django.db import connection
|
|
|
|
from dispatcherd.cli import (
|
|
CONTROL_ARG_SCHEMAS,
|
|
DEFAULT_CONFIG_FILE,
|
|
_base_cli_parent,
|
|
_control_common_parent,
|
|
_register_control_arguments,
|
|
_build_command_data_from_args,
|
|
)
|
|
from dispatcherd.config import setup as dispatcher_setup
|
|
from dispatcherd.factories import get_control_from_settings
|
|
from dispatcherd.service import control_tasks
|
|
|
|
from awx.main.dispatch.config import get_dispatcherd_config
|
|
from awx.main.management.commands.dispatcherd import ensure_no_dispatcherd_env_config
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
class Command(BaseCommand):
|
|
help = 'Dispatcher control operations'
|
|
|
|
def add_arguments(self, parser):
|
|
parser.description = 'Run dispatcherd control commands using awx-manage.'
|
|
base_parent = _base_cli_parent()
|
|
control_parent = _control_common_parent()
|
|
parser._add_container_actions(base_parent)
|
|
parser._add_container_actions(control_parent)
|
|
|
|
subparsers = parser.add_subparsers(dest='command', metavar='command')
|
|
subparsers.required = True
|
|
shared_parents = [base_parent, control_parent]
|
|
for command in control_tasks.__all__:
|
|
func = getattr(control_tasks, command, None)
|
|
doc = inspect.getdoc(func) or ''
|
|
summary = doc.splitlines()[0] if doc else None
|
|
command_parser = subparsers.add_parser(
|
|
command,
|
|
help=summary,
|
|
description=doc,
|
|
parents=shared_parents,
|
|
)
|
|
_register_control_arguments(command_parser, CONTROL_ARG_SCHEMAS.get(command))
|
|
|
|
def handle(self, *args, **options):
|
|
command = options.pop('command', None)
|
|
if not command:
|
|
raise CommandError('No dispatcher control command specified')
|
|
|
|
for django_opt in ('verbosity', 'traceback', 'no_color', 'force_color', 'skip_checks'):
|
|
options.pop(django_opt, None)
|
|
|
|
log_level = options.pop('log_level', 'DEBUG')
|
|
config_path = os.path.abspath(options.pop('config', DEFAULT_CONFIG_FILE))
|
|
expected_replies = options.pop('expected_replies', 1)
|
|
|
|
logging.basicConfig(level=getattr(logging, log_level), stream=sys.stdout)
|
|
logger.debug(f"Configured standard out logging at {log_level} level")
|
|
|
|
default_config = os.path.abspath(DEFAULT_CONFIG_FILE)
|
|
ensure_no_dispatcherd_env_config()
|
|
if config_path != default_config:
|
|
raise CommandError('The config path CLI option is not allowed for the awx-manage command')
|
|
if connection.vendor == 'sqlite':
|
|
raise CommandError('dispatcherctl is not supported with sqlite3; use a PostgreSQL database')
|
|
else:
|
|
logger.info('Using config generated from awx.main.dispatch.config.get_dispatcherd_config')
|
|
dispatcher_setup(get_dispatcherd_config())
|
|
|
|
schema_namespace = argparse.Namespace(**options)
|
|
data = _build_command_data_from_args(schema_namespace, command)
|
|
|
|
ctl = get_control_from_settings()
|
|
returned = ctl.control_with_reply(command, data=data, expected_replies=expected_replies)
|
|
self.stdout.write(yaml.dump(returned, default_flow_style=False))
|
|
if len(returned) < expected_replies:
|
|
logger.error(f'Obtained only {len(returned)} of {expected_replies}, exiting with non-zero code')
|
|
raise CommandError('dispatcherctl returned fewer replies than expected')
|