{"id":18798794,"url":"https://github.com/f5networks/f5-openstack-agent","last_synced_at":"2025-10-19T16:03:50.300Z","repository":{"id":3550573,"uuid":"44189799","full_name":"F5Networks/f5-openstack-agent","owner":"F5Networks","description":"The F5 Agent for OpenStack Neutron allows you to deploy BIG-IP services in an OpenStack environment.","archived":false,"fork":false,"pushed_at":"2025-04-03T15:24:30.000Z","size":5461,"stargazers_count":14,"open_issues_count":90,"forks_count":38,"subscribers_count":22,"default_branch":"master","last_synced_at":"2025-04-03T16:25:54.968Z","etag":null,"topics":["bigip","openstack"],"latest_commit_sha":null,"homepage":"http://clouddocs.f5.com/products/openstack/agent/latest","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/F5Networks.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"license.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":"SUPPORT.md","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-10-13T16:28:50.000Z","updated_at":"2022-08-09T06:15:26.000Z","dependencies_parsed_at":"2023-09-22T21:55:43.562Z","dependency_job_id":"1be01751-8ec9-4f25-aacc-efc7222179a5","html_url":"https://github.com/F5Networks/f5-openstack-agent","commit_stats":null,"previous_names":[],"tags_count":134,"template":false,"template_full_name":null,"purl":"pkg:github/F5Networks/f5-openstack-agent","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/F5Networks%2Ff5-openstack-agent","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/F5Networks%2Ff5-openstack-agent/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/F5Networks%2Ff5-openstack-agent/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/F5Networks%2Ff5-openstack-agent/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/F5Networks","download_url":"https://codeload.github.com/F5Networks/f5-openstack-agent/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/F5Networks%2Ff5-openstack-agent/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263013714,"owners_count":23399813,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bigip","openstack"],"created_at":"2024-11-07T22:13:00.745Z","updated_at":"2025-10-19T16:03:45.268Z","avatar_url":"https://github.com/F5Networks.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":".. raw:: html\n\n   \u003c!--\n   Copyright (c) 2015-2018, F5 Networks, Inc.\n\n   Licensed under the Apache License, Version 2.0 (the \"License\");\n   you may not use this file except in compliance with the License.\n   You may obtain a copy of the License at\n\n      http://www.apache.org/licenses/LICENSE-2.0\n\n   Unless required by applicable law or agreed to in writing, software\n   distributed under the License is distributed on an \"AS IS\" BASIS,\n   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n   See the License for the specific language governing permissions and\n   limitations under the License.\n   --\u003e\n\nF5 Agent for OpenStack Neutron\n==============================\n\n|Build Status| |slack badge| |coveralls badge|\n\n.. image:: https://coveralls.io/repos/github/F5Networks/f5-openstack-agent/badge.svg?branch=newton\n:target: https://coveralls.io/github/F5Networks/f5-openstack-agent?branch=newton\n         \nIntroduction\n------------\n\nThe F5 Agent for OpenStack Neutron is an OpenStack `Neutron plugin agent \u003chttps://docs.openstack.org/admin-guide/networking-arch.html#overview\u003e`_. It works in conjunction with the `F5 driver for OpenStack LBaaSv2 \u003chttp://clouddocs.f5.com/products/openstack/lbaasv2-driver/latest/index.html\u003e`_ to manage F5 BIG-IP `Local Traffic Manager \u003chttps://f5.com/products/big-ip/local-traffic-manager-ltm\u003e`_ (LTM) services via the OpenStack Neutron API.\n\nDocumentation\n-------------\n\nDocumentation is published on `clouddocs.f5.com \u003chttp://clouddocs.f5.com/products/openstack/agent/latest\u003e`_.\n\nCompatibility\n-------------\n\nThe F5 Agent for OpenStack Neutron is compatible with OpenStack releases from Liberty forward.\n\nSee the `F5 OpenStack Releases and Support Matrix \u003chttp://clouddocs.f5.com/cloud/openstack/latest/support/releases_and_versioning.html\u003e`_ for more information.\n\nInstalling the F5 Agent\n-----------------------\n\nPlease see the `product documentation \u003chttp://clouddocs.f5.com/products/openstack/agent/latest/#installation\u003e`_.\n\n\nUsing the Built-in Debugger\n---------------------------\n\nUse the built-in debugger -- ``debug_bundler.py`` -- to package information about your environment for debugging purposes.\n\nWhen the you install ``f5-openstack-agent``, the ``debug_bundler.py`` script installs itself in ``/usr/bin/f5/``.\nWhen you run the debugger, it searches for log and config files and dumps a complete listing of the ``pip lists`` output.\nThe debugger bundles everything it finds into a tarfile that you can provide to F5's support representatives to assist them in identifying the cause of your issue.\n\n-------------\n\n**WARNING**\n\nThe files added to the debug bundle may contain **VERY SENSITIVE INFORMATION** such as **encryption keys**, **passwords**, and **usernames**.\nDo not upload this bundle, or any information within, to a public forum unless you have thoroughly scrubbed sensitive information.\nWhen in doubt, don't upload it at all.\n\n-------------\n\n\nBasic usage with the default command-line arguments\n```````````````````````````````````````````````````\n\nThe command below creates a .tar file in the specified directory (in this example, `/home/myuser/debug_bundle_output/`) containing all logs and configuration files the script found.\nThe script offers a best-effort search of the specified directories.\nIf it cannot find the log files it is looking for in those directories, it prints an error message and continues to run.\n\n\n::\n\n  $ python /usr/bin/f5/debug_bundler.py /home/myuser/debug_bundle_output/\n\n\n\nOverride log/config file locations\n``````````````````````````````````\n\nThe default log location is `/var/log/neutron`.\nThe default configuration file location is `/etc/neutron`.\n\nTo override the log and/or config file locations, use the command-line arguments shown below: ::\n\n  $ python /usr/bin/f5/debug_bundler.py --log-dir=/var/log/mylogs --config-dir /etc/myconfigs/ ~/\n\n\nIssues\n``````\n\nIf you find any issues with the debug_bundler, please `file an issue \u003c#filing-issues\u003e`_.\n\n\nFor Developers\n--------------\n\nFiling Issues\n`````````````\n\nIf you find an issue, we would love to hear about it.\nPlease file an `issue \u003chttps://github.com/F5Networks/f5-openstack-agent/issues\u003e`_ in this repository.\nUse the issue template to tell us as much as you can about what you found, how you found it, your environment, etc.\nAdmins will triage your issue and assign it for a fix based on the priority level assigned.\nWe also welcome you to file issues for feature requests.\n\nContributing\n````````````\n\nSee `Contributing \u003cCONTRIBUTING.md\u003e`_.\n\nTesting\n```````\n\nBefore you open a pull request, your code must have passing `pytest \u003chttp://pytest.org\u003e`__ unit tests.\nIn addition, you should include a set of functional tests written to use an actual BIG-IP device for testing.\nInformation on how to run our test set is included below.\n\nStyle Checks\n~~~~~~~~~~~~\n\nWe use the ``hacking`` module for our style checks.\n\n::\n\n  $ pip install tox\n  $ tox -e style\n\nUnit Tests\n~~~~~~~~~~\n\nWe use ``tox`` to run our ``pytest`` unit tests.\n\nTo run the unit tests, use the ``tox`` ``unit`` environment.\n\n::\n\n  $ pip install tox\n  $ tox -e unit\n\nFunctional Tests\n~~~~~~~~~~~~~~~~\n\nYou can run functional tests without a full OpenStack deployment.\nThey do require access to a BIG-IP device or BIG-IP Virtual Edition (VE) instance.\n\n#. Copy and edit the `symbols.json.example \u003ctest/functional/symbols.json.example\u003e`_ with the correct values for your BIG-IP device.\n\n#. Run ``tox -e functest`` with the ``--symbols`` flag pointing to your updates symbols.json file.\n\n   For example, the command below calls the symbols file and runs the ``neutronless/disconnected_service`` functional test cases.\n   The ``tox`` target changes to the ``[test/functional](test/functional)`` directory before the tests run.\n\n::\n\n  $ tox -e functest -- \\\n    --symbols ~/path/to/symbols/symbols.json \\\n    neutronless/disconnected_service\n\n\n\nCopyright\n---------\n\nCopyright (c) 2015-2018, F5 Networks, Inc.\n\nSupport\n-------\n\nSee `Support \u003cSUPPORT.md\u003e`_.\n\nLicense\n-------\n\nApache V2.0\n```````````\n\nLicensed under the Apache License, Version 2.0 (the \"License\"); you may\nnot use this file except in compliance with the License. You may obtain\na copy of the License at\n\nhttp://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n\nContributor License Agreement\n-----------------------------\n\nIndividuals or business entities who contribute to this project must complete and submit the `F5 Contributor License Agreement \u003chttp://clouddocs.f5.com/cloud/openstack/v1/support/cla_landing.html\u003e`_ to Openstack\\_CLA@f5.com **before** their code submission can be added to this project.\n\n\n.. |Build Status| image:: https://travis-ci.org/F5Networks/f5-openstack-agent.svg?branch=newton\n   :target: https://travis-ci.org/F5Networks/f5-openstack-agent?branch=newton\n\n.. |slack badge| image:: https://f5-openstack-slack.herokuapp.com/badge.svg\n    :target: https://f5-openstack-slack.herokuapp.com/\n    :alt: Slack\n\n.. |coveralls badge| image:: https://coveralls.io/repos/github/F5Networks/f5-openstack-agent/badge.svg?branch=newton\n    :target: https://coveralls.io/github/F5Networks/f5-openstack-agent?branch=newton\n    :alt: Coveralls\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ff5networks%2Ff5-openstack-agent","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ff5networks%2Ff5-openstack-agent","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ff5networks%2Ff5-openstack-agent/lists"}