def _run_and_log_error_if_fails(remote, args):
+ """
+ Yet another wrapper around command execution. This one runs a command on
+ the given remote, then, if execution fails, logs the error and re-raises.
+
+ :param: remote -- the teuthology.orchestra.remote.Remote object
+ :param: args -- list of arguments comprising the command the be executed
+ :returns: None
+ :raises: CommandFailedError
+ """
response = StringIO()
try:
remote.run(
def _get_config_value_for_remote(ctx, remote, config, key):
- # This function was written to figure out which branch should be used for a
- # given remote. 'all' overrides any applicable roles.
-
+ """
+ Look through config, and attempt to determine the "best" value to use for a
+ given key. For example, given:
+
+ config = {
+ 'all':
+ {'branch': 'master'},
+ 'branch': 'next'
+ }
+ _get_config_value_for_remote(ctx, remote, config, 'branch')
+
+ would return 'master'.
+
+ :param: ctx -- the argparse.Namespace object
+ :param: remote -- the teuthology.orchestra.remote.Remote object
+ :param: config -- the config dict
+ :param: key -- the name of the value to retrieve
+ """
roles = ctx.cluster.remotes[remote]
if 'all' in config:
return config['all'].get(key)
def _get_baseurlinfo_and_dist(ctx, remote, config):
- # XXX CLEANUP
- # This helper function is in *dire* need of cleaning up What is `relval`?
- # Why so many `dist_` prepending keys?
- # The below list is an unfortunate usage of variables that confuse and make
- # it harder to read/understand/improve anything here:
- # dist, distro, distro_release, dist_release, dist_name, distri
+ """
+ Through various commands executed on the remote, determines the
+ distribution name and version in use, as well as the portion of the repo
+ URI to use to specify which version of the project (normally ceph) to
+ install.Example:
+
+ {'arch': 'x86_64',
+ 'dist': 'raring',
+ 'dist_release': None,
+ 'distro': 'Ubuntu',
+ 'distro_release': None,
+ 'flavor': 'basic',
+ 'relval': '13.04',
+ 'uri': 'ref/master'}
+
+ :param: ctx -- the argparse.Namespace object
+ :param: remote -- the teuthology.orchestra.remote.Remote object
+ :param: config -- the config dict
+ :returns: dict -- the information you want.
+ """
retval = {}
relval = None
r = remote.run(
def _get_baseurl(ctx, remote, config):
+ """
+ Figures out which package repo base URL to use.
+
+ Example:
+ 'http://gitbuilder.ceph.com/ceph-deb-raring-x86_64-basic/ref/master'
+ :param: ctx -- the argparse.Namespace object
+ :param: remote -- the teuthology.orchestra.remote.Remote object
+ :param: config -- the config dict
+ :returns: str -- the URL
+ """
# get distro name and arch
baseparms = _get_baseurlinfo_and_dist(ctx, remote, config)
base_url = 'http://{host}/{proj}-{pkg_type}-{dist}-{arch}-{flavor}/{uri}'.format(
"""
Look for, and parse, a file called 'version' in base_url.
- wait -- wait forever for the file to show up. (default False)
+ :param: remote -- the teuthology.orchestra.remote.Remote object
+ :param: wait -- wait forever for the file to show up. (default False)
+ :returns: str -- the version e.g. '0.67-240-g67a95b9-1raring'
+ :raises: VersionNotFoundError
"""
while True:
r = remote.run(
def _update_deb_package_list_and_install(ctx, remote, debs, config):
"""
- updates the package list so that apt-get can
- download the appropriate packages
+ Runs ``apt-get update`` first, then runs ``apt-get install``, installing
+ the requested packages on the remote system.
+
+ TODO: split this into at least two functions.
+
+ :param: ctx -- the argparse.Namespace object
+ :param: remote -- the teuthology.orchestra.remote.Remote object
+ :param: debs -- list of packages names to install
+ :param: config -- the config dict
"""
# check for ceph release key
log.info('Pulling from %s', base_url)
# get package version string
+ # FIXME this is a terrible hack.
while True:
r = remote.run(
args=[
def _yum_fix_repo_priority(remote, project):
+ """
+ On the remote, 'priority=1' lines to each enabled repo in:
+
+ /etc/yum.repos.d/{project}.repo
+
+ :param: remote -- the teuthology.orchestra.remote.Remote object
+ :param: project -- the project whose repos need modification
+ """
remote.run(
args=[
'sudo',
def _update_rpm_package_list_and_install(ctx, remote, rpm, config):
+ """
+ Installs the ceph-release package for the relevant branch, then installs
+ the requested packages on the remote system.
+
+ TODO: split this into at least two functions.
+
+ :param: ctx -- the argparse.Namespace object
+ :param: remote -- the teuthology.orchestra.remote.Remote object
+ :param: rpm -- list of packages names to install
+ :param: config -- the config dict
+ """
baseparms = _get_baseurlinfo_and_dist(ctx, remote, config)
log.info("Installing packages: {pkglist} on remote rpm {arch}".format(
pkglist=", ".join(rpm), arch=baseparms['arch']))
def purge_data(ctx):
"""
- Purge /var/lib/ceph
+ Purge /var/lib/ceph on every remote in ctx.
+
+ :param: ctx -- the argparse.Namespace object
"""
with parallel() as p:
for remote in ctx.cluster.remotes.iterkeys():
def _purge_data(remote):
+ """
+ Purge /var/lib/ceph on remote.
+
+ :param: remote -- the teuthology.orchestra.remote.Remote object
+ """
log.info('Purging /var/lib/ceph on %s', remote)
remote.run(args=[
'sudo',
def install_packages(ctx, pkgs, config):
"""
- installs Debian packages.
+ Installs packages on each remote in ctx.
+
+ :param: ctx -- the argparse.Namespace object
+ :param: pkgs -- list of packages names to install
+ :param: config -- the config dict
"""
install_pkgs = {
"deb": _update_deb_package_list_and_install,
def _remove_deb(ctx, config, remote, debs):
+ """
+ Removes Debian packages from remote, rudely
+
+ TODO: be less rude (e.g. using --force-yes)
+
+ :param: ctx -- the argparse.Namespace object
+ :param: config -- the config dict
+ :param: remote -- the teuthology.orchestra.remote.Remote object
+ :param: debs -- list of packages names to install
+ """
log.info("Removing packages: {pkglist} on Debian system.".format(
pkglist=", ".join(debs)))
# first ask nicely
def _remove_rpm(ctx, config, remote, rpm):
+ """
+ Removes RPM packages from remote
+
+ :param: ctx -- the argparse.Namespace object
+ :param: config -- the config dict
+ :param: remote -- the teuthology.orchestra.remote.Remote object
+ :param: rpm -- list of packages names to remove
+ """
log.info("Removing packages: {pkglist} on rpm system.".format(
pkglist=", ".join(rpm)))
baseparms = _get_baseurlinfo_and_dist(ctx, remote, config)
def remove_packages(ctx, config, pkgs):
+ """
+ Removes packages from each remote in ctx.
+
+ :param: ctx -- the argparse.Namespace object
+ :param: config -- the config dict
+ :param: pkgs -- list of packages names to remove
+ """
remove_pkgs = {
"deb": _remove_deb,
"rpm": _remove_rpm,
def _remove_sources_list_deb(remote, proj):
+ """
+ Removes /etc/apt/sources.list.d/{proj}.list and then runs ``apt-get
+ update``.
+
+ :param: remote -- the teuthology.orchestra.remote.Remote object
+ :param: proj -- the project whose sources.list needs removing
+ """
remote.run(
args=[
'sudo', 'rm', '-f', '/etc/apt/sources.list.d/{proj}.list'.format(proj=proj),
def _remove_sources_list_rpm(remote, proj):
+ """
+ Removes /etc/yum.repos.d/{proj}.repo, /var/lib/{proj}, and /var/log/{proj}.
+
+ :param: remote -- the teuthology.orchestra.remote.Remote object
+ :param: proj -- the project whose sources.list needs removing
+ """
remote.run(
args=[
'sudo', 'rm', '-f', '/etc/yum.repos.d/{proj}.repo'.format(proj=proj),
],
stdout=StringIO(),
)
- # There probably should be a way of removing these files that is implemented in the yum/rpm
- # remove procedures for the ceph package.
+ # FIXME
+ # There probably should be a way of removing these files that is
+ # implemented in the yum/rpm remove procedures for the ceph package.
+ # FIXME but why is this function doing these things?
remote.run(
args=[
'sudo', 'rm', '-fr', '/var/lib/{proj}'.format(proj=proj),
def remove_sources(ctx, config):
+ """
+ Removes repo source files from each remote in ctx.
+
+ :param: ctx -- the argparse.Namespace object
+ :param: config -- the config dict
+ """
remove_sources_pkgs = {
'deb': _remove_sources_list_deb,
'rpm': _remove_sources_list_rpm,
@contextlib.contextmanager
def install(ctx, config):
+ """
+ The install task. Installs packages for a given project on all hosts in
+ ctx. May work for projects besides ceph, but may not. Patches welcomed!
+
+ :param: ctx -- the argparse.Namespace object
+ :param: config -- the config dict
+ """
project = config.get('project', 'ceph')
def _upgrade_deb_packages(ctx, config, remote, debs):
"""
- upgrade all packages
+ Upgrade project's packages on remote Debian host
+ Before doing so, installs the project's GPG key, writes a sources.list
+ file, and runs ``apt-get update``.
+
+ :param: ctx -- the argparse.Namespace object
+ :param: config -- the config dict
+ :param: remote -- the teuthology.orchestra.remote.Remote object
+ :param: debs -- the Debian packages to be installed
+ :param: branch -- the branch of the project to be used
"""
# check for ceph release key
r = remote.run(
def _upgrade_rpm_packages(ctx, config, remote, pkgs):
"""
- Upgrade RPM packages.
+ Upgrade project's packages on remote RPM-based host
+ Before doing so, it makes sure the project's -release RPM is installed -
+ removing any previous version first.
+
+ :param: ctx -- the argparse.Namespace object
+ :param: config -- the config dict
+ :param: remote -- the teuthology.orchestra.remote.Remote object
+ :param: pkgs -- the RPM packages to be installed
+ :param: branch -- the branch of the project to be used
"""
distinfo = _get_baseurlinfo_and_dist(ctx, remote, config)
log.info(
@contextlib.contextmanager
def upgrade(ctx, config):
"""
- upgrades project debian packages.
+ Upgrades packages for a given project.
For example::
tasks:
- install.upgrade:
all:
+ :param: ctx -- the argparse.Namespace object
+ :param: config -- the config dict
"""
assert config is None or isinstance(config, dict), \
"install.upgrade only supports a dictionary for configuration"
@contextlib.contextmanager
def task(ctx, config):
"""
- Install packages
+ Install packages for a given project.
tasks:
- install:
ceph:
sha1: ...
+ :param: ctx -- the argparse.Namespace object
+ :param: config -- the config dict
"""
if config is None:
config = {}
projects / teuthology.git / commitdiff