exabgp-process


Nameexabgp-process JSON
Version 1.0.3 PyPI version JSON
download
home_pageNone
SummaryProcess for ExaBGP, started by ExaBGP service
upload_time2024-11-06 17:53:45
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseMIT License Copyright (c) 2018 Jiri Vrany, Petr Adamec, Josef Verich, CESNET Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords exabgp networking bgp process
VCS
bugtrack_url
requirements pika flask
Travis-CI No Travis.
coveralls test coverage No coveralls.
            
# ExaBGP Process Package

This application is a simple API that interfaces with the [ExaBGP service](https://github.com/Exa-Networks/exabgp/tree/main).

Each time this app receives a new command, it forwards the command to ExaBGP via stdout. The registered ExaBGP service monitors the stdout of this API application.

### Installation
You can install the package using pip:
```
pip install exabgp_process
```

### Configuration
Generate the configuration file and copy it to `/etc/exabgp/process.conf`. Be sure to set up the log directory and file in the config, and ensure the directory exists and is writable by the ExaBGP process:
```
exabgp-process --generate-config >> process.conf
mv process.conf /etc/exabgp/process.conf
```

### Add to ExaBGP Configuration
Include the following in your ExaBGP configuration:
```
process flowspec {
    run /usr/local/exabgp-process;
    encoder json;
}
```

The preferred setup uses RabbitMQ for message passing.

### Development and Testing
For development and testing, there is also an HTTP version available. However, please note that this web app lacks any security layer. Therefore, it's recommended to restrict access to localhost only.

For more information, refer to the [ExaBGP documentation](https://github.com/Exa-Networks/exabgp/wiki/Controlling-ExaBGP-:-possible-options-for-process).


### Changelog

1.0.3 - new format of message from server - json with keys: author, source, command. Author and source are for logging purposes, command is send to the process.
1.0.2 - switch to pyproject.toml for better description

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "exabgp-process",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "exabgp, networking, BGP, process",
    "author": null,
    "author_email": "Jiri Vrany <jiri.vrany@cesnet.cz>",
    "download_url": "https://files.pythonhosted.org/packages/79/0a/aced6678d76755a01c530781768795f22924cbfebfbc4e11d36e035af2c4/exabgp_process-1.0.3.tar.gz",
    "platform": null,
    "description": "\n# ExaBGP Process Package\n\nThis application is a simple API that interfaces with the [ExaBGP service](https://github.com/Exa-Networks/exabgp/tree/main).\n\nEach time this app receives a new command, it forwards the command to ExaBGP via stdout. The registered ExaBGP service monitors the stdout of this API application.\n\n### Installation\nYou can install the package using pip:\n```\npip install exabgp_process\n```\n\n### Configuration\nGenerate the configuration file and copy it to `/etc/exabgp/process.conf`. Be sure to set up the log directory and file in the config, and ensure the directory exists and is writable by the ExaBGP process:\n```\nexabgp-process --generate-config >> process.conf\nmv process.conf /etc/exabgp/process.conf\n```\n\n### Add to ExaBGP Configuration\nInclude the following in your ExaBGP configuration:\n```\nprocess flowspec {\n    run /usr/local/exabgp-process;\n    encoder json;\n}\n```\n\nThe preferred setup uses RabbitMQ for message passing.\n\n### Development and Testing\nFor development and testing, there is also an HTTP version available. However, please note that this web app lacks any security layer. Therefore, it's recommended to restrict access to localhost only.\n\nFor more information, refer to the [ExaBGP documentation](https://github.com/Exa-Networks/exabgp/wiki/Controlling-ExaBGP-:-possible-options-for-process).\n\n\n### Changelog\n\n1.0.3 - new format of message from server - json with keys: author, source, command. Author and source are for logging purposes, command is send to the process.\n1.0.2 - switch to pyproject.toml for better description\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2018 Jiri Vrany, Petr Adamec, Josef Verich, CESNET  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
    "summary": "Process for ExaBGP, started by ExaBGP service",
    "version": "1.0.3",
    "project_urls": {
        "Homepage": "https://github.com/CESNET/exabgp-process"
    },
    "split_keywords": [
        "exabgp",
        " networking",
        " bgp",
        " process"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8e6573cd0e653b280d309a2d44d738fd16da79ef4b0784c7ff6642abc429f73a",
                "md5": "49535e8831115b8e0912eaed09726df3",
                "sha256": "892297d5d664ead3440bf94334c4ddbfda2e142db792c1ba51bda3ef44a58739"
            },
            "downloads": -1,
            "filename": "exabgp_process-1.0.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "49535e8831115b8e0912eaed09726df3",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 6323,
            "upload_time": "2024-11-06T17:53:43",
            "upload_time_iso_8601": "2024-11-06T17:53:43.578322Z",
            "url": "https://files.pythonhosted.org/packages/8e/65/73cd0e653b280d309a2d44d738fd16da79ef4b0784c7ff6642abc429f73a/exabgp_process-1.0.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "790aaced6678d76755a01c530781768795f22924cbfebfbc4e11d36e035af2c4",
                "md5": "5ab1dfe7b9305e677c9c80510967e694",
                "sha256": "f3295bc2ced82c883424ad71e12f6af113cb26f46ecac649beb05bde8a58f9be"
            },
            "downloads": -1,
            "filename": "exabgp_process-1.0.3.tar.gz",
            "has_sig": false,
            "md5_digest": "5ab1dfe7b9305e677c9c80510967e694",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 4845,
            "upload_time": "2024-11-06T17:53:45",
            "upload_time_iso_8601": "2024-11-06T17:53:45.529346Z",
            "url": "https://files.pythonhosted.org/packages/79/0a/aced6678d76755a01c530781768795f22924cbfebfbc4e11d36e035af2c4/exabgp_process-1.0.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-06 17:53:45",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "CESNET",
    "github_project": "exabgp-process",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [
        {
            "name": "pika",
            "specs": [
                [
                    ">=",
                    "1.3.0"
                ]
            ]
        },
        {
            "name": "flask",
            "specs": [
                [
                    ">=",
                    "2.0.1"
                ]
            ]
        }
    ],
    "lcname": "exabgp-process"
}
        
Elapsed time: 4.01719s