Envoy Proxy control-plane written in Python
The purpose of
sovereign is to supply downstream envoy proxies with
configuration in near-realtime by responding to discovery requests.
- Accepts data from source(s) e.g. file, http, custom
- (optional) Applies modifications to the received data
- Renders the data into a Jinja2 template (or returns a static response)
- Serializes the rendered configuration as JSON and returns it to the Envoy proxy
The idea behind this architecture is to enable high-extensibility.
Users can add their own entry point to the package (todo: documentation) which the control-plane will automatically use to retrieve data to be turned into configuration on the fly.
- Python 3.7+
pip install sovereign
:new: Read-only user interface
This interface allows you to browse the resources currently returned by Sovereign.
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 the test env
Running the test env daemonized
make run-daemon acceptance
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.
Copyright (c) 2018 Atlassian and others. Apache 2.0 licensed, see LICENSE.txt file.
Release history Release notifications
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size sovereign-0.5.12-py3.7.egg (75.0 kB)||File type Egg||Python version 3.7||Upload date||Hashes View hashes|
|Filename, size sovereign-0.5.12.tar.gz (25.8 kB)||File type Source||Python version None||Upload date||Hashes View hashes|