Merge pull request #577 from mattgreene/mitaka

Merge Liberty into Mitaka
F5Networks · May 26, 2017 · b9b3db1 · b9b3db1
2 parents 63677a1 + fbe9755
commit b9b3db1
Show file tree

Hide file tree

Showing 15 changed files with 20 additions and 169 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -17,7 +17,6 @@ before_install:
 install:
 - pip install hacking pytest coverage
 - pip install -r requirements.test.txt
-- pip install -r requirements.docs.txt
 script:
 - flake8 ./f5lbaasdriver
 - coverage run --source f5lbaasdriver -m py.test f5lbaasdriver/v2/bigip/

diff --git a/docs/conf.py b/docs/conf.py
@@ -50,6 +50,8 @@
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
+suppress_warnings = ['image.nonlocal_uri']
+
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 # source_suffix = ['.rst', '.md']
@@ -313,6 +315,9 @@
 
 # intersphinx: refer to other F5 OpenStack documentation sets.
 
+f5_lbaasv2_driver_shim_version = '9.1.0'
+f5_lbaasv2_driver_shim_url = 'https://github.com/F5Networks/neutron-lbaas/releases/download/v%s/f5.tgz' % f5_lbaasv2_driver_shim_version
+
 intersphinx_mapping = {'heat': (
      'http://f5-openstack-heat.readthedocs.io/en/mitaka', None),
      'heatplugins': (
@@ -343,9 +348,11 @@
 .. |f5_lbaasv2_driver_rpm_url| replace:: https://github.com/F5Networks/f5-openstack-lbaasv2-driver/releases/download/v%(version)s/f5-openstack-lbaasv2-driver-%(version)s-1.el7.noarch.rpm
 .. |f5_lbaasv2_driver_deb_package| replace:: python-f5-openstack-lbaasv2-driver_%(version)s-1_1404_all.deb
 .. |f5_lbaasv2_driver_rpm_package| replace:: f5-openstack-lbaasv2-driver-%(version)s-1.el7.noarch.rpm
+.. |f5_lbaasv2_driver_shim_url| replace:: %(f5_lbaasv2_driver_shim_url)s
 .. |f5_agent_pip_url| replace:: git+https://github.com/F5Networks/f5-openstack-agent@v%(version)s
 ''' % {
   'openstack_release': openstack_release,
   'openstack_release_l': openstack_release.lower(),
+  'f5_lbaasv2_driver_shim_url': f5_lbaasv2_driver_shim_url,
   'version': version
 }
diff --git a/docs/f5lbaasdriver/f5lbaasdriver.rst b/docs/f5lbaasdriver/f5lbaasdriver.rst
diff --git a/docs/f5lbaasdriver/f5lbaasdriver.utils.rst b/docs/f5lbaasdriver/f5lbaasdriver.utils.rst
diff --git a/docs/f5lbaasdriver/f5lbaasdriver.utils.test.rst b/docs/f5lbaasdriver/f5lbaasdriver.utils.test.rst
diff --git a/docs/f5lbaasdriver/f5lbaasdriver.v2.bigip.rst b/docs/f5lbaasdriver/f5lbaasdriver.v2.bigip.rst
diff --git a/docs/f5lbaasdriver/f5lbaasdriver.v2.rst b/docs/f5lbaasdriver/f5lbaasdriver.v2.rst
diff --git a/docs/f5lbaasdriver/modules.rst b/docs/f5lbaasdriver/modules.rst
diff --git a/docs/glossary.rst b/docs/glossary.rst
@@ -71,10 +71,13 @@ Glossary
     multi-arm mode
     multiple-arm mode
         Multi-arm mode is a network topology wherein servers/clients connect to the BIG-IP via different interfaces; two or more VLANs can be used to handle management and data traffic.
+
     vcmp
         Virtual Clustered Multiprocessing (vCMP) is a feature of the BIG-IP system that allows you to run multiple instances of the BIG-IP software on a single hardware platform.
+
     vCMP host
         The vCMP host is the system-wide hypervisor that makes it possible for you to create and view BIG-IP instances, or vCMP 'guests'.
+
     vCMP guest
         A vCMP guest is an instance of BIG-IP software created on the vCMP system for the purpose of provisioning one or more BIG-IP modules to process application traffic.
 

diff --git a/docs/includes/ref_prerequisites.rst b/docs/includes/ref_prerequisites.rst
@@ -42,6 +42,7 @@
 - Knowledge of `BIG-IP vCMP <https://support.f5.com/kb/en-us/products/big-ip_ltm/manuals/product/vcmp-administration-appliances-12-1-1/1.html>`_ configuration and administration.
 
 - Knowledge of BIG-IP `system configuration`_, `local traffic management`_, & `device service clustering`_.
+
 .. must include the following at end of document:
     .. _system configuration: https://support.f5.com/kb/en-us/products/big-ip_ltm/manuals/product/bigip-system-initial-configuration-12-0-0/2.html#conceptid
     .. _local traffic management: https://support.f5.com/kb/en-us/products/big-ip_ltm/manuals/product/ltm-basics-12-0-0.html

diff --git a/docs/includes/topic_neutron-bigip-command-mapping.rst b/docs/includes/topic_neutron-bigip-command-mapping.rst
@@ -92,11 +92,11 @@ Further Reading
 
 
 .. rubric:: Footnotes:
-.. [#] This is done for all tunnel types, not just those configured as the ``advertised_tunnel_types`` in the :ref:`L2 Segmentation Mode Settings`.
+.. [#] This is done for all tunnel types, not just those configured as the ``advertised_tunnel_types`` in the :ref:`L2 Segmentation Mode` Settings.
 .. [#] Configured in ``Environment Settings --> environment_prefix``. The default prefix is ``Project``.
 .. [#] Run ``openstack project list`` to get a list of configured tenant names and IDs.
 .. [#] If using :ref:`global routed mode`, all traffic is directed to the self IP (no tunnel is created).
-.. [#] Configured in :ref:`L3 Segmentation Mode Settings` --> ``f5_snat_addresses_per_subnet``.
+.. [#] Configured in :ref:`L3 Segmentation Mode` Settings --> ``f5_snat_addresses_per_subnet``.
 .. [#] See :ref:`Certificate Manager / SSL Offloading`.
 
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -37,14 +37,6 @@ Contents
 .. include:: includes/topic_lbaasv2-plugin-overview.rst
     :start-line: 2
 
-API Documentation
-=================
-
-* :ref:`f5lbaasdriver`
-
-    * :ref:`f5lbaasdriver.utils`
-    * :ref:`f5lbaasdriver.v2`
-
 
 .. |Build Status| image:: https://travis-ci.org/F5Networks/f5-openstack-lbaasv2-driver.svg?branch=mitaka
     :target: https://travis-ci.org/F5Networks/f5-openstack-lbaasv2-driver?branch=mitaka

diff --git a/docs/map_before-you-begin.rst b/docs/map_before-you-begin.rst
@@ -32,9 +32,9 @@ Install the F5 Service Provider Package
 
 1. Download from GitHub.
 
-.. code-block:: shell
+.. parsed-literal::
 
-    $ curl -O -L https://github.com/F5Networks/neutron-lbaas/releases/download/v9.1.0/f5.tgz
+    $ curl –L –O |f5_lbaasv2_driver_shim_url|
 
 
 2. Install the service provider package on the Neutron controller.

diff --git a/docs/solution-test-plan.rst b/docs/solution-test-plan.rst
@@ -81,7 +81,7 @@ NA1: Global Routed Mode
 
 Edge deployment architecture using only OpenStack networking provider networks, with F5 OpenStack agents deployed in :ref:`Global Routed Mode <global-routed-mode>`.
 
-.. figure:: ../media/f5-lbaas-test-architecture-grm.png
+.. figure:: media/f5-lbaas-test-architecture-grm.png
     :align: center
     :alt: Global Routed Mode
 
@@ -90,7 +90,7 @@ NA2: L2 Adjacent Mode
 
 Micro-segmentation architecture using tenant networks, with F5 agents deployed in :ref:`L2 Adjacent Mode <L2 Segmentation Mode>`. Execute tests for VLAN and then VxLAN network types.
 
-.. figure:: ../media/f5-lbaas-test-architecture-l2adj.png
+.. figure:: media/f5-lbaas-test-architecture-l2adj.png
     :align: center
     :alt: L2 Adjacent Mode
 

diff --git a/requirements.docs.txt b/requirements.docs.txt
@@ -1,6 +1,6 @@
 Sphinx>=1.5.3
 six>=1.10.0
 git+https://github.com/f5devcentral/f5-sphinx-theme@master
-git+https://github.com/openstack/neutron.git@stable/mitaka
-git+https://github.com/openstack/neutron-lbaas.git@stable/mitaka
-pytest==2.9.1
+-e git+https://github.com/openstack/neutron#egg=neutron
+-e git+https://github.com/openstack/neutron-lbaas.git#egg=neutron_lbaas
+pytest