Initial implementation of Glance NFS plugin for Fuel

Change-Id: I50e71f55a71100d868409243b0f23994104cb605
This commit is contained in:
sbartel 2015-04-30 09:27:11 +02:00
parent fa277be0d2
commit d23b62cec4
16 changed files with 560 additions and 0 deletions

202
LICENSE Normal file
View File

@ -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.

106
README.md Normal file
View File

@ -0,0 +1,106 @@
Fuel Glance-nfs plugin for Fuel
=============================
Glance-nfs plugin
---------------
Overview
--------
glance-nfs uses nfs backend to store images. This plugin allow to mount a nfs volume
annd use it as storage backend for Glance.
This repo contains all necessary files to build glance-nfs Fuel plugin.
Requirements
------------
| Requirement | Version/Comment |
|----------------------------------|---------------------------------------------------------|
| Mirantis Openstack compatibility | 6.0 |
| NFS Server | an NFS server with volume accessible from compute nodes |
Recommendations
---------------
None.
Limitations
-----------
Only on nfs volume can be defined. So in HA deployment controller nodes will share the same
storage backend for images.
Installation Guide
==================
Glance-nfs plugin installation
----------------------------
1. Clone the fuel-plugin repo from: https://github.com/stackforge/fuel-plugin-glance-nfs.git
``git clone``
2. Install the Fuel Plugin Builder:
``pip install fuel-plugin-builder``
3. Build glance-nfs Fuel plugin:
``fpb --build fuel-plugin-glance-nfs/``
4. The glance_nfs-<x.x.x>.fp file will be created in the plugin folder (fuel-plugin-glance-nfs)
5. Move this file to the Fuel Master node with secure copy (scp):
``scp glance_nfs-<x.x.x>.fp root@:<the_Fuel_Master_node_IP address>:/tmp``
``cd /tmp``
6. Install the glance-nfs plugin:
``fuel plugins --install glance_nfs-<x.x.x>.fp``
6. Plugin is ready to use and can be enabled on the Settings tab of the Fuel web UI.
User Guide
==========
Glance-nfs plugin configuration
-----------------------------
1. Create a new environment with the Fuel UI wizard
2. Add a node with the "controller" role.
3. Click on the settings tab of the Fuel web UI
4. Scroll down the page, select the "glance-nfs plugin" checkbox
and fill-in the requiered fields
- the nfs volume to store images
- the mount point for the nfs volume
Here is a screenshot of the fields
![glance-nfs fields](./figures/glance-nfs-plugin.png "glance-nfs-fields")
Deployment details
------------------
Create mountpoint directory
Edit Fstab to add auto mount of NFS volume on the mountpoint
Configure Glance to use it as backend for images
Restart Glance-api services
Known issues
------------
The deployment failed if the NFS volume is not available during the deployment
Release Notes
-------------
**1.0.0**
* Initial release of the plugin

View File

@ -0,0 +1,27 @@
Puppet::Type.type(:glance_api_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/glance/glance-api.conf'
end
# this needs to be removed. This has been replaced with the class method
def file_path
self.class.file_path
end
end

View File

@ -0,0 +1,27 @@
Puppet::Type.type(:glance_cache_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/glance/glance-cache.conf'
end
# added for backwards compatibility with older versions of inifile
def file_path
self.class.file_path
end
end

View File

@ -0,0 +1,19 @@
Puppet::Type.newtype(:glance_api_config) do
ensurable
newparam(:name, :namevar => true) do
desc 'Section/setting name to manage from glance-api.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
end
end

View File

@ -0,0 +1,19 @@
Puppet::Type.newtype(:glance_cache_config) do
ensurable
newparam(:name, :namevar => true) do
desc 'Section/setting name to manage from glance-cache.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
end
end

View File

@ -0,0 +1,72 @@
class glance_nfs (
$nfs_volume_for_glance,
$nfs_mount_point_glance,
){
include glance_nfs::params
# Install package and start services
package { $glance_nfs::params::package_name:
ensure => present,
}
package { $glance_nfs::params::required_packages:
ensure => present,
}
service { $glance_nfs::params::service_name:
ensure => running,
}
if ($glance_nfs::params::nfs_service_name) {
service { $glance_nfs::params::nfs_service_name:
ensure => running,
}
}
# Configure Glance
glance_api_config {
'glance_store/default_store': value => 'file';
'glance_store/filesystem_store_datadir': value => "${nfs_mount_point_glance}/images";
'glance_store/stores': value => 'file';
}~> Service["$::glance_nfs::params::service_name"]
glance_cache_config {
'DEFAULT/filesystem_store_datadir': value => $nfs_mount_point_glance;
}~> Service["$::glance_nfs::params::service_name"]
# Create Mount Point
exec{ "/bin/mkdir -p $nfs_mount_point_glance":
unless => "/usr/bin/test -d $nfs_mount_point_glance",
before => mount["$nfs_mount_point_glance"],
}
# Mount NFS Share
mount { "$nfs_mount_point_glance":
atboot => true,
ensure => mounted,
device => "$nfs_volume_for_glance",
fstype => "nfs",
options => "vers=3",
}
# Apply permission on mount point
exec{ "/bin/chown glance:glance $nfs_mount_point_glance":
require => Mount["$nfs_mount_point_glance"],
}
exec{ "/bin/chmod 775 $nfs_mount_point_glance":
require => Mount["$nfs_mount_point_glance"],
}
exec{ "/bin/mkdir -p ${$nfs_mount_point_glance}/images":
unless => "/usr/bin/test -d ${$nfs_mount_point_glance}/images",
require => Mount["$nfs_mount_point_glance"],
}
exec{ "/bin/chown glance:glance ${$nfs_mount_point_glance}/images":
require => Exec["/bin/mkdir -p ${$nfs_mount_point_glance}/images"],
}
exec{ "/bin/chmod 775 ${$nfs_mount_point_glance}/images":
require => Exec["/bin/mkdir -p ${$nfs_mount_point_glance}/images"],
notify => Service["$::glance_nfs::params::service_name"],
}
}

View File

@ -0,0 +1,22 @@
class glance_nfs::params {
if $::osfamily == 'Debian' {
$required_packages = [ 'rpcbind', 'nfs-common', 'libevent-2.0',
'libgssglue1', 'libnfsidmap2', 'libtirpc1' ]
$package_name = 'glance-api'
$service_name = 'glance-api'
$nfs_service_name = undef
} elsif($::osfamily == 'RedHat') {
$required_packages = [ 'rpcbind', 'nfs-utils', 'nfs-utils-lib',
'libevent', 'libtirpc', 'libgssglue' ]
$package_name = 'openstack-glance'
$service_name = 'openstack-glance-api'
$nfs_service_name = ['rpcbind']
} else {
fail("unsuported osfamily ${::osfamily}, currently Debian and Redhat are the only supported platforms")
}
}

View File

@ -0,0 +1,5 @@
$fuel_settings = parseyaml(file('/etc/astute.yaml'))
class { 'glance_nfs':
nfs_volume_for_glance => $fuel_settings['glance_nfs']['nfs_volume_for_glance'],
nfs_mount_point_glance => $fuel_settings['glance_nfs']['nfs_mount_point_glance'],
}

14
environment_config.yaml Normal file
View File

@ -0,0 +1,14 @@
attributes:
nfs_volume_for_glance:
value: ""
label: "NFS Volume"
description: "NFS volume to store images (e.g. 192.168.0.2:/vol1)"
weight: 10
type: "text"
nfs_mount_point_glance:
value: "/mnt/glance"
label: "NFS mount point"
description: "Mount point to store images (Glance)"
weight: 20
type: "text"

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

35
metadata.yaml Normal file
View File

@ -0,0 +1,35 @@
# Plugin name
name: glance_nfs
title: Glance NFS plugin
# Plugin version
version: 1.0.0
# Description
description: Enables Glance to use NFS volume as storage backend for images
# 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
- os: ubuntu
version: 2014.2-6.0.1
mode: ['ha', 'multinode']
deployment_scripts_path: deployment_scripts/
repository_path: repositories/ubuntu
- os: centos
version: 2014.2-6.0.1
mode: ['ha', 'multinode']
deployment_scripts_path: deployment_scripts/
repository_path: repositories/centos
# Version of plugin package
package_version: '1.0.0'

4
pre_build_hook Normal file
View File

@ -0,0 +1,4 @@
#!/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.

View File

View File

8
tasks.yaml Normal file
View File

@ -0,0 +1,8 @@
# This task is required for controller nodes
- role: ['controller']
stage: post_deployment
type: puppet
parameters:
puppet_manifest: puppet/site.pp
puppet_modules: "puppet/modules/:/etc/puppet/modules/"
timeout: 360