From 3d61f2f4d88cb088d40838432a03ad0435800cb7 Mon Sep 17 00:00:00 2001 From: Ukov Dmitry Date: Thu, 11 Dec 2014 13:22:48 +0300 Subject: [PATCH] Initial implementation of Cinder NetApp plugin Change-Id: Ie913f72efba4abca8ca923b036f34f3c508b063c --- .gitignore | 3 + LICENSE | 202 ++++++++++++++++++ README.md | 4 + deployment_scripts/install_cinder_netapp.pp | 2 + .../plugin_cinder_netapp/manifests/init.pp | 67 ++++++ environment_config.yaml | 43 ++++ metadata.yaml | 31 +++ pre_build_hook | 5 + register_plugin.py | 105 +++++++++ tasks.yaml | 12 ++ 10 files changed, 474 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 README.md create mode 100644 deployment_scripts/install_cinder_netapp.pp create mode 100644 deployment_scripts/puppet/plugin_cinder_netapp/manifests/init.pp create mode 100644 environment_config.yaml create mode 100644 metadata.yaml create mode 100755 pre_build_hook create mode 100644 register_plugin.py create mode 100644 tasks.yaml diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..daedd39 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +.tox +.build +*.pyc 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..89b5ab0 --- /dev/null +++ b/README.md @@ -0,0 +1,4 @@ +cinder_netapp +============ + +Plugin description \ No newline at end of file diff --git a/deployment_scripts/install_cinder_netapp.pp b/deployment_scripts/install_cinder_netapp.pp new file mode 100644 index 0000000..2f3f602 --- /dev/null +++ b/deployment_scripts/install_cinder_netapp.pp @@ -0,0 +1,2 @@ +$fuel_settings = parseyaml($astute_settings_yaml) +class {'plugin_cinder_netapp': } diff --git a/deployment_scripts/puppet/plugin_cinder_netapp/manifests/init.pp b/deployment_scripts/puppet/plugin_cinder_netapp/manifests/init.pp new file mode 100644 index 0000000..89a94af --- /dev/null +++ b/deployment_scripts/puppet/plugin_cinder_netapp/manifests/init.pp @@ -0,0 +1,67 @@ +class plugin_cinder_netapp +{ + include cinder::params + + #TODO: (Dmitry Ukov) improve logic as soon as multibackend is implemented + if $::fuel_settings['cinder_netapp']['multibackend'] { + $section = 'cinder_netapp' + } else { + $srction = 'DEFAULT' + } + + case $::osfamily { + 'Debian': { + package { 'nfs-common': + before => Cinder::Backend::Netapp['cinder_netapp'], + } + } + 'RedHat': { + package { 'nfs-utils': } -> + service {'rpcbind': + ensure => running, + } -> + service {'rpcidmapd': + ensure => running, + } -> + service {'nfs': + ensure => running, + before => Cinder::Backend::Netapp['cinder_netapp'], + } + } + default: { + fail("Unsupported osfamily: ${::osfamily} operatingsystem: ${::operatingsystem}, module ${module_name} currently only supports osfamily RedHat and Debian") + } + } + + file { '/etc/cinder/shares.conf': + content => "${::fuel_settings['cinder_netapp']['nfs_server_ip']}:${::fuel_settings['cinder_netapp']['nfs_server_share']}" + } -> + cinder::backend::netapp { 'cinder_netapp': + netapp_login => $::fuel_settings['cinder_netapp']['netapp_login'], + netapp_password => $::fuel_settings['cinder_netapp']['netapp_password'], + netapp_server_hostname => $::fuel_settings['cinder_netapp']['netapp_server_hostname'], + volume_backend_name => $section, +# netapp_server_port => '80', +# netapp_size_multiplier => '1.2', +# netapp_storage_family => 'ontap_cluster', + netapp_storage_protocol => 'nfs', +# netapp_transport_type => 'http', +# netapp_vfiler => '', +# netapp_volume_list => '', + netapp_vserver => $::fuel_settings['cinder_netapp']['netapp_vserver'], +# expiry_thres_minutes => '720', +# thres_avl_size_perc_start => '20', +# thres_avl_size_perc_stop => '60', + nfs_shares_config => '/etc/cinder/shares.conf', +# netapp_copyoffload_tool_path => '', +# netapp_controller_ips => '', +# netapp_sa_password => '', +# netapp_storage_pools => '', +# netapp_webservice_path => '/devmgr/v2', + } ~> + service { $::cinder::params::volume_service: + } + +} + + diff --git a/environment_config.yaml b/environment_config.yaml new file mode 100644 index 0000000..c5ee69d --- /dev/null +++ b/environment_config.yaml @@ -0,0 +1,43 @@ +attributes: + multibackend: + value: false + label: 'Multibackend enabled' + description: 'NetApp driver will be used as a Cinder Multibackend feature' + weight: 35 + type: "checkbox" + netapp_login: + value: '' + label: 'Username' + description: 'Administrative user account name used to access the storage system or proxy server.' + weight: 45 + type: "text" + netapp_password: + value: '' + label: 'Password' + description: 'Password for the administrative user account specified in the netapp_login option.' + weight: 45 + type: "password" + netapp_server_hostname: + value: '' + label: 'NetApp Hostname/IP' + description: 'The hostname (or IP address) for the storage system or proxy server.' + weight: 55 + type: "text" + nfs_server_ip: + value: '' + label: 'NetApp NFS server Hostname/IP' + description: 'The hostname (or IP address) for NFS server started on NetApp apliance' + weight: 65 + type: "text" + nfs_server_share: + value: '' + label: 'NetApp NFS share' + description: 'The NFS share path (e.g. /vol2)' + weight: 75 + type: "text" + netapp_vserver: + value: '' + label: 'Vserver' + description: 'This option specifies the virtual storage server (Vserver) name on the storage cluster on which provisioning of block storage volumes should occur.' + weight: 75 + type: "text" diff --git a/metadata.yaml b/metadata.yaml new file mode 100644 index 0000000..0ffa78d --- /dev/null +++ b/metadata.yaml @@ -0,0 +1,31 @@ +# Plugin name +name: cinder_netapp +# Plugin version +version: 0.1.0 +# Description +description: Enable to use plugin X for Neutron +# 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 + +# Plugin types are required to determine what this plugins +# extends and how to install them +types: + - nailgun + - repository + - deployment_scripts + +# Version of plugin package +package_version: '1' diff --git a/pre_build_hook b/pre_build_hook new file mode 100755 index 0000000..dc05e98 --- /dev/null +++ b/pre_build_hook @@ -0,0 +1,5 @@ +#!/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. diff --git a/register_plugin.py b/register_plugin.py new file mode 100644 index 0000000..7390fad --- /dev/null +++ b/register_plugin.py @@ -0,0 +1,105 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- + +# Copyright 2014 Mirantis, Inc. +# +# 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. + +import json +import requests +import yaml + +# TODO(eli): it's a development version, and requires a +# lot of refactoring: +# * ask user for credentials +# * use fuel clien config to retrieve information +# about keystone/nailgun end-points +# * validation if current fuel version is compatibele with +# plugin's one +# +# Also there is discussion about moving this code in fuel-client + +keystone = '0.0.0.0:5000' +master = '0.0.0.0:8000' + + +class KeystoneClient(object): + """Simple keystone authentification client + + :param str username: is user name + :param str password: is user password + :param str auth_url: authentification url + :param str tenant_name: tenant name + """ + + def __init__(self, username=None, password=None, + auth_url=None, tenant_name=None): + self.auth_url = auth_url + self.tenant_name = tenant_name + self.username = username + self.password = password + + @property + def request(self): + """Creates authentification session if required + + :returns: :class:`requests.Session` object + """ + session = requests.Session() + token = self.get_token() + if token: + session.headers.update({'X-Auth-Token': token}) + + return session + + def get_token(self): + try: + resp = requests.post( + self.auth_url, + headers={'content-type': 'application/json'}, + data=json.dumps({ + 'auth': { + 'tenantName': self.tenant_name, + 'passwordCredentials': { + 'username': self.username, + 'password': self.password}}})).json() + + return (isinstance(resp, dict) and + resp.get('access', {}).get('token', {}).get('id')) + except (ValueError, requests.exceptions.RequestException) as exc: + print('Cannot authenticate in keystone: {0}'.format(exc)) + + return None + + +keystone_client = KeystoneClient( + username='admin', + password='admin', + auth_url='http://{0}/v2.0/tokens'.format(keystone), + tenant_name='admin') + + +def register_plugin(plugin_name): + with open('metadata.yaml') as m: + data = yaml.load(m.read()) + print(data) + resp = keystone_client.request.post( + 'http://{0}/api/plugins'.format(master), + json.dumps(data)) + print(resp) + + +if __name__ == '__main__': + import sys + plugin_name = sys.argv[1] + register_plugin(plugin_name) diff --git a/tasks.yaml b/tasks.yaml new file mode 100644 index 0000000..d5a1fc7 --- /dev/null +++ b/tasks.yaml @@ -0,0 +1,12 @@ +# This tasks will be applied on controller nodes, +# here you can also specify several roles, for example +# ['cinder', 'compute'] will be applied only on +# cinder and compute nodes +- role: ['cinder'] + stage: post_deployment + type: puppet + priority: 10 + parameters: + puppet_manifest: install_cinder_netapp.pp + puppet_modules: /etc/puppet/modules/ + timeout: 600