From 965b6ed026b21becd17ca84ce1626f9fa9a7f7dc Mon Sep 17 00:00:00 2001 From: Philipp Marek Date: Fri, 22 May 2015 22:05:35 +0200 Subject: [PATCH] drbd-devstack: Initial implementation. This devstack plugin helps to install DRBD on Cinder nodes; this provides a distributed, replicated, high-performant block storage. Change-Id: Ibd1a81c1af66a7aac14bed7840a918684a5a40ca --- .gitignore | 4 + CONTRIBUTING.rst | 13 ++ LICENSE | 176 +++++++++++++++++++ README.rst | 15 ++ drbd-devstack.json | 3 + drbd-devstack/devstack/.gitignore | 4 + drbd-devstack/devstack/lib/drbd_devstack | 209 +++++++++++++++++++++++ drbd-devstack/devstack/override-defaults | 4 + drbd-devstack/devstack/plugin.sh | 41 +++++ drbd-devstack/devstack/settings | 10 ++ tox.ini | 25 +++ 11 files changed, 504 insertions(+) create mode 100644 .gitignore create mode 100644 CONTRIBUTING.rst create mode 100644 LICENSE create mode 100644 README.rst create mode 100644 drbd-devstack.json create mode 100644 drbd-devstack/devstack/.gitignore create mode 100755 drbd-devstack/devstack/lib/drbd_devstack create mode 100644 drbd-devstack/devstack/override-defaults create mode 100644 drbd-devstack/devstack/plugin.sh create mode 100644 drbd-devstack/devstack/settings create mode 100644 tox.ini diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..1774e9b --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +.*.sw? +*~ + + diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 0000000..0664e26 --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,13 @@ +If you would like to contribute to the development of OpenStack, +you must follow the steps in the "If you're a developer, start here" +section of this page: + + http://wiki.openstack.org/HowToContribute + +Once those steps have been completed, changes to OpenStack +should be submitted for review via the Gerrit tool, following +the workflow documented at: + + http://wiki.openstack.org/GerritWorkflow + +Pull requests submitted through GitHub will be ignored. 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..71b83d5 --- /dev/null +++ b/README.rst @@ -0,0 +1,15 @@ +============= +drbd-devstack +============= + +DRBD installation helper for DevStack. + +* Free software: Apache license + +This plugin helps to install the DRBD backend for Cinder +(and, later on, Nova) in a devstack install. + +Usage +----- + +???? diff --git a/drbd-devstack.json b/drbd-devstack.json new file mode 100644 index 0000000..6c7ea78 --- /dev/null +++ b/drbd-devstack.json @@ -0,0 +1,3 @@ +{ + "service": "drbd-devstack" +} diff --git a/drbd-devstack/devstack/.gitignore b/drbd-devstack/devstack/.gitignore new file mode 100644 index 0000000..dcf51ce --- /dev/null +++ b/drbd-devstack/devstack/.gitignore @@ -0,0 +1,4 @@ +*~ +.*.sw? +.prereqs +.tox diff --git a/drbd-devstack/devstack/lib/drbd_devstack b/drbd-devstack/devstack/lib/drbd_devstack new file mode 100755 index 0000000..301127c --- /dev/null +++ b/drbd-devstack/devstack/lib/drbd_devstack @@ -0,0 +1,209 @@ +#!/bin/bash +# vim: set et ts=4 sw=4 ft=sh : +# Can we set global variables here? +# Hash to access LINBIT repositories +FILES="$(dirname '$0')/files" + +function pre_install_drbd_devstack { + # Install OS packages, if necessary + # see wget logic in https://github.com/openstack-dev/devstack/blob/master/pkg/elasticsearch.sh + # drbdmanage, drbd-dkms, drbd-utils + if [[ ! -d ${FILES} ]]; then + mkdir ${FILES} + fi + # drbd-dkms="drbd-dkms_9.0.0rc2-1_all.deb" + # drbd-utils="drbd-utils_8.9.2+linbit-1_amd64.deb" + # drbd-manage="python-drbdmanage_0.20-33_all.deb" + packages=('drbd-utils_8.9.3rc1-1_amd64.deb' 'drbd8-utils_8.9.3rc1-1_amd64.deb' 'drbd-dkms_9.0.0rc3-1_all.deb' 'python-drbdmanage_0.34-1_all.deb'); + # get packages + for p in "${packages[@]}"; do + if [[ ! -f ${FILES}/${p}* ]]; then + # If there are newer packages, change the download number here. + wget "http://openstack-ci-pkgs.linbit.com/packages/001/trusty/$p" -O ${FILES}/${p} + fi + done + # install packages + for i in "${packages[@]}"; do + if [[ -f "${FILES}/${i}" ]]; then + echo "installing ${i}" + sudo dpkg -i ${FILES}/${i} || true + fi + done + # now go fetch :) + echo echo "installing deps" + #sudo apt-get update + sudo apt-get install -f -y + sudo apt-get install python-dbus -y + return 0 +} + +function install_drbd_devstack { + # Install the service. + + # write /etc/drbdmanage*.conf + #echo "drbdctrl-vg = $DRBD_DRBDCTRL_VG" >> /etc/drbdmanaged.conf + #echo "volume-group = $DRBD_DATA_VG" >> /etc/drbdmanaged-lvm.conf + sudo sed -i "s/^drbdctrl-vg\s*=.*/drbdctrl-vg = ${DRBD_DRBDCTRL_VG}/g" /etc/drbdmanaged.conf + sudo sed -i "s/^volume-group\s*=.*/volume-group = ${DRBD_DATA_VG}/g" /etc/drbdmanaged-lvm.conf + + # allow the stack user access to drbdmanage + sudo echo << "EOF" > /etc/dbus-1/system.d/org.drbd.drbdmanaged-stack.conf + + + + + + +EOF + + # done. +} + +function configure_drbd_devstack { + # Configure the service. + local be_name="${1:-drbdmanage}" + + iniset $CINDER_CONF "$be_name" volume_backend_name "$be_name" + iniset $CINDER_CONF "$be_name" volume_driver cinder.volume.drivers.drbdmanagedrv.DrbdManageDriver +} + +function init_drbd_devstack { + # Initialize and start the service. + # need to setup loopback device(s) for DRBD + + # dd if=/dev/zero of=${FILES}/${DRBD_DRBDCTRL_VG} count=1 bs=${DRBD_DRBDCTRL_VG_SZ} + # mknod -m 660 /dev/${DRBD_DRBDCTRL_LODEV} b 7 66 + # losetup ${FILES}/${DRBD_DRBDCTRL_VG} + # sed -i 's/global_filter = \[ /global_filter = \[ "a|loop3|", /g' /etc/lvm/lvm.conf + # pvcreate /dev/loop3 + # vgcreate ${DRBD_DRBDCTRL_VG} + + # if the file exists, don't destroy it... + if [[ ! -f ${FILES}/${DRBD_DRBDCTRL_VG} ]]; then + #dd if=/dev/zero of=${FILES}/${DRBD_DRBDCTRL_VG} count=1 bs=${DRBD_DRBDCTRL_VG_SZ} + sudo truncate -s ${DRBD_DRBDCTRL_VG_SZ} ${FILES}/${DRBD_DRBDCTRL_VG} + fi + + # if the loop device is present, don't recreate it... + if [[ ! -e /dev/${DRBD_DRBDCTRL_LODEV} ]]; then + DRBDCTRL_LO_MINOR=`echo ${DRBD_DRBDCTRL_LODEV} | sed 's/loop//g'` + sudo mknod -m 660 /dev/${DRBD_DRBDCTRL_LODEV} b 7 ${DRBDCTRL_LO_MINOR} + fi + + # if the file is already assigned a loop device, don't reassign + sudo losetup -a | grep ${DRBD_DRBDCTRL_LODEV} | grep -q ${DRBD_DRBDCTRL_VG} + if [[ $? -ne 0 ]]; then + sudo losetup /dev/${DRBD_DRBDCTRL_LODEV} ${FILES}/${DRBD_DRBDCTRL_VG} + fi + + # if the lvm.conf already accepts the loop device, don't insert it again + sudo grep -q ${DRBD_DRBDCTRL_LODEV} /etc/lvm/lvm.conf + if [[ $? -ne 0 ]]; then + sudo sed -i.drbdctrl-bak "s/global_filter = \[ /global_filter = \[ \"a|${DRBD_DRBDCTRL_LODEV}|\", /g" /etc/lvm/lvm.conf + fi + + # if theres already a pv signature, don't try to recreate + sudo pvdisplay | grep -q ${DRBD_DRBDCTRL_LODEV} + if [[ $? -ne 0 ]]; then + sudo pvscan + sudo pvdisplay | grep -q ${DRBD_DRBDCTRL_LODEV} + if [[ $? -ne 0 ]]; then + sudo pvcreate /dev/${DRBD_DRBDCTRL_LODEV} + fi + fi + + # if theres already a vg, don't try to recreate + sudo vgdisplay | grep -q ${DRBD_DRBDCTRL_VG} + if [[ $? -ne 0 ]]; then + sudo vgscan + sudo vgdisplay | grep -q ${DRBD_DRBDCTRL_VG} + if [[ $? -ne 0 ]]; then + sudo vgcreate ${DRBD_DRBDCTRL_VG} /dev/${DRBD_DRBDCTRL_LODEV} + fi + fi + + # Do the same thing for the DATA volume group + # dd if=/dev/zero of=${FILES}/${DRBD_DATA_VG} count=1 bs=${DRBD_DATA_VG_SZ} + # losetup ${FILES}/${DRBD_DATA_VG} + # sed -i 's/global_filter = \[ /global_filter = \[ "a|loop4|", /g' /etc/lvm/lvm.conf + # pvcreate /dev/loop4 + # vgcreate ${DRBD_DATA_VG} + + # if the file exists, don't destroy it... + if [[ ! -f ${FILES}/${DRBD_DATA_VG} ]]; then + #dd if=/dev/zero of=${FILES}/${DRBD_DATA_VG} count=1 bs=${DRBD_DATA_VG_SZ} + sudo truncate -s ${DRBD_DATA_VG_SZ} ${FILES}/${DRBD_DATA_VG} + fi + + # if the loop device is present, don't recreate it... + if [[ ! -e /dev/${DRBD_DATA_LODEV} ]]; then + DATA_LO_MINOR=`echo ${DRBD_DATA_LODEV} | sed 's/loop//g'` + sudo mknod -m 660 /dev/${DRBD_DATA_LODEV} b 7 ${DATA_LO_MINOR} + fi + + # if the file is already assigned a loop device, don't reassign + sudo losetup -a | grep ${DRBD_DATA_LODEV} | grep -q ${DRBD_DATA_VG} + if [[ $? -ne 0 ]]; then + sudo losetup /dev/${DRBD_DATA_LODEV} ${FILES}/${DRBD_DATA_VG} + fi + + # if the lvm.conf already accepts the loop device, don't insert it again + sudo grep -q ${DRBD_DATA_LODEV} /etc/lvm/lvm.conf + if [[ $? -ne 0 ]]; then + sudo sed -i.drbddata-bak "s/global_filter = \[ /global_filter = \[ \"a|${DRBD_DATA_LODEV}|\", /g" /etc/lvm/lvm.conf + fi + + # if theres already a pv signature, don't try to recreate + sudo pvdisplay | grep -q ${DRBD_DATA_LODEV} + if [[ $? -ne 0 ]]; then + sudo pvscan + sudo pvdisplay | grep -q ${DRBD_DATA_LODEV} + if [[ $? -ne 0 ]]; then + sudo pvcreate /dev/${DRBD_DATA_LODEV} + fi + fi + + # if theres already a vg, don't try to recreate + sudo vgdisplay | grep -q ${DRBD_DATA_VG} + if [[ $? -ne 0 ]]; then + sudo vgscan + sudo vgdisplay | grep -q ${DRBD_DATA_VG} + if [[ $? -ne 0 ]]; then + sudo vgcreate ${DRBD_DATA_VG} /dev/${DRBD_DATA_LODEV} + fi + fi + + # initialize drbdmanage + sudo drbdmanage init --quiet + # FIXME: multi-node setups +} + +function shutdown_drbd_devstack { + # Shut the service down. + # drbdadm down all + # drbdmanage shutdown --quiet + echo "shutdown drbd devstack" +} + +function cleanup_drbd_devstack { + # Cleanup the service. + # something like + # drbdmanage list-resource --short | xargs -l drbdmanage remove-resource + # ??? + # drbdmanage resources -m | sed 's/,.*//g' | xargs -l drbdmanage remove-resource --quiet + echo "cleanup drbd devstack" +} + +#debug main +#source $(dirname '$0')/../settings +#pre_install_drbd_devstack +#install_drbd_devstack +#configure_drbd_devstack +#init_drbd_devstack + +# Tell emacs to use shell-script-mode +## Local variables: +## mode: shell-script +## End: diff --git a/drbd-devstack/devstack/override-defaults b/drbd-devstack/devstack/override-defaults new file mode 100644 index 0000000..200211c --- /dev/null +++ b/drbd-devstack/devstack/override-defaults @@ -0,0 +1,4 @@ +# Plug-in overrides + +CINDER_ENABLED_BACKENDS=${CINDER_ENABLED_BACKENDS:-drbd:drbd} + diff --git a/drbd-devstack/devstack/plugin.sh b/drbd-devstack/devstack/plugin.sh new file mode 100644 index 0000000..547f72d --- /dev/null +++ b/drbd-devstack/devstack/plugin.sh @@ -0,0 +1,41 @@ +# check for service enabled +if is_service_enabled drbd_devstack; then + if [[ "$1" == "source" ]]; then + # Initial source of lib script + source $(dirname "$0")/lib/drbd_devstack + fi + + if [[ "$1" == "stack" && "$2" == "pre-install" ]]; then + # Set up system services + echo_summary "Configuring system services drbd_devstack" + pre_install_drbd_devstack + + elif [[ "$1" == "stack" && "$2" == "install" ]]; then + # Perform installation of service source + echo_summary "Installing drbd_devstack" + install_drbd_devstack + + elif [[ "$1" == "stack" && "$2" == "post-config" ]]; then + # Configure after the other layer 1 and 2 services have been configured + echo_summary "Configuring drbd_devstack" + configure_drbd_devstack + + elif [[ "$1" == "stack" && "$2" == "extra" ]]; then + # Initialize and start the drbd_devstack service + echo_summary "Initializing drbd_devstack" + init_drbd_devstack + fi + + if [[ "$1" == "unstack" ]]; then + # Shut down drbd_devstack services + # no-op + shutdown_drbd_devstack + fi + + if [[ "$1" == "clean" ]]; then + # Remove state and transient data + # Remember clean.sh first calls unstack.sh + # no-op + cleanup_drbd_devstack + fi +fi diff --git a/drbd-devstack/devstack/settings b/drbd-devstack/devstack/settings new file mode 100644 index 0000000..4164ae2 --- /dev/null +++ b/drbd-devstack/devstack/settings @@ -0,0 +1,10 @@ +# Devstack settings + + +TEMPEST_STORAGE_PROTOCOL=drbd +DRBD_DRBDCTRL_VG_SZ=1G +DRBD_DRBDCTRL_LODEV=loop66 +DRBD_DRBDCTRL_VG=drbdpool +DRBD_DATA_VG_SZ=7G +DRBD_DATA_VG=drbddata +DRBD_DATA_LODEV=loop67 diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..20ecbaa --- /dev/null +++ b/tox.ini @@ -0,0 +1,25 @@ +[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 \) \ # prune all 'dot' dirs + -not \( -type d -name doc -prune \) \ # skip documentation + -type f \ # only files + -not -name \*~ \ # skip editors, readme, etc + -not -name \*.md \ + \( \ + -name \*.sh -or \ + -name \*rc -or \ + -name functions\* -or \ + -wholename \*/lib/\* \ # /lib files are shell, but + \) \ # have no extension + -print0 | xargs -0 bashate -v"