sovereign
=========
Mission statement
-----------------
This project implements a JSON control-plane based on the [envoy](https://envoyproxy.io) [data-plane-api](https://github.com/envoyproxy/data-plane-api)
The purpose of `sovereign` is to supply downstream envoy proxies with
configuration in near-realtime by responding to discovery requests.
Mechanism of Operation
----------------------
tl;dr version:
```
* Polls HTTP/File/Other for data
* (optional) Applies transforms to the data
* Uses the data to generate Envoy configuration from templates
```
In a nutshell, Sovereign
gathers contextual data (*"sources"* and *"template context"*),
optionally applies transforms to that data (using *"modifiers"*) and finally
uses the data to generate envoy configuration from either python code, or jinja2 templates.
This is performed in a semi-stateless way, where the only state is data cached in memory.
Template context is intended to be statically configured, whereas *Sources*
are meant to be dynamic - for example, fetching from an API, an S3 bucket,
or a file that receives updates.
*Modifiers* can mutate the data retrieved from sources, just in case the data
is in a less than favorable structure.
Both modifiers and sources are pluggable, i.e. it's easy to write your own and
plug them into Sovereign for your use-case.
Currently, Sovereign supports only providing configuration to Envoy as JSON.
That is to say, gRPC is not supported yet. Contributions in this area are highly
appreciated!
The JSON configuration can be viewed in real-time with Sovereign's read-only web interface.
Requirements
------------
* Python 3.8+
Installation
------------
```
pip install sovereign
```
Documentation
-------------
[Read the docs here!](https://vsyrakis.bitbucket.io/sovereign/docs/)
:new: Read-only user interface
------------------------
Added in `v0.5.3`!
This interface allows you to browse the resources currently returned by Sovereign.
Local development
=================
Requirements
------------
* Docker
* Docker-compose
Installing dependencies for dev
-------------------------------
I recommend creating a virtualenv before doing any dev work
```
python3 -m venv venv
source venv/bin/activate
pip install -r requirements-dev.txt
```
Running locally
---------------
Running the test env
```
make run
```
Running the test env daemonized
```
make run-daemon
```
Pylint
```
make lint
```
Unit tests
```
make unit
```
Acceptance tests
```
make run-daemon acceptance
```
Contributors
============
Pull requests, issues and comments welcome. For pull requests:
* Add tests for new features and bug fixes
* Follow the existing style
* Separate unrelated changes into multiple pull requests
See the existing issues for things to start contributing.
For bigger changes, make sure you start a discussion first by creating
an issue and explaining the intended change.
Atlassian requires contributors to sign a Contributor License Agreement,
known as a CLA. This serves as a record stating that the contributor is
entitled to contribute the code/documentation/translation to the project
and is willing to have it used in distributions and derivative works
(or is willing to transfer ownership).
Prior to accepting your contributions we ask that you please follow the appropriate
link below to digitally sign the CLA. The Corporate CLA is for those who are
contributing as a member of an organization and the individual CLA is for
those contributing as an individual.
* [CLA for corporate contributors](https://na2.docusign.net/Member/PowerFormSigning.aspx?PowerFormId=e1c17c66-ca4d-4aab-a953-2c231af4a20b)
* [CLA for individuals](https://na2.docusign.net/Member/PowerFormSigning.aspx?PowerFormId=3f94fbdc-2fbe-46ac-b14c-5d152700ae5d)
License
========
Copyright (c) 2018 Atlassian and others.
Apache 2.0 licensed, see [LICENSE.txt](LICENSE.txt) file.
Raw data
{
"_id": null,
"home_page": "https://pypi.org/project/sovereign/",
"name": "sovereign",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.11",
"maintainer_email": null,
"keywords": "envoy, envoyproxy, control-plane, management, server",
"author": "Vasili Syrakis",
"author_email": "vsyrakis@atlassian.com",
"download_url": "https://files.pythonhosted.org/packages/dd/d4/66a27904d1c1086b46240586f5f4fcbf6a4271df178523c73b3ee8f67020/sovereign-0.25.2.tar.gz",
"platform": null,
"description": "sovereign\n=========\n\nMission statement\n-----------------\nThis project implements a JSON control-plane based on the [envoy](https://envoyproxy.io) [data-plane-api](https://github.com/envoyproxy/data-plane-api)\n\nThe purpose of `sovereign` is to supply downstream envoy proxies with \nconfiguration in near-realtime by responding to discovery requests.\n\nMechanism of Operation\n----------------------\ntl;dr version:\n```\n* Polls HTTP/File/Other for data\n* (optional) Applies transforms to the data\n* Uses the data to generate Envoy configuration from templates\n```\n\nIn a nutshell, Sovereign \ngathers contextual data (*\"sources\"* and *\"template context\"*), \noptionally applies transforms to that data (using *\"modifiers\"*) and finally \nuses the data to generate envoy configuration from either python code, or jinja2 templates.\n\nThis is performed in a semi-stateless way, where the only state is data cached in memory.\n\nTemplate context is intended to be statically configured, whereas *Sources* \nare meant to be dynamic - for example, fetching from an API, an S3 bucket, \nor a file that receives updates.\n\n*Modifiers* can mutate the data retrieved from sources, just in case the data \nis in a less than favorable structure.\n\nBoth modifiers and sources are pluggable, i.e. it's easy to write your own and \nplug them into Sovereign for your use-case.\n\nCurrently, Sovereign supports only providing configuration to Envoy as JSON. \nThat is to say, gRPC is not supported yet. Contributions in this area are highly\nappreciated!\n\nThe JSON configuration can be viewed in real-time with Sovereign's read-only web interface.\n\nRequirements\n------------\n* Python 3.8+\n\nInstallation\n------------\n```\npip install sovereign\n```\n\nDocumentation\n-------------\n[Read the docs here!](https://vsyrakis.bitbucket.io/sovereign/docs/)\n\n:new: Read-only user interface\n------------------------\nAdded in `v0.5.3`!\n\nThis interface allows you to browse the resources currently returned by Sovereign.\n\n\n\nLocal development\n=================\n\nRequirements\n------------\n* Docker\n* Docker-compose\n\nInstalling dependencies for dev\n-------------------------------\nI recommend creating a virtualenv before doing any dev work\n\n```\npython3 -m venv venv\nsource venv/bin/activate\npip install -r requirements-dev.txt\n```\n\nRunning locally\n---------------\nRunning the test env\n\n```\nmake run\n```\n \nRunning the test env daemonized\n\n```\nmake run-daemon\n```\n\nPylint\n\n```\nmake lint\n```\n\nUnit tests\n\n```\nmake unit\n```\n\nAcceptance tests\n\n```\nmake run-daemon acceptance\n```\n\n\nContributors\n============\n\nPull requests, issues and comments welcome. For pull requests:\n\n* Add tests for new features and bug fixes\n* Follow the existing style\n* Separate unrelated changes into multiple pull requests\n\nSee the existing issues for things to start contributing.\n\nFor bigger changes, make sure you start a discussion first by creating\nan issue and explaining the intended change.\n\nAtlassian requires contributors to sign a Contributor License Agreement,\nknown as a CLA. This serves as a record stating that the contributor is\nentitled to contribute the code/documentation/translation to the project\nand is willing to have it used in distributions and derivative works\n(or is willing to transfer ownership).\n\nPrior to accepting your contributions we ask that you please follow the appropriate\nlink below to digitally sign the CLA. The Corporate CLA is for those who are\ncontributing as a member of an organization and the individual CLA is for\nthose contributing as an individual.\n\n* [CLA for corporate contributors](https://na2.docusign.net/Member/PowerFormSigning.aspx?PowerFormId=e1c17c66-ca4d-4aab-a953-2c231af4a20b)\n* [CLA for individuals](https://na2.docusign.net/Member/PowerFormSigning.aspx?PowerFormId=3f94fbdc-2fbe-46ac-b14c-5d152700ae5d)\n\n\nLicense\n========\n\nCopyright (c) 2018 Atlassian and others.\nApache 2.0 licensed, see [LICENSE.txt](LICENSE.txt) file.\n\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Envoy Proxy control-plane written in Python",
"version": "0.25.2",
"project_urls": {
"Documentation": "https://vsyrakis.bitbucket.io/sovereign/docs/",
"Homepage": "https://pypi.org/project/sovereign/",
"Repository": "https://bitbucket.org/atlassian/sovereign/src/master/"
},
"split_keywords": [
"envoy",
" envoyproxy",
" control-plane",
" management",
" server"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b542263a354ca58b85664a3a59d75c055a61a89a0378ba0519d572c1ab815a57",
"md5": "611724de049896796c06443c0ae29e1d",
"sha256": "3bbd03a0092f4b2c3fba6457a3138709d5788f5093509f10a77582be3223c2f3"
},
"downloads": -1,
"filename": "sovereign-0.25.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "611724de049896796c06443c0ae29e1d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.11",
"size": 111289,
"upload_time": "2024-03-27T05:29:27",
"upload_time_iso_8601": "2024-03-27T05:29:27.408936Z",
"url": "https://files.pythonhosted.org/packages/b5/42/263a354ca58b85664a3a59d75c055a61a89a0378ba0519d572c1ab815a57/sovereign-0.25.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ddd466a27904d1c1086b46240586f5f4fcbf6a4271df178523c73b3ee8f67020",
"md5": "2b894de17a425630a08efe270491a2a5",
"sha256": "f40c74ea85fa76d2f49bb829dff5ba61cb7c688bdf05f00a262fe6118d5286b2"
},
"downloads": -1,
"filename": "sovereign-0.25.2.tar.gz",
"has_sig": false,
"md5_digest": "2b894de17a425630a08efe270491a2a5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.11",
"size": 96652,
"upload_time": "2024-03-27T05:29:30",
"upload_time_iso_8601": "2024-03-27T05:29:30.343222Z",
"url": "https://files.pythonhosted.org/packages/dd/d4/66a27904d1c1086b46240586f5f4fcbf6a4271df178523c73b3ee8f67020/sovereign-0.25.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-27 05:29:30",
"github": false,
"gitlab": false,
"bitbucket": true,
"codeberg": false,
"bitbucket_user": "atlassian",
"bitbucket_project": "sovereign",
"lcname": "sovereign"
}
JSON