initial setup of bigswitch fuel plugin
Change-Id: I243959153186b31ac7a4beef4a9d3f5b633e7717
This commit is contained in:
parent
f4619878ba
commit
1fd2c801d8
|
@ -0,0 +1,12 @@
|
|||
*.rpm
|
||||
*.log
|
||||
*.mo
|
||||
*.sw?
|
||||
*~
|
||||
/.*
|
||||
!/.coveragerc
|
||||
!/.gitignore
|
||||
!/.gitreview
|
||||
!/.mailmap
|
||||
!/.pylintrc
|
||||
!/.testr.conf
|
|
@ -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.
|
||||
|
|
@ -0,0 +1,146 @@
|
|||
fuel-plugin-bigswitch
|
||||
============
|
||||
|
||||
|
||||
cd fuel-plugin-bigswitch/
|
||||
|
||||
fpb --build .
|
||||
|
||||
Check if file fuel-plugin-bigswitch-1.0-1.0.0-1.noarch.rpm was created.
|
||||
|
||||
Overview
|
||||
--------
|
||||
|
||||
This is Big Switch Cloud Fabric (BCF) fuel plugin. It deploys Big Switch Neutron drivers and
|
||||
plugins in a Fuel environment.
|
||||
|
||||
Requirements
|
||||
------------
|
||||
|
||||
| Requirement | Version/Comment |
|
||||
|----------------------------------|-----------------|
|
||||
| Mirantis OpenStack compatibility | 7.0 |
|
||||
| Big Switch Big Cloud Fabric | 3.5 |
|
||||
|
||||
Recommendations
|
||||
---------------
|
||||
|
||||
None.
|
||||
|
||||
Limitations
|
||||
-----------
|
||||
|
||||
None.
|
||||
|
||||
Installation Guide
|
||||
==================
|
||||
|
||||
BigSwitch plugin installation
|
||||
----------------------------------------
|
||||
|
||||
1. Clone the fuel-plugin-bigswitch repo from github:
|
||||
|
||||
git clone https://github.com/openstack/fuel-plugin-bigswitch
|
||||
|
||||
2. Install the Fuel Plugin Builder:
|
||||
|
||||
pip install fuel-plugin-builder
|
||||
|
||||
3. Build Openvswitch Fuel plugin:
|
||||
|
||||
fpb --build fuel-plugin-bigswitch/
|
||||
|
||||
4. The *fuel-plugin-bigswitch-[x.x.x].rpm* plugin package will be created in the plugin folder.
|
||||
|
||||
5. Move this file to the Fuel Master node with secure copy (scp):
|
||||
|
||||
scp fuel-plugin-bigswitch-[x.x.x].rpm root@<the_Fuel_Master_node_IP address>:/tmp
|
||||
|
||||
6. While logged in Fuel Master install the BigSwitch plugin:
|
||||
|
||||
fuel plugins --install fuel-plugin-bigswitch-[x.x.x].rpm
|
||||
|
||||
7. Check if the plugin was installed successfully:
|
||||
|
||||
fuel plugins
|
||||
|
||||
id | name | version | package_version
|
||||
---|-----------------------|---------|----------------
|
||||
1 | fuel-plugin-bigswitch | 1.0.0 | 1.0.0
|
||||
|
||||
8. Plugin is ready to use and can be enabled on the Settings tab of the Fuel web UI.
|
||||
|
||||
|
||||
User Guide
|
||||
==========
|
||||
|
||||
BigSwitch plugin configuration
|
||||
---------------------------------------------
|
||||
|
||||
1. Create a new environment with the Fuel UI wizard.
|
||||
2. Click on the Settings tab of the Fuel web UI.
|
||||
3. Scroll down the page, select the plugin checkbox.
|
||||
|
||||
|
||||
Build options
|
||||
-------------
|
||||
|
||||
It is possible to modify process of building plugin by setting environment variables. Look into [pre_build_hook file](pre_build_hook) for more details.
|
||||
|
||||
Dependencies
|
||||
------------
|
||||
|
||||
If you plan to use plugin in environment without internet access, modify build command:
|
||||
|
||||
INCLUDE_DEPENDENCIES=true fpb --build fuel-plugin-bigswitch/
|
||||
|
||||
Pre build script will try download required dependencies so it become part of the compiled plugin.
|
||||
|
||||
Note: List of packages for [ubuntu](bigswitch_package/ubuntu/dependencies.txt) and [centos](bigswitch_package/centos/dependencies.txt) may need to be modified if packages in centos or ubuntu repositories will change.
|
||||
|
||||
Testing
|
||||
-------
|
||||
|
||||
None.
|
||||
|
||||
Known issues
|
||||
------------
|
||||
|
||||
None.
|
||||
|
||||
Release Notes
|
||||
-------------
|
||||
|
||||
**1.0.0**
|
||||
|
||||
* Initial release of the plugin. This is a beta version.
|
||||
|
||||
|
||||
Development
|
||||
===========
|
||||
|
||||
The *OpenStack Development Mailing List* is the preferred way to communicate,
|
||||
emails should be sent to `openstack-dev@lists.openstack.org` with the subject
|
||||
prefixed by `[fuel][plugins][bigswitch]`.
|
||||
|
||||
Reporting Bugs
|
||||
--------------
|
||||
|
||||
Bugs should be filled on the [Launchpad fuel-plugins project](
|
||||
https://bugs.launchpad.net/fuel-plugins) (not GitHub) with the tag `bigswitch`.
|
||||
|
||||
|
||||
Contributing
|
||||
------------
|
||||
|
||||
If you would like to contribute to the development of this Fuel plugin you must
|
||||
follow the [OpenStack development workflow](
|
||||
http://docs.openstack.org/infra/manual/developers.html#development-workflow).
|
||||
|
||||
Patch reviews take place on the [OpenStack gerrit](
|
||||
https://review.openstack.org/#/q/status:open+project:openstack/fuel-plugin-bigswitch,n,z)
|
||||
system.
|
||||
|
||||
Contributors
|
||||
------------
|
||||
* kanzhe.jiang@bigswitch.com
|
|
@ -0,0 +1,4 @@
|
|||
#!/bin/bash
|
||||
|
||||
# It's a script which deploys your plugin
|
||||
echo fuel-plugin-bigswitch > /tmp/fuel-plugin-bigswitch
|
|
@ -0,0 +1,38 @@
|
|||
# These tasks will be merged into deployment graph. Here you
|
||||
# can specify new tasks for any roles, even built-in ones.
|
||||
|
||||
- id: fuel-plugin-bigswitch
|
||||
type: group
|
||||
role: [fuel-plugin-bigswitch]
|
||||
|
||||
- id: fuel-plugin-bigswitch-deployment-puppet
|
||||
type: puppet
|
||||
groups: [fuel-plugin-bigswitch]
|
||||
required_for: [deploy_end]
|
||||
requires: [deploy_start]
|
||||
parameters:
|
||||
puppet_manifest: "deploy.pp"
|
||||
puppet_modules: ""
|
||||
timeout: 3600
|
||||
|
||||
#- id: fuel-plugin-bigswitch-post-deployment-sh
|
||||
# type: shell
|
||||
# role: [fuel-plugin-bigswitch]
|
||||
# required_for: [post_deployment_end]
|
||||
# requires: [post_deployment_start]
|
||||
# parameters:
|
||||
# cmd: echo post_deployment_task_executed > /tmp/post_deployment
|
||||
# retries: 3
|
||||
# interval: 20
|
||||
# timeout: 180
|
||||
|
||||
#- id: fuel-plugin-bigswitch-pre-deployment-sh
|
||||
# type: shell
|
||||
# role: [fuel-plugin-bigswitch]
|
||||
# required_for: [pre_deployment_end]
|
||||
# requires: [pre_deployment_start]
|
||||
# parameters:
|
||||
# cmd: echo pre_deployment_task_executed > /tmp/pre_deployment
|
||||
# retries: 3
|
||||
# interval: 20
|
||||
# timeout: 180
|
|
@ -0,0 +1,66 @@
|
|||
attributes:
|
||||
|
||||
metadata:
|
||||
restrictions:
|
||||
- condition: "not (cluster:net_provider == 'neutron' and networking_parameters:segmentation_type == 'vlan')"
|
||||
message: "Please use Neutron with VLAN segmentation, the only network type supported with Big Switch plugin."
|
||||
|
||||
bcf_mode:
|
||||
type: "select"
|
||||
weight: 5
|
||||
value: "P-Only"
|
||||
label: "BCF Fabric Mode"
|
||||
description: "Big Cloud Fabric can be deployed in either physical-only or physical+virtual Modes."
|
||||
values:
|
||||
- data: "p-only"
|
||||
label: "P-Only"
|
||||
- data: "p+v"
|
||||
label: "P+V"
|
||||
|
||||
bcf_controller_1:
|
||||
value: ""
|
||||
label: "BCF Controller1"
|
||||
description: "BCF Controller' IP address and ports: <ip>:<port>"
|
||||
weight: 10
|
||||
type: "text"
|
||||
regex:
|
||||
source: '^(?:\d|1?\d\d|2[0-4]\d|25[0-5])(?:\.(?:\d|1?\d\d|2[0-4]\d|25[0-5])){3}(?:\:(?:(6553[0-5])|(655[0-2]\d)|(65[0-4]\d{2})|(6[0-4]\d{3})|([1-5]\d{4})|([1-9]\d{1,3})|([1-9])))$'
|
||||
error: "Invalid IP address and port"
|
||||
|
||||
bcf_controller_2:
|
||||
value: ""
|
||||
label: "BCF Controller2"
|
||||
description: "BCF Controller' IP address and ports: <ip>:<port>"
|
||||
weight: 11
|
||||
type: "text"
|
||||
regex:
|
||||
source: '^(?:\d|1?\d\d|2[0-4]\d|25[0-5])(?:\.(?:\d|1?\d\d|2[0-4]\d|25[0-5])){3}(?:\:(?:(6553[0-5])|(655[0-2]\d)|(65[0-4]\d{2})|(6[0-4]\d{3})|([1-5]\d{4})|([1-9]\d{1,3})|([1-9])))$'
|
||||
error: "Invalid IP address and port"
|
||||
|
||||
bcf_controller_username:
|
||||
value: ""
|
||||
label: "BCF Controller Username"
|
||||
description: "Username to access BCF controllers"
|
||||
weight: 20
|
||||
type: "text"
|
||||
|
||||
bcf_controller_password:
|
||||
value: ""
|
||||
label: "BCF Controller Password"
|
||||
description: "Password to access BCF controllers"
|
||||
weight: 21
|
||||
type: "text"
|
||||
|
||||
openstack_instance_id:
|
||||
value: ""
|
||||
label: "Openstack Instance ID"
|
||||
description: "The Openstack instance ID that is unique within the BCF fabric"
|
||||
weight: 40
|
||||
type: "text"
|
||||
|
||||
bcf_controller_os_mgmt:
|
||||
value: ""
|
||||
label: "Openstack Management Tenant Name"
|
||||
description: "The tenant that defines Openstack management segments"
|
||||
weight: 30
|
||||
type: "text"
|
|
@ -0,0 +1,30 @@
|
|||
# Plugin name
|
||||
name: fuel-plugin-bigswitch
|
||||
# Human-readable name for your plugin
|
||||
title: Big Switch Networking Plugin
|
||||
# Plugin version
|
||||
version: '1.0.0'
|
||||
# Description
|
||||
description: Enable to use plugin Big Switch for Neutron
|
||||
# Required fuel version
|
||||
fuel_version: ['7.0']
|
||||
# Specify license of your plugin
|
||||
licenses: ['Apache License Version 2.0']
|
||||
# Specify author or company name
|
||||
authors: ['Kanzhe Jiang']
|
||||
# A link to the plugin's page
|
||||
homepage: 'https://github.com/stackforge/fuel-plugins'
|
||||
# Specify a group which your plugin implements, possible options:
|
||||
# network, storage, storage::cinder, storage::glance, hypervisor
|
||||
groups: ['network']
|
||||
|
||||
# The plugin is compatible with releases in the list
|
||||
releases:
|
||||
- os: ubuntu
|
||||
version: 2015.1.0-7.0
|
||||
mode: ['ha']
|
||||
deployment_scripts_path: deployment_scripts/
|
||||
repository_path: repositories/ubuntu
|
||||
|
||||
# Version of plugin package
|
||||
package_version: '1.0.0'
|
|
@ -0,0 +1,15 @@
|
|||
# Unique network role name
|
||||
- id: "example_net_role"
|
||||
# Role mapping to network
|
||||
default_mapping: "public"
|
||||
properties:
|
||||
# Should be true if network role requires subnet being set
|
||||
subnet: true
|
||||
# Should be true if network role requires gateway being set
|
||||
gateway: false
|
||||
# List of VIPs to be allocated
|
||||
vip:
|
||||
# Unique VIP name
|
||||
- name: "vip_name"
|
||||
# Optional linux namespace for VIP
|
||||
namespace: "haproxy"
|
|
@ -0,0 +1,13 @@
|
|||
fuel-plugin-bigswitch:
|
||||
# Role name
|
||||
name: "Set here the name for the role. This name will be displayed in the Fuel web UI"
|
||||
# Role description
|
||||
description: "Write description for your role"
|
||||
# If primaty then during orchestration this role will be
|
||||
# splitted into primary-role and role
|
||||
has_primary: false
|
||||
# Assign public IP to node if true
|
||||
public_ip_required: false
|
||||
# Weight that will be used to sort out the
|
||||
# roles on the Fuel web UI
|
||||
weight: 1000
|
|
@ -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.
|
|
@ -0,0 +1,7 @@
|
|||
volumes_roles_mapping:
|
||||
# Default role mapping
|
||||
fuel-plugin-bigswitch:
|
||||
- {allocate_size: "min", id: "os"}
|
||||
|
||||
# Set here new volumes for your role
|
||||
volumes: []
|
Loading…
Reference in New Issue