sovereign 0.17.1__tar.gz → 1.0.0a3__tar.gz

{sovereign-0.17.1 → sovereign-1.0.0a3}/PKG-INFO

@@ -1,13 +1,13 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: sovereign
-Version: 0.17.1
+Version: 1.0.0a3
 Summary: Envoy Proxy control-plane written in Python
-Home-page: https://pypi.org/project/sovereign/
-License: Apache-2.0
-Keywords: envoy,envoyproxy,control-plane,management,server
-Author: Vasili Syrakis
-Author-email: vsyrakis@atlassian.com
-Requires-Python: >=3.8,<4.0
+Project-URL: Homepage, https://pypi.org/project/sovereign/
+Project-URL: Repository, https://bitbucket.org/atlassian/sovereign/src/master/
+Project-URL: Documentation, https://developer.atlassian.com/platform/sovereign/
+Author-email: Vasili Syrakis <vsyrakis@atlassian.com>
+License-Expression: Apache-2.0
+Keywords: control-plane,envoy,envoyproxy,management,server
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: No Input/Output (Daemon)
 Classifier: Intended Audience :: Developers
@@ -16,88 +16,103 @@ Classifier: Intended Audience :: System Administrators
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Natural Language :: English
 Classifier: Operating System :: POSIX :: Linux
-Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Topic :: Internet :: Proxy Servers
+Requires-Python: <4.0,>=3.11.0
+Requires-Dist: aiofiles<24,>=23.2.1
+Requires-Dist: cachelib<0.11,>=0.10.2
+Requires-Dist: cachetools<6,>=5.3.2
+Requires-Dist: croniter<2,>=1.4.1
+Requires-Dist: cryptography>=45.0.2
+Requires-Dist: fastapi<0.129,>=0.128.0
+Requires-Dist: glom<24,>=23.3.0
+Requires-Dist: h11<0.17,>=0.16.0
+Requires-Dist: jinja2<4,>=3.1.2
+Requires-Dist: jmespath<2,>=1.0.1
+Requires-Dist: pydantic-settings<2.6.0
+Requires-Dist: pydantic<3,>=2.7.2
+Requires-Dist: pyyaml<7,>=6.0.1
+Requires-Dist: requests<3,>=2.32.4
+Requires-Dist: rich>=14.2.0
+Requires-Dist: starlette-context<0.4,>=0.3.6
+Requires-Dist: starlette<0.50,>=0.49.1
+Requires-Dist: structlog<24,>=23.1.0
+Requires-Dist: supervisor<5,>=4.2.5
+Requires-Dist: uvicorn<0.24,>=0.23.2
+Requires-Dist: uvloop<1.0,>0.19.0
 Provides-Extra: boto
+Requires-Dist: boto3<2,>=1.28.62; extra == 'boto'
 Provides-Extra: caching
+Provides-Extra: httptools
+Requires-Dist: httptools<0.7,>=0.6.0; extra == 'httptools'
 Provides-Extra: orjson
+Requires-Dist: orjson<4,>=3.9.15; extra == 'orjson'
 Provides-Extra: sentry
+Requires-Dist: sentry-sdk<3,>=2.14.0; extra == 'sentry'
 Provides-Extra: statsd
+Requires-Dist: datadog>=0.50.1; extra == 'statsd'
 Provides-Extra: ujson
-Requires-Dist: Jinja2 (>=3.1.2,<4.0.0)
-Requires-Dist: PyYAML (>=5.4,<6.0)
-Requires-Dist: aiofiles (>=22.1.0,<23.0.0)
-Requires-Dist: boto3 (>=1.17.0,<2.0.0); extra == "boto"
-Requires-Dist: cachelib (>=0.1.1,<0.2.0)
-Requires-Dist: cashews[redis] (>=5.0.0,<6.0.0); extra == "caching"
-Requires-Dist: croniter (>=1.3.5,<2.0.0)
-Requires-Dist: cryptography (>=38.0.3,<39.0.0)
-Requires-Dist: datadog (>=0.39.0,<0.40.0); extra == "statsd"
-Requires-Dist: fastapi (>=0.88.0,<0.89.0)
-Requires-Dist: glom (>=20.11.0,<21.0.0)
-Requires-Dist: gunicorn (>=20.1.0,<21.0.0)
-Requires-Dist: orjson (>=3.4.7,<4.0.0); extra == "orjson"
-Requires-Dist: requests (>=2.28.1,<3.0.0)
-Requires-Dist: sentry-sdk (>=0.19.5,<0.20.0); extra == "sentry"
-Requires-Dist: structlog (==21.5.0)
-Requires-Dist: ujson (>=5.4.0,<6.0.0); extra == "ujson"
-Requires-Dist: uvicorn (>=0.20.0,<0.21.0)
-Requires-Dist: uvloop (>=0.17.0,<0.18.0)
-Project-URL: Documentation, https://vsyrakis.bitbucket.io/sovereign/docs/
-Project-URL: Repository, https://bitbucket.org/atlassian/sovereign/src/master/
+Requires-Dist: ujson<6,>=5.8.0; extra == 'ujson'
 Description-Content-Type: text/markdown
 
 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.
+The purpose of `sovereign` is to supply downstream envoy proxies with dynamic configuration.
+
 
 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
-```
+Sovereign allows you to define templates that represent each resource type
+provided by Envoy. For example, clusters, routes, listeners, secrets,
+extension_configs, etc.
 
-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.
+In order to enrich the templates with data, Sovereign has ways of polling data
+out-of-band which it then includes as variables that can be accessed within the
+templates.
 
-This is performed in a semi-stateless way, where the only state is data cached in memory.
+This allows Sovereign to provide configuration to Envoy that changes over time
+depending on the data sources, without needing to redeploy the control-plane.
 
-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.
+Sovereign provides some built-in ways of polling data (such as over HTTP, or
+on-disk) but also exposes extension points, allowing you to write your own
+plugins in Python.
 
-*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.
+Support
+------------
+[Submit new issues here](https://bitbucket.org/atlassian/sovereign/issues/new)
+
+If you're unable to submit an issue on Bitbucket, send an email to [vsyrakis@atlassian.com](mailto:vsyrakis@atlassian.com)
 
-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.
+Release
+------------
+See [RELEASE.md]
+
+
+Roadmap
+------------
+* Performance improvements
+* Data persistence
+* Push API (versus polling)
+* Client for Sovereign
+* gRPC
+
 
 Requirements
 ------------
 * Python 3.8+
 
+
 Installation
 ------------
 ```
@@ -106,62 +121,53 @@ pip install sovereign
 
 Documentation
 -------------
-[Read the docs here!](https://vsyrakis.bitbucket.io/sovereign/docs/)
-
-:new: Read-only user interface
-------------------------
-Added in `v0.5.3`!
+[Read the docs here!](https://developer.atlassian.com/platform/sovereign/)
 
-This interface allows you to browse the resources currently returned by Sovereign.
 
-![Sovereign User Interface Screenshot](https://bitbucket.org/atlassian/sovereign/src/master/assets/sovereign_ui.png)
 
 Local development
 =================
 
+
 Requirements
 ------------
+* uv
 * Docker
 * Docker-compose
 
+
 Installing dependencies for dev
 -------------------------------
-I recommend creating a virtualenv before doing any dev work
-
+Dependencies and creation of virtualenv is handled by uv
 ```
-python3 -m venv venv
-source venv/bin/activate
-pip install -r requirements-dev.txt
+uv sync
+uv venv activate
+uv run <command>
 ```
 
 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
 ```
@@ -169,7 +175,6 @@ make run-daemon acceptance
 
 Contributors
 ============
-
 Pull requests, issues and comments welcome. For pull requests:
 
 * Add tests for new features and bug fixes
@@ -198,9 +203,7 @@ those contributing as an individual.
 
 License
 ========
-
 Copyright (c) 2018 Atlassian and others.
 Apache 2.0 licensed, see [LICENSE.txt](LICENSE.txt) file.
 
 
-

{sovereign-0.17.1 → sovereign-1.0.0a3}/README.md

@@ -1,49 +1,58 @@
 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.
+The purpose of `sovereign` is to supply downstream envoy proxies with dynamic configuration.
+
 
 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
-```
+Sovereign allows you to define templates that represent each resource type
+provided by Envoy. For example, clusters, routes, listeners, secrets,
+extension_configs, etc.
+
+In order to enrich the templates with data, Sovereign has ways of polling data
+out-of-band which it then includes as variables that can be accessed within the
+templates.
+
+This allows Sovereign to provide configuration to Envoy that changes over time
+depending on the data sources, without needing to redeploy the control-plane.
 
-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.
+Sovereign provides some built-in ways of polling data (such as over HTTP, or
+on-disk) but also exposes extension points, allowing you to write your own
+plugins in Python.
 
-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.
+Support
+------------
+[Submit new issues here](https://bitbucket.org/atlassian/sovereign/issues/new)
+
+If you're unable to submit an issue on Bitbucket, send an email to [vsyrakis@atlassian.com](mailto:vsyrakis@atlassian.com)
+
 
-*Modifiers* can mutate the data retrieved from sources, just in case the data 
-is in a less than favorable structure.
+Release
+------------
+See [RELEASE.md]
 
-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!
+Roadmap
+------------
+* Performance improvements
+* Data persistence
+* Push API (versus polling)
+* Client for Sovereign
+* gRPC
 
-The JSON configuration can be viewed in real-time with Sovereign's read-only web interface.
 
 Requirements
 ------------
 * Python 3.8+
 
+
 Installation
 ------------
 ```
@@ -52,62 +61,53 @@ pip install sovereign
 
 Documentation
 -------------
-[Read the docs here!](https://vsyrakis.bitbucket.io/sovereign/docs/)
+[Read the docs here!](https://developer.atlassian.com/platform/sovereign/)
 
-:new: Read-only user interface
-------------------------
-Added in `v0.5.3`!
 
-This interface allows you to browse the resources currently returned by Sovereign.
-
-![Sovereign User Interface Screenshot](https://bitbucket.org/atlassian/sovereign/src/master/assets/sovereign_ui.png)
 
 Local development
 =================
 
+
 Requirements
 ------------
+* uv
 * Docker
 * Docker-compose
 
+
 Installing dependencies for dev
 -------------------------------
-I recommend creating a virtualenv before doing any dev work
-
+Dependencies and creation of virtualenv is handled by uv
 ```
-python3 -m venv venv
-source venv/bin/activate
-pip install -r requirements-dev.txt
+uv sync
+uv venv activate
+uv run <command>
 ```
 
 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
 ```
@@ -115,7 +115,6 @@ make run-daemon acceptance
 
 Contributors
 ============
-
 Pull requests, issues and comments welcome. For pull requests:
 
 * Add tests for new features and bug fixes
@@ -144,7 +143,6 @@ those contributing as an individual.
 
 License
 ========
-
 Copyright (c) 2018 Atlassian and others.
 Apache 2.0 licensed, see [LICENSE.txt](LICENSE.txt) file.
 

sovereign-1.0.0a3/pyproject.toml

@@ -0,0 +1,161 @@
+[project]
+name = "sovereign"
+version = "1.0.0a3"
+description = "Envoy Proxy control-plane written in Python"
+authors = [{ name = "Vasili Syrakis", email = "vsyrakis@atlassian.com" }]
+requires-python = ">=3.11.0, <4.0"
+readme = "README.md"
+license = "Apache-2.0"
+keywords = [
+    "envoy",
+    "envoyproxy",
+    "control-plane",
+    "management",
+    "server",
+]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: No Input/Output (Daemon)",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Information Technology",
+    "Intended Audience :: System Administrators",
+    "License :: OSI Approved :: Apache Software License",
+    "Natural Language :: English",
+    "Operating System :: POSIX :: Linux",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Topic :: Internet :: Proxy Servers",
+]
+dependencies = [
+    "uvicorn>=0.23.2,<0.24",
+    "aiofiles>=23.2.1,<24",
+    "requests>=2.32.4,<3",
+    "PyYAML>=6.0.1,<7",
+    "Jinja2>=3.1.2,<4",
+    "structlog>=23.1.0,<24",
+    "cachelib>=0.10.2,<0.11",
+    "glom>=23.3.0,<24",
+    "cryptography>=45.0.2",
+    "fastapi>=0.128.0,<0.129",
+    "uvloop>0.19.0,<1.0",
+    "croniter>=1.4.1,<2",
+    "cachetools>=5.3.2,<6",
+    "pydantic>=2.7.2,<3",
+    "pydantic-settings<2.6.0",
+    "starlette-context>=0.3.6,<0.4",
+    "starlette>=0.49.1,<0.50",
+    "h11>=0.16.0,<0.17",
+    "supervisor>=4.2.5,<5",
+    "jmespath>=1.0.1,<2",
+    "rich>=14.2.0",
+]
+
+[project.optional-dependencies]
+sentry = ["sentry-sdk>=2.14.0,<3"]
+boto = ["boto3>=1.28.62,<2"]
+statsd = ["datadog>=0.50.1"]
+ujson = ["ujson>=5.8.0,<6"]
+orjson = ["orjson>=3.9.15,<4"]
+caching = []
+httptools = ["httptools>=0.6.0,<0.7"]
+
+[project.urls]
+Homepage = "https://pypi.org/project/sovereign/"
+Repository = "https://bitbucket.org/atlassian/sovereign/src/master/"
+Documentation = "https://developer.atlassian.com/platform/sovereign/"
+
+[project.scripts]
+sovereign = "sovereign.server:main"
+sovereign-web = "sovereign.server:web"
+sovereign-worker = "sovereign.server:worker"
+
+[project.entry-points."sovereign.sources"]
+file = "sovereign.sources.file:File"
+inline = "sovereign.sources.inline:Inline"
+
+[project.entry-points."sovereign.modifiers"]
+sovereign_3rd_party_test = "sovereign.testing.modifiers:Test"
+
+[project.entry-points."sovereign.loaders"]
+example = "sovereign.testing.loaders:Multiply"
+file = "sovereign.dynamic_config.loaders:File"
+pkgdata = "sovereign.dynamic_config.loaders:PackageData"
+http = "sovereign.dynamic_config.loaders:Web"
+https = "sovereign.dynamic_config.loaders:Web"
+env = "sovereign.dynamic_config.loaders:EnvironmentVariable"
+module = "sovereign.dynamic_config.loaders:PythonModule"
+s3 = "sovereign.dynamic_config.loaders:S3Bucket"
+python = "sovereign.dynamic_config.loaders:PythonInlineCode"
+inline = "sovereign.dynamic_config.loaders:Inline"
+
+[project.entry-points."sovereign.deserializers"]
+yaml = "sovereign.dynamic_config.deser:YamlDeserializer"
+json = "sovereign.dynamic_config.deser:JsonDeserializer"
+jinja = "sovereign.dynamic_config.deser:JinjaDeserializer"
+jinja2 = "sovereign.dynamic_config.deser:JinjaDeserializer"
+string = "sovereign.dynamic_config.deser:StringDeserializer"
+raw = "sovereign.dynamic_config.deser:PassthroughDeserializer"
+none = "sovereign.dynamic_config.deser:PassthroughDeserializer"
+passthrough = "sovereign.dynamic_config.deser:PassthroughDeserializer"
+ujson = "sovereign.dynamic_config.deser:UjsonDeserializer"
+orjson = "sovereign.dynamic_config.deser:OrjsonDeserializer"
+
+[project.entry-points."sovereign.cache.backends"]
+s3 = "sovereign.cache.backends.s3:S3Backend"
+
+[project.entry-points."sovereign.data_stores"]
+memory = "sovereign.v2.data.data_store:InMemoryDataStore"
+sqlite = "sovereign.v2.data.data_store:SqliteDataStore"
+
+[project.entry-points."sovereign.queues"]
+memory = "sovereign.v2.data.worker_queue:InMemoryQueue"
+sqlite = "sovereign.v2.data.worker_queue:SqliteQueue"
+
+[dependency-groups]
+dev = [
+    "freezegun",
+    "httpx",
+    "moto>=5.0.0",
+    "pytest-asyncio",
+    "pytest-mock",
+    "ruff",
+    "tavern",
+    "toml",
+    "ty",
+    "ty==0.0.1a26",
+    "types-PyYAML",
+    "types-cachetools",
+    "types-croniter",
+    "types-mock>=5.2.0.20250306,<6",
+    "types-requests",
+    "types-setuptools",
+    "types-ujson",
+]
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "src/sovereign",
+    "src/sovereign_files",
+    "src/sovereign_files/**/*",
+]
+
+[tool.hatch.build.targets.wheel]
+include = [
+    "src/sovereign",
+    "src/sovereign_files",
+    "src/sovereign_files/**/*",
+]
+
+[tool.hatch.build.targets.wheel.sources]
+"src/sovereign" = "sovereign"
+"src/sovereign_files" = "sovereign_files"
+
+[[tool.uv.index]]
+url = "https://pypi.org/simple"
+default = true
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"

sovereign-1.0.0a3/src/sovereign/__init__.py

@@ -0,0 +1,32 @@
+from contextvars import ContextVar
+from importlib.metadata import version
+
+from sovereign.configuration import EncryptionConfig, config
+from sovereign.logging.bootstrapper import LoggerBootstrapper
+from sovereign.statistics import configure_statsd
+from sovereign.utils.crypto.crypto import CipherContainer
+from sovereign.utils.crypto.suites import EncryptionType
+
+_request_id_ctx_var: ContextVar[str] = ContextVar("request_id", default="")
+
+
+def get_request_id() -> str:
+    return _request_id_ctx_var.get()
+
+
+WORKER_URL = "http://localhost:9080"
+DIST_NAME = "sovereign"
+__version__ = version(DIST_NAME)
+
+stats = configure_statsd()
+logs = LoggerBootstrapper(config)
+application_logger = logs.application_logger.logger
+
+encryption_configs = config.authentication.encryption_configs
+server_cipher_container = CipherContainer.from_encryption_configs(
+    encryption_configs, logger=application_logger
+)
+disabled_ciphersuite = CipherContainer.from_encryption_configs(
+    encryption_configs=[EncryptionConfig("", EncryptionType.DISABLED)],
+    logger=application_logger,
+)