From 26d6721495f58e1c105bab00ee7e5d293e011f66 Mon Sep 17 00:00:00 2001 From: Maciej Relewicz Date: Wed, 15 Jun 2016 15:51:56 +0200 Subject: [PATCH] Initail commit Change-Id: I85c571a133e782f5a30ec8a9b5734aefa57e9871 --- .gitignore | 3 + .travis.yml | 9 + LICENSE | 202 ++++++++++++++++++ README.md | 64 ++++++ .../manifests/networking-sfc-compute.pp | 60 ++++++ .../manifests/networking-sfc-controller.pp | 90 ++++++++ deployment_tasks.yaml | 24 +++ environment_config.yaml | 5 + metadata.yaml | 33 +++ post_install.sh | 2 + pre_build_hook | 40 ++++ repositories/ubuntu/.gitkeep | 0 tasks.yaml | 1 + uninstall.sh | 2 + 14 files changed, 535 insertions(+) create mode 100644 .gitignore create mode 100644 .travis.yml create mode 100644 LICENSE create mode 100644 README.md create mode 100644 deployment_scripts/puppet/manifests/networking-sfc-compute.pp create mode 100644 deployment_scripts/puppet/manifests/networking-sfc-controller.pp create mode 100644 deployment_tasks.yaml create mode 100644 environment_config.yaml create mode 100644 metadata.yaml create mode 100755 post_install.sh create mode 100755 pre_build_hook create mode 100644 repositories/ubuntu/.gitkeep create mode 100644 tasks.yaml create mode 100755 uninstall.sh diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..ba2a59c --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +.build/ +networking-sfc*.noarch.rpm +tmp diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..07b28fa --- /dev/null +++ b/.travis.yml @@ -0,0 +1,9 @@ +language: python +python: + - "2.7" +sudo: true +install: + - sudo apt-get install createrepo rpm dpkg-dev + - pip install fuel-plugin-builder + - gem install fpm +script: cd .. && fpb --build fuel-plugin-networking-sfc 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..e795e22 --- /dev/null +++ b/README.md @@ -0,0 +1,64 @@ +Networking SFC plugin for Fuel +======================= + +Networking SFC +-------------- + +One of the foundations for NFV enabled clouds is to have +Networking Service Function Chaining which provides an +ability to define an ordered list of network services +which to form a “chain” of services. This could be used +by f.e. Telcos to simplify management of their infrastructure. + +This plugin extends MOS with Networking SFC. + +Requirements +------------ + +| Requirement | Version | +|:---------------------------------|:--------| +| Mirantis OpenStack compatibility | 9.0 | + +It is required to install this on vxlans enabled environment. Will not work otherwise. + +Installation Guide +================== + +Networking SFC plugin installation +--------------------------- + +To install Networking SFC plugin, follow these steps: + +1. Build a plugin `fpb --build dir` + +2. Copy the plugin on already installed Fuel Master node; ssh can be used for + that. If you do not have the Fuel Master node yet, see + [Quick Start Guide](https://software.mirantis.com/quick-start/) : + + # scp networking-sfc-.noarch.rpm root@:/tmp + +3. Install the plugin: + + # cd /tmp + # fuel plugins --install networking-sfc-.noarch.rpm + +4. Check if the plugin was installed successfully: + + # [root@nailgun ~]# fuel plugins + id | name | version | package_version | releases + ---|----------------|---------|-----------------|-------------------- + 1 | networking-sfc | 1.0.0 | 4.0.0 | ubuntu (mitaka-9.0) + +Networking SFC plugin configuration +---------------------------- + +1. Create an environment. +2. Enable L2 Population in network tab. +3. Enable the plugin on the Settings tab of the Fuel web UI. +4. Deploy the environment. + +Contributors +------------ + + * Damian Szeluga (developer) + * Maciej Relewicz (developer) diff --git a/deployment_scripts/puppet/manifests/networking-sfc-compute.pp b/deployment_scripts/puppet/manifests/networking-sfc-compute.pp new file mode 100644 index 0000000..116d3d7 --- /dev/null +++ b/deployment_scripts/puppet/manifests/networking-sfc-compute.pp @@ -0,0 +1,60 @@ +# Copyright 2016 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. +notice('MODULAR: networking-sfc/networking-sfc-compute.pp') + +$use_neutron = hiera('use_neutron', false) + +if $use_neutron { + include ::neutron::params + + $neutron_config = hiera_hash('neutron_config') + + $default_service_plugins = [ + 'neutron.services.l3_router.l3_router_plugin.L3RouterPlugin', + 'neutron.services.metering.metering_plugin.MeteringPlugin', + ] + $sfc_plugins = [ + 'networking_sfc.services.flowclassifier.plugin.FlowClassifierPlugin', + 'networking_sfc.services.sfc.plugin.SfcPlugin', + ] + + $enabled_plugins = inline_template("<%= (@default_service_plugins + @sfc_plugins).join(',') %>") + + service {'neutron-openvswitch-agent': + ensure => running, + enable => true, + hasstatus => true, + } + + package {'python-networking-sfc': + ensure => installed, + } -> + + neutron_config { 'DEFAULT/service_plugins': value => $enabled_plugins } -> + + neutron_plugin_ml2 { 'securitygroup/enable_security_group': value => 'False'} -> + neutron_plugin_ml2 { 'securitygroup/enable_ipset': value => 'False'} -> + neutron_plugin_ml2 { 'securitygroup/firewall_driver': value => 'neutron.agent.firewall.NoopFirewallDriver'} -> + + file_line { 'Add OSV section to neutron.conf': + path => '/etc/neutron/neutron.conf', + line => "\n[sfc]\ndrivers = ovs\n", + } -> + + exec { 'Modify neutron-openvswitch-agent.conf': + command => "sed -i 's|/usr/bin|/usr/local/bin|g' /etc/init/neutron-openvswitch-agent.conf", + path => '/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/root/bin', + notify => Service['neutron-openvswitch-agent'] + } +} diff --git a/deployment_scripts/puppet/manifests/networking-sfc-controller.pp b/deployment_scripts/puppet/manifests/networking-sfc-controller.pp new file mode 100644 index 0000000..07af7cb --- /dev/null +++ b/deployment_scripts/puppet/manifests/networking-sfc-controller.pp @@ -0,0 +1,90 @@ +# Copyright 2016 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. + +notice('MODULAR: networking-sfc/networking-sfc-controller.pp') + +$use_neutron = hiera('use_neutron', false) + +if $use_neutron { + include ::neutron::params + + $primary_controller = hiera('primary_controller') + $node_name = hiera('node_name') + $neutron_config = hiera_hash('neutron_config') + $neutron_server_enable = pick($neutron_config['neutron_server_enable'], true) + $neutron_nodes = hiera_hash('neutron_nodes') + + $default_service_plugins = [ + 'neutron.services.l3_router.l3_router_plugin.L3RouterPlugin', + 'neutron.services.metering.metering_plugin.MeteringPlugin', + ] + $sfc_plugins = [ + 'networking_sfc.services.flowclassifier.plugin.FlowClassifierPlugin', + 'networking_sfc.services.sfc.plugin.SfcPlugin', + ] + + $enabled_plugins = inline_template("<%= (@default_service_plugins + @sfc_plugins).join(',') %>") + + if $node_name in keys($neutron_nodes) { + if $neutron_server_enable { + $service_ensure = 'running' + } else { + $service_ensure = 'stopped' + } + service { 'neutron-server': + name => $::neutron::params::server_service, + enable => $neutron_server_enable, + ensure => $service_ensure, + hasstatus => true, + hasrestart => true, + tag => 'neutron-service', + } + } + + service {'neutron-openvswitch-agent': + ensure => running, + enable => true, + hasstatus => true, + } + + package {'python-networking-sfc': + ensure => installed, + } + + if $primary_controller { + $extra_params = '--config-file /etc/neutron/neutron.conf --config-file /etc/neutron/plugin.ini --subproject networking-sfc' + + class { '::neutron::db::sync': + extra_params => $extra_params, + } + notify{"Schema upgrade for SFC": } ~> Exec['neutron-db-sync'] + } + + neutron_config { 'DEFAULT/service_plugins': value => $enabled_plugins } -> + + neutron_plugin_ml2 { 'securitygroup/enable_security_group': value => 'False'} -> + neutron_plugin_ml2 { 'securitygroup/enable_ipset': value => 'False'} -> + neutron_plugin_ml2 { 'securitygroup/firewall_driver': value => 'neutron.agent.firewall.NoopFirewallDriver'} -> + + file_line { 'Add OSV section to neutron.conf': + path => '/etc/neutron/neutron.conf', + line => "\n[sfc]\ndrivers = ovs\n", + } -> + + exec { 'Modify neutron-openvswitch-agent.conf': + command => "sed -i 's|/usr/bin|/usr/local/bin|g' /etc/init/neutron-openvswitch-agent.conf", + path => '/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/root/bin', + notify => [Service['neutron-openvswitch-agent'],Service['neutron-server']], + } +} diff --git a/deployment_tasks.yaml b/deployment_tasks.yaml new file mode 100644 index 0000000..556f2bd --- /dev/null +++ b/deployment_tasks.yaml @@ -0,0 +1,24 @@ +############################################## +# Deployment groups +# Deployment tasks +- id: networking-sfc-controller + type: puppet + version: 2.0.0 + groups: [primary-controller,controller] + requires: [post_deployment_start] + required_for: [post_deployment_end] + parameters: + puppet_manifest: puppet/manifests/networking-sfc-controller.pp + puppet_modules: puppet/modules:/etc/puppet/modules + timeout: 120 + +- id: networking-sfc-compute + type: puppet + version: 2.0.0 + groups: [compute] + requires: [post_deployment_start] + required_for: [post_deployment_end] + parameters: + puppet_manifest: puppet/manifests/networking-sfc-compute.pp + puppet_modules: puppet/modules:/etc/puppet/modules + timeout: 120 diff --git a/environment_config.yaml b/environment_config.yaml new file mode 100644 index 0000000..684c077 --- /dev/null +++ b/environment_config.yaml @@ -0,0 +1,5 @@ +attributes: + metadata: + restrictions: + - condition: "not ((cluster:net_provider == 'neutron' and networking_parameters:segmentation_type != 'vlan') and (settings:neutron_advanced_configuration.neutron_l2_pop.value == true))" + message: "Please use Neutron with tunneling segmentation and L2 population option enabled" diff --git a/metadata.yaml b/metadata.yaml new file mode 100644 index 0000000..7074f7d --- /dev/null +++ b/metadata.yaml @@ -0,0 +1,33 @@ +# Plugin name +name: networking-sfc +# Human-readable name for your plugin +title: Service Function Chaining Extension for OpenStack Networking +# Plugin version +version: '1.0.0' +# Description +description: Service Function Chaining is a mechanism for overriding the basic destination based forwarding that is typical of IP networks. +# Required fuel version +fuel_version: ['9.0'] +# Specify license of your plugin +licenses: ['Apache License Version 2.0'] +# Specify author or company name +authors: ['Maciej Relewicz ', 'Damian Szeluga '] +# A link to the plugin's page +homepage: 'https://github.com/damjanek/fuel-plugin-networking-sfc' +# Specify a group which your plugin implements, possible options: +# network, storage, storage::cinder, storage::glance, hypervisor +groups: [network] +# Change `false` to `true` if the plugin can be installed in the environment +# after the deployment. +is_hotpluggable: false + +# The plugin is compatible with releases in the list +releases: + - os: ubuntu + version: mitaka-9.0 + mode: ['ha'] + deployment_scripts_path: deployment_scripts/ + repository_path: repositories/ubuntu + +# Version of plugin package +package_version: '4.0.0' diff --git a/post_install.sh b/post_install.sh new file mode 100755 index 0000000..f3bcd73 --- /dev/null +++ b/post_install.sh @@ -0,0 +1,2 @@ +#!/bin/bash +#Add custom scripts/workarounds here diff --git a/pre_build_hook b/pre_build_hook new file mode 100755 index 0000000..bf8f016 --- /dev/null +++ b/pre_build_hook @@ -0,0 +1,40 @@ +#!/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. +set -eux + +#git reposotory with source code +GIT_REPOSITORY_URL=https://github.com/openstack/networking-sfc.git + +#package information +VERSION_NUMBER=${VERSION_NUMBER:-0.0.1} +DESCRIPTION="Networking SFC for Openstack" +MAINTAINERS="Maciej Relewicz, Damian Szeluga" + +DIR="$(dirname `readlink -f $0`)" +TMP_DIR="${DIR}/tmp" + +#Remove temporary files +CLEANUP=${CLEANUP:-true} + +function cleanup { + rm -rf "${TMP_DIR}" +} + +command -v fpm >/dev/null 2>&1 || { echo >&2 "fpm ruby gem required but it's not installed. Aborting."; exit 1; } + +cleanup +mkdir -p "${TMP_DIR}" +pushd $TMP_DIR + +git clone $GIT_REPOSITORY_URL networking-sfc + +pushd "${DIR}/repositories/ubuntu/" +fpm --architecture all --force -s python --no-python-dependencies -t deb -m "${MAINTAINERS}" --python-install-lib /usr/lib/python2.7/dist-packages ${TMP_DIR}/networking-sfc/setup.py +popd + +if [ "$CLEANUP" != false ];then + cleanup +fi 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..fe51488 --- /dev/null +++ b/tasks.yaml @@ -0,0 +1 @@ +[] diff --git a/uninstall.sh b/uninstall.sh new file mode 100755 index 0000000..f3bcd73 --- /dev/null +++ b/uninstall.sh @@ -0,0 +1,2 @@ +#!/bin/bash +#Add custom scripts/workarounds here