mirror of
https://github.com/goauthentik/authentik
synced 2026-05-12 18:06:21 +02:00
1848c6c380
* outposts: create separate metrics service Signed-off-by: Jens Langhammer <jens@goauthentik.io> * fix service monitor plumbing Signed-off-by: Jens Langhammer <jens@goauthentik.io> * update docs Signed-off-by: Jens Langhammer <jens@goauthentik.io> * format Signed-off-by: Jens Langhammer <jens@goauthentik.io> * fix Signed-off-by: Jens Langhammer <jens@goauthentik.io> * add some static tests Signed-off-by: Jens Langhammer <jens@goauthentik.io> * make metrics service ClusterIP Signed-off-by: Jens Langhammer <jens@goauthentik.io> * update service monitor when labels mismatch Signed-off-by: Jens Langhammer <jens@goauthentik.io> --------- Signed-off-by: Jens Langhammer <jens@goauthentik.io>
108 lines
3.0 KiB
Python
108 lines
3.0 KiB
Python
"""Base Controller"""
|
|
|
|
from dataclasses import dataclass
|
|
|
|
from structlog.stdlib import get_logger
|
|
|
|
from authentik import authentik_build_hash, authentik_version
|
|
from authentik.events.logs import LogEvent, capture_logs
|
|
from authentik.lib.config import CONFIG
|
|
from authentik.lib.sentry import SentryIgnoredException
|
|
from authentik.outposts.models import (
|
|
Outpost,
|
|
OutpostServiceConnection,
|
|
OutpostServiceConnectionState,
|
|
)
|
|
|
|
FIELD_MANAGER = "goauthentik.io"
|
|
|
|
|
|
class ControllerException(SentryIgnoredException):
|
|
"""Exception raised when anything fails during controller run"""
|
|
|
|
|
|
@dataclass
|
|
class DeploymentPort:
|
|
"""Info about deployment's single port."""
|
|
|
|
port: int
|
|
name: str
|
|
protocol: str
|
|
inner_port: int | None = None
|
|
|
|
|
|
class BaseClient:
|
|
"""Base class for custom clients"""
|
|
|
|
def fetch_state(self) -> OutpostServiceConnectionState:
|
|
"""Get state, version info"""
|
|
raise NotImplementedError
|
|
|
|
def __enter__(self):
|
|
return self
|
|
|
|
def __exit__(self, exc_type, exc_value, traceback):
|
|
"""Cleanup after usage"""
|
|
|
|
|
|
class BaseController:
|
|
"""Base Outpost deployment controller"""
|
|
|
|
deployment_ports: list[DeploymentPort]
|
|
client: BaseClient
|
|
outpost: Outpost
|
|
connection: OutpostServiceConnection
|
|
|
|
def __init__(self, outpost: Outpost, connection: OutpostServiceConnection):
|
|
self.outpost = outpost
|
|
self.connection = connection
|
|
self.logger = get_logger()
|
|
self.deployment_ports = []
|
|
self.metrics_ports = [
|
|
DeploymentPort(9300, "http-metrics", "tcp"),
|
|
]
|
|
|
|
def up(self):
|
|
"""Called by scheduled task to reconcile deployment/service/etc"""
|
|
raise NotImplementedError
|
|
|
|
def up_with_logs(self) -> list[LogEvent]:
|
|
"""Call .up() but capture all log output and return it."""
|
|
with capture_logs() as logs:
|
|
self.up()
|
|
return logs
|
|
|
|
def down(self):
|
|
"""Handler to delete everything we've created"""
|
|
raise NotImplementedError
|
|
|
|
def down_with_logs(self) -> list[LogEvent]:
|
|
"""Call .down() but capture all log output and return it."""
|
|
with capture_logs() as logs:
|
|
self.down()
|
|
return logs
|
|
|
|
def __enter__(self):
|
|
return self
|
|
|
|
def __exit__(self, exc_type, exc_value, traceback):
|
|
"""Cleanup after usage"""
|
|
if hasattr(self, "client"):
|
|
self.client.__exit__(exc_type, exc_value, traceback)
|
|
|
|
def get_static_deployment(self) -> str:
|
|
"""Return a static deployment configuration"""
|
|
raise NotImplementedError
|
|
|
|
def get_container_image(self) -> str:
|
|
"""Get container image to use for this outpost"""
|
|
if self.outpost.config.container_image is not None:
|
|
return self.outpost.config.container_image
|
|
|
|
image_name_template: str = CONFIG.get("outposts.container_image_base")
|
|
return image_name_template % {
|
|
"type": self.outpost.type,
|
|
"version": authentik_version(),
|
|
"build_hash": authentik_build_hash(),
|
|
}
|