Retire repository
Fuel repositories are all retired in openstack namespace, retire remaining fuel repos in x namespace since they are unused now. This change removes all content from the repository and adds the usual README file to point out that the repository is retired following the process from https://docs.openstack.org/infra/manual/drivers.html#retiring-a-project See also http://lists.openstack.org/pipermail/openstack-discuss/2019-December/011675.html A related change is: https://review.opendev.org/699752 . Change-Id: I8996480cfc4b52b9649ba243ee54206deaec5ab2
This commit is contained in:
Andreas Jaeger
parent
723915be73
commit
5ccb155037
|
|
@ -1,7 +0,0 @@
|
|||
*.pyc
|
||||
*.sqlite
|
||||
|
||||
*.gem
|
||||
|
||||
# vim swap files
|
||||
.*.swp
|
||||
202
LICENSE
202
LICENSE
|
|
@ -1,202 +0,0 @@
|
|||
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.
|
||||
|
||||
53
README.md
53
README.md
|
|
@ -1,53 +0,0 @@
|
|||
FWaaS plugin
|
||||
============
|
||||
|
||||
FWaaS (Firewall-as-a-Service) is a Neutron extension that introduces Firewall feature set.
|
||||
|
||||
This repo contains all necessary files to build FWaaS Fuel plugin.
|
||||
Supported Fuel version is 7.0.
|
||||
|
||||
Building the plugin
|
||||
-------------------
|
||||
|
||||
1. Clone the FWaaS plugin repo from `https://github.com/stackforge/fuel-plugin-neutron-fwaas`.
|
||||
2. Install Fuel Plugin Builder:
|
||||
|
||||
``pip install fuel-plugin-builder``
|
||||
|
||||
3. Execute ``fpb --build <path>`` command, where <path> is the path to the plugin's main
|
||||
folder (fwaas). For example:
|
||||
|
||||
``fpb --build fuel-plugin-neutron-fwaas/
|
||||
|
||||
4. The fwaas-plugin-<x.x.x>.rpm plugin file will be created.
|
||||
|
||||
5. Move this file to the Fuel Master node with secure copy (scp):
|
||||
|
||||
``scp fwaas-plugin-<x.x.x>.rpm root@:<the_Fuel_Master_node_IP address>:/tmp``
|
||||
``cd /tmp``
|
||||
|
||||
6. Install it using the following command:
|
||||
|
||||
``fuel plugins --install fwaas-plugin-<x.x.x>.rpm``
|
||||
|
||||
6. Plugin is ready to use and can be enabled on the Settings tab of the Fuel web UI.
|
||||
|
||||
Note that you can also download the built FWaaS plugin from the
|
||||
[Fuel Plugins Catalog](https://software.mirantis.com/download-mirantis-openstack-fuel-plug-ins/).
|
||||
|
||||
Deployment details
|
||||
------------------
|
||||
|
||||
FWaaS deployment requires only adding a couple parameters in neutron.conf and
|
||||
enabling FWaaS tab in Horizon.
|
||||
|
||||
Currently this plugin is not compatible with Neutron DVR.
|
||||
|
||||
Accessing FWaaS functionality
|
||||
------------------------------
|
||||
|
||||
Firewall settings can be found on the Openstack Dashboard (Horizon) in
|
||||
Project -> Network -> Firewall.
|
||||
|
||||
Please use official Openstack documentation to obtain more information:
|
||||
- http://docs.openstack.org/admin-guide-cloud/content/install_neutron-fwaas-agent.html
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
This project is no longer maintained.
|
||||
|
||||
The contents of this repository are still available in the Git
|
||||
source code management system. To see the contents of this
|
||||
repository before it reached its end of life, please check out the
|
||||
previous commit with "git checkout HEAD^1".
|
||||
|
||||
For any further questions, please email
|
||||
openstack-discuss@lists.openstack.org or join #openstack-dev on
|
||||
Freenode.
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
# Copyright 2015 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.
|
||||
|
||||
include fwaas
|
||||
|
|
@ -1,44 +0,0 @@
|
|||
# FWaaS
|
||||
|
||||
#### Table of Contents
|
||||
|
||||
1. [Overview](#overview)
|
||||
2. [Module Description - What the module does and why it is useful](#module-description)
|
||||
3. [Setup - The basics of getting started with FWaaS](#setup)
|
||||
* [What FWaaS affects](#what-fwaas-affects)
|
||||
* [Beginning with VPNaaS](#beginning-with-fwaas)
|
||||
4. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
|
||||
5. [Limitations - OS compatibility, etc.](#limitations)
|
||||
|
||||
## Overview
|
||||
|
||||
This is FWaaS plugin for FUEL, which provides an ability to setup FWaaS Neuton extention
|
||||
that introduces Firewall feature set.
|
||||
|
||||
## Module Description
|
||||
|
||||
FWaaS Neutron extention provides additional perimeter firewall management to Networking.
|
||||
FWaaS uses iptables to apply firewall policy to all Networking routers within a project.
|
||||
It supports one firewall policy and logical firewall instance per project.
|
||||
|
||||
## Setup
|
||||
|
||||
### What FWaaS affects
|
||||
|
||||
* During installation manifests add a couple options in neutron.conf and enable FWaaS tab in Horizon.
|
||||
|
||||
### Beginning with VPNaaS
|
||||
|
||||
How to use FWaaS you can find here:
|
||||
http://docs.openstack.org/api/openstack-network/2.0/content/fwaas_ext.html
|
||||
|
||||
## Reference
|
||||
|
||||
Here, list the classes, types, providers, facts, etc contained in your module.
|
||||
This section should include all of the under-the-hood workings of your module so
|
||||
people know what the module is touching on their system but don't need to mess
|
||||
with things. (We are working on automating this section!)
|
||||
|
||||
## Limitations
|
||||
|
||||
This plugin supports only the following OS: CentOS 6.4 and Ubuntu 12.04.
|
||||
|
|
@ -1,19 +0,0 @@
|
|||
# Copyright 2015 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.
|
||||
|
||||
Facter.add('is_l3_enabled') do
|
||||
setcode do
|
||||
Facter::Util::Resolution.exec("pcs status xml | grep ocf-neutron-l3-agent | egrep -o Started -m 1")
|
||||
end
|
||||
end
|
||||
|
|
@ -1,116 +0,0 @@
|
|||
# Copyright 2015 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.
|
||||
|
||||
#This class contains common changes for deployment FWaaS functionality in Neutron.
|
||||
#It enables Firewall tab in Horizon and restart Neutron L3 agent.
|
||||
|
||||
|
||||
class fwaas::enable_in_neutron_config {
|
||||
|
||||
ini_subsetting {'add_fwaas_service_plugin':
|
||||
ensure => present,
|
||||
section => 'DEFAULT',
|
||||
key_val_separator => '=',
|
||||
path => '/etc/neutron/neutron.conf',
|
||||
setting => 'service_plugins',
|
||||
subsetting => 'neutron_fwaas.services.firewall.',
|
||||
subsetting_separator => ',',
|
||||
value => 'fwaas_plugin.FirewallPlugin',
|
||||
}
|
||||
|
||||
neutron_config {
|
||||
'fwaas/enabled': value => 'True';
|
||||
'fwaas/driver' : value => 'neutron_fwaas.services.firewall.drivers.linux.iptables_fwaas.IptablesFwaasDriver';
|
||||
}
|
||||
|
||||
service { $fwaas::params::server_service:
|
||||
ensure => running,
|
||||
enable => true,
|
||||
}
|
||||
|
||||
Neutron_config<||> ~> Service[$fwaas::params::server_service]
|
||||
Ini_subsetting['add_fwaas_service_plugin'] ~> Service[$fwaas::params::server_service]
|
||||
}
|
||||
|
||||
|
||||
class fwaas::enable_in_dashboard {
|
||||
|
||||
service { $fwaas::params::dashboard_service:
|
||||
ensure => running,
|
||||
enable => true,
|
||||
}
|
||||
|
||||
|
||||
exec { 'enable_fwaas_dashboard':
|
||||
command => "/bin/sed -i \"s/'enable_firewall': False/'enable_firewall': True/\" ${fwaas::params::dashboard_settings}",
|
||||
unless => "/bin/egrep \"'enable_firewall': True\" ${fwaas::params::dashboard_settings}",
|
||||
}
|
||||
|
||||
Exec['enable_fwaas_dashboard'] ~> Service[$fwaas::params::dashboard_service]
|
||||
|
||||
}
|
||||
|
||||
|
||||
class fwaas {
|
||||
|
||||
include fwaas::params
|
||||
include fwaas::enable_in_neutron_config
|
||||
include fwaas::enable_in_dashboard
|
||||
|
||||
$primary_controller = hiera('primary_controller')
|
||||
|
||||
if $::fwaas::params::fwaas_package {
|
||||
Package['neutron-fwaas'] -> Class[fwaas::enable_in_neutron_config]
|
||||
package { 'neutron-fwaas':
|
||||
ensure => present,
|
||||
name => $::fwaas::params::fwaas_package,
|
||||
}
|
||||
}
|
||||
|
||||
if $primary_controller {
|
||||
|
||||
Package<| title == 'neutron-fwaas' |> -> Exec['neutron-db-sync']
|
||||
|
||||
exec { 'neutron-db-sync':
|
||||
command => 'neutron-db-manage --config-file /etc/neutron/neutron.conf --config-file /etc/neutron/plugin.ini --subproject neutron-fwaas upgrade head',
|
||||
path => '/usr/bin',
|
||||
refreshonly => true,
|
||||
tries => 10,
|
||||
try_sleep => 10,
|
||||
}
|
||||
Neutron_config<||> ~> Exec['neutron-db-sync']
|
||||
Ini_subsetting['add_fwaas_service_plugin'] ~> Exec['neutron-db-sync']
|
||||
Exec['neutron-db-sync'] ~> Service[$fwaas::params::server_service]
|
||||
}
|
||||
|
||||
if $fwaas::params::ha {
|
||||
|
||||
service {$fwaas::params::p_l3_agent:
|
||||
ensure => running,
|
||||
enable => true,
|
||||
provider => 'pacemaker',
|
||||
subscribe => Class[fwaas::enable_in_neutron_config],
|
||||
}
|
||||
|
||||
} else {
|
||||
|
||||
service {$fwaas::params::l3_agent_service:
|
||||
ensure => running,
|
||||
enable => true,
|
||||
subscribe => Class[fwaas::enable_in_neutron_config],
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
|
|
@ -1,63 +0,0 @@
|
|||
# Copyright 2015 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.
|
||||
|
||||
#This class contains necessary parameters for all other manifests
|
||||
|
||||
class fwaas::params {
|
||||
|
||||
$ha = hiera('deployment_mode') ? { 'ha_compact'=>true, default=>false }
|
||||
$l3_enabled = $::is_l3_enabled ? { 'Started'=>true, default=>false }
|
||||
|
||||
$server_service = 'neutron-server'
|
||||
|
||||
if($l3_enabled) {
|
||||
|
||||
$l3_agent_service = 'neutron-l3-agent'
|
||||
$p_l3_agent = 'p_neutron-l3-agent'
|
||||
|
||||
} else {
|
||||
|
||||
$l3_agent_service = 'neutron-vpn-agent'
|
||||
$p_l3_agent = 'p_neutron-vpn-agent'
|
||||
|
||||
}
|
||||
|
||||
if($::osfamily == 'Redhat') {
|
||||
$server_package = 'openstack-neutron'
|
||||
$fwaas_package = 'python-neutron-fwaas'
|
||||
|
||||
$dashboard_package = 'openstack-dashboard'
|
||||
$dashboard_service = 'httpd'
|
||||
$dashboard_settings = '/etc/openstack-dashboard/local_settings'
|
||||
|
||||
$node_name = $full_node_name
|
||||
|
||||
} elsif($::osfamily == 'Debian') {
|
||||
|
||||
$server_package = 'neutron-server'
|
||||
$fwaas_package = 'python-neutron-fwaas'
|
||||
|
||||
$dashboard_package = 'python-django-horizon'
|
||||
$dashboard_service = 'apache2'
|
||||
$dashboard_settings = '/etc/openstack-dashboard/local_settings.py'
|
||||
|
||||
$array_node_name = split($full_node_name, '[.]')
|
||||
$node_name = $array_node_name[0]
|
||||
|
||||
} else {
|
||||
|
||||
fail("Unsupported osfamily ${::osfamily}")
|
||||
|
||||
}
|
||||
}
|
||||
181
doc/Makefile
181
doc/Makefile
|
|
@ -1,181 +0,0 @@
|
|||
# Makefile for Sphinx documentation
|
||||
#
|
||||
|
||||
# You can set these variables from the command line.
|
||||
SPHINXOPTS =
|
||||
SPHINXBUILD = sphinx-build
|
||||
PAPER =
|
||||
BUILDDIR = build
|
||||
|
||||
# User-friendly check for sphinx-build
|
||||
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
|
||||
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
|
||||
endif
|
||||
|
||||
# Internal variables.
|
||||
PAPEROPT_a4 = -D latex_paper_size=a4
|
||||
PAPEROPT_letter = -D latex_paper_size=letter
|
||||
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
|
||||
# the i18n builder cannot share the environment and doctrees with the others
|
||||
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
|
||||
|
||||
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext lifehtml
|
||||
|
||||
help:
|
||||
@echo "Please use \`make <target>' where <target> is one of"
|
||||
@echo " html to make standalone HTML files"
|
||||
@echo " dirhtml to make HTML files named index.html in directories"
|
||||
@echo " singlehtml to make a single large HTML file"
|
||||
@echo " pickle to make pickle files"
|
||||
@echo " json to make JSON files"
|
||||
@echo " htmlhelp to make HTML files and a HTML help project"
|
||||
@echo " qthelp to make HTML files and a qthelp project"
|
||||
@echo " devhelp to make HTML files and a Devhelp project"
|
||||
@echo " epub to make an epub"
|
||||
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
|
||||
@echo " latexpdf to make LaTeX files and run them through pdflatex"
|
||||
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
|
||||
@echo " text to make text files"
|
||||
@echo " man to make manual pages"
|
||||
@echo " texinfo to make Texinfo files"
|
||||
@echo " info to make Texinfo files and run them through makeinfo"
|
||||
@echo " gettext to make PO message catalogs"
|
||||
@echo " changes to make an overview of all changed/added/deprecated items"
|
||||
@echo " xml to make Docutils-native XML files"
|
||||
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
|
||||
@echo " linkcheck to check all external links for integrity"
|
||||
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
|
||||
@echo " livehtml to run html server"
|
||||
|
||||
clean:
|
||||
rm -rf $(BUILDDIR)/*
|
||||
|
||||
html:
|
||||
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
||||
@echo
|
||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
||||
|
||||
dirhtml:
|
||||
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
|
||||
@echo
|
||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
|
||||
|
||||
singlehtml:
|
||||
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
|
||||
@echo
|
||||
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
|
||||
|
||||
pickle:
|
||||
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
|
||||
@echo
|
||||
@echo "Build finished; now you can process the pickle files."
|
||||
|
||||
json:
|
||||
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
|
||||
@echo
|
||||
@echo "Build finished; now you can process the JSON files."
|
||||
|
||||
htmlhelp:
|
||||
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
|
||||
@echo
|
||||
@echo "Build finished; now you can run HTML Help Workshop with the" \
|
||||
".hhp project file in $(BUILDDIR)/htmlhelp."
|
||||
|
||||
qthelp:
|
||||
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
|
||||
@echo
|
||||
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
|
||||
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
|
||||
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/FWaaSPluginforFuel.qhcp"
|
||||
@echo "To view the help file:"
|
||||
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/FWaaSPluginforFuel.qhc"
|
||||
|
||||
devhelp:
|
||||
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
|
||||
@echo
|
||||
@echo "Build finished."
|
||||
@echo "To view the help file:"
|
||||
@echo "# mkdir -p $$HOME/.local/share/devhelp/FWaaSPluginforFuel"
|
||||
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/FWaaSPluginforFuel"
|
||||
@echo "# devhelp"
|
||||
|
||||
epub:
|
||||
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
|
||||
@echo
|
||||
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
|
||||
|
||||
latex:
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
@echo
|
||||
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
|
||||
@echo "Run \`make' in that directory to run these through (pdf)latex" \
|
||||
"(use \`make latexpdf' here to do that automatically)."
|
||||
|
||||
latexpdf:
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
@echo "Running LaTeX files through pdflatex..."
|
||||
$(MAKE) -C $(BUILDDIR)/latex all-pdf
|
||||
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
||||
|
||||
latexpdfja:
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
@echo "Running LaTeX files through platex and dvipdfmx..."
|
||||
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
|
||||
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
||||
|
||||
text:
|
||||
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
|
||||
@echo
|
||||
@echo "Build finished. The text files are in $(BUILDDIR)/text."
|
||||
|
||||
man:
|
||||
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
|
||||
@echo
|
||||
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
|
||||
|
||||
texinfo:
|
||||
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
||||
@echo
|
||||
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
|
||||
@echo "Run \`make' in that directory to run these through makeinfo" \
|
||||
"(use \`make info' here to do that automatically)."
|
||||
|
||||
info:
|
||||
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
||||
@echo "Running Texinfo files through makeinfo..."
|
||||
make -C $(BUILDDIR)/texinfo info
|
||||
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
|
||||
|
||||
gettext:
|
||||
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
|
||||
@echo
|
||||
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
|
||||
|
||||
changes:
|
||||
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
|
||||
@echo
|
||||
@echo "The overview file is in $(BUILDDIR)/changes."
|
||||
|
||||
linkcheck:
|
||||
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
|
||||
@echo
|
||||
@echo "Link check complete; look for any errors in the above output " \
|
||||
"or in $(BUILDDIR)/linkcheck/output.txt."
|
||||
|
||||
doctest:
|
||||
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
|
||||
@echo "Testing of doctests in the sources finished, look at the " \
|
||||
"results in $(BUILDDIR)/doctest/output.txt."
|
||||
|
||||
xml:
|
||||
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
|
||||
@echo
|
||||
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
|
||||
|
||||
pseudoxml:
|
||||
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
|
||||
@echo
|
||||
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
|
||||
|
||||
livehtml:
|
||||
sphinx-autobuild -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 32 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 25 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 23 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 18 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 17 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 18 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 34 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 32 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 44 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 43 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 34 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 33 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 55 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 18 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 21 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 17 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 22 KiB |
|
|
@ -1,10 +0,0 @@
|
|||
Appendix
|
||||
--------
|
||||
|
||||
+----+-----------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| # | Title of resource | Link on resource |
|
||||
+====+=======================+=========================================================================================================================+
|
||||
| 1 | Fuel Plugins CLI | `Link <https://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#fuel-plugins-cli/>`_ |
|
||||
+----+-----------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| 2 | Firewall-as-a-Service | `Link <http://docs.openstack.org/admin-guide-cloud/networking_introduction.html#firewall-as-a-service-fwaas-overview/>`_|
|
||||
+----+-----------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
|
|
@ -1,340 +0,0 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# fuel-plugin-fwaas documentation build configuration file, created by
|
||||
# sphinx-quickstart on Wed Oct 7 12:48:35 2015.
|
||||
#
|
||||
# This file is execfile()d with the current directory set to its
|
||||
# containing dir.
|
||||
#
|
||||
# Note that not all possible configuration values are present in this
|
||||
# autogenerated file.
|
||||
#
|
||||
# All configuration values have a default; values that are commented out
|
||||
# serve to show the default.
|
||||
|
||||
import sys
|
||||
import os
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||
#sys.path.insert(0, os.path.abspath('.'))
|
||||
|
||||
# -- General configuration ------------------------------------------------
|
||||
|
||||
# If your documentation needs a minimal Sphinx version, state it here.
|
||||
#needs_sphinx = '1.0'
|
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||
# ones.
|
||||
extensions = [
|
||||
# 'sphinx.ext.todo',
|
||||
# 'sphinx.ext.coverage',
|
||||
]
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
||||
# The suffix of source filenames.
|
||||
source_suffix = '.rst'
|
||||
|
||||
# The encoding of source files.
|
||||
#source_encoding = 'utf-8-sig'
|
||||
|
||||
# The master toctree document.
|
||||
master_doc = 'index'
|
||||
|
||||
# General information about the project.
|
||||
project = u'The FWaaS plugin for Fuel'
|
||||
copyright = u'2015, Mirantis Inc.'
|
||||
|
||||
# The version info for the project you're documenting, acts as replacement for
|
||||
# |version| and |release|, also used in various other places throughout the
|
||||
# built documents.
|
||||
#
|
||||
# The short X.Y version.
|
||||
version = '1.1-1.1.0-1'
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = '1.1-1.1.0-1'
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
#language = None
|
||||
|
||||
# There are two options for replacing |today|: either, you set today to some
|
||||
# non-false value, then it is used:
|
||||
#today = ''
|
||||
# Else, today_fmt is used as the format for a strftime call.
|
||||
#today_fmt = '%B %d, %Y'
|
||||
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
exclude_patterns = []
|
||||
|
||||
# The reST default role (used for this markup: `text`) to use for all
|
||||
# documents.
|
||||
#default_role = None
|
||||
|
||||
# If true, '()' will be appended to :func: etc. cross-reference text.
|
||||
#add_function_parentheses = True
|
||||
|
||||
# If true, the current module name will be prepended to all description
|
||||
# unit titles (such as .. function::).
|
||||
#add_module_names = True
|
||||
|
||||
# If true, sectionauthor and moduleauthor directives will be shown in the
|
||||
# output. They are ignored by default.
|
||||
#show_authors = False
|
||||
|
||||
# The name of the Pygments (syntax highlighting) style to use.
|
||||
pygments_style = 'sphinx'
|
||||
|
||||
# A list of ignored prefixes for module index sorting.
|
||||
#modindex_common_prefix = []
|
||||
|
||||
# If true, keep warnings as "system message" paragraphs in the built documents.
|
||||
#keep_warnings = False
|
||||
|
||||
|
||||
# -- Options for HTML output ----------------------------------------------
|
||||
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
html_theme = 'default'
|
||||
|
||||
# Theme options are theme-specific and customize the look and feel of a theme
|
||||
# further. For a list of options available for each theme, see the
|
||||
# documentation.
|
||||
#html_theme_options = {}
|
||||
|
||||
# Add any paths that contain custom themes here, relative to this directory.
|
||||
#html_theme_path = []
|
||||
|
||||
# The name for this set of Sphinx documents. If None, it defaults to
|
||||
# "<project> v<release> documentation".
|
||||
#html_title = None
|
||||
|
||||
# A shorter title for the navigation bar. Default is the same as html_title.
|
||||
#html_short_title = None
|
||||
|
||||
# The name of an image file (relative to this directory) to place at the top
|
||||
# of the sidebar.
|
||||
#html_logo = None
|
||||
|
||||
# The name of an image file (within the static path) to use as favicon of the
|
||||
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
||||
# pixels large.
|
||||
#html_favicon = None
|
||||
|
||||
# Add any paths that contain custom static files (such as style sheets) here,
|
||||
# relative to this directory. They are copied after the builtin static files,
|
||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
html_static_path = ['_static']
|
||||
|
||||
# Add any extra paths that contain custom files (such as robots.txt or
|
||||
# .htaccess) here, relative to this directory. These files are copied
|
||||
# directly to the root of the documentation.
|
||||
#html_extra_path = []
|
||||
|
||||
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
||||
# using the given strftime format.
|
||||
#html_last_updated_fmt = '%b %d, %Y'
|
||||
|
||||
# If true, SmartyPants will be used to convert quotes and dashes to
|
||||
# typographically correct entities.
|
||||
#html_use_smartypants = True
|
||||
|
||||
# Custom sidebar templates, maps document names to template names.
|
||||
#html_sidebars = {}
|
||||
|
||||
# Additional templates that should be rendered to pages, maps page names to
|
||||
# template names.
|
||||
#html_additional_pages = {}
|
||||
|
||||
# If false, no module index is generated.
|
||||
#html_domain_indices = True
|
||||
|
||||
# If false, no index is generated.
|
||||
#html_use_index = True
|
||||
|
||||
# If true, the index is split into individual pages for each letter.
|
||||
#html_split_index = False
|
||||
|
||||
# If true, links to the reST sources are added to the pages.
|
||||
#html_show_sourcelink = True
|
||||
|
||||
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
||||
#html_show_sphinx = True
|
||||
|
||||
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
||||
#html_show_copyright = True
|
||||
|
||||
# If true, an OpenSearch description file will be output, and all pages will
|
||||
# contain a <link> tag referring to it. The value of this option must be the
|
||||
# base URL from which the finished HTML is served.
|
||||
#html_use_opensearch = ''
|
||||
|
||||
# This is the file name suffix for HTML files (e.g. ".xhtml").
|
||||
#html_file_suffix = None
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = 'fuel-plugin-fwaasdoc'
|
||||
|
||||
|
||||
# -- Options for LaTeX output ---------------------------------------------
|
||||
|
||||
latex_elements = {
|
||||
# The paper size ('letterpaper' or 'a4paper').
|
||||
#'papersize': 'letterpaper',
|
||||
|
||||
# The font size ('10pt', '11pt' or '12pt').
|
||||
#'pointsize': '10pt',
|
||||
|
||||
# Additional stuff for the LaTeX preamble.
|
||||
#'preamble': '',
|
||||
}
|
||||
|
||||
# Grouping the document tree into LaTeX files. List of tuples
|
||||
# (source start file, target name, title,
|
||||
# author, documentclass [howto, manual, or own class]).
|
||||
latex_documents = [
|
||||
('index', 'fuel-plugin-fwaas.tex', u'The FWaaS Plugin for Fuel Documentation',
|
||||
u'Mirantis Inc.', 'manual'),
|
||||
]
|
||||
|
||||
# The name of an image file (relative to this directory) to place at the top of
|
||||
# the title page.
|
||||
#latex_logo = None
|
||||
|
||||
# For "manual" documents, if this is true, then toplevel headings are parts,
|
||||
# not chapters.
|
||||
#latex_use_parts = False
|
||||
|
||||
# If true, show page references after internal links.
|
||||
#latex_show_pagerefs = False
|
||||
|
||||
# If true, show URL addresses after external links.
|
||||
#latex_show_urls = False
|
||||
|
||||
# Documents to append as an appendix to all manuals.
|
||||
#latex_appendices = []
|
||||
|
||||
# If false, no module index is generated.
|
||||
#latex_domain_indices = True
|
||||
|
||||
# make latex stop printing blank pages between sections
|
||||
# http://stackoverflow.com/questions/5422997/sphinx-docs-remove-blank-pages-from-generated-pdfs
|
||||
latex_elements = { 'classoptions': ',openany,oneside', 'babel' : '\\usepackage[english]{babel}' }
|
||||
|
||||
|
||||
# -- Options for manual page output ---------------------------------------
|
||||
|
||||
# One entry per manual page. List of tuples
|
||||
# (source start file, name, description, authors, manual section).
|
||||
man_pages = [
|
||||
('index', 'fuel-plugin-fwaas', u'Guide to the FWaaS Plugin ver. 1.1-1.1.0-1 for Fuel',
|
||||
[u'Mirantis Inc.'], 1)
|
||||
]
|
||||
|
||||
# If true, show URL addresses after external links.
|
||||
#man_show_urls = False
|
||||
|
||||
|
||||
# -- Options for Texinfo output -------------------------------------------
|
||||
|
||||
# Grouping the document tree into Texinfo files. List of tuples
|
||||
# (source start file, target name, title, author,
|
||||
# dir menu entry, description, category)
|
||||
texinfo_documents = [
|
||||
('index', 'fuel-plugin-fwaas', u'The FWaaS Plugin for Fuel Documentation',
|
||||
u'Mirantis Inc.', 'fuel-plugin-fwaas', 'The FWaaS Plugin for Fuel Documentation',
|
||||
'Miscellaneous'),
|
||||
]
|
||||
|
||||
# Documents to append as an appendix to all manuals.
|
||||
#texinfo_appendices = []
|
||||
|
||||
# If false, no module index is generated.
|
||||
#texinfo_domain_indices = True
|
||||
|
||||
# How to display URL addresses: 'footnote', 'no', or 'inline'.
|
||||
#texinfo_show_urls = 'footnote'
|
||||
|
||||
# If true, do not generate a @detailmenu in the "Top" node's menu.
|
||||
#texinfo_no_detailmenu = False
|
||||
|
||||
# Insert footnotes where they are defined instead of
|
||||
# at the end.
|
||||
pdf_inline_footnotes = True
|
||||
|
||||
|
||||
|
||||
# -- Options for Epub output ----------------------------------------------
|
||||
|
||||
# Bibliographic Dublin Core info.
|
||||
epub_title = u'The FWaaS Plugin for Fuel'
|
||||
epub_author = u'Mirantis Inc.'
|
||||
epub_publisher = u'Mirantis Inc.'
|
||||
epub_copyright = u'2015, Mirantis Inc.'
|
||||
|
||||
# The basename for the epub file. It defaults to the project name.
|
||||
#epub_basename = u'fuel-plugin-openbook'
|
||||
|
||||
# The HTML theme for the epub output. Since the default themes are not optimized
|
||||
# for small screen space, using the same theme for HTML and epub output is
|
||||
# usually not wise. This defaults to 'epub', a theme designed to save visual
|
||||
# space.
|
||||
#epub_theme = 'epub'
|
||||
|
||||
# The language of the text. It defaults to the language option
|
||||
# or en if the language is not set.
|
||||
#epub_language = ''
|
||||
|
||||
# The scheme of the identifier. Typical schemes are ISBN or URL.
|
||||
#epub_scheme = ''
|
||||
|
||||
# The unique identifier of the text. This can be a ISBN number
|
||||
# or the project homepage.
|
||||
#epub_identifier = ''
|
||||
|
||||
# A unique identification for the text.
|
||||
#epub_uid = ''
|
||||
|
||||
# A tuple containing the cover image and cover page html template filenames.
|
||||
#epub_cover = ()
|
||||
|
||||
# A sequence of (type, uri, title) tuples for the guide element of content.opf.
|
||||
#epub_guide = ()
|
||||
|
||||
# HTML files that should be inserted before the pages created by sphinx.
|
||||
# The format is a list of tuples containing the path and title.
|
||||
#epub_pre_files = []
|
||||
|
||||
# HTML files shat should be inserted after the pages created by sphinx.
|
||||
# The format is a list of tuples containing the path and title.
|
||||
#epub_post_files = []
|
||||
|
||||
# A list of files that should not be packed into the epub file.
|
||||
epub_exclude_files = ['search.html']
|
||||
|
||||
# The depth of the table of contents in toc.ncx.
|
||||
#epub_tocdepth = 3
|
||||
|
||||
# Allow duplicate toc entries.
|
||||
#epub_tocdup = True
|
||||
|
||||
# Choose between 'default' and 'includehidden'.
|
||||
#epub_tocscope = 'default'
|
||||
|
||||
# Fix unsupported image types using the PIL.
|
||||
#epub_fix_images = False
|
||||
|
||||
# Scale large images.
|
||||
#epub_max_image_width = 0
|
||||
|
||||
# How to display URL addresses: 'footnote', 'no', or 'inline'.
|
||||
#epub_show_urls = 'inline'
|
||||
|
||||
# If false, no index is generated.
|
||||
#epub_use_index = True
|
||||
|
|
@ -1,21 +0,0 @@
|
|||
.. fuel-plugin-fwaas-doc master file, created by
|
||||
sphinx-quickstart on Mon Nov 16 09:11:57 2015.
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
Welcome to FWaaS Plugin for Fuel's documentation!
|
||||
=================================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
overview
|
||||
installation_guide
|
||||
user_guide
|
||||
appendix
|
||||
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
* :ref:`search`
|
||||
|
|
@ -1,52 +0,0 @@
|
|||
.. _installation:
|
||||
|
||||
Installation Guide
|
||||
-------------------
|
||||
|
||||
Installing FWaaS plugin
|
||||
+++++++++++++++++++++++
|
||||
|
||||
|
||||
#. Download the plugin from `Fuel Plugins Catalog`_.
|
||||
|
||||
#. Copy the plugin on already installed Fuel Master node::
|
||||
|
||||
[user@home ~]$ scp fwaas-plugin-1.1-1.1.0-1.noarch.rpm root@:/
|
||||
<the_Fuel_Master_node_IP>:~/
|
||||
|
||||
#. Log into the Fuel Master node. Install the plugin::
|
||||
|
||||
[root@fuel ~]# fuel plugins --install fwaas-plugin-1.1-1.1.0-1.noarch.rpm
|
||||
|
||||
#. Verify that the plugin is installed correctly::
|
||||
|
||||
[root@fuel ~]# fuel plugins --list
|
||||
id | name | version | package_version
|
||||
---|--------------|---------|----------------
|
||||
1 | fwaas_plugin | 1.1.0 | 2.0.0
|
||||
|
||||
|
||||
Creating Environment with FWaaS
|
||||
+++++++++++++++++++++++++++++++
|
||||
|
||||
#. After plugin is installed, create a new OpenStack environment with Neutron
|
||||
as a network provider.
|
||||
|
||||
#. `Configure your environment`_.
|
||||
|
||||
#. Open the Settings tab of the Fuel web UI and scroll down the page. Select
|
||||
FWaaS plugin checkbox:
|
||||
|
||||
.. image:: _static/fwaas_in_fuel_ui.png
|
||||
|
||||
#. `Deploy your environment`_.
|
||||
|
||||
|
||||
**********
|
||||
References
|
||||
**********
|
||||
|
||||
.. target-notes::
|
||||
.. _Fuel Plugins Catalog: https://software.mirantis.com/download-mirantis-openstack-fuel-plug-ins
|
||||
.. _Configure your environment: http://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#configure-your-environment
|
||||
.. _Deploy your environment: http://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#deploy-changes
|
||||
|
|
@ -1,75 +0,0 @@
|
|||
.. _overview:
|
||||
|
||||
Document purpose
|
||||
================
|
||||
|
||||
This document provides instructions for installing, configuring and using
|
||||
Neutron Firewall-as-a-Service plugin for Fuel.
|
||||
|
||||
|
||||
Key terms, acronyms and abbreviations
|
||||
-------------------------------------
|
||||
|
||||
+----------------------------+------------------------------------------------+
|
||||
| Term/abbreviation | Definition |
|
||||
+============================+================================================+
|
||||
| FWaaS | Firewall-as-a-Service |
|
||||
+----------------------------+------------------------------------------------+
|
||||
| IPTables | A user-space application program that allows |
|
||||
| | a system administrator to configure the tables |
|
||||
| | provided by the Linux kernel firewall and the |
|
||||
| | chains and rules it stores. Different kernel |
|
||||
| | modules and programs are currently used for |
|
||||
| | different protocols; IPTables applies to IPv4, |
|
||||
| | ip6tables to IPv6, arptables to ARP, and |
|
||||
| | ebtables to Ethernet frames. |
|
||||
+----------------------------+------------------------------------------------+
|
||||
| VM | Virtual Machine (Instance) |
|
||||
+----------------------------+------------------------------------------------+
|
||||
|
||||
|
||||
FWaaS Plugin
|
||||
------------
|
||||
|
||||
The Firewall-as-a-Service (FWaaS) is a Neutron plugin, which adds perimeter
|
||||
firewall management to Networking. FWaaS uses IPTables to apply firewall policy
|
||||
to the selected router. Whereas security groups operate at the instance-level,
|
||||
FWaaS operates at the router-level.
|
||||
|
||||
|
||||
Requirements
|
||||
------------
|
||||
|
||||
+----------------------------+------------------------------------------------+
|
||||
| Requirement | Version/Comment |
|
||||
+============================+================================================+
|
||||
| Fuel | 7.0 release with Maintenance Update 2 |
|
||||
+----------------------------+------------------------------------------------+
|
||||
| OpenStack compatibility | 2015.1 Kilo with Maintenance Update 2 |
|
||||
+----------------------------+------------------------------------------------+
|
||||
| Operating systems | Ubuntu 14.04 LTS |
|
||||
+----------------------------+------------------------------------------------+
|
||||
|
||||
|
||||
Limitations
|
||||
-----------
|
||||
|
||||
FWaaS plugin can be enabled only in environments with Neutron with ML2 plugin
|
||||
with OpenVSwitch Mechanism driver (default configuration) as the networking
|
||||
option and tested only with the IPTables driver.
|
||||
|
||||
|
||||
Known issues
|
||||
------------
|
||||
|
||||
Please make sure that your environment contains maintenance update MU-2 for
|
||||
MOS 7.0 which has a fix for the High bug:
|
||||
`[FWaaS] Error firewall state after updating policy or rule`_
|
||||
|
||||
If your environment doesn't contain MU-2, please apply it:
|
||||
`How to apply Mirantis OpenStack 7.0 Maintenance Update`_
|
||||
|
||||
.. target-notes::
|
||||
.. _[FWaaS] Error firewall state after updating policy or rule: https://bugs.launchpad.net/mos/7.0.x/+bug/1510576
|
||||
.. _How to apply Mirantis OpenStack 7.0 Maintenance Update: https://docs.mirantis.com/openstack/fuel/fuel-7.0/maintenance-updates.html
|
||||
|
||||
|
|
@ -1,177 +0,0 @@
|
|||
|
||||
.. _user-guide:
|
||||
|
||||
User Guide
|
||||
==========
|
||||
|
||||
Configuring FWaaS service
|
||||
-------------------------
|
||||
|
||||
|
||||
Once OpenStack has been deployed, we can start configuring FWaaS.
|
||||
|
||||
This section provides an example of configuration and step-by-step instructions
|
||||
for configuring the plugin.
|
||||
|
||||
Here is an example task. We will have the following network architecture in our
|
||||
Project:
|
||||
|
||||
.. figure:: _static/net_arch.png
|
||||
:scale: 100 %
|
||||
:align: center
|
||||
|
||||
Before we start, we need to be remember that every Project in OpenStack is
|
||||
assigned the default security group for the cluster in its default form, which
|
||||
is usually restrictive. So you’ll probably need to create a few additional
|
||||
rules in each Project’s default security group: like a general ICMP rule,
|
||||
enabling pings, and a port 22 TCP rule, enabling SSH an example task:
|
||||
|
||||
.. figure:: _static/security_groups.png
|
||||
:scale: 100 %
|
||||
:align: center
|
||||
|
||||
Let's get started with the testing of connectivity between our VMs (using ping).
|
||||
So, for the current state situation is the following (see the network topology
|
||||
above):
|
||||
|
||||
.. figure:: _static/table_default.png
|
||||
:scale: 100 %
|
||||
:align: center
|
||||
|
||||
|
||||
1. Let's create **Firewall**
|
||||
|
||||
Open *Network* menu in the left-hand menu and select *Firewalls* option.
|
||||
|
||||
.. figure:: _static/select_firewalls_menu.png
|
||||
:scale: 100 %
|
||||
:align: center
|
||||
|
||||
2. Create **Policy**
|
||||
|
||||
Enter *Firewall Policies* tab and click *Add Policy* button.
|
||||
|
||||
.. figure:: _static/create_policy.png
|
||||
:scale: 100 %
|
||||
:align: center
|
||||
|
||||
In this window, we should fill in policy name and description of this
|
||||
policy in the *Name* and *Description* fields. Also, here we can set
|
||||
*Shared* and *Audited flags*:
|
||||
|
||||
* *Shared* - allow to share your policy with all other Projects.
|
||||
* *Audited* - indicate whether the particular firewall policy was
|
||||
audited or not by the creator of the firewall policy.
|
||||
|
||||
And click *Add* button to finish.
|
||||
|
||||
.. figure:: _static/fill_policy_params.png
|
||||
:scale: 100 %
|
||||
:align: center
|
||||
|
||||
3. Create **Firewall**
|
||||
|
||||
Enter *Firewalls* tab and click *Create Firewall* button.
|
||||
|
||||
.. figure:: _static/create_firewall.png
|
||||
:scale: 100 %
|
||||
:align: center
|
||||
|
||||
In *Add Firewall* tab we should fill in *Name*, *Description* fields and
|
||||
choose our policy that was created in previous step.
|
||||
* *Shared* - allow to share your Firewall with all other Projects.
|
||||
* *Admin State* - option provide an ability to set UP or DOWN the
|
||||
Firewall.
|
||||
|
||||
.. figure:: _static/fill_firewall_params.png
|
||||
:scale: 100 %
|
||||
:align: center
|
||||
|
||||
**NOTE**: The firewall remains in *PENDING_CREATE* state until you create
|
||||
a Networking router and attach an interface to it.
|
||||
|
||||
In *Routers* tab we should choose routers from the available routers on
|
||||
which we want to enable our Firewall. Let's apply it only for router **r1**.
|
||||
|
||||
.. figure:: _static/add_firewall_to_r1.png
|
||||
:scale: 100 %
|
||||
:align: center
|
||||
|
||||
4. Let’s test connectivity between our VMs with new Firewall which we applied
|
||||
on the router **r1**
|
||||
|
||||
.. figure:: _static/table_fw_r1.png
|
||||
:scale: 100 %
|
||||
:align: center
|
||||
|
||||
**WARNING**: Firewall always adds a default rule to **deny** all at the
|
||||
lowest precedence of each policy. Consequently, a firewall policy with no
|
||||
rules blocks all traffic by default.
|
||||
|
||||
Since we applied our Firewall only for the router **r1** we can that **r1**
|
||||
blocks all traffic and router **r2** works as before. For the adding and
|
||||
removing routers to the Firewall we should click drop-down button near the
|
||||
*Edit Firewall* button and select *Add/Remove Router*:
|
||||
|
||||
.. figure:: _static/add_firewall_to_r2.png
|
||||
:scale: 100 %
|
||||
:align: center
|
||||
|
||||
5. Create **Rule**
|
||||
|
||||
For the allowing ICMP traffic we need to create a new rule.
|
||||
Enter *Firewall Rules* tab and press *Add Rule* button:
|
||||
|
||||
|
||||
.. figure:: _static/create_rule.png
|
||||
:scale: 100 %
|
||||
:align: center
|
||||
|
||||
Here, as usual we should fill in Name and Description fields. And specify
|
||||
the type of traffic, a couple of flags and action for it:
|
||||
|
||||
* *Protocol* - type of protocol (ICMP, TCP, UDP or ANY).
|
||||
* *Source( Destination) IP Address/Subnet* - It might be single IP
|
||||
172.18.161.10 or CIDR like 172.18.161.0/24
|
||||
* *Source(Destination) Port / Port Range* - It might be a single Port 80
|
||||
or range like 100:200.
|
||||
* *Action* - what to do (ALLOW or DENY) with this type traffic.
|
||||
* *Shared* - allow to share your rule with all other Projects.
|
||||
* *Enable* - provide an ability to turn ON or OFF this rule.
|
||||
|
||||
.. figure:: _static/fill_rule_parameters.png
|
||||
:scale: 100 %
|
||||
:align: center
|
||||
|
||||
6. Add **Rule** to the **Policy**
|
||||
|
||||
Add the created rule into our policy:
|
||||
|
||||
* Enter Firewall Policies.
|
||||
* In column for our policy, click drop-down button and select Insert
|
||||
Rule.
|
||||
|
||||
.. figure:: _static/add_rule_to_policy.png
|
||||
:scale: 100 %
|
||||
:align: center
|
||||
|
||||
* In *Insert Rule to Policy* window, we can choose the necessary rule
|
||||
and specify the order of applying the rules. It's important that the
|
||||
rules are setup in proper order. The first rule that matches the type
|
||||
of traffic will be used.
|
||||
|
||||
.. figure:: _static/insert_rule_into_policy.png
|
||||
:scale: 100 %
|
||||
:align: center
|
||||
|
||||
7. And let’s test connectivity again
|
||||
|
||||
.. figure:: _static/table_all_routers_with_fw_and_icmp_rule.png
|
||||
:scale: 100 %
|
||||
:align: center
|
||||
|
||||
The situation is the same that we have without a Firewall, but only for the
|
||||
ICMP traffic while for the other types of packets it remained the same as
|
||||
at the beginning.
|
||||
|
||||
|
||||
|
|
@ -1,8 +0,0 @@
|
|||
attributes:
|
||||
# Show fwaas only for neutron
|
||||
metadata:
|
||||
restrictions:
|
||||
- condition: cluster:net_provider != 'neutron'
|
||||
action: hide
|
||||
- condition: settings:neutron_advanced_configuration.neutron_dvr.value == true
|
||||
message: "Neutron DVR must be disabled in order to use FWaaS plugin"
|
||||
|
|
@ -1,29 +0,0 @@
|
|||
# Plugin name
|
||||
name: fwaas-plugin
|
||||
# Human-readable name for your plugin
|
||||
title: FWaaS plugin for Neutron
|
||||
# Plugin version
|
||||
version: 1.1.0
|
||||
# Description
|
||||
description: Neutron extension that introduces FireWall feature set
|
||||
# Required fuel version
|
||||
fuel_version: ['7.0']
|
||||
# Specify license of your plugin
|
||||
licenses: ['Apache License Version 2.0']
|
||||
# Specify author or company name
|
||||
authors: ['Andrey Epifanov, Sergey Kolekonov']
|
||||
# A link to the plugin's page
|
||||
homepage: 'https://github.com/stackforge/fuel-plugin-neutron-fwaas'
|
||||
# Groups
|
||||
groups: ['network']
|
||||
|
||||
# The plugin is compatible with releases in the list
|
||||
releases:
|
||||
- os: ubuntu
|
||||
version: 2015.1-7.0
|
||||
mode: ['ha']
|
||||
deployment_scripts_path: deployment_scripts/
|
||||
repository_path: repositories/ubuntu
|
||||
|
||||
# Version of plugin package
|
||||
package_version: '2.0.0'
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
#!/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.
|
||||
|
|
@ -1,138 +0,0 @@
|
|||
===============================================
|
||||
Fuel plugin for FWaaS functionality in Neutron
|
||||
===============================================
|
||||
|
||||
https://blueprints.launchpad.net/fuel/+spec/support-fwaas-in-mos
|
||||
|
||||
FWaaS (FireWall-as-a-Service) is Neutron extension that introduces firewall
|
||||
feature set.
|
||||
Neutron FwaaS provides a cloud-centric abstractions for a security feature
|
||||
set spanning traditional L2/L3 firewalls to richer application-aware
|
||||
next-generation firewalls.
|
||||
This plugin uses IPTables driver.
|
||||
|
||||
Problem description
|
||||
===================
|
||||
|
||||
FWaaS is a very popular and useful feature, which controls the incoming and
|
||||
outgoing network traffic based on an applied rule set. A firewall establishes
|
||||
a barrier between a trusted, secure internal network and another network
|
||||
(e.g., the Internet) that is assumed not to be secure and trusted. Today
|
||||
it is a neccesary functionality for the using OpenStack in production.
|
||||
|
||||
Proposed change
|
||||
===============
|
||||
|
||||
Implement FUEL plugin which will configure FWaaS functionality in Neutron
|
||||
and Horizon.
|
||||
|
||||
Alternatives
|
||||
------------
|
||||
|
||||
It also might be implemented as a part of FUEL core, but we decided to make
|
||||
it as a plugin for several reasons:
|
||||
* Community decided to separate FWaaS and other aaS services into their own
|
||||
project(repo), so we would do it the same way.
|
||||
* Another reason is that any new additional functionality makes a project and
|
||||
testing more difficult, which is an additional risk for the FUEL release.
|
||||
|
||||
Data model impact
|
||||
-----------------
|
||||
|
||||
None
|
||||
|
||||
REST API impact
|
||||
---------------
|
||||
|
||||
None
|
||||
|
||||
Upgrade impact
|
||||
--------------
|
||||
|
||||
None
|
||||
|
||||
Security impact
|
||||
---------------
|
||||
|
||||
None
|
||||
|
||||
Notifications impact
|
||||
--------------------
|
||||
|
||||
None
|
||||
|
||||
Other end user impact
|
||||
---------------------
|
||||
|
||||
None
|
||||
|
||||
Performance Impact
|
||||
------------------
|
||||
|
||||
None
|
||||
|
||||
Other deployer impact
|
||||
---------------------
|
||||
|
||||
None
|
||||
|
||||
Developer impact
|
||||
----------------
|
||||
|
||||
None
|
||||
|
||||
Implementation
|
||||
==============
|
||||
|
||||
Assignee(s)
|
||||
-----------
|
||||
|
||||
Primary assignee:
|
||||
Andrey Epifanov <aepifanov@mirantis.com> - feature lead, developer
|
||||
|
||||
Other contrubitors:
|
||||
|
||||
Stanislaw Bogatkin <sbogatkin@mirantis.com> - design reviewer
|
||||
Sergey Kolekonov <skilekonov@mirantis.com> - design reviewer
|
||||
Timur Nurlygayanov <tnurlygayanov@mirantis.com> - QA engineer
|
||||
Kristina Kuznetsova <kkuznetsova@mirantis.com> - QA engineer
|
||||
Irina Povolotskaya <ipovolotskaya@mirantis.com> - technical writer
|
||||
|
||||
Work Items
|
||||
----------
|
||||
|
||||
* Implement Fuel plugin.
|
||||
* Implement puppet manifests.
|
||||
* Testing.
|
||||
* Write documentation.
|
||||
|
||||
Dependencies
|
||||
============
|
||||
|
||||
* Fuel 6.1 and higher.
|
||||
|
||||
Testing
|
||||
=======
|
||||
|
||||
* Prepare a test plan.
|
||||
* Test deployment with activated plugin for all FUEL deployment modes.
|
||||
* Test FWaaS functionality as well according to the `FWaaS Testing
|
||||
<https://wiki.openstack.org/wiki/Quantum/FWaaS/Testing>`_.
|
||||
* Provide integration tests with other OpenStack components and Neutron plugins.
|
||||
|
||||
Documentation Impact
|
||||
====================
|
||||
|
||||
* Deployment Guide (how to prepare an env for installation, how to install
|
||||
the plugin, how to deploy OpenStack env with the plugin).
|
||||
* User Guide (which features the plugin provides, how to use them in the
|
||||
deployed OS env).
|
||||
* Test Plan.
|
||||
* Test Report.
|
||||
|
||||
References
|
||||
==========
|
||||
|
||||
* https://wiki.openstack.org/wiki/Neutron/FWaaS
|
||||
* https://wiki.openstack.org/wiki/Neutron/FWaaS/HowToInstall
|
||||
* https://wiki.openstack.org/wiki/Quantum/FWaaS/Testing
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
- role: ['controller','primary-controller']
|
||||
stage: post_deployment
|
||||
type: puppet
|
||||
parameters:
|
||||
puppet_manifest: puppet/manifests/site.pp
|
||||
puppet_modules: puppet/modules:/etc/puppet/modules
|
||||
timeout: 720
|
||||
Loading…
Reference in New Issue