262 lines
9.8 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-02-16 15:17:28 -08:00
import time
2012-02-16 15:02:21 -08:00
from urlparse import urlunparse
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
2012-01-24 18:10:38 -08:00
#id
TYPE = settings.KEYSTONE
2012-02-06 21:12:00 -08:00
LOG = logging.getLogger("devstack.components.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"
2012-02-16 14:42:55 -08:00
CATALOG_CONF = 'default_catalog.templates'
CONFIGS = [ROOT_CONF, CATALOG_CONF]
CFG_SECTION = 'DEFAULT'
2012-01-24 18:03:42 -08:00
#this is a special conf
MANAGE_DATA_CONF = 'keystone_init.sh'
2012-02-16 15:17:28 -08:00
MANAGE_CMD_ROOT = [sh.joinpths("/", "bin", 'bash')]
MANAGE_ADMIN_USER = 'admin'
MANAGE_DEMO_USER = 'demo'
MANAGE_INVIS_USER = 'invisible_to_admin'
2012-01-11 12:47:33 -08:00
#sync db command
MANAGE_APP_NAME = 'keystone-manage'
SYNC_DB_CMD = [sh.joinpths('%BINDIR%', MANAGE_APP_NAME), 'db_sync']
#what to start
2012-02-16 15:02:21 -08:00
APP_NAME = 'keystone-all'
APP_OPTIONS = {
2012-02-16 15:02:21 -08:00
APP_NAME: ['--config-file', sh.joinpths('%ROOT%', CONFIG_DIR, ROOT_CONF),
"--debug", '-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 = ['general.json', 'keystone.json']
2012-02-16 15:17:28 -08:00
#used to wait until started before we can run the data setup script
WAIT_ONLINE_TO = settings.WAIT_ALIVE_SECS
#config keys we warm up so u won't be prompted later
WARMUP_PWS = ['horizon_keystone_admin', 'service_token']
#ec2 rc filename
EC2RC_FN = 'ec2rc'
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)
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):
2012-01-31 22:05:38 -08:00
places = list()
places.append({
2012-01-31 22:05:38 -08:00
'uri': ("git", "keystone_repo"),
'branch': ("git", "keystone_branch"),
})
return places
def _get_pips(self):
2012-01-31 22:05:38 -08:00
return list(REQ_PIPS)
def _get_pkgs(self):
2012-01-31 22:05:38 -08:00
return list(REQ_PKGS)
2012-02-03 00:11:41 -08:00
def _get_symlinks(self):
links = dict()
for fn in self._get_config_files():
source_fn = self._get_target_config_name(fn)
links[source_fn] = sh.joinpths("/", "etc", "keystone", fn)
return links
2012-02-03 00:11:41 -08:00
def post_install(self):
2012-02-04 21:08:20 -08:00
comp.PythonInstallComponent.post_install(self)
2012-01-11 12:47:33 -08:00
self._setup_db()
self._sync_db()
self._setup_initer()
2012-01-11 12:47:33 -08:00
def _sync_db(self):
2012-02-01 14:35:16 -08:00
LOG.info("Syncing keystone to database named %s.", DB_NAME)
params = dict()
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):
2012-01-31 22:05:38 -08:00
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_initer(self):
2012-02-16 16:50:42 -08:00
LOG.info("Configuring keystone initializer template %s.", MANAGE_DATA_CONF)
(_, 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)
sh.chmod(tgt_fn, 0755)
2012-01-11 12:47:33 -08:00
def _config_adjust(self, contents, name):
2012-02-16 15:02:21 -08:00
if name == ROOT_CONF:
#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)
if log_filename:
LOG.info("Ensuring log file %s exists and is empty." % (log_filename))
log_dir = sh.dirname(log_filename)
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 warm_configs(self):
for pw_key in WARMUP_PWS:
self.cfg.get("passwords", pw_key)
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-02-16 15:17:28 -08:00
mp['SERVICE_HOST'] = self.cfg.get('host', 'ip')
mp['DEST'] = self.appdir
mp['BIN_DIR'] = self.bindir
mp['CONFIG_FILE'] = sh.joinpths(self.cfgdir, ROOT_CONF)
2012-01-25 12:59:12 -08:00
if config_fn == ROOT_CONF:
mp['SQL_CONN'] = self.cfg.get_dbdsn(DB_NAME)
mp['KEYSTONE_DIR'] = self.appdir
2012-02-16 14:48:23 -08:00
mp.update(get_shared_params(self.cfg))
2012-01-25 12:59:12 -08:00
elif config_fn == MANAGE_DATA_CONF:
mp['ADMIN_PASSWORD'] = self.cfg.get('passwords', 'horizon_keystone_admin')
mp['ADMIN_USER_NAME'] = self.cfg.getdefaulted("keystone", "admin_user", MANAGE_ADMIN_USER)
mp['DEMO_USER_NAME'] = self.cfg.getdefaulted("keystone", "demo_user", MANAGE_DEMO_USER)
mp['INVIS_USER_NAME'] = self.cfg.getdefaulted("keystone", "invisible_user", MANAGE_INVIS_USER)
mp.update(get_shared_params(self.cfg))
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)
2012-02-16 15:17:28 -08:00
def post_start(self):
tgt_fn = sh.joinpths(self.bindir, MANAGE_DATA_CONF)
if sh.isfile(tgt_fn):
#still there, run it
#these environment additions are important
#in that they eventually affect how this script runs
2012-02-16 16:50:42 -08:00
LOG.info("Waiting %s seconds so that keystone can start up before running first time init." % (WAIT_ONLINE_TO))
2012-02-16 15:17:28 -08:00
time.sleep(WAIT_ONLINE_TO)
env = dict()
env['ENABLED_SERVICES'] = ",".join(self.instances.keys())
env['BIN_DIR'] = self.bindir
setup_cmd = MANAGE_CMD_ROOT + [tgt_fn]
2012-02-16 16:50:42 -08:00
LOG.info("Running (%s) command to initialize keystone." % (" ".join(setup_cmd)))
(sysout, stderr) = sh.execute(*setup_cmd, env_overrides=env, run_as_root=False)
if sysout:
ec2rcfn = self.cfg.getdefaulted("keystone", "ec2_rc_fn", EC2RC_FN)
sh.write_file(ec2rcfn, sysout)
2012-02-16 16:50:42 -08:00
LOG.debug("Removing (%s) file since we successfully initialized keystone." % (tgt_fn))
2012-02-16 15:17:28 -08:00
sh.unlink(tgt_fn)
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.getdefaulted('keystone', 'keystone_auth_host', host_ip)
mp['KEYSTONE_AUTH_HOST'] = keystone_auth_host
2012-02-16 15:02:21 -08:00
keystone_auth_port = config.get('keystone', 'keystone_auth_port')
mp['KEYSTONE_AUTH_PORT'] = keystone_auth_port
keystone_auth_proto = config.get('keystone', 'keystone_auth_protocol')
mp['KEYSTONE_AUTH_PROTOCOL'] = keystone_auth_proto
keystone_service_host = config.getdefaulted('keystone', 'keystone_service_host', host_ip)
mp['KEYSTONE_SERVICE_HOST'] = keystone_service_host
2012-02-16 15:02:21 -08:00
keystone_service_port = config.get('keystone', 'keystone_service_port')
mp['KEYSTONE_SERVICE_PORT'] = keystone_service_port
keystone_service_proto = config.get('keystone', 'keystone_service_protocol')
mp['KEYSTONE_SERVICE_PROTOCOL'] = keystone_service_proto
2012-02-16 15:03:27 -08:00
#TODO is this right???
mp['AUTH_ENDPOINT'] = urlunparse((keystone_auth_proto,
"%s:%s" % (keystone_auth_host, keystone_auth_port),
"v2.0", "", "", ""))
#TODO is this right???
mp['SERVICE_ENDPOINT'] = urlunparse((keystone_service_proto,
"%s:%s" % (keystone_service_host, keystone_service_port),
"v2.0", "", "", ""))
mp['SERVICE_TOKEN'] = config.get("passwords", "service_token")
return mp