sovereign

Release 0.9.4

Envoy Proxy control-plane written in Python

Repository PyPI Python

Keywords
envoy, envoyproxy, control-plane, management, server
License
Apache-2.0
Install
pip install sovereign==0.9.4

Documentation

sovereign

Mission statement

This project implements a JSON control-plane based on the envoy data-plane-api

The purpose of sovereign is to supply downstream envoy proxies with configuration in near-realtime by responding to discovery requests.

Features

  1. Accepts data from source(s) e.g. file, http, custom
  2. (optional) Applies modifications to the received data
  3. Renders the data into a Jinja2 template (or returns a static response)
  4. 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.

Requirements

  • Python 3.7+

Installation

pip install sovereign

Documentation

Read the docs here!

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.

License

Copyright (c) 2018 Atlassian and others. Apache 2.0 licensed, see LICENSE.txt file.

Stats

Dependencies
15
Dependent packages
0
Dependent repositories
0
Total releases
185
Latest release
First release
Forks
4
Contributors
0
Repository size
12.8 MB
SourceRank
6

Development practices

Source repo 2FA enabled
TEXT!
Package manager 2FA enabled
TEXT!
Is security responsive
TEXT!
Dependencies are managed
TEXT!
Issue-free release available
TEXT!
Succession plan available
TEXT!
Package manager 2FA enabled
TEXT!

The Tidelift Subscription provides access to a continuously curated stream of human-researched and maintainer-verified data on open source packages and their licenses, releases, vulnerabilities, and development practices.

Learn more →

Releases

0.15.0
0.16.1
0.14.3
0.14.1
0.13.0
0.16.0
0.14.2
0.14.0
0.17.1
0.17.0
See all 185 releases

Something wrong with this page? Make a suggestion

Export .ABOUT file for this package

Last synced: 2024-04-02 21:14:06 UTC

Login to resync this project