From 5f3b33c4b315c73a7b1eb25f1c0112ff87d30e7a Mon Sep 17 00:00:00 2001 From: OpenStack Project Creator Date: Tue, 27 Oct 2015 12:52:54 +0000 Subject: [PATCH] Implement: Fuel install QEMU Todo lists: 1. update dependencies.txt after RPM/debian packages are uploaded to official site Change-Id: I05515b20f1e368cebc53a29762ca646af88591ac Closes-Bug:#1507878 Signed-off-by: lingyu1 --- LICENSE | 202 ++++++++++++++++++ README.md | 146 +++++++++++++ .../puppet/manifests/qemu-install.pp | 24 +++ environment_config.yaml | 7 + metadata.yaml | 35 +++ pre_build_hook | 41 ++++ qemu_package/centos/dependencies.txt | 1 + qemu_package/ubuntu/dependencies.txt | 5 + repositories/centos/.gitkeep | 0 repositories/ubuntu/.gitkeep | 0 tasks.yaml | 8 + 11 files changed, 469 insertions(+) create mode 100644 LICENSE create mode 100644 README.md create mode 100644 deployment_scripts/puppet/manifests/qemu-install.pp create mode 100644 environment_config.yaml create mode 100644 metadata.yaml create mode 100755 pre_build_hook create mode 100644 qemu_package/centos/dependencies.txt create mode 100644 qemu_package/ubuntu/dependencies.txt create mode 100644 repositories/centos/.gitkeep create mode 100644 repositories/ubuntu/.gitkeep create mode 100644 tasks.yaml diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..e06d208 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ +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. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + 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. + diff --git a/README.md b/README.md new file mode 100644 index 0000000..8d05633 --- /dev/null +++ b/README.md @@ -0,0 +1,146 @@ +Qemu Plugin for Fuel +================================ + +Qemu plugin +----------------------- + +Overview +-------- + +New fuel plugin fuel-plugin-qemu is developed to deploy QEMU >2.2 in Fuel@OPNFV, which is requested by OVS with DPDK. + +Requirements +------------ + +| Requirement | Version/Comment | +|----------------------------------|-----------------| +| Mirantis OpenStack compatibility | 6.1 | + +Recommendations +--------------- + +None. + +Limitations +----------- + +None. + +Installation Guide +================== + +Qemu plugin installation +---------------------------------------- + +1. Clone the fuel-plugin-qemu repo from stackforge: + + git clone https://github.com/stackforge/fuel-plugin-qemu + +2. Install the Fuel Plugin Builder: + + pip install fuel-plugin-builder + +3. Install the [fpm gem](https://github.com/jordansissel/fpm): + + gem install fpm + +4. Build Qemu Fuel plugin: + + fpb --build fuel-plugin-qemu/ + +5. The *fuel-plugin-qemu-[x.x.x].rpm* plugin package will be created in the plugin folder. + +6. Move this file to the Fuel Master node with secure copy (scp): + + scp fuel-plugin-qemu-[x.x.x].rpm root@:/tmp + +7. While logged in Fuel Master install the Qemu plugin: + + fuel plugins --install fuel-plugin-qemu-[x.x.x].rpm + +8. Check if the plugin was installed successfully: + + fuel plugins + + id | name | version | package_version + ---|------------------|---------|---------------- + 1 | fuel-plugin-qemu | 0.5.0 | 2.0.0 + +9. Plugin is ready to use and can be enabled on the Settings tab of the Fuel web UI. + + +User Guide +========== + +Qemu plugin configuration +--------------------------------------------- + +1. Create a new environment with the Fuel UI wizard. +2. Click on the Settings tab of the Fuel web UI. +3. Scroll down the page, select the plugin checkbox. + + +Build options +------------- + +It is possible to modify process of building plugin by setting environment variables. Look into [pre_build_hook file](pre_build_hook) for more details. + +Dependencies +------------ + +If you plan to use plugin in environment without internet access or/and CentOS environment modify build command: + + INCLUDE_DEPENDENCIES=true fpb --build fuel-plugin-qemu/ + +Pre build script will try download required dependencies so it become part of the compiled plugin. + +Note: List of packages for [ubuntu](qemu_package/ubuntu/dependencies.txt) and [centos](qemu_package/centos/dependencies.txt) may need to be modified if packages in centos or ubuntu repositories will change. + +Testing +------- + +None. + +Known issues +------------ + +None. + +Release Notes +------------- + +**0.5.0** + +* Initial release of the plugin. This is a beta version. + + +Development +=========== + +The *OpenStack Development Mailing List* is the preferred way to communicate, +emails should be sent to `openstack-dev@lists.openstack.org` with the subject +prefixed by `[fuel][plugins][qemu]`. + +Reporting Bugs +-------------- + +Bugs should be filled on the [Launchpad fuel-plugins project]( +https://bugs.launchpad.net/fuel-plugins) (not GitHub) with the tag `qemu`. + + +Contributing +------------ + +If you would like to contribute to the development of this Fuel plugin you must +follow the [OpenStack development workflow]( +http://docs.openstack.org/infra/manual/developers.html#development-workflow). + +Patch reviews take place on the [OpenStack gerrit]( +https://review.openstack.org/#/q/status:open+project:stackforge/fuel-plugin-qemu,n,z) +system. + +Contributors +------------ + +* ling.y.yu@intel.com,ruijing.guo@intel.com + diff --git a/deployment_scripts/puppet/manifests/qemu-install.pp b/deployment_scripts/puppet/manifests/qemu-install.pp new file mode 100644 index 0000000..472acea --- /dev/null +++ b/deployment_scripts/puppet/manifests/qemu-install.pp @@ -0,0 +1,24 @@ +$qemu_version = "1:2.4+dfsg-4ubuntu1" +if $operatingsystem == 'Ubuntu' { + package { 'qemu-block-extra': + ensure => "${qemu_version}", + } + package { 'qemu-utils': + ensure => "${qemu_version}", + require => Package['qemu-block-extra'], + } + package { 'qemu-system': + ensure => "${qemu_version}", + } + package { 'qemu-user': + ensure => "${qemu_version}", + } + package { 'qemu': + ensure => "${qemu_version}", + require => Package['qemu-utils','qemu-system','qemu-user'], + } +} elsif $operatingsystem == 'CentOS' { + package { 'qemu': + ensure => "2.4.0.1-1", + } +} diff --git a/environment_config.yaml b/environment_config.yaml new file mode 100644 index 0000000..4fa5260 --- /dev/null +++ b/environment_config.yaml @@ -0,0 +1,7 @@ +attributes: + fuel-plugin-qemu_text: + value: '2.4' + label: 'Version' + description: 'Description for version' + weight: 25 + type: "text" diff --git a/metadata.yaml b/metadata.yaml new file mode 100644 index 0000000..e74f91b --- /dev/null +++ b/metadata.yaml @@ -0,0 +1,35 @@ +# Plugin name +name: fuel-plugin-qemu +# Human-readable name for your plugin +title: fuel-plugin-qemu +# Plugin version +version: '0.5.0' +# Description +description: 'This plugin provides to deploy openvswitch' +# Required fuel version +fuel_version: ['6.1'] +# Specify license of your plugin +licenses: ['Apache License Version 2.0'] +# Specify author or company name +authors: ['ling.y.yu@intel.com','ruijing.guo@intel.com'] +# A link to the plugin's page +homepage: 'https://github.com/openstack/fuel-plugin-qemu' +# Specify a group which your plugin implements, possible options: +# network, storage, storage::cinder, storage::glance, hypervisor +groups: ['hypervisor'] + +# The plugin is compatible with releases in the list +releases: + - os: ubuntu + version: 2014.2-6.1 + mode: ['ha', 'multinode'] + deployment_scripts_path: deployment_scripts/ + repository_path: repositories/ubuntu + - os: centos + version: 2014.2-6.1 + mode: ['ha', 'multinode'] + deployment_scripts_path: deployment_scripts/ + repository_path: repositories/centos + +# Version of plugin package +package_version: '2.0.0' diff --git a/pre_build_hook b/pre_build_hook new file mode 100755 index 0000000..4445180 --- /dev/null +++ b/pre_build_hook @@ -0,0 +1,41 @@ +#!/bin/bash + +# Add here any the actions which are required before plugin build +# like packages building, packages downloading from mirrors and so on. +# The script should return 0 if there were no errors. +set -eux + +BUILD_FOR=${BUILD_FOR:-centos ubuntu} +DIR="$(dirname `readlink -f $0`)" + +INCLUDE_DEPENDENCIES=${INCLUDE_DEPENDENCIES:-true} + +function download_dependencies { + if [ "$INCLUDE_DEPENDENCIES" = true ] + then + wget --content-disposition -N -i "${DIR}/qemu_package/${1}/dependencies.txt" + fi +} + + +function build_pkg { + case $1 in + centos) + pushd "${DIR}/repositories/${1}/" + download_dependencies ${1} + popd + ;; + ubuntu) + pushd "${DIR}/repositories/${1}/" + download_dependencies ${1} + popd + ;; + *) echo "Not supported system"; exit 1;; + esac +} + + +for system in $BUILD_FOR +do + build_pkg $system +done diff --git a/qemu_package/centos/dependencies.txt b/qemu_package/centos/dependencies.txt new file mode 100644 index 0000000..00b2214 --- /dev/null +++ b/qemu_package/centos/dependencies.txt @@ -0,0 +1 @@ +https://github.com/lingyu1/fuel-rpm/blob/master/centos/6.5/x86_64/Packages/qemu-2.4.0.1-1.x86_64.rpm?raw=true diff --git a/qemu_package/ubuntu/dependencies.txt b/qemu_package/ubuntu/dependencies.txt new file mode 100644 index 0000000..d191896 --- /dev/null +++ b/qemu_package/ubuntu/dependencies.txt @@ -0,0 +1,5 @@ +https://github.com/lingyu1/fuel-rpm/blob/master/ubuntu/14.04.1/x86_64/Packages/qemu-block-extra_2.4+dfsg-4ubuntu1_amd64.deb?raw=true +https://github.com/lingyu1/fuel-rpm/blob/master/ubuntu/14.04.1/x86_64/Packages/qemu-system_2.4+dfsg-4ubuntu1_amd64.deb?raw=true +https://github.com/lingyu1/fuel-rpm/blob/master/ubuntu/14.04.1/x86_64/Packages/qemu-utils_2.4+dfsg-4ubuntu1_amd64.deb?raw=true +https://github.com/lingyu1/fuel-rpm/blob/master/ubuntu/14.04.1/x86_64/Packages/qemu_2.4+dfsg-4ubuntu1_amd64.deb?raw=true +https://github.com/lingyu1/fuel-rpm/blob/master/ubuntu/14.04.1/x86_64/Packages/qemu-user_2.4+dfsg-4ubuntu1_amd64.deb?raw=true diff --git a/repositories/centos/.gitkeep b/repositories/centos/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/repositories/ubuntu/.gitkeep b/repositories/ubuntu/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/tasks.yaml b/tasks.yaml new file mode 100644 index 0000000..635888a --- /dev/null +++ b/tasks.yaml @@ -0,0 +1,8 @@ +- id: qemu_install + role: '*' + stage: pre_deployment + type: puppet + parameters: + puppet_manifest: puppet/manifests/qemu-install.pp + puppet_modules: puppet/modules:/etc/puppet/modules + timeout: 720