246 lines
7.4 KiB
Python
246 lines
7.4 KiB
Python
#!/usr/bin/env 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 karbor management.
|
|
"""
|
|
|
|
from __future__ import print_function
|
|
|
|
|
|
import os
|
|
import sys
|
|
|
|
from oslo_config import cfg
|
|
from oslo_db.sqlalchemy import migration
|
|
from oslo_log import log as logging
|
|
|
|
from karbor import i18n
|
|
i18n.enable_lazy()
|
|
|
|
# Need to register global_opts
|
|
from karbor.common import config # noqa
|
|
from karbor import context
|
|
from karbor import db
|
|
from karbor.db import migration as db_migration
|
|
from karbor.db.sqlalchemy import api as db_api
|
|
from karbor.i18n import _
|
|
from karbor import objects
|
|
from karbor import utils
|
|
from karbor import version
|
|
|
|
|
|
CONF = cfg.CONF
|
|
|
|
|
|
# Decorators for actions
|
|
def args(*args, **kwargs):
|
|
def _decorator(func):
|
|
func.__dict__.setdefault('args', []).insert(0, (args, kwargs))
|
|
return func
|
|
return _decorator
|
|
|
|
|
|
class DbCommands(object):
|
|
"""Class for managing the database."""
|
|
|
|
def __init__(self):
|
|
pass
|
|
|
|
@args('version', nargs='?', default=None,
|
|
help='Database version')
|
|
def sync(self, version=None):
|
|
"""Sync the database up to the most recent version."""
|
|
return db_migration.db_sync(version)
|
|
|
|
def version(self):
|
|
"""Print the current database version."""
|
|
print(db_migration.MIGRATE_REPO_PATH)
|
|
print(migration.db_version(db_api.get_engine(),
|
|
db_migration.MIGRATE_REPO_PATH,
|
|
db_migration.INIT_VERSION))
|
|
|
|
|
|
class VersionCommands(object):
|
|
"""Class for exposing the codebase version."""
|
|
|
|
def __init__(self):
|
|
pass
|
|
|
|
def list(self):
|
|
print(version.version_string())
|
|
|
|
def __call__(self):
|
|
self.list()
|
|
|
|
|
|
class ConfigCommands(object):
|
|
"""Class for exposing the flags defined by flag_file(s)."""
|
|
|
|
def __init__(self):
|
|
pass
|
|
|
|
@args('param', nargs='?', default=None,
|
|
help='Configuration parameter to display (default: %(default)s)')
|
|
def list(self, param=None):
|
|
"""List parameters configured for karbor.
|
|
|
|
Lists all parameters configured for karbor unless an optional argument
|
|
is specified. If the parameter is specified we only print the
|
|
requested parameter. If the parameter is not found an appropriate
|
|
error is produced by .get*().
|
|
"""
|
|
param = param and param.strip()
|
|
if param:
|
|
print('%s = %s' % (param, CONF.get(param)))
|
|
else:
|
|
for key, value in CONF.items():
|
|
print('%s = %s' % (key, value))
|
|
|
|
|
|
class ServiceCommands(object):
|
|
"""Methods for managing services."""
|
|
def list(self):
|
|
"""Show a list of all karbor services."""
|
|
|
|
ctxt = context.get_admin_context()
|
|
services = db.service_get_all(ctxt)
|
|
print_format = "%-16s %-36s %-10s %-5s %-10s"
|
|
print(print_format % (_('Binary'),
|
|
_('Host'),
|
|
_('Status'),
|
|
_('State'),
|
|
_('Updated At')))
|
|
for svc in services:
|
|
alive = utils.service_is_up(svc)
|
|
art = ":-)" if alive else "XXX"
|
|
status = 'enabled'
|
|
if svc['disabled']:
|
|
status = 'disabled'
|
|
print(print_format % (svc['binary'], svc['host'].partition('.')[0],
|
|
status, art,
|
|
svc['updated_at']))
|
|
|
|
|
|
CATEGORIES = {
|
|
'config': ConfigCommands,
|
|
'db': DbCommands,
|
|
'service': ServiceCommands,
|
|
'version': VersionCommands,
|
|
}
|
|
|
|
|
|
def methods_of(obj):
|
|
"""Return non-private methods from an object.
|
|
|
|
Get all callable methods of an object that don't start with underscore
|
|
:return: a list of tuples of the form (method_name, method)
|
|
"""
|
|
result = []
|
|
for i in dir(obj):
|
|
if callable(getattr(obj, i)) and not i.startswith('_'):
|
|
result.append((i, getattr(obj, i)))
|
|
return result
|
|
|
|
|
|
def add_command_parsers(subparsers):
|
|
for category in CATEGORIES:
|
|
command_object = CATEGORIES[category]()
|
|
|
|
parser = subparsers.add_parser(category)
|
|
parser.set_defaults(command_object=command_object)
|
|
|
|
category_subparsers = parser.add_subparsers(dest='action')
|
|
|
|
for (action, action_fn) in methods_of(command_object):
|
|
parser = category_subparsers.add_parser(action)
|
|
|
|
action_kwargs = []
|
|
for args, kwargs in getattr(action_fn, 'args', []):
|
|
parser.add_argument(*args, **kwargs)
|
|
|
|
parser.set_defaults(action_fn=action_fn)
|
|
parser.set_defaults(action_kwargs=action_kwargs)
|
|
|
|
|
|
category_opt = cfg.SubCommandOpt('category',
|
|
title='Command categories',
|
|
handler=add_command_parsers)
|
|
|
|
|
|
def get_arg_string(args):
|
|
arg = None
|
|
if args[0] == '-':
|
|
# (Note)zhiteng: args starts with FLAGS.oparser.prefix_chars
|
|
# is optional args. Notice that cfg module takes care of
|
|
# actual ArgParser so prefix_chars is always '-'.
|
|
if args[1] == '-':
|
|
# This is long optional arg
|
|
arg = args[2:]
|
|
else:
|
|
arg = args[1:]
|
|
else:
|
|
arg = args
|
|
|
|
return arg
|
|
|
|
|
|
def fetch_func_args(func):
|
|
fn_args = []
|
|
for args, kwargs in getattr(func, 'args', []):
|
|
arg = get_arg_string(args[0])
|
|
fn_args.append(getattr(CONF.category, arg))
|
|
|
|
return fn_args
|
|
|
|
|
|
def main():
|
|
"""Parse options and call the appropriate class/method."""
|
|
objects.register_all()
|
|
CONF.register_cli_opt(category_opt)
|
|
script_name = sys.argv[0]
|
|
if len(sys.argv) < 2:
|
|
print(_("\nOpenStack Karbor version: %(version)s\n") %
|
|
{'version': version.version_string()})
|
|
print(script_name + " category action [<args>]")
|
|
print(_("Available categories:"))
|
|
for category in CATEGORIES:
|
|
print(_("\t%s") % category)
|
|
sys.exit(2)
|
|
|
|
try:
|
|
CONF(sys.argv[1:], project='karbor',
|
|
version=version.version_string())
|
|
logging.setup(CONF, "karbor")
|
|
except cfg.ConfigDirNotFoundError as details:
|
|
print(_("Invalid directory: %s") % details)
|
|
sys.exit(2)
|
|
except cfg.ConfigFilesNotFoundError:
|
|
cfgfile = CONF.config_file[-1] if CONF.config_file else None
|
|
if cfgfile and not os.access(cfgfile, os.R_OK):
|
|
st = os.stat(cfgfile)
|
|
print(_("Could not read %s, Please try running this"
|
|
"command again as root/Administrator privilege"
|
|
"using sudo.") % cfgfile)
|
|
try:
|
|
os.execvp('sudo', ['sudo', '-u', '#%s' % st.st_uid] + sys.argv)
|
|
except Exception:
|
|
print(_('sudo failed, continuing as if nothing happened'))
|
|
|
|
print(_('Please re-run karbor-manage as root.'))
|
|
sys.exit(2)
|
|
|
|
fn = CONF.category.action_fn
|
|
fn_args = fetch_func_args(fn)
|
|
fn(*fn_args)
|