Plugin to setup libvirt/QEMU from tar releases

This patch enables the devstack installation of custom qemu/libvirt
versions from tar releases.

How to enable the plugin
========================

1 Download devstack::

     git clone https://git.openstack.org/openstack-dev/devstack

2. Add devstack-plugin-tar-installer external repository in the local.conf file::

     > cat local.conf
     [[local|localrc]]
     enable_plugin devstack-tar-installer-plugin git@git.virtualopensystems.com:sesame/devstack-qemu-libvirt-from-tar-plugin.git

3. Configure the plugin by definig these variables in the local.conf file::
     QEMU_VERSION=2.1.5
     LIBVIRT_VERSION=1.2.9

3. run ``stack.sh``

Tested with Ubuntu Trusty, QEMU 2.6.0-rc1 and libvirt 1.2.7

Change-Id: I0bfffe52be66b9da8f878dc8f807faf187cf3217
Signed-off-by: Michele Paolino <m.paolino@virtualopensystems.com>
This commit is contained in:
Michele Paolino 2016-05-06 16:21:11 +02:00
parent d2d9575815
commit 17da674358
25 changed files with 909 additions and 0 deletions

17
CONTRIBUTING.rst Normal file
View File

@ -0,0 +1,17 @@
If you would like to contribute to the development of OpenStack, you must
follow the steps in this page:
http://docs.openstack.org/infra/manual/developers.html
If you already have a good understanding of how the system works and your
OpenStack accounts are set up, you can skip to the development workflow
section of this documentation to learn how changes to OpenStack should be
submitted for review via the Gerrit tool:
http://docs.openstack.org/infra/manual/developers.html#development-workflow
Pull requests submitted through GitHub will be ignored.
Bugs should be filed on Launchpad, not GitHub:
https://bugs.launchpad.net/devstack-plugin-tar-installer

4
HACKING.rst Normal file
View File

@ -0,0 +1,4 @@
devstack-plugin-tar-installer Style Commandments
===============================================
Read the OpenStack Style Commandments http://docs.openstack.org/developer/hacking/

176
LICENSE Normal file
View File

@ -0,0 +1,176 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

6
MANIFEST.in Normal file
View File

@ -0,0 +1,6 @@
include AUTHORS
include ChangeLog
exclude .gitignore
exclude .gitreview
global-exclude *.pyc

83
README.rst Normal file
View File

@ -0,0 +1,83 @@
===============================
devstack-plugin-tar-installer
===============================
By default DevStack installs all the software needed to run OpenStack from the
OS' repository, however sometimes there is a need to test OpenStack against
the latest (or custom) versions of specific software programs (e.g., qemu and
libvirt).
* Free software: Apache license
* Documentation: http://docs.openstack.org/developer/devstack-plugin-tar-installer
* Source: http://git.openstack.org/cgit/openstack/devstack-plugin-tar-installer
* Bugs: http://bugs.launchpad.net/devstack-plugin-tar-installer
Virtual Open Systems devstack-plugin-tar-installer plugin
=========================================================
By default DevStack installs QEMU and libvirt from the OS' repository,
however sometimes there is a need to test OpenStack against the latest
version of these two programs.
The definition of the variables *LIBVIRT_VERSION* and *QEMU_VERSION*
in the devstack **local.conf** file will result in the compilation and
installation of libvirt and QEMU. E.g.,:
QEMU_VERSION=2.1.5
LIBVIRT_VERSION=1.2.9
The sources of the version pointed by these variables are downloaded
from the official libvirt and QEMU project websites, if not otherwise
specified by the variables *LIBVIRT_URL_BASE* and *QEMU_URL_BASE*
in the same file. E.g.,:
LIBVIRT_URL_BASE="http://www.virtualopensystems.com/sources/"
QEMU_URL_BASE="http://www.virtualopensystems.com/sources/"
If none of these variables will be defined, the standard plugin values,
will be taken from the file **devstack/settings**.
*Note: OpenStack and its components (e.g. Nova) are mainly tested with the
repository version of both libvirt and QEMU.
Thus be aware that the use of a different version may lead to an unstable
or not working OpenStack environment.*
Enabling the plugin
===================
1 Download devstack::
git clone https://git.openstack.org/openstack-dev/devstack
2. Add devstack-plugin-tar-installer external repository in the local.conf file::
> cat local.conf
[[local|localrc]]
enable_plugin devstack-tar-installer-plugin git@git.virtualopensystems.com:sesame/devstack-qemu-libvirt-from-tar-plugin.git
3. Configure the plugin by definig the variables as described above::
QEMU_VERSION=2.1.5
LIBVIRT_VERSION=1.2.9
3. run ``stack.sh``
References
==========
Blueprint:
https://blueprints.launchpad.net/devstack/+spec/devstack-tar-installer-plugin
Old spec:
https://review.openstack.org/#/c/108714/
Features
--------
* Installs QEMU and/or libvirt from tar
Acknowledgements
---------------------
This work has been supported by the FP7 TRESCCA and H2020 SESAME projects,
under the grant numbers 318036 and 671596.

2
babel.cfg Normal file
View File

@ -0,0 +1,2 @@
[python: **.py]

View File

@ -0,0 +1,19 @@
# -*- coding: utf-8 -*-
# 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 pbr.version
__version__ = pbr.version.VersionInfo(
'devstack-plugin-tar-installer').version_string()

View File

@ -0,0 +1,23 @@
# -*- coding: utf-8 -*-
# Copyright 2010-2011 OpenStack Foundation
# Copyright (c) 2013 Hewlett-Packard Development Company, L.P.
#
# 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.
from oslotest import base
class TestCase(base.BaseTestCase):
"""Test case base class for all unit tests."""

View File

@ -0,0 +1,28 @@
# -*- coding: utf-8 -*-
# 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.
"""
test_devstack-plugin-tar-installer
----------------------------------
Tests for `devstack-plugin-tar-installer` module.
"""
from devstack-plugin-tar-installer.tests import base
class TestDevstack-plugin-tar-installer(base.TestCase):
def test_something(self):
pass

113
devstack/build_libvirt.sh Executable file
View File

@ -0,0 +1,113 @@
#!/usr/bin/env bash
#
# Copyright (c) 2015-2016 Virtual Open Systems, SAS.
#
# Michele Paolino <m.paolino@virtualopensystems.com>
# Virtual Open Systems devstack-plugin-tar-installer
#
# build_libvirt.sh - Install libvirt and its dependencies.
#
# Echo commands
set -o xtrace
# Exit on error to stop unexpected errors
set -o errexit
function usage {
echo "$0 - Install libvirt from tar releases."
echo ""
echo "Usage: $0 <LIBVIRT_VERSION>"
echo ""
echo "Example: $0 1.3.3"
}
# Keep track of the current directory
TOOLS_DIR=${TOOLS_DIR:-$(cd $(dirname "$0") && pwd)}
TOP_DIR=${TOP_DIR:-$(cd $TOOLS_DIR/..; pwd)}
# Import common functions and variables
source $TOOLS_DIR/functions
source $TOOLS_DIR/stackrc
# Find the cache dir
SOURCE_FILE=$TOP_DIR/files
# Reclone/configure libvirt each time the script is run
RECLONE=$(trueorfalse False $RECLONE)
# If this value is not user defined, use the official link
LIBVIRT_URL_BASE=${LIBVIRT_URL_BASE:-https://libvirt.org/sources/}
# Getting program version from the bash argument
LIBVIRT_VERSION=$1
# libvirt is released as .tar.gz
LIBVIRT_FILE=libvirt-"$LIBVIRT_VERSION".tar.gz
LIBVIRT_DIR="$DEST"/libvirt-"$LIBVIRT_VERSION"
LIBVIRT_URL="$LIBVIRT_URL_BASE""$LIBVIRT_FILE"
# libvirtd debug variables
NOW=`date +"%F-%T"`
WHERE=`hostname`
EPOCH=`date +%s`
if [[ -z "$1" ]]; then
usage
exit 1
fi
if [[ "$1" == remove ]]; then
echo "Removing libvirt $LIBVIRT_VERSION from the system"
rm "$SOURCE_FILE"/"$LIBVIRT_FILE"
cd "$LIBVIRT_DIR"
sudo make uninstall
cd ..
rm -r "$LIBVIRT_DIR"
else
echo "Installing libvirt $LIBVIRT_VERSION"
echo "Installing libvirt build dependencies"
if is_ubuntu; then
sudo apt-get build-dep libvirt -y
install_package python-guestfs
if [[ ${DISTRO} =~ (precise) ]]; then
sudo apt-get install libnl-route-3-dev -y
fi
elif is_fedora || is_suse; then
install_package yum-utils
sudo dnf builddep libvirt -y
install_package python-libguestfs
fi
echo "Downloading the libvirt sources"
wget -N "$LIBVIRT_URL" -P "$SOURCE_FILE"
if [[ ! -d "$LIBVIRT_DIR" || "$RECLONE" = "True" ]]; then
echo "Configuring libvirt"
tar -xf "$SOURCE_FILE"/"$LIBVIRT_FILE" -C "$DEST"
cd "$LIBVIRT_DIR"
./configure --prefix=/ --exec-prefix=/usr \
--with-packager="OpenStack DevStack $WHERE $NOW" \
--with-packager_version="$EPOCH"
fi
# Polkit configurations
if is_ubuntu; then
cat <<EOF | sudo tee /etc/polkit-1/localauthority/50-local.d/50-libvirt-remote-access.pkla
[libvirt Management Access]
Identity=unix-user:$STACK_USER
Action=org.libvirt.unix.manage
ResultAny=yes
ResultInactive=yes
ResultActive=yes
EOF
fi
echo "Compiling libvirt"
cd "$LIBVIRT_DIR"
make -j"$(nproc)"
sudo make install
fi
cd "$TOOLS_DIR"

90
devstack/build_qemu.sh Executable file
View File

@ -0,0 +1,90 @@
#!/usr/bin/env bash
#
# Copyright (c) 2015-2016 Virtual Open Systems, SAS.
#
# Michele Paolino <m.paolino@virtualopensystems.com>
# Virtual Open Systems devstack-plugin-tar-installer
#
# build_qemu.sh - Install QEMU and its dependencies.
#
# Echo commands
set -o xtrace
# Exit on error to stop unexpected errors
set -o errexit
function usage {
echo "$0 - Install QEMU from tar releases."
echo ""
echo "Usage: $0 <QEMU_VERSION>"
echo ""
echo "Example: $0 2.5.0"
}
# Keep track of the current directory
TOOLS_DIR=${TOOLS_DIR:-$(cd $(dirname "$0") && pwd)}
TOP_DIR=${TOP_DIR:-$(cd $TOOLS_DIR/..; pwd)}
# Import common functions and variables
source $TOOLS_DIR/functions
source $TOOLS_DIR/stackrc
# Find the cache dir
SOURCE_FILE=$TOP_DIR/files
# Reclone/configure qemu each time the script is run
RECLONE=$(trueorfalse False $RECLONE)
# If this value is not user defined, use the official link
QEMU_URL_BASE=${QEMU_URL_BASE:-http://wiki.qemu-project.org/download/}
# Getting program version from the bash argument
QEMU_VERSION=$1
# QEMU is released as .tar.bz2
QEMU_FILE=qemu-"$QEMU_VERSION".tar.bz2
QEMU_DIR="$DEST"/qemu-"$QEMU_VERSION"
QEMU_URL="$QEMU_URL_BASE""$QEMU_FILE"
if [[ -z "$1" ]]; then
usage
exit 1
fi
if [[ "$1" == remove ]]; then
echo "Removing QEMU $QEMU_VERSION from the system"
rm "$QEMU_DIR"/"$QEMU_FILE"
cd "$DEST"/"$QEMU_DIR"
sudo make uninstall
cd ..
rm -r "$QEMU_DIR"
else
echo "Installing QEMU $QEMU_VERSION"
echo "Installing QEMU build dependencies"
if is_ubuntu; then
sudo apt-get build-dep qemu -y
if [[ ${DISTRO} =~ (precise) ]]; then
sudo apt-get install dh-autoreconf -y
fi
elif is_fedora || is_suse; then
install_package yum-utils
sudo dnf builddep qemu -y
fi
echo "Downloading the QEMU sources"
wget -N "$QEMU_URL" -P "$SOURCE_FILE"
if [[ ! -d "$QEMU_DIR" || "$RECLONE" = "True" ]]; then
echo "Configuring QEMU"
tar -xf "$SOURCE_FILE"/"$QEMU_FILE" -C "$DEST"
cd "$QEMU_DIR"
./configure --target-list=`uname -m`-softmmu --prefix=/usr
fi
echo "Compiling QEMU"
cd "$QEMU_DIR"
make -j"$(nproc)"
sudo make install
fi
cd "$TOOLS_DIR"

77
devstack/plugin.sh Executable file
View File

@ -0,0 +1,77 @@
# Copyright (c) 2016 Virtual Open Systems, SAS.
#
# Michele Paolino <m.paolino@virtualopensystems.com>
# Virtual Open Systems devstack plugin for installing qemu and libvirt
# from tar releases - plugin.sh
env | sort
# Save trace setting
XTRACE=$(set +o | grep xtrace)
set -o xtrace
# Set up default directories
VOSYS_PLUGIN_DIR=$DEST/devstack-tar_installer_plugin/devstack
function install_tar_installer_plugin {
if [[ -n "$QEMU_VERSION" ]]; then
source $VOSYS_PLUGIN_DIR/build_qemu.sh "$QEMU_VERSION"
fi
if [[ -n "$LIBVIRT_VERSION" ]]; then
source $VOSYS_PLUGIN_DIR/build_libvirt.sh "$LIBVIRT_VERSION"
fi
}
function remove_tar_installer_plugin {
if [[ -n "$QEMU_VERSION" ]]; then
source $VOSYS_PLUGIN_DIR/build_qemu.sh remove
fi
if [[ -n "$LIBVIRT_VERSION" ]]; then
source $VOSYS_PLUGIN_DIR/build_libvirt.sh remove
fi
}
# check for service enabled
if is_service_enabled devstack-tar_installer_plugin; then
if [[ "$1" == "stack" && "$2" == "pre-install" ]]; then
# Configure after the other layer 1 and 2 services have been configured
# no-op
:
elif [[ "$1" == "stack" && "$2" == "install" ]]; then
# Perform installation of service source
echo_summary "install phase - Virtual Open Systems plugin for \
installing qemu/libvirt from tar releases"
install_tar_installer_plugin
elif [[ "$1" == "stack" && "$2" == "post-config" ]]; then
# Configure after the other layer 1 and 2 services have been configured
# no-op
:
elif [[ "$1" == "stack" && "$2" == "extra" ]]; then
# Initialize and start the tar_installer_plugin service
# no-op
:
fi
if [[ "$1" == "unstack" ]]; then
# Shut down tar_installer_plugin services
# no-op
:
fi
if [[ "$1" == "clean" ]]; then
# Remove state and transient data
# Remember clean.sh first calls unstack.sh
echo_summary "clean phase - Virtual Open Systems plugin for \
installing qemu/libvirt from tar releases"
remove_tar_installer_plugin
fi
fi

27
devstack/settings Normal file
View File

@ -0,0 +1,27 @@
# Copyright (c) 2016 Virtual Open Systems, SAS.
#
# Michele Paolino <m.paolino@virtualopensystems.com>
# Virtual Open Systems devstack plugin for installing qemu and libvirt
# from tar releases - settings file
enable_service devstack-tar-installer-plugin
# libvirt and QEMU/KVM installation from sources
#
# when the variables QEMU_VERSION, LIBVIRT_VERSION, or both are specified
# (e.g. in the local.conf file), we download the sources from the official
# websites and install libvirt/QEMU binaries
#
QEMU_VERSION=${QEMU_VERSION:-2.6.0-rc1}
LIBVIRT_VERSION=${LIBVIRT_VERSION:-1.2.9}
# Custom versions of the libvirt/QEMU sources can be made available at a
# different URL using the variables LIBVIRT_URL_BASE and QEMU_URL_BASE.
# Please note: Following the official releases of these two projects,
# the libvirt archive extension must be .tar.gz, while the
# qemu archive extension has to be .tar.bz2
QEMU_URL_BASE=${QEMU_URL_BASE:-http://wiki.qemu-project.org/download/}
LIBVIRT_URL_BASE=${LIBVIRT_URL_BASE:-https://libvirt.org/sources/}

75
doc/source/conf.py Executable file
View File

@ -0,0 +1,75 @@
# -*- coding: utf-8 -*-
# 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 os
import sys
sys.path.insert(0, os.path.abspath('../..'))
# -- General configuration ----------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [
'sphinx.ext.autodoc',
#'sphinx.ext.intersphinx',
'oslosphinx'
]
# autodoc generation is a bit aggressive and a nuisance when doing heavy
# text edit cycles.
# execute "export SPHINX_DEBUG=1" in your terminal to disable
# The suffix of source filenames.
source_suffix = '.rst'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'devstack-plugin-tar-installer'
copyright = u'2013, OpenStack Foundation'
# If true, '()' will be appended to :func: etc. cross-reference text.
add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
add_module_names = True
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# -- Options for HTML output --------------------------------------------------
# The theme to use for HTML and HTML Help pages. Major themes that come with
# Sphinx are currently 'default' and 'sphinxdoc'.
# html_theme_path = ["."]
# html_theme = '_theme'
# html_static_path = ['static']
# Output file base name for HTML help builder.
htmlhelp_basename = '%sdoc' % project
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass
# [howto/manual]).
latex_documents = [
('index',
'%s.tex' % project,
u'%s Documentation' % project,
u'OpenStack Foundation', 'manual'),
]
# Example configuration for intersphinx: refer to the Python standard library.
#intersphinx_mapping = {'http://docs.python.org/': None}

View File

@ -0,0 +1,4 @@
============
Contributing
============
.. include:: ../../CONTRIBUTING.rst

25
doc/source/index.rst Normal file
View File

@ -0,0 +1,25 @@
.. devstack-plugin-tar-installer documentation master file, created by
sphinx-quickstart on Tue Jul 9 22:26:36 2013.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to devstack-plugin-tar-installer's documentation!
========================================================
Contents:
.. toctree::
:maxdepth: 2
readme
installation
usage
contributing
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

View File

@ -0,0 +1,12 @@
============
Installation
============
At the command line::
$ pip install devstack-plugin-tar-installer
Or, if you have virtualenvwrapper installed::
$ mkvirtualenv devstack-plugin-tar-installer
$ pip install devstack-plugin-tar-installer

1
doc/source/readme.rst Normal file
View File

@ -0,0 +1 @@
.. include:: ../../README.rst

7
doc/source/usage.rst Normal file
View File

@ -0,0 +1,7 @@
========
Usage
========
To use devstack-plugin-tar-installer in a project::
import devstack-plugin-tar-installer

5
requirements.txt Normal file
View File

@ -0,0 +1,5 @@
# The order of packages is significant, because pip processes them in the order
# of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later.
pbr>=1.6

46
setup.cfg Normal file
View File

@ -0,0 +1,46 @@
[metadata]
name = devstack-plugin-tar-installer
summary = By default DevStack installs all the software needed to run OpenStack from the OS' repository, however sometimes there is a need to test OpenStack against the latest (or custom) versions of specific software programs (e.g., qemu and libvirt).
description-file =
README.rst
author = OpenStack
author-email = openstack-dev@lists.openstack.org
home-page = http://www.openstack.org/
classifier =
Environment :: OpenStack
Intended Audience :: Information Technology
Intended Audience :: System Administrators
License :: OSI Approved :: Apache Software License
Operating System :: POSIX :: Linux
Programming Language :: Python
Programming Language :: Python :: 2
Programming Language :: Python :: 2.7
Programming Language :: Python :: 3
Programming Language :: Python :: 3.3
Programming Language :: Python :: 3.4
[files]
packages =
devstack-plugin-tar-installer
[build_sphinx]
source-dir = doc/source
build-dir = doc/build
all_files = 1
[upload_sphinx]
upload-dir = doc/build/html
[compile_catalog]
directory = devstack-plugin-tar-installer/locale
domain = devstack-plugin-tar-installer
[update_catalog]
domain = devstack-plugin-tar-installer
output_dir = devstack-plugin-tar-installer/locale
input_file = devstack-plugin-tar-installer/locale/devstack-plugin-tar-installer.pot
[extract_messages]
keywords = _ gettext ngettext l_ lazy_gettext
mapping_file = babel.cfg
output_file = devstack-plugin-tar-installer/locale/devstack-plugin-tar-installer.pot

29
setup.py Normal file
View File

@ -0,0 +1,29 @@
# Copyright (c) 2013 Hewlett-Packard Development Company, L.P.
#
# 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.
# THIS FILE IS MANAGED BY THE GLOBAL REQUIREMENTS REPO - DO NOT EDIT
import setuptools
# In python < 2.7.4, a lazy loading of package `pbr` will break
# setuptools if some other modules registered functions in `atexit`.
# solution from: http://bugs.python.org/issue15881#msg170215
try:
import multiprocessing # noqa
except ImportError:
pass
setuptools.setup(
setup_requires=['pbr'],
pbr=True)

14
test-requirements.txt Normal file
View File

@ -0,0 +1,14 @@
# The order of packages is significant, because pip processes them in the order
# of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later.
hacking<0.11,>=0.10.0
coverage>=3.6
python-subunit>=0.0.18
sphinx!=1.2.0,!=1.3b1,<1.3,>=1.1.2
oslosphinx>=2.5.0 # Apache-2.0
oslotest>=1.10.0 # Apache-2.0
testrepository>=0.0.18
testscenarios>=0.4
testtools>=1.4.0

26
tox.ini Normal file
View File

@ -0,0 +1,26 @@
[tox]
minversion = 1.6
skipsdist = True
envlist = bashate
[testenv]
usedevelop = False
install_command = pip install {opts} {packages}
[testenv:bashate]
deps = bashate
whitelist_externals = bash
commands = bash -c "find {toxinidir} \
-not \( -type d -name .?\* -prune \) \
-not \( -type d -name doc -prune \) \
-type f \
-not -name .\*.sw? \
-not -name \*~ \
-not -name \*.md \
\( \
-name \*.sh -or \
-name \*rc -or \
-name functions\* -or \
-wholename \*/lib/\* \
\) \
-print0 | xargs -0 bashate -v"