commit e4f3ba26d6f6a15458222fb69356a5ed1804a74a Author: Alexander Kislitsky Date: Fri Dec 12 18:21:32 2014 +0300 NFS plugin Provides external NFS server as Cinder backend .build and *.fp added to .gitignore Change-Id: Ibb98cf483ce8f45466555b9e1e1a939f85a6f4da Implements: blueprint cinder-neutron-plugins-in-fuel 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..ecc870b --- /dev/null +++ b/README.md @@ -0,0 +1,4 @@ +External NFS storage as Cinder backend +====================================== + +Plugin for using external NFS shares as Cinder backend. diff --git a/deployment_scripts/puppet/modules/cindernfs/lib/puppet/provider/cinder_config/ini_setting.rb b/deployment_scripts/puppet/modules/cindernfs/lib/puppet/provider/cinder_config/ini_setting.rb new file mode 100644 index 0000000..6dcd955 --- /dev/null +++ b/deployment_scripts/puppet/modules/cindernfs/lib/puppet/provider/cinder_config/ini_setting.rb @@ -0,0 +1,27 @@ +Puppet::Type.type(:cinder_config).provide( + :ini_setting, + :parent => Puppet::Type.type(:ini_setting).provider(:ruby) +) do + + def section + resource[:name].split('/', 2).first + end + + def setting + resource[:name].split('/', 2).last + end + + def separator + '=' + end + + def self.file_path + '/etc/cinder/cinder.conf' + end + + # added for backwards compatibility with older versions of inifile + def file_path + self.class.file_path + end + +end diff --git a/deployment_scripts/puppet/modules/cindernfs/lib/puppet/type/cinder_config.rb b/deployment_scripts/puppet/modules/cindernfs/lib/puppet/type/cinder_config.rb new file mode 100644 index 0000000..62d3825 --- /dev/null +++ b/deployment_scripts/puppet/modules/cindernfs/lib/puppet/type/cinder_config.rb @@ -0,0 +1,42 @@ +Puppet::Type.newtype(:cinder_config) do + + ensurable + + newparam(:name, :namevar => true) do + desc 'Section/setting name to manage from /etc/cinder/cinder.conf' + newvalues(/\S+\/\S+/) + end + + newproperty(:value) do + desc 'The value of the setting to be defined.' + munge do |value| + value = value.to_s.strip + value.capitalize! if value =~ /^(true|false)$/i + value + end + + def is_to_s( currentvalue ) + if resource.secret? + return '[old secret redacted]' + else + return currentvalue + end + end + + def should_to_s( newvalue ) + if resource.secret? + return '[new secret redacted]' + else + return newvalue + end + end + end + + newparam(:secret, :boolean => true) do + desc 'Whether to hide the value from Puppet logs. Defaults to `false`.' + + newvalues(:true, :false) + + defaultto false + end +end diff --git a/deployment_scripts/puppet/modules/cindernfs/manifests/backend/nfs.pp b/deployment_scripts/puppet/modules/cindernfs/manifests/backend/nfs.pp new file mode 100644 index 0000000..52d9b10 --- /dev/null +++ b/deployment_scripts/puppet/modules/cindernfs/manifests/backend/nfs.pp @@ -0,0 +1,67 @@ +# +# == Class: cindernfs::backend::nfs +# +# Configures Cinder to use NFS as a volume driver +# +# === Parameters +# +# [*nfs_shares*] +# (required) An array of nfs volume locations. +# Must be an array even if there is only one volume. +# +# [*volume_backend_name*] +# (optional) Allows for the volume_backend_name to be separate of $name. +# Defaults to: $name +# +# [*nfs_mount_options*] +# (optional) NFS mount points. +# +# [*nfs_shares_config*] +# (optional) The config file to store the given $nfs_shares. +# Defaults to '/etc/cinder/nfsshares' +# +# === Examples +# +# cindernfs::backend::nfs { 'myNFS': +# nfs_shares = ['192.168.1.1:/volumes'], +# } +# +define cindernfs::backend::nfs ( + $nfs_shares, + $volume_backend_name = 'DEFAULT', + $nfs_mount_options = undef, + $nfs_shares_config = '/etc/cinder/nfsshares', + $nfs_sparsed_volumes = false, +) { + + $content = join($nfs_shares, "\n") + + package { $cindernfs::params::package_name: + ensure => present, + } + + package { $cindernfs::params::required_packages: + ensure => present, + } + + service { $cindernfs::params::volume_service_name: + ensure => running, + } + + file { $nfs_shares_config: + content => "${content}\n", + require => [ Package[$cindernfs::params::package_name], Package[$cindernfs::params::required_packages] ], + notify => Service[$cindernfs::params::volume_service_name], + mode => 0640, + owner => 'root', + group => 'cinder', + } + + cinder_config { + "${name}/volume_backend_name": value => $volume_backend_name; + "${name}/volume_driver": value => 'cinder.volume.drivers.nfs.NfsDriver'; + "${name}/nfs_shares_config": value => $nfs_shares_config; + "${name}/nfs_mount_options": value => $nfs_mount_options; + "${name}/nfs_sparsed_volumes": value => $nfs_sparsed_volumes; + } +} diff --git a/deployment_scripts/puppet/modules/cindernfs/manifests/params.pp b/deployment_scripts/puppet/modules/cindernfs/manifests/params.pp new file mode 100644 index 0000000..432fa29 --- /dev/null +++ b/deployment_scripts/puppet/modules/cindernfs/manifests/params.pp @@ -0,0 +1,21 @@ +# +class cindernfs::params { + + $cinder_conf = '/etc/cinder/cinder.conf' + + if $::osfamily == 'Debian' { + $required_packages = [ 'rpcbind', 'nfs-common', 'libevent-2.0', + 'libgssglue1', 'libnfsidmap2', 'libtirpc1' ] + $package_name = 'cinder-volume' + $volume_service_name = 'cinder-volume' + + } elsif($::osfamily == 'RedHat') { + $required_packages = [ 'rpcbind', 'nfs-utils', 'nfs-utils-lib', + 'libevent', 'key-utils', 'libtirpc', 'libgssglue' ] + $package_name = 'openstack-cinder' + $volume_service_name = 'openstack-cinder-volume' + + } else { + fail("unsuported osfamily ${::osfamily}, currently Debian and Redhat are the only supported platforms") + } +} diff --git a/deployment_scripts/puppet/modules/cindernfs/manifests/volume/nfs.pp b/deployment_scripts/puppet/modules/cindernfs/manifests/volume/nfs.pp new file mode 100644 index 0000000..8830d00 --- /dev/null +++ b/deployment_scripts/puppet/modules/cindernfs/manifests/volume/nfs.pp @@ -0,0 +1,44 @@ +# +# == Class: cindernfs::volume::nfs +# +# Configures Cinder to use NFS as a volume driver +# +# === Parameters +# +# [*nfs_shares*] +# (required) An array of nfs volume locations. +# Must be an array even if there is only one volume. +# +# [*nfs_sparsed_volumes*] +# (optional) Whether or not to use sparse (thin) volumes. +# Defaults to undef which uses the driver's default of "true". +# +# [*nfs_mount_point_base*] +# (optional) Where to mount the Gluster volumes. +# Defaults to undef which uses the driver's default of "$state_path/mnt". +# +# [*nfs_shares_config*] +# (optional) The config file to store the given $nfs_shares. +# Defaults to '/etc/cinder/shares.conf' +# +# === Examples +# +# class { 'cindernfs::volume::nfs': +# nfs_shares = ['192.168.1.1:/volumes'], +# } +# +class cindernfs::volume::nfs ( + $nfs_shares, + $nfs_mount_options = undef, + $nfs_shares_config = '/etc/cinder/nfsshares', + $nfs_sparsed_volumes = false, +) { + include cindernfs::params + + cindernfs::backend::nfs { 'DEFAULT': + nfs_shares => $nfs_shares, + nfs_mount_options => $nfs_mount_options, + nfs_shares_config => $nfs_shares_config, + nfs_sparsed_volumes => $nfs_sparsed_volumes, + } +} diff --git a/deployment_scripts/puppet/site.pp b/deployment_scripts/puppet/site.pp new file mode 100644 index 0000000..7c3fa7f --- /dev/null +++ b/deployment_scripts/puppet/site.pp @@ -0,0 +1,8 @@ +$fuel_settings = parseyaml(file('/etc/astute.yaml')) + +# Just apply nfs volumes +class { 'cindernfs::volume::nfs': + nfs_shares => split($fuel_settings['external_nfs']['endpoint'], ','), + nfs_mount_options => $fuel_settings['external_nfs']['mount_options'], + nfs_sparsed_volumes => $fuel_settings['external_nfs']['sparsed_volumes'], +} diff --git a/environment_config.yaml b/environment_config.yaml new file mode 100644 index 0000000..74d7d00 --- /dev/null +++ b/environment_config.yaml @@ -0,0 +1,19 @@ +attributes: + endpoint: + value: '' + label: 'NFS endpoints' + description: 'comma separated HOST:SHARE values' + weight: 25 + type: "text" + mount_options: + value: '' + label: 'NFS mount options' + description: 'optional NFS mount parameters' + weight: 25 + type: "text" + sparsed_volumes: + type: "checkbox" + weight: 30 + value: false + label: "NFS sparsed volumes" + description: "" diff --git a/metadata.yaml b/metadata.yaml new file mode 100644 index 0000000..3bae18f --- /dev/null +++ b/metadata.yaml @@ -0,0 +1,25 @@ +# Plugin name +name: external_nfs +title: External NFS backend for Cinder +# Plugin version +version: 1.0.0 +# Description +description: External NFS backend for Cinder +# Required fuel version +fuel_version: ['6.0'] + +# The plugin is compatible with releases in the list +releases: + - os: ubuntu + version: 2014.2-6.0 + mode: ['ha', 'multinode'] + deployment_scripts_path: deployment_scripts/ + repository_path: repositories/ubuntu + - os: centos + version: 2014.2-6.0 + mode: ['ha', 'multinode'] + deployment_scripts_path: deployment_scripts/ + repository_path: repositories/centos + +# Version of plugin package +package_version: '1.0.0' diff --git a/pre_build_hook b/pre_build_hook new file mode 100755 index 0000000..5091d43 --- /dev/null +++ b/pre_build_hook @@ -0,0 +1,46 @@ +#!/bin/bash + +set -eux + +ROOT="$(dirname `readlink -f $0`)" +MODULES="${ROOT}"/deployment_scripts/puppet/modules +TMP_DIR="${ROOT}"/tmp +mkdir -p "${MODULES}" +mkdir -p "${TMP_DIR}" +REPO_PATH='https://github.com/stackforge/fuel-library/tarball/f43d885914d74fbd062096763222f350f47480e1' + +wget -qO- "${REPO_PATH}" | \ + tar -C "${MODULES}" --strip-components=3 -zxvf - \ + stackforge-fuel-library-f43d885/deployment/puppet/{inifile,stdlib} + +RPM_REPO="${ROOT}"/repositories/centos/ +RPM_REPO_URL="http://mirror.fuel-infra.org/fwm/6.0/centos/os/x86_64/Packages/" +RPM_PACKAGES="nfs-utils-lib-1.1.5-6.el6.x86_64.rpm +keyutils-1.4-4.el6.x86_64.rpm +libgssglue-0.1-11.el6.x86_64.rpm +nfs-utils-1.2.3-39.el6.x86_64.rpm +libevent-1.4.13-4.el6.x86_64.rpm +rpcbind-0.2.0-11.el6.x86_64.rpm +libtirpc-0.2.1-6.el6_5.2.x86_64.rpm" + +DEB_REPO="${ROOT}"/repositories/ubuntu/ +DEB_REPO_URL="http://mirror.fuel-infra.org/fwm/6.0/ubuntu/pool/main/" +DEB_PACKAGES="libtirpc1_0.2.2-5_amd64.deb +libgssglue1_0.3-4ubuntu0.1_amd64.deb +libevent-2.0-5_2.0.16-stable-1_amd64.deb +nfs-common_1.2.5-3ubuntu3.1_amd64.deb +libnfsidmap2_0.25-1ubuntu2_amd64.deb +rpcbind_0.2.0-7ubuntu1.2_amd64.deb" + +download_packages () { + local REPO_PATH=$1 + local REPO_URL=$2 + local PACKAGES=$3 + + for PACKAGE in ${PACKAGES}; do + wget -P ${REPO_PATH} -nc ${REPO_URL}${PACKAGE} + done +} + +download_packages ${RPM_REPO} ${RPM_REPO_URL} "$RPM_PACKAGES" +download_packages ${DEB_REPO} ${DEB_REPO_URL} "$DEB_PACKAGES" \ No newline at end of file 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..a826f47 --- /dev/null +++ b/tasks.yaml @@ -0,0 +1,8 @@ +# This task is required for cinder nodes +- role: ['cinder'] + stage: post_deployment + type: puppet + parameters: + puppet_manifest: puppet/site.pp + puppet_modules: puppet/modules/ + timeout: 360