Merge lp:~junaidali/charms/trusty/neutron-api-plumgrid/oil-sapi-changes into lp:charms/trusty/neutron-api-plumgrid

[Junaid Ali]

Added charm series in metadata.yaml file
Updated networking-plumgrid version mappings
Added support for deb networking install - PG ONS 6.X.X
Added new configs in plumlib.ini

Unmerged revisions

11. By Junaid Ali on 2016-10-17

Changes:
    Added charm series in metadata.yaml file
    Updated networking-plumgrid version mappings
    Added support for deb networking install - PG ONS 6.X.X
    Added new configs in plumlib.ini

10. By Junaid Ali on 2016-10-15

Changes:
  Added charm series in metadata.yaml file
  Added charm series in metadata.yaml file
  Added support for deb networking install - PG ONS 6.X.X
  Added new configs in plumlib.ini
  Ensured neutron-server is restarted after a package update

=== added file 'LICENSE'
--- LICENSE	1970-01-01 00:00:00 +0000
+++ LICENSE	2016-10-17 17:20:39 +0000
@@ -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.

=== modified file 'Makefile'
--- Makefile	2016-05-25 16:26:49 +0000
+++ Makefile	2016-10-17 17:20:39 +0000
@@ -4,12 +4,11 @@
 virtualenv:
 	virtualenv .venv
 	.venv/bin/pip install flake8 nose coverage mock pyyaml netifaces \
-        netaddr jinja2 pyflakes pep8 six pbr funcsigs psutil charm-tools \
-		simplejson
+        netaddr jinja2 pyflakes pep8 six pbr funcsigs psutil
 
 lint: virtualenv
 	.venv/bin/flake8 --exclude hooks/charmhelpers hooks unit_tests tests --ignore E402
-	@.venv/bin/charm-proof
+	@charm proof
 
 unit_test: virtualenv
 	@echo Starting tests...

=== modified file 'README.md'
--- README.md	2016-04-15 11:03:21 +0000
+++ README.md	2016-10-17 17:20:39 +0000
@@ -23,7 +23,7 @@
 
 # Known Limitations and Issues
 
-The charm currently only supports Kilo Openstack Release.
+This charm currently doesn't support Ubuntu 16.04.
 
 # Configuration
 
@@ -44,3 +44,5 @@
 # Contact Information
 
 Bilal Baqar <[e-mail]>
+Javeria Khan <[e-mail]>
+Junaid Ali <[e-mail]>

=== modified file 'config.yaml'
--- config.yaml	2016-06-21 17:30:37 +0000
+++ config.yaml	2016-10-17 17:20:39 +0000
@@ -15,7 +15,14 @@
     default: 'latest'
     type: string
     description: |
-       Provide the build version of PLUMgrid packages that needs to be installed
+       Provide the build version of plumgrid-pythonlib package that needs to be installed
+  networking-build:
+    type: string
+    default:
+    description: |
+       Provide the build version of networking-plumgrid package that needs to be installed.
+       Accepted values are either 'latest' (which installs latest networking-plumgrid
+       package available) or a specific version for the package.
   networking-plumgrid-version:
     default: null
     type: string
@@ -57,3 +64,17 @@
     type: string
     default: Default
     description: Keystone project domain name
+  enable-deb-networking-install:
+    type: boolean
+    default: False
+    description: |
+      If enabled networking plumgrid is installed from deb package on LCM instead of
+      installation using pip
+  enable-flow-tap:
+    type: boolean
+    default: True
+    description: Toggles reverse flow creation for tap based policies
+  enable-metaconfig:
+    type: boolean
+    default: True
+    description: Enables/disables nova communication for metaconfig

=== modified file 'copyright'
--- copyright	2015-07-29 18:35:16 +0000
+++ copyright	2016-10-17 17:20:39 +0000
@@ -1,9 +1,16 @@
 Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0
 
 Files: *
-Copyright: 2015, PLUMgrid Inc.
-License: GPL-3
-
-License: GPL-3
- On Debian GNU/Linux system you can find the complete text of the
- GPL-3 license in '/usr/share/common-licenses/GPL-3'
+Copyright: 2016, PLUMgrid Inc., All Rights Reserved.
+License: Apache-2.0
+ 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.

=== modified file 'hooks/neutron_plumgrid_context.py'
--- hooks/neutron_plumgrid_context.py	2016-06-21 17:30:37 +0000
+++ hooks/neutron_plumgrid_context.py	2016-10-17 17:20:39 +0000
@@ -120,6 +120,8 @@
         pg_ctxt['connector_type'] = config('connector-type')
         pg_ctxt['user_domain_name'] = config('user-domain-name')
         pg_ctxt['project_domain_name'] = config('project-domain-name')
+        pg_ctxt['enable_reverse_flow_tap'] = config('enable-flow-tap')
+        pg_ctxt['nova_metaconfig'] = config('enable-metaconfig')
         if enable_metadata:
             plumgrid_edge_ctxt = _edge_context()
             pg_ctxt['nova_metadata_proxy_secret'] = \

=== modified file 'hooks/neutron_plumgrid_hooks.py'
--- hooks/neutron_plumgrid_hooks.py	2016-05-22 15:53:34 +0000
+++ hooks/neutron_plumgrid_hooks.py	2016-10-17 17:20:39 +0000
@@ -6,7 +6,6 @@
 # in this file.
 
 import sys
-from charmhelpers.core.host import service_running
 from charmhelpers.core.hookenv import (
     Hooks,
     UnregisteredHookError,
@@ -17,7 +16,9 @@
 
 from charmhelpers.core.host import (
     restart_on_change,
-    service_restart
+    service_start,
+    service_stop,
+    service_running
 )
 
 from charmhelpers.fetch import (
@@ -64,6 +65,7 @@
     charm_config = config()
     if (charm_config.changed('install_sources') or
         charm_config.changed('plumgrid-build') or
+        charm_config.changed('networking-build') or
             charm_config.changed('install_keys')):
         status_set('maintenance', 'Upgrading apt packages')
         if charm_config.changed('install_sources'):
@@ -73,12 +75,14 @@
         pkgs = determine_packages()
         for pkg in pkgs:
             apt_install(pkg, options=['--force-yes'], fatal=True)
-        service_restart('neutron-server')
+        service_stop('neutron-server')
     if (charm_config.changed('networking-plumgrid-version') or
             charm_config.changed('pip-proxy')):
         ensure_files()
-        service_restart('neutron-server')
+        service_stop('neutron-server')
     CONFIGS.write_all()
+    if not service_running('neutron-server'):
+        service_start('neutron-server')
 
 
 @hooks.hook('neutron-plugin-api-relation-joined')

=== modified file 'hooks/neutron_plumgrid_utils.py'
--- hooks/neutron_plumgrid_utils.py	2016-08-26 06:21:37 +0000
+++ hooks/neutron_plumgrid_utils.py	2016-10-17 17:20:39 +0000
@@ -12,6 +12,7 @@
 from charmhelpers.contrib.openstack.neutron import neutron_plugin_attribute
 from charmhelpers.contrib.python.packages import pip_install
 from charmhelpers.fetch import (
+    apt_install,
     apt_cache
 )
 from charmhelpers.core.hookenv import (
@@ -27,7 +28,8 @@
 TEMPLATES = 'templates/'
 
 PG_PACKAGES = [
-    'plumgrid-pythonlib'
+    'plumgrid-pythonlib',
+    'networking-plumgrid'
 ]
 
 NEUTRON_CONF_DIR = "/etc/neutron"
@@ -56,10 +58,16 @@
     }),
 ])
 
-NETWORKING_PLUMGRID_VERSION = OrderedDict([
-    ('kilo', '2015.1.5.4'),
-    ('liberty', '2015.2.5.4'),
-    ('mitaka', '2016.1.1.2'),
+# PG-ONS 6.X.X
+NETWORKING_PLUMGRID_PIP_VERSION = OrderedDict([
+    ('kilo', '2015.1.5.4'),
+    ('liberty', '2015.2.6.4'),
+    ('mitaka', '2016.1.6.4'),
+])
+NETWORKING_PLUMGRID_DEB_VERSION = OrderedDict([
+    ('kilo', '2015.1.5.4'),
+    ('liberty', '2015.2.6.4'),
+    ('mitaka', '2016.1.6.4.xenial1'),
 ])
 
 
@@ -85,11 +93,20 @@
     enable PLUMgrid in Openstack.
     '''
     pkgs = []
-    tag = config('plumgrid-build')
     for pkg in PG_PACKAGES:
+        tag = ''
+        if pkg == 'plumgrid-pythonlib':
+            tag = config('plumgrid-build')
+        elif (pkg == 'networking-plumgrid' and
+              config('enable-deb-networking-install')):
+            if config('networking-build'):
+                tag = config('networking-build')
+            else:
+                release = os_release('neutron-common', base='kilo')
+                tag = NETWORKING_PLUMGRID_DEB_VERSION[release]
         if tag == 'latest':
             pkgs.append(pkg)
-        else:
+        elif tag:
             if tag in [i.ver_str for i in apt_cache()[pkg].version_list]:
                 pkgs.append('%s=%s' % (pkg, tag))
             else:
@@ -167,17 +184,24 @@
     Installs networking-plumgrid package
     '''
     release = os_release('neutron-common', base='kilo')
-    if config('networking-plumgrid-version') is None:
-        package_version = NETWORKING_PLUMGRID_VERSION[release]
-    else:
-        package_version = config('networking-plumgrid-version')
-    package_name = 'networking-plumgrid==%s' % package_version
-    if config('pip-proxy') != "None":
-        pip_install(package_name, fatal=True, proxy=config('pip-proxy'))
-    else:
-        pip_install(package_name, fatal=True)
-    if is_leader() and package_version != '2015.1.1.1':
-        migrate_neutron_db()
+    if not config('enable-deb-networking-install'):
+        if config('networking-plumgrid-version') is None:
+            package_version = NETWORKING_PLUMGRID_PIP_VERSION[release]
+        else:
+            package_version = config('networking-plumgrid-version')
+        package_name = 'networking-plumgrid==%s' % package_version
+        if config('pip-proxy') != "None":
+            pip_install(package_name, fatal=True, proxy=config('pip-proxy'))
+        else:
+            pip_install(package_name, fatal=True)
+        if is_leader() and package_version != '2015.1.1.1':
+            migrate_neutron_db()
+    else:
+        apt_install('networking-plumgrid=%s' %
+                    NETWORKING_PLUMGRID_DEB_VERSION[release],
+                    options=['--force-yes'], fatal=True)
+        if is_leader():
+            migrate_neutron_db()
 
 
 def migrate_neutron_db():

=== modified file 'metadata.yaml'
--- metadata.yaml	2016-05-04 14:03:49 +0000
+++ metadata.yaml	2016-10-17 17:20:39 +0000
@@ -14,6 +14,9 @@
   reduce the deployment time of OpenStack clouds, enables users to create
   private Virtual Domains™ for their projects and is compatible with the
   leading OpenStack distributions.
+series:
+  - xenial
+  - trusty
 tags:
   - openstack
 subordinate: true

=== modified file 'templates/kilo/plumlib.ini'
--- templates/kilo/plumlib.ini	2016-06-21 17:30:37 +0000
+++ templates/kilo/plumlib.ini	2016-10-17 17:20:39 +0000
@@ -14,9 +14,15 @@
 # Reverse Flow Flag
 enable_reverse_flow = True
 
+# Reverse Flow Flag Tap
+enable_reverse_flow_tap = {{ enable_reverse_flow_tap }}
+
 # Flag to enable/disable virtual appliance creation
 vapp_flag = False
 
+# Flag to enable/disable nova communication for metaconfig
+nova_metaconfig = {{ nova_metaconfig }}
+
 # Metadata Flags. If "metadata_ns" is set to false, respective
 # namespace for metadata won't be created on this node
 [PLUMgridMetadata]

=== modified file 'unit_tests/test_neutron_plumgrid_plugin_context.py'
--- unit_tests/test_neutron_plumgrid_plugin_context.py	2016-06-21 17:40:31 +0000
+++ unit_tests/test_neutron_plumgrid_plugin_context.py	2016-10-17 17:20:39 +0000
@@ -61,7 +61,9 @@
             'switch-password': 'plumgrid',
             'connector-type': 'service',
             'user-domain-name': 'Default',
-            'project-domain-name': 'Default'
+            'project-domain-name': 'Default',
+            'enable-flow-tap': 'True',
+            'enable-metaconfig': 'True',
         }
 
         def mock_config(key=None):
@@ -98,5 +100,7 @@
             'pg_metadata_ip': '169.254.169.254',
             'pg_metadata_subnet': '169.254.169.254/30',
             'pg_metadata_port': '8775',
+            'enable_reverse_flow_tap': 'True',
+            'nova_metaconfig': 'True',
         }
         self.assertEquals(expect, napi_ctxt())