From 217010a78a8af5fdff095471c9af131dc2598212 Mon Sep 17 00:00:00 2001 From: Eric Harney Date: Wed, 27 Jan 2016 12:16:50 -0500 Subject: [PATCH] Initial import Import from github/eharney/devstack-plugin-nfs @ 9106b37 + rename override_defaults -> override-defaults + remove xtrace from override-defaults + restart NFS service after config + add .exports suffix to /etc/exports.d/ config + no_root_squash + is_suse Change-Id: I6b9dcd55bcbb28a0567bf5bf279eac4dbb21ef22 --- LICENSE | 201 +++++++++++++++++++++++++++++++++++++ README.md | 4 + devstack/override-defaults | 6 ++ devstack/plugin.sh | 98 ++++++++++++++++++ tox.ini | 25 +++++ 5 files changed, 334 insertions(+) create mode 100644 LICENSE create mode 100644 README.md create mode 100644 devstack/override-defaults create mode 100644 devstack/plugin.sh create mode 100644 tox.ini diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..8dada3e --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + 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..28916af --- /dev/null +++ b/README.md @@ -0,0 +1,4 @@ +To use: + +enable_plugin devstack-plugin-nfs http://url_to/this_plugin/nfs + diff --git a/devstack/override-defaults b/devstack/override-defaults new file mode 100644 index 0000000..5e013e3 --- /dev/null +++ b/devstack/override-defaults @@ -0,0 +1,6 @@ +ENABLE_NFS_CINDER=$(trueorfalse True ENABLE_NFS_CINDER) + +if [[ $ENABLE_NFS_CINDER == "True" ]]; then + CINDER_DRIVER=nfs + CINDER_ENABLED_BACKENDS=nfs:nfs +fi diff --git a/devstack/plugin.sh b/devstack/plugin.sh new file mode 100644 index 0000000..4c15289 --- /dev/null +++ b/devstack/plugin.sh @@ -0,0 +1,98 @@ +# + +XTRACE=$(set +o | grep xtrace) +set +o xtrace + +NFS_EXPORT_DIR=${NFS_EXPORT_DIR:-/srv/nfs1} +STACK_NFS_CONF=${STACK_NFS_CONF:-/etc/exports.d/stack_nfs.exports} +NFS_SHARES_CONF=${NFS_SHARES_CONF:-/etc/cinder/nfs-shares.conf} +NFS_SECURE_FILE_PERMISSIONS=${NFS_SECURE_FILE_PERMISSIONS:-False} +NFS_SECURE_FILE_OPERATIONS=${NFS_SECURE_FILE_OPERATIONS:-False} + +if is_ubuntu; then + NFS_SERVICE=nfs-kernel-server +else + NFS_SERVICE=nfs-server +fi + +function install_nfs { + if is_ubuntu; then + install_package nfs-common + install_package nfs-kernel-server + elif is_fedora; then + install_package nfs-utils + elif is_suse; then + install_package nfs-kernel-server + install_package nfs-client + fi +} + +function configure_nfs { + sudo mkdir -p $NFS_EXPORT_DIR + sudo mkdir -p /etc/exports.d + + cat </dev/null +$NFS_EXPORT_DIR localhost(rw,no_root_squash) +EOF +} + +function start_nfs { + sudo service $NFS_SERVICE start +} + +# is_nfs_enabled_for_service() - checks whether the OpenStack service +# specified as an argument is enabled with NFS as its storage backend. +function is_nfs_enabled_for_service { + local config config_name enabled service + enabled=1 + service=$1 + # Construct the global variable ENABLE_NFS_.* corresponding to a + # $service. + config_name=ENABLE_NFS_$(echo $service | \ + tr '[:lower:]' '[:upper:]' | tr '-' '_') + config=$(eval echo "\$$config_name") + + if (is_service_enabled $service) && [[ $config == 'True' ]]; then + enabled=0 + fi + return $enabled +} + +function configure_cinder_nfs { + echo "localhost:${NFS_EXPORT_DIR}" > ${NFS_SHARES_CONF} + iniset $CINDER_CONF nfs nfs_shares_config ${NFS_SHARES_CONF} + iniset $CINDER_CONF nfs nas_secure_file_operations \ + ${NFS_SECURE_FILE_OPERATIONS} + iniset $CINDER_CONF nfs nas_secure_file_permissions \ + ${NFS_SECURE_FILE_PERMISSIONS} +} + + +if [[ "$1" == "stack" && "$2" == "pre-install" ]]; then + echo_summary "Installing NFS" + install_nfs + echo_summary "Configuring NFS" + configure_nfs + echo_summary "Initializing NFS" + start_nfs +elif [[ "$1" == "stack" && "$2" == "post-config" ]]; then + if is_nfs_enabled_for_service cinder; then + configure_cinder_nfs + sudo service $NFS_SERVICE restart + fi +fi + +if [[ "$1" == "unstack" ]]; then + # Unmount any NFS shares mounted by Cinder + find ${DATA_DIR}/cinder/mnt -mindepth 1 -maxdepth 1 -type d \ + | sudo xargs umount -l + + sudo rm -f ${STACK_NFS_CONF} + + # Reload to ensure (removed) config is reread, but don't + # interfere with other NFS exports. + sudo service $NFS_SERVICE reload +fi + + +$XTRACE diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..8e75f0d --- /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 \) \ + -not \( -type d -name doc -prune \) \ + -type f \ + -not -name \*~ \ + -not -name \*.md \ + \( \ + -name \*.sh -or \ + -name \*rc -or \ + -name functions\* -or \ + -wholename \*/lib/\* \ + \) \ + -print0 | xargs -0 bashate -v"