Merge pull request #905 from jputrino/master

Fixes #904 for master

Author: jputrino

.travis.yml

@@ -64,20 +64,21 @@ deploy:
       python: 2.7
     skip_cleanup: true
   # deploy docs to s3
-  # if this is not a tagged release, the docs will deploy to /products/openstack/lbaasv2-driver/$TRAVIS_BRANCH/
+  # docs on master only deploy to /products/openstack/lbaasv2-driver/master/
   - provider: script
     skip_cleanup: true
     on:
       branch: master
       repo: F5Networks/f5-openstack-lbaasv2-driver
       condition: $TRAVIS_TAG = ""
     script:
-    - ./docs/scripts/deploy-docs.sh publish-product-docs-to-prod openstack/lbaasv2-driver newton
-   # if this is a tagged release, the docs go to /products/openstack/lbaasv2-driver/$TRAVIS_BRANCH/vX.Y
-  - provider: script
-    skip_cleanup: true
-    on:
-      tags: true
-      repo: F5Networks/f5-openstack-lbaasv2-driver
-    script:
-    - ./docs/scripts/deploy-docs.sh publish-product-docs-to-prod openstack/lbaasv2-driver/$TRAVIS_BRANCH $RELEASE_TAG
+    - ./docs/scripts/deploy-docs.sh publish-product-docs-to-prod openstack/lbaasv2-driver master
+  # For tagged releases, the docs publish at /products/openstack/lbaasv2-driver/<branch-name>/vX.Y
+  # This section is commented out on the master branch because we don't need to publish tagged releases to /master
+  #- provider: script
+  #  skip_cleanup: true
+  #  on:
+  #    tags: true
+  #    repo: F5Networks/f5-openstack-lbaasv2-driver
+  #  script:
+  #  - ./docs/scripts/deploy-docs.sh publish-product-docs-to-prod openstack/lbaasv2-driver/master $RELEASE_TAG

Makefile

@@ -5,6 +5,7 @@
 help:
 	@echo "  docker-preview     to build live preview of docs using sphinx-autobuild in a docker container"
 	@echo "  docker-test        to build and test docs in a docker container"
+	@echo "  docker-html        one-time HTML build in a docker container"
 
 # Build live preview docs in a docker container
 .PHONY: docker-preview
@@ -17,4 +18,11 @@ docker-preview:
 .PHONY: docker-test
 docker-test:
 	make -C docs clean
-	./docs/scripts/docker-docs.sh ./docs/scripts/test-docs.sh
+	./docs/scripts/docker-docs.sh ./docs/scripts/test-docs.sh
+
+
+# build HTML docs in a docker container
+.PHONY: docker-html
+docker-html:
+	make -C docs clean
+	./docs/scripts/docker-docs.sh make -C docs/ html

docs/README.rst

@@ -16,12 +16,13 @@ F5 Driver for OpenStack LBaaSv2
    :titlesonly:
    :hidden:
 
+   RELEASE-NOTES
    environment-generator
 
-version |release|
+version |version|
 -----------------
 
-|release-notes|
+:ref:`Release Notes`
 
 The |driver-long| is a Neutron LBaaSv2 service provider driver (``f5lbaasdriver``) that runs within the `OpenStack Neutron`_ controller.
 The |driver-short| is an alternative to the default Neutron LBaaS service provider driver.

docs/RELEASE-NOTES.rst

@@ -0,0 +1,23 @@
+.. index:: Release Notes
+
+.. _Release Notes:
+
+Release Notes
+=============
+
+v10.2.0 (Newton)
+----------------
+
+Added Functionality
+```````````````````
+* Enhanced F5 Agent resiliency.
+  - F5 Agents manage BIG-IPs dynamically, resulting in improved tolerance for BIG-IP device failures.
+  - F5 Agents will continue to run during BIG-IP device downtime and discover when BIG-IP devices come back online.
+
+Bug Fixes
+`````````
+* See the `changelog <https://github.com/F5Networks/f5-openstack-lbaasv2-driver/compare/v10.1.0...v10.2.0>`_ for the full list of changes in this release.
+
+Limitations
+```````````
+* None noted.

docs/conf.py

@@ -66,31 +66,23 @@
 
 # General information about the project.
 project = u'F5 Driver for OpenStack LBaaSv2'
-copyright = u'2017 F5 Networks Inc.'
+copyright = u'2018 F5 Networks Inc.'
 author = u'F5 Networks'
 
 # 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 = VERSION
+
 # The full version, including alpha/beta/rc tags.
+version = VERSION
 release = VERSION
 
 # OpenStack release
 openstack_release = "Newton"
 
-rst_prolog = '''
-.. raw:: html
-
-   <script type="text/javascript">
-    var home = "clouddocs.f5.com";
-    var rtd = "f5-openstack-lbaasv2-driver.readthedocs.io";
-
-    if (window.location.hostname === rtd) {window.location.assign("http://" + home + "/products/openstack/lbaasv2-driver/newton");}
-   </script>
-'''
+#rst_prolog = '''
+#'''
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -367,9 +359,6 @@
 .. |rpm-download| raw:: html
     
     <a class="btn btn-info" href="https://github.com/F5Networks/f5-openstack-lbaasv2-driver/releases/download/v%(version)s/f5-openstack-lbaasv2-driver-%(version)s-1.el7.noarch.rpm">RPM package</a>
-.. |release-notes| raw:: html
-
-    <a class="btn btn-success" href="%(base_url)s/products/openstack/lbaasv2-driver/v%(version)s/">Release Notes</a>
 .. |agent-long| replace:: F5 Agent for OpenStack Neutron
 .. |agent| replace:: :code:`f5-openstack-agent`
 .. |driver| replace:: :code:`f5-openstack-lbaasv2-driver`
@@ -379,23 +368,23 @@
     <a target="_blank" href="%(base_url)s/products/openstack/agent/%(openstack_release)s">F5 Agent for OpenStack Neutron</a>
 .. |driver-short| replace:: F5 driver
 .. _OpenStack Neutron: https://docs.openstack.org/neutron/%(openstack_release_l)s/
-.. _F5 Agent for OpenStack Neutron: %(base_url)s/products/openstack/%(version)s/agent/
+.. _F5 Agent for OpenStack Neutron: %(base_url)s/products/openstack/agent/%(openstack_release_l)s
 .. _user documentation: %(base_url)s/cloud/openstack/latest/lbaas
 .. _Neutron LBaaS API: https://wiki.openstack.org/wiki/Neutron/LBaaS/API_2.0
-.. _available F5 agent: %(base_url)s/products/openstack/%(version)s/agent/
+.. _available F5 agent: %(base_url)s/products/openstack/agent/%(openstack_release_l)s
 .. _F5 Service Provider Package: %(base_url)s/cloud/openstack/latest/lbaas-prep
 .. _Download the latest debian package: |f5_lbaasv2_driver_deb_url|
 .. _Download the latest rpm package: |f5_lbaasv2_driver_rpm_url|
 .. _Partners: %(base_url)s/cloud/openstack/latest/support/partners.html
-.. _Configure and start the F5 Agent: %(base_url)s/products/openstack/%(version)s/agent/index.html#configure-the-agent-long
-.. _Capacity-based Scale out: %(base_url)s/cloud/openstack/v1/lbaas/lbaas-differentiated-service-environments.html
-.. _Differentiated Service Environments: %(base_url)s/cloud/openstack/v1/lbaas/lbaas-capacity-based-scaleout.html
+.. _Configure and start the F5 Agent: %(base_url)s/products/openstack/agent/%(openstack_release_l)s/#configure-the-f5-agent
+.. _Capacity-based Scale out: %(base_url)s/cloud/openstack/v1/lbaas/capacity-based-scaleout.html
+.. _Differentiated Service Environments: %(base_url)s/cloud/openstack/v1/lbaas/differentiated-service-environments.html
 ''' % {
   'openstack_release': openstack_release,
   'openstack_release_l': openstack_release.lower(),
   'f5_lbaasv2_driver_shim_url': f5_lbaasv2_driver_shim_url,
   'version': version,
-   'base_url': 'http://clouddocs.f5.com'
+  'base_url': 'http://clouddocs.f5.com'
 }
 
 # Links to external sites (i.e., outside of clouddocs)

docs/scripts/test-docs.sh

@@ -9,8 +9,7 @@ echo "Building docs with Sphinx"
 make -C docs html
 
 echo "Checking grammar and style"
-write-good `find ./docs -not \( -path ./docs/drafts -prune \) -name '*.rst'` --passive --so --no-illusion --thereIs --cliches || true
+write-good `find ./docs -not \( -path ./docs/drafts -prune \) -name '*.rst'` --passive --so --no-illusion --thereIs --cliches
 
 echo "Checking links"
-make -C docs linkcheck | grep "broken" || true
-
+make -C docs linkcheck

f5lbaasdriver/__init__.py

@@ -1 +1 @@
-__version__ = "10.1.0"
+__version__ = "10.2.0"