241 lines
8.6 KiB
Python
Raw Normal View History

2012-01-11 12:47:33 -08:00
# vim: tabstop=4 shiftwidth=4 softtabstop=4
2012-01-26 12:54:36 -08:00
# Copyright (C) 2012 Yahoo! Inc. All Rights Reserved.
2012-01-11 12:47:33 -08:00
#
# 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 io
2012-01-11 12:47:33 -08:00
from devstack import cfg
from devstack import component as comp
from devstack import log as logging
from devstack import settings
from devstack import shell as sh
from devstack import utils
from devstack.components import db
LOG = logging.getLogger("devstack.components.keystone")
2012-01-24 18:10:38 -08:00
#id
TYPE = settings.KEYSTONE
2012-01-24 18:10:38 -08:00
#this db will be dropped then created
2012-01-24 18:03:42 -08:00
DB_NAME = "keystone"
#subdirs of the git checkout
2012-01-11 12:47:33 -08:00
BIN_DIR = "bin"
CONFIG_DIR = "etc"
2012-01-24 18:03:42 -08:00
#simple confs
ROOT_CONF = "keystone.conf"
CONFIGS = [ROOT_CONF]
CFG_SECTION = 'DEFAULT'
2012-01-24 18:03:42 -08:00
#this is a special conf
MANAGE_DATA_CONF = 'keystone_data.sh'
2012-01-24 18:03:42 -08:00
MANAGER_CMD_ROOT = [sh.joinpths("/", "bin", 'bash')]
2012-01-11 12:47:33 -08:00
#sync db command
SYNC_DB_CMD = [sh.joinpths('%BINDIR%', 'keystone-manage'), 'sync_database']
#what to start
APP_OPTIONS = {
'keystone': ['--config-file', sh.joinpths('%ROOT%', CONFIG_DIR, ROOT_CONF),
2012-01-24 18:03:42 -08:00
"--verbose", '-d',
'--log-config=' + sh.joinpths('%ROOT%', CONFIG_DIR, 'logging.cnf')]
}
#the pkg json files keystone requires for installation
REQ_PKGS = ['general.json', 'keystone.json']
2012-01-31 16:07:40 -08:00
#pip files that keystone requires
REQ_PIPS = ['keystone.json']
class KeystoneUninstaller(comp.PythonUninstallComponent):
2012-01-11 12:47:33 -08:00
def __init__(self, *args, **kargs):
comp.PythonUninstallComponent.__init__(self, TYPE, *args, **kargs)
self.cfgdir = sh.joinpths(self.appdir, CONFIG_DIR)
self.bindir = sh.joinpths(self.appdir, BIN_DIR)
2012-01-11 12:47:33 -08:00
2012-01-13 19:04:26 -08:00
class KeystoneInstaller(comp.PythonInstallComponent):
2012-01-11 12:47:33 -08:00
def __init__(self, *args, **kargs):
comp.PythonInstallComponent.__init__(self, TYPE, *args, **kargs)
2012-01-18 22:54:13 -08:00
self.git_loc = self.cfg.get("git", "keystone_repo")
self.git_branch = self.cfg.get("git", "keystone_branch")
self.cfgdir = sh.joinpths(self.appdir, CONFIG_DIR)
self.bindir = sh.joinpths(self.appdir, BIN_DIR)
2012-01-11 12:47:33 -08:00
def _get_download_locations(self):
places = comp.PythonInstallComponent._get_download_locations(self)
places.append({
2012-01-18 22:54:13 -08:00
'uri': self.git_loc,
'branch': self.git_branch,
})
return places
def _get_pips(self):
pips = comp.PythonInstallComponent._get_pips(self)
for fn in REQ_PIPS:
full_name = sh.joinpths(settings.STACK_PIP_DIR, fn)
pips = utils.extract_pip_list([full_name], self.distro, pips)
return pips
def _get_pkgs(self):
pkgs = comp.PythonInstallComponent._get_pkgs(self)
for fn in REQ_PKGS:
full_name = sh.joinpths(settings.STACK_PKG_DIR, fn)
pkgs = utils.extract_pkg_list([full_name], self.distro, pkgs)
return pkgs
def post_install(self):
parent_result = comp.PythonInstallComponent.post_install(self)
2012-01-11 12:47:33 -08:00
self._setup_db()
self._sync_db()
2012-01-11 12:47:33 -08:00
self._setup_data()
return parent_result
2012-01-11 12:47:33 -08:00
def _sync_db(self):
LOG.info("Syncing keystone to database named %s", DB_NAME)
params = dict()
#it seems like this command only works if fully specified
#probably a bug
params['BINDIR'] = self.bindir
cmds = [{'cmd': SYNC_DB_CMD}]
utils.execute_template(*cmds, cwd=self.bindir, params=params)
def _get_config_files(self):
return list(CONFIGS)
2012-01-11 12:47:33 -08:00
def _setup_db(self):
LOG.info("Fixing up database named %s", DB_NAME)
db.drop_db(self.cfg, DB_NAME)
db.create_db(self.cfg, DB_NAME)
2012-01-11 12:47:33 -08:00
def _setup_data(self):
2012-01-24 22:29:14 -08:00
LOG.info("Configuring data setup template %s", MANAGE_DATA_CONF)
(src_fn, contents) = utils.load_template(self.component_name, MANAGE_DATA_CONF)
params = self._get_param_map(MANAGE_DATA_CONF)
contents = utils.param_replace(contents, params, True)
tgt_fn = sh.joinpths(self.bindir, MANAGE_DATA_CONF)
sh.write_file(tgt_fn, contents)
2012-01-24 18:03:42 -08:00
# This environment additions are important
2012-01-24 22:29:14 -08:00
# in that they eventually affect how this script runs
env = dict()
env['ENABLED_SERVICES'] = ",".join(self.instances.keys())
env['BIN_DIR'] = self.bindir
2012-01-24 18:03:42 -08:00
setup_cmd = MANAGER_CMD_ROOT + [tgt_fn]
LOG.info("Running (%s) command to setup keystone." % (" ".join(setup_cmd)))
sh.execute(*setup_cmd, env_overrides=env)
2012-01-11 12:47:33 -08:00
def _config_adjust(self, contents, name):
2012-01-25 12:59:12 -08:00
if name not in CONFIGS:
return contents
2012-01-18 20:12:04 -08:00
#use config parser and
#then extract known configs that
#will need locations/directories/files made (or touched)...
with io.BytesIO(contents) as stream:
config = cfg.IgnoreMissingConfigParser()
config.readfp(stream)
log_filename = config.get('log_file', CFG_SECTION)
2012-01-25 12:59:12 -08:00
if log_filename:
LOG.info("Ensuring log file %s exists and is empty" % (log_filename))
log_dir = sh.dirname(log_filename)
2012-01-25 12:59:12 -08:00
if log_dir:
LOG.info("Ensuring log directory %s exists" % (log_dir))
self.tracewriter.make_dir(log_dir)
#destroy then recreate it (the log file)
sh.unlink(log_filename)
sh.touch_file(log_filename)
self.tracewriter.file_touched(log_filename)
#we might need to handle more in the future...
#nothing modified so just return the original
return contents
2012-01-11 12:47:33 -08:00
def _get_param_map(self, config_fn):
#these be used to fill in the configuration/cmds +
#params with actual values
2012-01-11 12:47:33 -08:00
mp = dict()
2012-01-25 12:59:12 -08:00
if config_fn == ROOT_CONF:
host_ip = self.cfg.get('host', 'ip')
mp['DEST'] = self.appdir
mp['SQL_CONN'] = self.cfg.get_dbdsn(DB_NAME)
mp['SERVICE_HOST'] = host_ip
mp['ADMIN_HOST'] = host_ip
2012-01-25 12:59:12 -08:00
elif config_fn == MANAGE_DATA_CONF:
host_ip = self.cfg.get('host', 'ip')
mp['ADMIN_PASSWORD'] = self.cfg.get('passwords', 'horizon_keystone_admin')
mp['SERVICE_HOST'] = host_ip
mp.update(get_shared_params(self.cfg))
else:
mp['DEST'] = self.appdir
mp['BIN_DIR'] = self.bindir
mp['CONFIG_FILE'] = sh.joinpths(self.cfgdir, ROOT_CONF)
2012-01-11 12:47:33 -08:00
return mp
class KeystoneRuntime(comp.PythonRuntime):
2012-01-11 12:47:33 -08:00
def __init__(self, *args, **kargs):
comp.PythonRuntime.__init__(self, TYPE, *args, **kargs)
self.cfgdir = sh.joinpths(self.appdir, CONFIG_DIR)
self.bindir = sh.joinpths(self.appdir, BIN_DIR)
def _get_apps_to_start(self):
apps = list()
for app_name in APP_OPTIONS.keys():
apps.append({
'name': app_name,
'path': sh.joinpths(self.bindir, app_name),
})
return apps
def _get_app_options(self, app):
return APP_OPTIONS.get(app)
2012-01-24 18:03:42 -08:00
def get_shared_params(config):
mp = dict()
host_ip = config.get('host', 'ip')
keystone_auth_host = config.get('keystone', 'keystone_auth_host')
2012-01-25 12:59:12 -08:00
if not keystone_auth_host:
keystone_auth_host = host_ip
mp['KEYSTONE_AUTH_HOST'] = keystone_auth_host
mp['KEYSTONE_AUTH_PORT'] = config.get('keystone', 'keystone_auth_port')
mp['KEYSTONE_AUTH_PROTOCOL'] = config.get('keystone', 'keystone_auth_protocol')
keystone_service_host = config.get('keystone', 'keystone_service_host')
2012-01-25 12:59:12 -08:00
if not keystone_service_host:
keystone_service_host = host_ip
mp['KEYSTONE_SERVICE_HOST'] = keystone_service_host
mp['KEYSTONE_SERVICE_PORT'] = config.get('keystone', 'keystone_service_port')
mp['KEYSTONE_SERVICE_PROTOCOL'] = config.get('keystone', 'keystone_service_protocol')
mp['SERVICE_TOKEN'] = config.get("passwords", "service_token")
return mp
def describe(opts=None):
description = """
Module: {module_name}
Description:
{description}
Component options:
{component_opts}
"""
params = dict()
params['component_opts'] = "TBD"
params['module_name'] = __name__
params['description'] = __doc__ or "Handles actions for the keystone component."
out = description.format(**params)
return out.strip("\n")