From fa342a790074da0dbeed147e22380490f277c771 Mon Sep 17 00:00:00 2001 From: Rodolfo Alonso Hernandez Date: Wed, 24 May 2017 17:18:00 +0100 Subject: [PATCH] Initial release This commit contains the scripts to download from source QEMU and libvirt, specify a specific commit ID and apply on top of it a list of patches. Change-Id: Id52690f4f175c990f0b481c900a30087c07c0c31 --- .gitignore | 58 ++++ .mailmap | 3 + .testr.conf | 7 + CONTRIBUTING.rst | 17 ++ HACKING.rst | 4 + LICENSE | 176 +++++++++++ README.rst | 19 ++ babel.cfg | 2 + devstack/libs/libvirt | 223 ++++++++++++++ devstack/plugin.sh | 56 ++++ devstack/settings | 25 ++ doc/source/conf.py | 75 +++++ doc/source/contributing.rst | 4 + doc/source/index.rst | 25 ++ doc/source/installation.rst | 26 ++ doc/source/readme.rst | 1 + doc/source/usage.rst | 7 + readme.md | 25 ++ releasenotes/notes/.placeholder | 0 .../initial_release-6ee97b0a3ef70187.yaml | 12 + releasenotes/source/_static/.placeholder | 0 releasenotes/source/_templates/.placeholder | 0 releasenotes/source/conf.py | 275 ++++++++++++++++++ releasenotes/source/index.rst | 8 + releasenotes/source/unreleased.rst | 5 + requirements.txt | 5 + setup.cfg | 47 +++ setup.py | 29 ++ test-requirements.txt | 16 + tox.ini | 49 ++++ 30 files changed, 1199 insertions(+) create mode 100644 .gitignore create mode 100644 .mailmap create mode 100644 .testr.conf create mode 100644 CONTRIBUTING.rst create mode 100644 HACKING.rst create mode 100644 LICENSE create mode 100644 README.rst create mode 100644 babel.cfg create mode 100644 devstack/libs/libvirt create mode 100644 devstack/plugin.sh create mode 100644 devstack/settings create mode 100644 doc/source/conf.py create mode 100644 doc/source/contributing.rst create mode 100644 doc/source/index.rst create mode 100644 doc/source/installation.rst create mode 100644 doc/source/readme.rst create mode 100644 doc/source/usage.rst create mode 100644 readme.md create mode 100644 releasenotes/notes/.placeholder create mode 100644 releasenotes/notes/initial_release-6ee97b0a3ef70187.yaml create mode 100644 releasenotes/source/_static/.placeholder create mode 100644 releasenotes/source/_templates/.placeholder create mode 100644 releasenotes/source/conf.py create mode 100644 releasenotes/source/index.rst create mode 100644 releasenotes/source/unreleased.rst create mode 100644 requirements.txt create mode 100644 setup.cfg create mode 100644 setup.py create mode 100644 test-requirements.txt create mode 100644 tox.ini diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..963e589 --- /dev/null +++ b/.gitignore @@ -0,0 +1,58 @@ +*.py[cod] + +# C extensions +*.so + +# Packages +*.egg* +*.egg-info +dist +build +eggs +parts +bin +var +sdist +develop-eggs +.installed.cfg +lib +lib64 + +# Installer logs +pip-log.txt + +# Unit test / coverage reports +cover/ +.coverage* +!.coveragerc +.tox +nosetests.xml +.testrepository +.venv + +# Translations +*.mo + +# Mr Developer +.mr.developer.cfg +.project +.pydevproject + +# Complexity +output/*.html +output/*/index.html + +# Sphinx +doc/build + +# pbr generates these +AUTHORS +ChangeLog + +# Editors +*~ +.*.swp +.*sw? + +# Files created by releasenotes build +releasenotes/build \ No newline at end of file diff --git a/.mailmap b/.mailmap new file mode 100644 index 0000000..516ae6f --- /dev/null +++ b/.mailmap @@ -0,0 +1,3 @@ +# Format is: +# +# diff --git a/.testr.conf b/.testr.conf new file mode 100644 index 0000000..6d83b3c --- /dev/null +++ b/.testr.conf @@ -0,0 +1,7 @@ +[DEFAULT] +test_command=OS_STDOUT_CAPTURE=${OS_STDOUT_CAPTURE:-1} \ + OS_STDERR_CAPTURE=${OS_STDERR_CAPTURE:-1} \ + OS_TEST_TIMEOUT=${OS_TEST_TIMEOUT:-60} \ + ${PYTHON:-python} -m subunit.run discover -t ./ . $LISTOPT $IDOPTION +test_id_option=--load-list $IDFILE +test_list_option=--list diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 0000000..905a50d --- /dev/null +++ b/CONTRIBUTING.rst @@ -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-libvirt-qemu diff --git a/HACKING.rst b/HACKING.rst new file mode 100644 index 0000000..8dedc60 --- /dev/null +++ b/HACKING.rst @@ -0,0 +1,4 @@ +devstack-plugin-libvirt-qemu Style Commandments +=============================================== + +Read the OpenStack Style Commandments http://docs.openstack.org/developer/hacking/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..68c771a --- /dev/null +++ b/LICENSE @@ -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. + diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..3c6dcfe --- /dev/null +++ b/README.rst @@ -0,0 +1,19 @@ +=============================== +devstack-plugin-libvirt-qemu +=============================== + +OpenStack Boilerplate contains all the boilerplate you need to create an OpenStack package. + +Please fill here a long description which must be at least 3 lines wrapped on +80 cols, so that distribution package maintainers can use it in their packages. +Note that this is a hard requirement. + +* Free software: Apache license +* Documentation: http://docs.openstack.org/developer/devstack-plugin-libvirt-qemu +* Source: http://git.openstack.org/cgit/devstack-plugin-libvirt-qemu/devstack-plugin-libvirt-qemu +* Bugs: http://bugs.launchpad.net/devstack-plugin-libvirt-qemu + +Features +-------- + +* TODO diff --git a/babel.cfg b/babel.cfg new file mode 100644 index 0000000..15cd6cb --- /dev/null +++ b/babel.cfg @@ -0,0 +1,2 @@ +[python: **.py] + diff --git a/devstack/libs/libvirt b/devstack/libs/libvirt new file mode 100644 index 0000000..bce2b34 --- /dev/null +++ b/devstack/libs/libvirt @@ -0,0 +1,223 @@ +#!/bin/bash +# +# common functions for devstack-libvirt-qemu plugin +# ------------------------------------- + +# +# ovs installation +# + +# +# git_update_repo +# Due to missing support in devstack, this local function can handle +# updating / refreshing repos based on commit id +# it's taking following arguments +# $1 .. path to repo, $2 .. commit/tag for update of existing repo +# +function git_update_repo { + local git_dest=$1 + local git_ref=$2 + + pushd $git_dest + git fetch + git checkout -f $git_ref # Clean modified tracked files + git clean -d -f # Clean untracked files + popd +} + +function clone_repo { + local git_remote=$1 + local git_dest=$2 + local git_ref=$3 + + git_timed clone $git_remote $git_dest + pushd $git_dest + git checkout -f $git_ref # Clean modified tracked files + git clean -d -f # Clean untracked files + popd +} + +function get_repo { + local git_remote=$1 + local git_ref=$2 + local git_dest=$3 + + if [ ! -d $git_dest ] || [ "$RECLONE" == True ]; then + # If directory exists and should be just refreshed + # it's not possible to use devstack git_clone with commit's id + if [ -d $git_dest} ]; then + git_update_repo $git_dest $git_ref + else + git_clone $git_remote $git_dest $git_ref + fi + fi +} + +function patch_repo { + if [ "$LIBVIRT_PATCHES" != "" ]; then + # $1 destination, $2 commit/branch/tag, $3 patch urls (space seperated) + pushd $1 + git clean -f -x -d + git reset --hard $2 + local patches=( $3 ) + for url in "${patches[@]}"; do + curl $url | patch -p1 + done + popd + fi + +} + +function clone_libvirt_qemu { + OFFLINE=$(trueorfalse False OFFLINE) + RECLONE=$(trueorfalse False RECLONE) + if [[ "$OFFLINE" != True && ( "$RECLONE" == True || ! -e ${LIBVIRT_DIR}/BUILD_COMPLETE ) ]]; then + get_repo $LIBVIRT_REPO $LIBVIRT_BRANCH $LIBVIRT_DIR + patch_repo $LIBVIRT_REPO $LIBVIRT_BRANCH $LIBVIRT_PATCHES + get_repo $QEMU_REPO $QEMU_BRANCH $QEMU_DIR + patch_repo $QEMU_REPO $QEMU_BRANCH $QEMU_PATCHES + fi +} + +function install_libvirt_src { + if [ -e "${LIBVIRT_DIR}/BUILD_COMPLETE" ]; then + echo "Libvirt already built." + pushd ${LIBVIRT_DIR} + sudo make install + popd + return + fi + pushd ${LIBVIRT_DIR} + ./autogen.sh --system + make -j $(nproc) EXTRA_CFLAGS='-fPIC' + sudo make install + touch ${LIBVIRT_DIR}/BUILD_COMPLETE + popd +} + +function install_qemu_src { + if [ -e "${QEMU_DIR}/BUILD_COMPLETE" ]; then + echo "Qemu already built." + pushd ${QEMU_DIR} + sudo make install + popd + return + fi + pushd ${QEMU_DIR} + # FIXME(ralonsoh): libfdt 1.4.2 not present in Ubuntu repositories. + git submodule update --init dtc + ./configure + make -j $(nproc) EXTRA_CFLAGS='-fPIC' + sudo make install + touch ${QEMU_DIR}/BUILD_COMPLETE + popd +} + +function add_repositories { + if is_ubuntu; then + if ! [[ $(dpkg --get-selections | ag software-properties-common) ]]; then + sudo_with_proxies apt-get install -y software-properties-common + fi + sudo_with_proxies add-apt-repository -s 'deb http://archive.ubuntu.com/ubuntu/ xenial main' + sudo_with_proxies apt-get update + #else + #TODO(ralonsoh): add Red Hat needed repositories. + fi +} + +function install_build_deps { + if is_ubuntu; then + sudo_with_proxies apt-get build-dep -y $1 + else + [ rpm -qa | grep yum-builddep > /dev/null ] && sudo_with_proxies yum install -y yum-builddep + sudo_with_proxies yum-builddep -y $1 + fi +} + +function configure_libvirtd_src { + cat << EOF | sudo tee /etc/libvirt/libvirtd.conf +unix_sock_group = "libvirt" +unix_sock_ro_perms = "0660" +unix_sock_rw_perms = "0660" +unix_sock_admin_perms = "0660" +EOF +} + +function configure_groups_users { + getent group libvirt > /dev/null || sudo addgroup -f -r libvirt + sudo usermod -G libvirt -a root + getent group kvm > /dev/null || sudo groupadd -f -r kvm + getent group qemu > /dev/null || sudo groupadd -f -r qemu + getent passwd qemu > /dev/null || sudo useradd -r -g qemu -G kvm -d / -s /sbin/nologin -c "qemu user" qemu +} + +function install_libvirt_qemu_src { + # Install deps + set +o errexit + if is_ubuntu; then + if [ dpkg -s libvirt-bin | grep installed > /dev/null ]; then + stop_service libvirt-bin + fi + if [ dpkg -s libvirt0 | grep installed > /dev/null ]; then + apt-get remove --purge libvirt0 + fi + add_repositories + install_build_deps libvirt-bin + install_build_deps qemu-kvm + install_package libnuma-dev gcc make build-essential autopoint + else + if [ rpm -qa | grep libvirtd > /dev/null ]; then + stop_service libvirtd + fi + if [ rpm -qa | grep libvirt0 > /dev/null ]; then + yum remove libvirt0 + fi + install_build_deps libvirtd + install_build_deps qemu + install_package libnuma-devel gcc make autopoint pkg-config + fi + set -o errexit + + install_libvirt_src + install_qemu_src + if is_ubuntu; then + sudo ln -s -f /usr/lib/systemd/system/libvirtd.service /usr/lib/systemd/system/libvirt-bin.service + fi + type systemctl 2>&1 >/dev/null && sudo systemctl daemon-reload + + configure_libvirtd_src + + configure_groups_users + + if is_ubuntu; then + sudo apparmor_parser -R /etc/apparmor.d/usr.sbin.libvirtd || /bin/true + start_service libvirt-bin + else + #TODO(ralonsoh): check if Red Hat needs selinux permissive mode + start_service libvirtd + fi + start_service virtlogd + sudo_with_proxies pip install -U libvirt-python +} + +function cleanup_libvirt_qemu_source { + sudo rm -rf ${LIBVIRT_DIR} + sudo rm -rf ${QEMU_DIR} +} + +function uninstall_libvirt_qemu { + pushd ${LIBVIRT_DIR} + sudo make uninstall + popd + pushd ${QEMU_DIR} + sudo make uninstall + popd +} + + +# if we are installing libvirt and qemu dont install distro packages. +if [ $LIBVIRT_QEMU_SRC_INSTALL == 'True' ]; then +function install_libvirt { + install_libvirt_qemu_src +} +fi diff --git a/devstack/plugin.sh b/devstack/plugin.sh new file mode 100644 index 0000000..3f454e9 --- /dev/null +++ b/devstack/plugin.sh @@ -0,0 +1,56 @@ +#!/bin/bash + +#local xtrace=$(set +o | grep xtrace) + +if [ "$VERBOSE" == 'True' ]; then + # enabling verbosity on whole plugin - default behavior + set -o xtrace +fi + +local error_on_clone=${ERROR_ON_CLONE} +# disabling ERROR_NO_CLONE to allow this plugin work with devstack-gate +ERROR_ON_CLONE=False + + # Initial source of lib script + source $DEVSTACK_LIBVIRT_QEMU_PLUGIN_DIR/devstack/libs/libvirt + + case $1 in + "stack") + case $2 in + "pre-install") + # cloning source code + if [ $LIBVIRT_QEMU_SRC_INSTALL == 'True' ]; then + echo_summary "Downloading source repos for libvirt and qemu" + clone_libvirt_qemu + else + echo_summary "Cloning of src files for libvirt and qemu disabled" + fi + ;; + "install") + # no-op + # install called via by devstack/lib/nova + : + ;; + "post-config") + # no-op + : + ;; + "extra") + # no-op + : + ;; + esac + ;; + "unstack") + # Shut Down OVS-DPDK + uninstall_libvirt_qemu + ;; + "clean") + # Remove state and transient data + # Remember clean.sh first calls unstack.sh + cleanup_libvirt_qemu_source + ;; + esac + +ERROR_ON_CLONE=$error_on_clone +$xtrace diff --git a/devstack/settings b/devstack/settings new file mode 100644 index 0000000..4890b5b --- /dev/null +++ b/devstack/settings @@ -0,0 +1,25 @@ +if [ "$VERBOSE" == "False" ]; then + # allow local debugging + set -o xtrace +fi + +DEVSTACK_LIBVIRT_QEMU_PLUGIN_DIR=$( cd "$( dirname "${BASH_SOURCE[0]}" )" && cd .. && pwd ) + +LIBVIRT_QEMU_SRC_INSTALL=${LIBVIRT_QEMU_SRC_INSTALL:-'True'} + +LIBVIRT_REPO=${LIBVIRT_REPO:-'https://github.com/libvirt/libvirt'} +LIBVIRT_BRANCH=${LIBVIRT_BRANCH:-'master'} +LIBVIRT_DIR=${LIBVIRT_DIR:-"${DEST}/libvirt"} + +QEMU_REPO=${QEMU_REPO:-'https://github.com/qemu/qemu'} +QEMU_BRANCH=${QEMU_BRANCH:-'master'} +QEMU_DIR=${QEMU_DIR:-"${DEST}/qemu"} + +# Do not apply any patches by default +LIBVIRT_PATCHES=${LIBVIRT_PATCHES:-''} +QEMU_PATCHES=${QEMU_PATCHES:-''} + +if [ "$VERBOSE" == "False" ]; then + # turn off debugging again + set +o xtrace +fi diff --git a/doc/source/conf.py b/doc/source/conf.py new file mode 100644 index 0000000..789791b --- /dev/null +++ b/doc/source/conf.py @@ -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-libvirt-qemu' +copyright = u'2016, 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} diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst new file mode 100644 index 0000000..1728a61 --- /dev/null +++ b/doc/source/contributing.rst @@ -0,0 +1,4 @@ +============ +Contributing +============ +.. include:: ../../CONTRIBUTING.rst diff --git a/doc/source/index.rst b/doc/source/index.rst new file mode 100644 index 0000000..fba5407 --- /dev/null +++ b/doc/source/index.rst @@ -0,0 +1,25 @@ +.. devstack-plugin-libvirt-qemu 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-libvirt-qemu's documentation! +======================================================== + +Contents: + +.. toctree:: + :maxdepth: 2 + + readme + installation + usage + contributing + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/doc/source/installation.rst b/doc/source/installation.rst new file mode 100644 index 0000000..0f90388 --- /dev/null +++ b/doc/source/installation.rst @@ -0,0 +1,26 @@ +============ +Installation +============ + +At the command line:: + + $ pip install devstack-plugin-libvirt-qemu + +Or, if you have virtualenvwrapper installed:: + + $ mkvirtualenv devstack-plugin-libvirt-qemu + $ pip install devstack-plugin-libvirt-qemu + + +Notes +===== + +``libvirt`` needs ``python-libvirt`` library to be used in OpenStack. The +version downloaded and compiled must have a compatible Python API binding +available to be installed. Check `The libvirt virtualization API python binding +`_ to find the list of available +versions to be installed. + +This plugin has been tested manually only in: + +* Ubuntu 16.04 diff --git a/doc/source/readme.rst b/doc/source/readme.rst new file mode 100644 index 0000000..a6210d3 --- /dev/null +++ b/doc/source/readme.rst @@ -0,0 +1 @@ +.. include:: ../../README.rst diff --git a/doc/source/usage.rst b/doc/source/usage.rst new file mode 100644 index 0000000..28b3dd4 --- /dev/null +++ b/doc/source/usage.rst @@ -0,0 +1,7 @@ +===== +Usage +===== + +To use devstack-plugin-libvirt-qemu in a project:: + + import devstack_plugin_libvirt_qemu diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..bd7d680 --- /dev/null +++ b/readme.md @@ -0,0 +1,25 @@ +============================ +devstack-plugin-libvirt-qemu +============================ + +This project is a set of scripts to be executed along with DevStack. DevStack +is a set of scripts and utilities to quickly deploy an OpenStack cloud. + +This DevStack plugin provides the ability to download from the source and +compile libvirt and QEMU. Also gives the ability to set an specific git commit +to be used in the compilation + +A Collection of Agents and Drivers to support managing DPDK accelerated Open +vSwitch with neutron. + +* Free software: Apache license +* Source: https://github.com/openstack/devstack-plugin-libvirt-qemu + + +The following are links to background information that provide additional +insight into the related programs used in this project: + +* libvirt + - Official libvirt website: https://github.com/openstack/devstack-plugin-libvirt-qemu +* Qemu: + - Official QEMU website: http://www.qemu.org/ diff --git a/releasenotes/notes/.placeholder b/releasenotes/notes/.placeholder new file mode 100644 index 0000000..e69de29 diff --git a/releasenotes/notes/initial_release-6ee97b0a3ef70187.yaml b/releasenotes/notes/initial_release-6ee97b0a3ef70187.yaml new file mode 100644 index 0000000..a23b946 --- /dev/null +++ b/releasenotes/notes/initial_release-6ee97b0a3ef70187.yaml @@ -0,0 +1,12 @@ +--- +prelude: > + This project is a plugin for DevStack. Gives the ability to download and + compile libvirt and QEMU from source. +features: + - | + To compile libvirt and QEMU from source during the installation time while + executing DevStack. + - | + To set a git commmit id, tag or branch name for both projects. + - | + To list a set o patches to be applied on top of the downloaded source code. diff --git a/releasenotes/source/_static/.placeholder b/releasenotes/source/_static/.placeholder new file mode 100644 index 0000000..e69de29 diff --git a/releasenotes/source/_templates/.placeholder b/releasenotes/source/_templates/.placeholder new file mode 100644 index 0000000..e69de29 diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py new file mode 100644 index 0000000..03278d2 --- /dev/null +++ b/releasenotes/source/conf.py @@ -0,0 +1,275 @@ +# -*- 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. + +# Glance Release Notes documentation build configuration file, created by +# sphinx-quickstart on Tue Nov 3 17:40:50 2015. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'oslosphinx', + 'reno.sphinxext', +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +# source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'devstack_plugin_libvirt_qemu Release Notes' +copyright = u'2016, OpenStack Foundation' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +# The full version, including alpha/beta/rc tags. +release = '' +# The short X.Y version. +version = '' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +# today = '' +# Else, today_fmt is used as the format for a strftime call. +# today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = [] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +# default_role = None + +# 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 + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +# show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +# modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +# keep_warnings = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'default' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +# html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +# html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +# html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +# html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +# html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +# html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +# html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +# html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +# html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +# html_additional_pages = {} + +# If false, no module index is generated. +# html_domain_indices = True + +# If false, no index is generated. +# html_use_index = True + +# If true, the index is split into individual pages for each letter. +# html_split_index = False + +# If true, links to the reST sources are added to the pages. +# html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +# html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +# html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +# html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +# html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'GlanceReleaseNotesdoc' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # 'preamble': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + ('index', 'GlanceReleaseNotes.tex', u'Glance Release Notes Documentation', + u'Glance Developers', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +# latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +# latex_use_parts = False + +# If true, show page references after internal links. +# latex_show_pagerefs = False + +# If true, show URL addresses after external links. +# latex_show_urls = False + +# Documents to append as an appendix to all manuals. +# latex_appendices = [] + +# If false, no module index is generated. +# latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'glancereleasenotes', u'Glance Release Notes Documentation', + [u'Glance Developers'], 1) +] + +# If true, show URL addresses after external links. +# man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', 'GlanceReleaseNotes', u'Glance Release Notes Documentation', + u'Glance Developers', 'GlanceReleaseNotes', + 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +# texinfo_appendices = [] + +# If false, no module index is generated. +# texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +# texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +# texinfo_no_detailmenu = False + +# -- Options for Internationalization output ------------------------------ +locale_dirs = ['locale/'] diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst new file mode 100644 index 0000000..c3f47f8 --- /dev/null +++ b/releasenotes/source/index.rst @@ -0,0 +1,8 @@ +============================================ + devstack_plugin_libvirt_qemu Release Notes +============================================ + +.. toctree:: + :maxdepth: 1 + + unreleased diff --git a/releasenotes/source/unreleased.rst b/releasenotes/source/unreleased.rst new file mode 100644 index 0000000..cd22aab --- /dev/null +++ b/releasenotes/source/unreleased.rst @@ -0,0 +1,5 @@ +============================== + Current Series Release Notes +============================== + +.. release-notes:: diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..1d18dd3 --- /dev/null +++ b/requirements.txt @@ -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>=2.0 # Apache-2.0 diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..0cf48e5 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,47 @@ +[metadata] +name = devstack-plugin-libvirt-qemu +summary = OpenStack Boilerplate contains all the boilerplate you need to create an OpenStack package. +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_libvirt_qemu + +[build_sphinx] +all-files = 1 +warning-is-error = 1 +source-dir = doc/source +build-dir = doc/build + +[upload_sphinx] +upload-dir = doc/build/html + +[compile_catalog] +directory = devstack_plugin_libvirt_qemu/locale +domain = devstack_plugin_libvirt_qemu + +[update_catalog] +domain = devstack_plugin_libvirt_qemu +output_dir = devstack_plugin_libvirt_qemu/locale +input_file = devstack_plugin_libvirt_qemu/locale/devstack_plugin_libvirt_qemu.pot + +[extract_messages] +keywords = _ gettext ngettext l_ lazy_gettext +mapping_file = babel.cfg +output_file = devstack_plugin_libvirt_qemu/locale/devstack_plugin_libvirt_qemu.pot diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..3887303 --- /dev/null +++ b/setup.py @@ -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>=2.0'], + pbr=True) diff --git a/test-requirements.txt b/test-requirements.txt new file mode 100644 index 0000000..08b0ad2 --- /dev/null +++ b/test-requirements.txt @@ -0,0 +1,16 @@ +# 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.12.0,<0.13 # Apache-2.0 + +coverage>=4.0 # Apache-2.0 +python-subunit>=0.0.18 # Apache-2.0/BSD +sphinx>=1.5.1,<1.6 # BSD +oslosphinx>=4.7.0 # Apache-2.0 +oslotest>=1.10.0 # Apache-2.0 +testrepository>=0.0.18 # Apache-2.0/BSD +testtools>=1.4.0 # MIT + +# releasenotes +reno>=1.8.0 # Apache-2.0 diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..21a8e52 --- /dev/null +++ b/tox.ini @@ -0,0 +1,49 @@ +[tox] +minversion = 2.0 +envlist = bashate +skipsdist = True + +[testenv] +usedevelop = True +install_command = pip install -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt} {opts} {packages} +setenv = + VIRTUAL_ENV={envdir} + PYTHONWARNINGS=default::DeprecationWarning +deps = -r{toxinidir}/test-requirements.txt +commands = python setup.py test --slowest --testr-args='{posargs}' + +[testenv:bashate] +# if you want to test out some changes you have made to bashate +# against devstack, just set BASHATE_INSTALL_PATH=/path/... to your +# modified bashate tree +deps = + {env:BASHATE_INSTALL_PATH:bashate==0.5.1} +whitelist_externals = bash +commands = bash -c "find {toxinidir} \ + -not \( -type d -name .?\* -prune \) \ + -not \( -type d -name doc -prune \) \ + -not \( -type f -name localrc -prune \) \ + -type f \ + -not -name \*~ \ + -not -name \*.md \ + -not -name stack-screenrc \ + -not -name \*.orig \ + -not -name \*.rej \ + \( \ + -name \*.sh -or \ + -name \*rc -or \ + -name functions\* -or \ + -wholename \*/inc/\* -or \ + -wholename \*/lib/\* \ + \) \ + -print0 | xargs -0 bashate -v -iE006 -eE005,E042" + +[testenv:docs] +commands = python setup.py build_sphinx + +[testenv:releasenotes] +commands = + sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html + +[testenv:debug] +commands = oslo_debug_helper {posargs}