summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEric Harney <eharney@redhat.com>2016-01-27 12:16:50 -0500
committerEric Harney <eharney@redhat.com>2016-03-30 09:06:44 -0400
commit217010a78a8af5fdff095471c9af131dc2598212 (patch)
treefaca37ec5b8a423f02a7b1349f53e22398049ca9
parente5c041f63afb7bdca00411277928306ba9546133 (diff)
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
Notes
Notes (review): Code-Review+1: Tom Barron <tpb@dyncloud.net> Code-Review+2: Eric Harney <eharney@redhat.com> Workflow+1: Eric Harney <eharney@redhat.com> Verified+2: Jenkins Submitted-by: Jenkins Submitted-at: Wed, 30 Mar 2016 13:58:00 +0000 Reviewed-on: https://review.openstack.org/296563 Project: openstack/devstack-plugin-nfs Branch: refs/heads/master
-rw-r--r--LICENSE201
-rw-r--r--README.md4
-rw-r--r--devstack/override-defaults6
-rw-r--r--devstack/plugin.sh98
-rw-r--r--tox.ini25
5 files changed, 334 insertions, 0 deletions
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..8dada3e
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,201 @@
1 Apache License
2 Version 2.0, January 2004
3 http://www.apache.org/licenses/
4
5 TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
7 1. Definitions.
8
9 "License" shall mean the terms and conditions for use, reproduction,
10 and distribution as defined by Sections 1 through 9 of this document.
11
12 "Licensor" shall mean the copyright owner or entity authorized by
13 the copyright owner that is granting the License.
14
15 "Legal Entity" shall mean the union of the acting entity and all
16 other entities that control, are controlled by, or are under common
17 control with that entity. For the purposes of this definition,
18 "control" means (i) the power, direct or indirect, to cause the
19 direction or management of such entity, whether by contract or
20 otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 outstanding shares, or (iii) beneficial ownership of such entity.
22
23 "You" (or "Your") shall mean an individual or Legal Entity
24 exercising permissions granted by this License.
25
26 "Source" form shall mean the preferred form for making modifications,
27 including but not limited to software source code, documentation
28 source, and configuration files.
29
30 "Object" form shall mean any form resulting from mechanical
31 transformation or translation of a Source form, including but
32 not limited to compiled object code, generated documentation,
33 and conversions to other media types.
34
35 "Work" shall mean the work of authorship, whether in Source or
36 Object form, made available under the License, as indicated by a
37 copyright notice that is included in or attached to the work
38 (an example is provided in the Appendix below).
39
40 "Derivative Works" shall mean any work, whether in Source or Object
41 form, that is based on (or derived from) the Work and for which the
42 editorial revisions, annotations, elaborations, or other modifications
43 represent, as a whole, an original work of authorship. For the purposes
44 of this License, Derivative Works shall not include works that remain
45 separable from, or merely link (or bind by name) to the interfaces of,
46 the Work and Derivative Works thereof.
47
48 "Contribution" shall mean any work of authorship, including
49 the original version of the Work and any modifications or additions
50 to that Work or Derivative Works thereof, that is intentionally
51 submitted to Licensor for inclusion in the Work by the copyright owner
52 or by an individual or Legal Entity authorized to submit on behalf of
53 the copyright owner. For the purposes of this definition, "submitted"
54 means any form of electronic, verbal, or written communication sent
55 to the Licensor or its representatives, including but not limited to
56 communication on electronic mailing lists, source code control systems,
57 and issue tracking systems that are managed by, or on behalf of, the
58 Licensor for the purpose of discussing and improving the Work, but
59 excluding communication that is conspicuously marked or otherwise
60 designated in writing by the copyright owner as "Not a Contribution."
61
62 "Contributor" shall mean Licensor and any individual or Legal Entity
63 on behalf of whom a Contribution has been received by Licensor and
64 subsequently incorporated within the Work.
65
66 2. Grant of Copyright License. Subject to the terms and conditions of
67 this License, each Contributor hereby grants to You a perpetual,
68 worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 copyright license to reproduce, prepare Derivative Works of,
70 publicly display, publicly perform, sublicense, and distribute the
71 Work and such Derivative Works in Source or Object form.
72
73 3. Grant of Patent License. Subject to the terms and conditions of
74 this License, each Contributor hereby grants to You a perpetual,
75 worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 (except as stated in this section) patent license to make, have made,
77 use, offer to sell, sell, import, and otherwise transfer the Work,
78 where such license applies only to those patent claims licensable
79 by such Contributor that are necessarily infringed by their
80 Contribution(s) alone or by combination of their Contribution(s)
81 with the Work to which such Contribution(s) was submitted. If You
82 institute patent litigation against any entity (including a
83 cross-claim or counterclaim in a lawsuit) alleging that the Work
84 or a Contribution incorporated within the Work constitutes direct
85 or contributory patent infringement, then any patent licenses
86 granted to You under this License for that Work shall terminate
87 as of the date such litigation is filed.
88
89 4. Redistribution. You may reproduce and distribute copies of the
90 Work or Derivative Works thereof in any medium, with or without
91 modifications, and in Source or Object form, provided that You
92 meet the following conditions:
93
94 (a) You must give any other recipients of the Work or
95 Derivative Works a copy of this License; and
96
97 (b) You must cause any modified files to carry prominent notices
98 stating that You changed the files; and
99
100 (c) You must retain, in the Source form of any Derivative Works
101 that You distribute, all copyright, patent, trademark, and
102 attribution notices from the Source form of the Work,
103 excluding those notices that do not pertain to any part of
104 the Derivative Works; and
105
106 (d) If the Work includes a "NOTICE" text file as part of its
107 distribution, then any Derivative Works that You distribute must
108 include a readable copy of the attribution notices contained
109 within such NOTICE file, excluding those notices that do not
110 pertain to any part of the Derivative Works, in at least one
111 of the following places: within a NOTICE text file distributed
112 as part of the Derivative Works; within the Source form or
113 documentation, if provided along with the Derivative Works; or,
114 within a display generated by the Derivative Works, if and
115 wherever such third-party notices normally appear. The contents
116 of the NOTICE file are for informational purposes only and
117 do not modify the License. You may add Your own attribution
118 notices within Derivative Works that You distribute, alongside
119 or as an addendum to the NOTICE text from the Work, provided
120 that such additional attribution notices cannot be construed
121 as modifying the License.
122
123 You may add Your own copyright statement to Your modifications and
124 may provide additional or different license terms and conditions
125 for use, reproduction, or distribution of Your modifications, or
126 for any such Derivative Works as a whole, provided Your use,
127 reproduction, and distribution of the Work otherwise complies with
128 the conditions stated in this License.
129
130 5. Submission of Contributions. Unless You explicitly state otherwise,
131 any Contribution intentionally submitted for inclusion in the Work
132 by You to the Licensor shall be under the terms and conditions of
133 this License, without any additional terms or conditions.
134 Notwithstanding the above, nothing herein shall supersede or modify
135 the terms of any separate license agreement you may have executed
136 with Licensor regarding such Contributions.
137
138 6. Trademarks. This License does not grant permission to use the trade
139 names, trademarks, service marks, or product names of the Licensor,
140 except as required for reasonable and customary use in describing the
141 origin of the Work and reproducing the content of the NOTICE file.
142
143 7. Disclaimer of Warranty. Unless required by applicable law or
144 agreed to in writing, Licensor provides the Work (and each
145 Contributor provides its Contributions) on an "AS IS" BASIS,
146 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 implied, including, without limitation, any warranties or conditions
148 of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 PARTICULAR PURPOSE. You are solely responsible for determining the
150 appropriateness of using or redistributing the Work and assume any
151 risks associated with Your exercise of permissions under this License.
152
153 8. Limitation of Liability. In no event and under no legal theory,
154 whether in tort (including negligence), contract, or otherwise,
155 unless required by applicable law (such as deliberate and grossly
156 negligent acts) or agreed to in writing, shall any Contributor be
157 liable to You for damages, including any direct, indirect, special,
158 incidental, or consequential damages of any character arising as a
159 result of this License or out of the use or inability to use the
160 Work (including but not limited to damages for loss of goodwill,
161 work stoppage, computer failure or malfunction, or any and all
162 other commercial damages or losses), even if such Contributor
163 has been advised of the possibility of such damages.
164
165 9. Accepting Warranty or Additional Liability. While redistributing
166 the Work or Derivative Works thereof, You may choose to offer,
167 and charge a fee for, acceptance of support, warranty, indemnity,
168 or other liability obligations and/or rights consistent with this
169 License. However, in accepting such obligations, You may act only
170 on Your own behalf and on Your sole responsibility, not on behalf
171 of any other Contributor, and only if You agree to indemnify,
172 defend, and hold each Contributor harmless for any liability
173 incurred by, or claims asserted against, such Contributor by reason
174 of your accepting any such warranty or additional liability.
175
176 END OF TERMS AND CONDITIONS
177
178 APPENDIX: How to apply the Apache License to your work.
179
180 To apply the Apache License to your work, attach the following
181 boilerplate notice, with the fields enclosed by brackets "{}"
182 replaced with your own identifying information. (Don't include
183 the brackets!) The text should be enclosed in the appropriate
184 comment syntax for the file format. We also recommend that a
185 file or class name and description of purpose be included on the
186 same "printed page" as the copyright notice for easier
187 identification within third-party archives.
188
189 Copyright {yyyy} {name of copyright owner}
190
191 Licensed under the Apache License, Version 2.0 (the "License");
192 you may not use this file except in compliance with the License.
193 You may obtain a copy of the License at
194
195 http://www.apache.org/licenses/LICENSE-2.0
196
197 Unless required by applicable law or agreed to in writing, software
198 distributed under the License is distributed on an "AS IS" BASIS,
199 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 See the License for the specific language governing permissions and
201 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 @@
1To use:
2
3enable_plugin devstack-plugin-nfs http://url_to/this_plugin/nfs
4
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 @@
1ENABLE_NFS_CINDER=$(trueorfalse True ENABLE_NFS_CINDER)
2
3if [[ $ENABLE_NFS_CINDER == "True" ]]; then
4 CINDER_DRIVER=nfs
5 CINDER_ENABLED_BACKENDS=nfs:nfs
6fi
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 @@
1#
2
3XTRACE=$(set +o | grep xtrace)
4set +o xtrace
5
6NFS_EXPORT_DIR=${NFS_EXPORT_DIR:-/srv/nfs1}
7STACK_NFS_CONF=${STACK_NFS_CONF:-/etc/exports.d/stack_nfs.exports}
8NFS_SHARES_CONF=${NFS_SHARES_CONF:-/etc/cinder/nfs-shares.conf}
9NFS_SECURE_FILE_PERMISSIONS=${NFS_SECURE_FILE_PERMISSIONS:-False}
10NFS_SECURE_FILE_OPERATIONS=${NFS_SECURE_FILE_OPERATIONS:-False}
11
12if is_ubuntu; then
13 NFS_SERVICE=nfs-kernel-server
14else
15 NFS_SERVICE=nfs-server
16fi
17
18function install_nfs {
19 if is_ubuntu; then
20 install_package nfs-common
21 install_package nfs-kernel-server
22 elif is_fedora; then
23 install_package nfs-utils
24 elif is_suse; then
25 install_package nfs-kernel-server
26 install_package nfs-client
27 fi
28}
29
30function configure_nfs {
31 sudo mkdir -p $NFS_EXPORT_DIR
32 sudo mkdir -p /etc/exports.d
33
34 cat <<EOF | sudo tee ${STACK_NFS_CONF}>/dev/null
35$NFS_EXPORT_DIR localhost(rw,no_root_squash)
36EOF
37}
38
39function start_nfs {
40 sudo service $NFS_SERVICE start
41}
42
43# is_nfs_enabled_for_service() - checks whether the OpenStack service
44# specified as an argument is enabled with NFS as its storage backend.
45function is_nfs_enabled_for_service {
46 local config config_name enabled service
47 enabled=1
48 service=$1
49 # Construct the global variable ENABLE_NFS_.* corresponding to a
50 # $service.
51 config_name=ENABLE_NFS_$(echo $service | \
52 tr '[:lower:]' '[:upper:]' | tr '-' '_')
53 config=$(eval echo "\$$config_name")
54
55 if (is_service_enabled $service) && [[ $config == 'True' ]]; then
56 enabled=0
57 fi
58 return $enabled
59}
60
61function configure_cinder_nfs {
62 echo "localhost:${NFS_EXPORT_DIR}" > ${NFS_SHARES_CONF}
63 iniset $CINDER_CONF nfs nfs_shares_config ${NFS_SHARES_CONF}
64 iniset $CINDER_CONF nfs nas_secure_file_operations \
65 ${NFS_SECURE_FILE_OPERATIONS}
66 iniset $CINDER_CONF nfs nas_secure_file_permissions \
67 ${NFS_SECURE_FILE_PERMISSIONS}
68}
69
70
71if [[ "$1" == "stack" && "$2" == "pre-install" ]]; then
72 echo_summary "Installing NFS"
73 install_nfs
74 echo_summary "Configuring NFS"
75 configure_nfs
76 echo_summary "Initializing NFS"
77 start_nfs
78elif [[ "$1" == "stack" && "$2" == "post-config" ]]; then
79 if is_nfs_enabled_for_service cinder; then
80 configure_cinder_nfs
81 sudo service $NFS_SERVICE restart
82 fi
83fi
84
85if [[ "$1" == "unstack" ]]; then
86 # Unmount any NFS shares mounted by Cinder
87 find ${DATA_DIR}/cinder/mnt -mindepth 1 -maxdepth 1 -type d \
88 | sudo xargs umount -l
89
90 sudo rm -f ${STACK_NFS_CONF}
91
92 # Reload to ensure (removed) config is reread, but don't
93 # interfere with other NFS exports.
94 sudo service $NFS_SERVICE reload
95fi
96
97
98$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 @@
1[tox]
2minversion = 1.6
3skipsdist = True
4envlist = bashate
5
6[testenv]
7usedevelop = False
8install_command = pip install {opts} {packages}
9
10[testenv:bashate]
11deps = bashate
12whitelist_externals = bash
13commands = bash -c "find {toxinidir} \
14 -not \( -type d -name .?\* -prune \) \
15 -not \( -type d -name doc -prune \) \
16 -type f \
17 -not -name \*~ \
18 -not -name \*.md \
19 \( \
20 -name \*.sh -or \
21 -name \*rc -or \
22 -name functions\* -or \
23 -wholename \*/lib/\* \
24 \) \
25 -print0 | xargs -0 bashate -v"