charmarr-lib-vpn 0.2.2__tar.gz

charmarr_lib_vpn-0.2.2/.gitignore

@@ -0,0 +1,207 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

charmarr_lib_vpn-0.2.2/CHANGELOG.md

@@ -0,0 +1,23 @@
+# Changelog
+
+## [0.2.2](https://github.com/charmarr/charmarr-lib/compare/charmarr-lib-vpn-v0.2.1...charmarr-lib-vpn-v0.2.2) (2025-12-16)
+
+
+### Bug Fixes
+
+* **vpn:** fixes local version file update ([c4b5ce2](https://github.com/charmarr/charmarr-lib/commit/c4b5ce27825522ff07aee1e194755ced42401f8c))
+
+## [0.2.1](https://github.com/charmarr/charmarr-lib/compare/charmarr-lib-vpn-v0.2.0...charmarr-lib-vpn-v0.2.1) (2025-12-16)
+
+
+### Bug Fixes
+
+* **vpn:** fixes release please process ([72c0ea3](https://github.com/charmarr/charmarr-lib/commit/72c0ea3998188b96b74445e7076ac9e0ac5cebd2))
+
+## [0.2.0](https://github.com/charmarr/charmarr-lib/compare/charmarr-lib-vpn-v0.1.0...charmarr-lib-vpn-v0.2.0) (2025-12-15)
+
+
+### Features
+
+* adds dev envs for charmarr lib packages ([b8ee5b2](https://github.com/charmarr/charmarr-lib/commit/b8ee5b29bf07a9c4e53a5443da3742c62ec4191c))
+* scaffolds monorepo with required packages ([eca8d38](https://github.com/charmarr/charmarr-lib/commit/eca8d38bec8f03dcabd4363b84e1743e495fed4c))

charmarr_lib_vpn-0.2.2/PKG-INFO

@@ -0,0 +1,139 @@
+Metadata-Version: 2.4
+Name: charmarr-lib-vpn
+Version: 0.2.2
+Summary: VPN gateway charm library for Kubernetes
+Author-email: Adhitya Ravi <adhityashan95@gmail.com>
+License: LGPL-3.0-or-later
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.12
+Requires-Dist: charmarr-lib-krm>=0.1
+Requires-Dist: lightkube>=0.15
+Requires-Dist: ops>=2.0
+Requires-Dist: pydantic>=2.0
+Provides-Extra: dev
+Requires-Dist: mypy>=1.8; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.1; extra == 'dev'
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <img src="../assets/charmarr-charmarr-lib.png" width="350" alt="Charmarr Lib">
+</p>
+
+<h1 align="center">charmarr-lib-vpn</h1>
+
+VPN gateway charm library for Kubernetes.
+
+## Features
+
+- VPN gateway Juju relation interface
+- StatefulSet patching utilities for pod-gateway integration
+- NetworkPolicy kill switch implementation
+- Reusable beyond Charmarr ecosystem
+
+## Installation
+
+```bash
+pip install charmarr-lib-vpn
+```
+
+## Usage
+
+### Interfaces
+
+```python
+from charmarr_lib.vpn.interfaces import (
+    VPNGatewayProvider,
+    VPNGatewayRequirer,
+    VPNGatewayProviderData,
+    VPNGatewayRequirerData,
+    VPNGatewayChangedEvent,
+)
+```
+
+### Gateway Patching (VPN gateway side - gluetun)
+
+```python
+from charmarr_lib.vpn import (
+    reconcile_gateway,
+    build_gateway_patch,
+    is_gateway_patched,
+)
+from charmarr_lib.krm import K8sResourceManager
+
+manager = K8sResourceManager()
+provider_data = VPNGatewayProviderData(
+    vxlan_id=42,
+    vxlan_ip_network="172.16.0.0/24",
+    cluster_cidrs="10.1.0.0/16,10.152.183.0/24",
+)
+
+# Idempotent reconciliation
+result = reconcile_gateway(
+    manager=manager,
+    statefulset_name="gluetun",
+    namespace="vpn-gateway",
+    data=provider_data,
+    pod_cidr="10.1.0.0/16",
+)
+```
+
+### Client Patching (Download client side - qBittorrent)
+
+```python
+from charmarr_lib.vpn import (
+    reconcile_gateway_client,
+    build_gateway_client_patch,
+    build_gateway_client_configmap_data,
+    is_gateway_client_patched,
+)
+
+# Create client-side VPN routing
+result = reconcile_gateway_client(
+    manager=manager,
+    statefulset_name="qbittorrent",
+    namespace="download-clients",
+    data=requirer_data,
+    configmap_name="qbittorrent-vpn-config",
+)
+```
+
+### Kill Switch (NetworkPolicy)
+
+```python
+from charmarr_lib.vpn import (
+    KillSwitchConfig,
+    reconcile_kill_switch,
+)
+
+# Create NetworkPolicy that blocks non-VPN egress
+config = KillSwitchConfig(
+    app_name="qbittorrent",
+    namespace="download-clients",
+    cluster_cidrs=["10.1.0.0/16", "10.152.183.0/24"],
+    dns_namespace="kube-system",
+)
+reconcile_kill_switch(manager, "qbittorrent", "download-clients", config)
+
+# Remove kill switch on relation-broken
+reconcile_kill_switch(manager, "qbittorrent", "download-clients", None)
+```
+
+### Constants
+
+```python
+from charmarr_lib.vpn import (
+    POD_GATEWAY_IMAGE,
+    DEFAULT_VXLAN_ID,
+    DEFAULT_VXLAN_IP_NETWORK,
+    GATEWAY_INIT_CONTAINER_NAME,
+    GATEWAY_SIDECAR_CONTAINER_NAME,
+    CLIENT_INIT_CONTAINER_NAME,
+    CLIENT_SIDECAR_CONTAINER_NAME,
+)
+```

charmarr_lib_vpn-0.2.2/README.md

@@ -0,0 +1,116 @@
+<p align="center">
+  <img src="../assets/charmarr-charmarr-lib.png" width="350" alt="Charmarr Lib">
+</p>
+
+<h1 align="center">charmarr-lib-vpn</h1>
+
+VPN gateway charm library for Kubernetes.
+
+## Features
+
+- VPN gateway Juju relation interface
+- StatefulSet patching utilities for pod-gateway integration
+- NetworkPolicy kill switch implementation
+- Reusable beyond Charmarr ecosystem
+
+## Installation
+
+```bash
+pip install charmarr-lib-vpn
+```
+
+## Usage
+
+### Interfaces
+
+```python
+from charmarr_lib.vpn.interfaces import (
+    VPNGatewayProvider,
+    VPNGatewayRequirer,
+    VPNGatewayProviderData,
+    VPNGatewayRequirerData,
+    VPNGatewayChangedEvent,
+)
+```
+
+### Gateway Patching (VPN gateway side - gluetun)
+
+```python
+from charmarr_lib.vpn import (
+    reconcile_gateway,
+    build_gateway_patch,
+    is_gateway_patched,
+)
+from charmarr_lib.krm import K8sResourceManager
+
+manager = K8sResourceManager()
+provider_data = VPNGatewayProviderData(
+    vxlan_id=42,
+    vxlan_ip_network="172.16.0.0/24",
+    cluster_cidrs="10.1.0.0/16,10.152.183.0/24",
+)
+
+# Idempotent reconciliation
+result = reconcile_gateway(
+    manager=manager,
+    statefulset_name="gluetun",
+    namespace="vpn-gateway",
+    data=provider_data,
+    pod_cidr="10.1.0.0/16",
+)
+```
+
+### Client Patching (Download client side - qBittorrent)
+
+```python
+from charmarr_lib.vpn import (
+    reconcile_gateway_client,
+    build_gateway_client_patch,
+    build_gateway_client_configmap_data,
+    is_gateway_client_patched,
+)
+
+# Create client-side VPN routing
+result = reconcile_gateway_client(
+    manager=manager,
+    statefulset_name="qbittorrent",
+    namespace="download-clients",
+    data=requirer_data,
+    configmap_name="qbittorrent-vpn-config",
+)
+```
+
+### Kill Switch (NetworkPolicy)
+
+```python
+from charmarr_lib.vpn import (
+    KillSwitchConfig,
+    reconcile_kill_switch,
+)
+
+# Create NetworkPolicy that blocks non-VPN egress
+config = KillSwitchConfig(
+    app_name="qbittorrent",
+    namespace="download-clients",
+    cluster_cidrs=["10.1.0.0/16", "10.152.183.0/24"],
+    dns_namespace="kube-system",
+)
+reconcile_kill_switch(manager, "qbittorrent", "download-clients", config)
+
+# Remove kill switch on relation-broken
+reconcile_kill_switch(manager, "qbittorrent", "download-clients", None)
+```
+
+### Constants
+
+```python
+from charmarr_lib.vpn import (
+    POD_GATEWAY_IMAGE,
+    DEFAULT_VXLAN_ID,
+    DEFAULT_VXLAN_IP_NETWORK,
+    GATEWAY_INIT_CONTAINER_NAME,
+    GATEWAY_SIDECAR_CONTAINER_NAME,
+    CLIENT_INIT_CONTAINER_NAME,
+    CLIENT_SIDECAR_CONTAINER_NAME,
+)
+```

charmarr_lib_vpn-0.2.2/pyproject.toml

@@ -0,0 +1,44 @@
+[project]
+name = "charmarr-lib-vpn"
+description = "VPN gateway charm library for Kubernetes"
+dynamic = ["version"]
+readme = "README.md"
+requires-python = ">=3.12"
+license = { text = "LGPL-3.0-or-later" }
+authors = [
+    { name = "Adhitya Ravi", email = "adhityashan95@gmail.com" }
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+]
+dependencies = [
+    "charmarr-lib-krm>=0.1",
+    "ops>=2.0",
+    "pydantic>=2.0",
+    "lightkube>=0.15",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.0",
+    "pytest-cov>=4.0",
+    "ruff>=0.1",
+    "mypy>=1.8",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/charmarr_lib"]
+
+[tool.hatch.version]
+path = "src/charmarr_lib/vpn/_version.py"
+
+[tool.uv.sources]
+charmarr-lib-krm = { workspace = true }

charmarr_lib_vpn-0.2.2/src/charmarr_lib/vpn/__init__.py

@@ -0,0 +1,50 @@
+# Copyright 2025 The Charmarr Project
+# See LICENSE file for licensing details.
+
+"""VPN gateway charm library for Kubernetes."""
+
+from charmarr_lib.vpn._k8s import (
+    KillSwitchConfig,
+    build_gateway_client_configmap_data,
+    build_gateway_client_patch,
+    build_gateway_patch,
+    is_gateway_client_patched,
+    is_gateway_patched,
+    reconcile_gateway,
+    reconcile_gateway_client,
+    reconcile_kill_switch,
+)
+from charmarr_lib.vpn.constants import (
+    CLIENT_INIT_CONTAINER_NAME,
+    CLIENT_SIDECAR_CONTAINER_NAME,
+    DEFAULT_VPN_BLOCK_OTHER_TRAFFIC,
+    DEFAULT_VPN_INTERFACE,
+    DEFAULT_VXLAN_GATEWAY_FIRST_DYNAMIC_IP,
+    DEFAULT_VXLAN_ID,
+    DEFAULT_VXLAN_IP_NETWORK,
+    GATEWAY_INIT_CONTAINER_NAME,
+    GATEWAY_SIDECAR_CONTAINER_NAME,
+    POD_GATEWAY_IMAGE,
+)
+
+__all__ = [
+    "CLIENT_INIT_CONTAINER_NAME",
+    "CLIENT_SIDECAR_CONTAINER_NAME",
+    "DEFAULT_VPN_BLOCK_OTHER_TRAFFIC",
+    "DEFAULT_VPN_INTERFACE",
+    "DEFAULT_VXLAN_GATEWAY_FIRST_DYNAMIC_IP",
+    "DEFAULT_VXLAN_ID",
+    "DEFAULT_VXLAN_IP_NETWORK",
+    "GATEWAY_INIT_CONTAINER_NAME",
+    "GATEWAY_SIDECAR_CONTAINER_NAME",
+    "POD_GATEWAY_IMAGE",
+    "KillSwitchConfig",
+    "build_gateway_client_configmap_data",
+    "build_gateway_client_patch",
+    "build_gateway_patch",
+    "is_gateway_client_patched",
+    "is_gateway_patched",
+    "reconcile_gateway",
+    "reconcile_gateway_client",
+    "reconcile_kill_switch",
+]

charmarr_lib_vpn-0.2.2/src/charmarr_lib/vpn/_k8s/__init__.py

@@ -0,0 +1,53 @@
+# Copyright 2025 The Charmarr Project
+# See LICENSE file for licensing details.
+
+"""StatefulSet patching and NetworkPolicy for pod-gateway VPN routing.
+
+This module provides functions to patch Kubernetes StatefulSets with
+pod-gateway containers for VXLAN overlay VPN routing, plus NetworkPolicy
+kill switch for traffic protection.
+
+Gateway-side patching (for gluetun-k8s):
+- gateway-init: Creates VXLAN tunnel, sets up iptables forwarding
+- gateway-sidecar: Runs DHCP and DNS server for client pods
+
+Gateway client patching (for qbittorrent-k8s, sabnzbd-k8s):
+- vpn-route-init: Creates VXLAN interface, gets IP via DHCP
+- vpn-route-sidecar: Monitors gateway connectivity
+
+Kill switch (for qbittorrent-k8s, sabnzbd-k8s):
+- NetworkPolicy that blocks egress except cluster CIDRs + DNS
+- Prevents traffic leaks if VXLAN routing fails
+
+See ADRs:
+- lib/adr-002-charmarr-vpn.md
+- networking/adr-004-vpn-kill-switch.md
+"""
+
+from charmarr_lib.vpn._k8s._gateway import (
+    build_gateway_patch,
+    is_gateway_patched,
+    reconcile_gateway,
+)
+from charmarr_lib.vpn._k8s._gateway_client import (
+    build_gateway_client_configmap_data,
+    build_gateway_client_patch,
+    is_gateway_client_patched,
+    reconcile_gateway_client,
+)
+from charmarr_lib.vpn._k8s._kill_switch import (
+    KillSwitchConfig,
+    reconcile_kill_switch,
+)
+
+__all__ = [
+    "KillSwitchConfig",
+    "build_gateway_client_configmap_data",
+    "build_gateway_client_patch",
+    "build_gateway_patch",
+    "is_gateway_client_patched",
+    "is_gateway_patched",
+    "reconcile_gateway",
+    "reconcile_gateway_client",
+    "reconcile_kill_switch",
+]