charmlibs-interfaces-service-mesh 1.0.0__tar.gz

charmlibs_interfaces_service_mesh-1.0.0/.gitignore

@@ -0,0 +1,184 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$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
+cos-tool*
+# 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.*
+.coverage-*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+.report/
+
+# 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
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# 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
+.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/
+
+# PyPI configuration file
+.pypirc
+
+# packed charms
+.packed
+
+# temporary directory for packing charms
+.tmp
+
+# uv.lock from example libraries as we don't commit these
+.example/**/uv.lock
+.tutorial/**/uv.lock
+interfaces/.example/**/uv.lock

charmlibs_interfaces_service_mesh-1.0.0/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 1.0.0
+
+Initial release. Migrated from `charms.istio_beacon_k8s.v0.service_mesh` (v0.19).

charmlibs_interfaces_service_mesh-1.0.0/PKG-INFO

@@ -0,0 +1,31 @@
+Metadata-Version: 2.4
+Name: charmlibs-interfaces-service-mesh
+Version: 1.0.0
+Summary: The charmlibs.interfaces.service_mesh package.
+Project-URL: Documentation, https://documentation.ubuntu.com/charmlibs/reference/charmlibs/interfaces/service-mesh
+Project-URL: Repository, https://github.com/canonical/charmlibs/tree/main/interfaces/service-mesh
+Project-URL: Issues, https://github.com/canonical/charmlibs/issues
+Project-URL: Changelog, https://github.com/canonical/charmlibs/blob/main/interfaces/service-mesh/CHANGELOG.md
+Author: Service Mesh
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Requires-Dist: canonical-service-mesh<1
+Requires-Dist: ops<3,>=2
+Requires-Dist: pydantic<3,>=2
+Description-Content-Type: text/markdown
+
+# charmlibs.interfaces.service_mesh
+
+The `service-mesh` interface library.
+
+To install, add `charmlibs-interfaces-service-mesh` to your Python dependencies. Then in your Python code, import as:
+
+```py
+from charmlibs.interfaces import service_mesh
+```
+
+See the [reference documentation](https://documentation.ubuntu.com/charmlibs/reference/charmlibs/interfaces/service-mesh) for more.

charmlibs_interfaces_service_mesh-1.0.0/README.md

@@ -0,0 +1,11 @@
+# charmlibs.interfaces.service_mesh
+
+The `service-mesh` interface library.
+
+To install, add `charmlibs-interfaces-service-mesh` to your Python dependencies. Then in your Python code, import as:
+
+```py
+from charmlibs.interfaces import service_mesh
+```
+
+See the [reference documentation](https://documentation.ubuntu.com/charmlibs/reference/charmlibs/interfaces/service-mesh) for more.

charmlibs_interfaces_service_mesh-1.0.0/pyproject.toml

@@ -0,0 +1,75 @@
+[project]
+name = "charmlibs-interfaces-service-mesh"
+description = "The charmlibs.interfaces.service_mesh package."
+readme = "README.md"
+requires-python = ">=3.10"
+authors = [
+    {name="Service Mesh"},
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: Apache Software License",
+    "Intended Audience :: Developers",
+    "Operating System :: POSIX :: Linux",
+    "Development Status :: 5 - Production/Stable",
+]
+dynamic = ["version"]
+dependencies = [
+    "ops>=2,<3",
+    "pydantic>=2,<3",
+    "canonical-service-mesh<1",
+]
+
+[dependency-groups]
+lint = [  # installed for `just lint interfaces/service-mesh` (unit, functional, and integration are also installed)
+    # "typing_extensions",
+]
+unit = [  # installed for `just unit interfaces/service-mesh`
+    "ops[testing]",
+]
+functional = [  # installed for `just functional interfaces/service-mesh`
+]
+integration = [  # installed for `just integration interfaces/service-mesh`
+    "jubilant",
+]
+
+[project.urls]
+"Documentation" = "https://documentation.ubuntu.com/charmlibs/reference/charmlibs/interfaces/service-mesh"
+"Repository" = "https://github.com/canonical/charmlibs/tree/main/interfaces/service-mesh"
+"Issues" = "https://github.com/canonical/charmlibs/issues"
+"Changelog" = "https://github.com/canonical/charmlibs/blob/main/interfaces/service-mesh/CHANGELOG.md"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/charmlibs"]
+
+[tool.hatch.version]
+path = "src/charmlibs/interfaces/service_mesh/_version.py"
+
+[tool.ruff]
+extend = "../../pyproject.toml"
+src = ["src", "tests/unit"]  # correctly sort local imports in tests
+
+[tool.ruff.lint.extend-per-file-ignores]
+# add additional per-file-ignores here to avoid overriding repo-level config
+"tests/**/*" = [
+    # "E501",  # line too long
+]
+
+[tool.pyright]
+extends = "../../pyproject.toml"
+include = ["src", "tests"]
+pythonVersion = "3.10"  # check no python > 3.10 features are used
+
+[tool.charmlibs.functional]
+ubuntu = []  # ubuntu versions to run functional tests with, e.g. "24.04" (defaults to just "latest")
+pebble = []  # pebble versions to run functional tests with, e.g. "v1.0.0", "master" (defaults to no pebble versions)
+sudo = false  # whether to run functional tests with sudo (defaults to false)
+
+[tool.charmlibs.integration]
+# tags to run integration tests with (defaults to running once with no tag, i.e. tags = [''])
+# Available in CI in tests/integration/pack.sh and integration tests as CHARMLIBS_TAG
+tags = []  # Not used by the pack.sh and integration tests generated by the template

charmlibs_interfaces_service_mesh-1.0.0/src/charmlibs/interfaces/service_mesh/__init__.py

@@ -0,0 +1,121 @@
+# Copyright 2025 Canonical Ltd.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Service mesh interface library.
+
+This library facilitates adding your charmed application to a service mesh,
+leveraging the ``service_mesh`` and ``cross_model_mesh`` interfaces to provide
+secure, policy-driven traffic management between applications.
+
+What is this library for?
+=========================
+
+This library is for enrolling a charm onto a Charmed Service Mesh solution
+and automatically provisioning network policies that restrict cluster-internal
+network traffic between charms.
+
+Service meshes provide capabilities for routing, controlling, and monitoring
+traffic between applications. A key feature is the ability to enforce
+authorization policies that govern which pods can communicate with each other
+and on which ports, paths, and HTTP methods. For example, you can define that
+a metrics scraper pod is allowed to ``GET /metrics`` on port ``9090`` from a
+producer pod, while preventing all other pods from accessing it.
+
+The ``ServiceMeshConsumer`` subscribes a charm to a related service mesh by
+declaring access policies based on the charm's Juju relations. Since
+application relations often reflect traffic flow patterns (e.g. a database
+consumer connecting to a database provider), the consumer automatically
+generates the appropriate mesh traffic rules. It also handles labelling the
+charm's Kubernetes resources to enroll them in the mesh, and supports
+cross-model relations for multi-model deployments.
+
+The ``ServiceMeshProvider`` publishes mesh enrollment labels and the mesh type
+to consumers, and collects the aggregated policies requested by all related
+consumer charms so the mesh control plane can enforce them.
+
+Consumer usage::
+
+    from charmlibs.interfaces.service_mesh import (
+        Method, Endpoint, AppPolicy, UnitPolicy, ServiceMeshConsumer,
+    )
+
+    class MyCharm(CharmBase):
+        def __init__(self, *args):
+            super().__init__(*args)
+            self._mesh = ServiceMeshConsumer(
+                self,
+                policies=[
+                    AppPolicy(
+                        relation="data",
+                        endpoints=[
+                            Endpoint(
+                                ports=[HTTP_LISTEN_PORT],
+                                methods=[Method.get],
+                                paths=["/data"],
+                            ),
+                        ],
+                    ),
+                    UnitPolicy(relation="metrics", ports=[HTTP_LISTEN_PORT]),
+                ],
+            )
+
+Provider usage::
+
+    from charmlibs.interfaces.service_mesh import ServiceMeshProvider, MeshType
+
+    class MyServiceMeshCharm(CharmBase):
+        def __init__(self, *args):
+            super().__init__(*args)
+            self._mesh = ServiceMeshProvider(
+                charm=self,
+                labels={"istio.io/dataplane-mode": "ambient"},
+                mesh_type=MeshType.istio,
+            )
+"""
+
+from canonical_service_mesh.enums import MeshType, Method, PolicyTargetType
+
+from ._service_mesh import (
+    AppPolicy,
+    CMRData,
+    Endpoint,
+    MeshPolicy,
+    Policy,
+    ServiceMeshConsumer,
+    ServiceMeshProvider,
+    ServiceMeshProviderAppData,
+    UnitPolicy,
+    build_mesh_policies,
+    get_data_from_cmr_relation,
+    label_configmap_name_template,
+)
+from ._version import __version__ as __version__
+
+__all__ = [
+    'AppPolicy',
+    'CMRData',
+    'Endpoint',
+    'MeshPolicy',
+    'MeshType',
+    'Method',
+    'Policy',
+    'PolicyTargetType',
+    'ServiceMeshConsumer',
+    'ServiceMeshProvider',
+    'ServiceMeshProviderAppData',
+    'UnitPolicy',
+    'build_mesh_policies',
+    'get_data_from_cmr_relation',
+    'label_configmap_name_template',
+]