f5-openstack-lbaasv1

|Build status| |docs build status| |slack badge|

**End of Software Development for F5 OpenStack LBaaS version 1**

F5 announces the End of Software Development (EoSD) for the F5 OpenStack LBaaS version 1 integration, effective October 1, 2016. This announcement is in compliance with the OpenStack community deprecation of the OpenStack Neutron LBaaS version 1 plugin. Customers are encouraged to move to OpenStack LBaaS version 2.

F5 will continue to repair defects and perform maintenance on the F5 OpenStack LBaaS version 1 integration until the Openstack Ocata release in April 2017.

For additional information, please refer to the :ref:`F5 OpenStack Releases and Support Matrix`.

Introduction

This repo houses the code for the F5 OpenStack LBaaSv1 plugin. Please see the documentation <http://f5-openstack-lbaasv1.readthedocs.org/en/latest/>__ for more information.

Installation & Configuration

See the documentation <http://f5-openstack-lbaasv1.readthedocs.org/en/latest/>__.

Filing Issues

If you find an issue we would love to hear about it. Please let us know by filing an issue in this repository and tell us as much as you can about what you found and how you found it.

Contributing

See Contributing <CONTRIBUTING.md>_.

Build

Creating packages requires that docker engine being installed and running on the build machine. Instructions on how to accomplish this are located at https://docs.docker.com.

Debian Packages

Specify the docker_debs makefile target to build debian packages for the
Ubuntu 14.04 LTS (Trusty) release.

.. code-block:: shell

    $ make docker_debs

Packages are built in the following directory:

::

    ./build/deb_dist


RPM Packages
````````````
Specify the docker_el7_rpms makefile target to build RPM packages for the
CentOS/RedHat 7 release.

.. code-block:: shell

    $ make docker_el7_rpms

Packages are built in the following directory:

::

    ./build/el7


Specify the docker_el6_rpms makefile target to build RPM packages for the
CentOS/RedHat 6 release.

.. code-block:: shell

    $ make docker_el6_rpms

Packages are built in the following directory:

::

    ./build/el6


All Packages
````````````
Specify the package makefile target to build packages for all supported
releases.

.. code-block:: shell

    $ make package

PyPI
----
To make a PyPI package...

.. code-block:: shell

    python setup.py sdist

Test
----
Before you open a pull request, your code must have passing
`pytest <http://pytest.org>`__ unit tests. In addition, you should
include a set of functional tests written to use a real BIG-IP® device
for testing. Information on how to run our set of tests is included
below.

Unit Tests
``````````
We use pytest for our unit tests.

#. If you haven't already, install the required test packages and the
   requirements.txt in your virtual environment.

   .. code-block:: shell

       $ pip install hacking pytest pytest-cov
       $ pip install -r requirements.txt


#. Run the tests and produce a coverage repor. The ``--cov-report=html`` will
   create a ``htmlcov/`` directory that you can view in your browser
   to see the missing lines of code.

   .. code-block:: shell

       py.test --cov ./icontrol --cov-report=html
       open htmlcov/index.html

Style Checks
````````````
We use the hacking module for our style checks (installed as part of
step 1 in the Unit Test section).

    .. code-block:: shell

        $ flake8 ./

Support
-------
See `Support <SUPPORT.md>`_.

Copyright
---------
Copyright 2013-2016 F5 Networks, Inc.

License
-------

Apache V2.0
```````````
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
ou 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.

Contributor License Agreement

Individuals or business entities who contribute to this project must have completed and submitted the F5 Contributor License Agreement <http://f5-openstack-docs.readthedocs.org/en/latest/cla_landing.html>_ to [email protected] prior to their code submission being included in this project.

.. |Build status| image:: https://travis-ci.org/F5Networks/f5-openstack-lbaasv1.svg?branch=1.0 :target: https://travis-ci.org/F5Networks/f5-openstack-lbaasv1 :alt: Build Status

.. |docs build status| image:: http://readthedocs.org/projects/f5-openstack-lbaasv1/badge/?version=1.0 :target: http://f5-openstack-lbaasv1.readthedocs.org/en/1.0/?badge=1.0 :alt: Documentation Status

.. |slack badge| image:: https://f5-openstack-slack.herokuapp.com/badge.svg :target: https://f5-openstack-slack.herokuapp.com/ :alt: Slack