authentik.outposts.controllers.base

  1"""Base Controller"""
  2
  3from dataclasses import dataclass
  4
  5from structlog.stdlib import get_logger
  6
  7from authentik import authentik_build_hash, authentik_version
  8from authentik.events.logs import LogEvent, capture_logs
  9from authentik.lib.config import CONFIG
 10from authentik.lib.sentry import SentryIgnoredException
 11from authentik.outposts.models import (
 12    Outpost,
 13    OutpostServiceConnection,
 14    OutpostServiceConnectionState,
 15)
 16
 17FIELD_MANAGER = "goauthentik.io"
 18
 19
 20class ControllerException(SentryIgnoredException):
 21    """Exception raised when anything fails during controller run"""
 22
 23
 24@dataclass
 25class DeploymentPort:
 26    """Info about deployment's single port."""
 27
 28    port: int
 29    name: str
 30    protocol: str
 31    inner_port: int | None = None
 32
 33
 34class BaseClient:
 35    """Base class for custom clients"""
 36
 37    def fetch_state(self) -> OutpostServiceConnectionState:
 38        """Get state, version info"""
 39        raise NotImplementedError
 40
 41    def __enter__(self):
 42        return self
 43
 44    def __exit__(self, exc_type, exc_value, traceback):
 45        """Cleanup after usage"""
 46
 47
 48class BaseController:
 49    """Base Outpost deployment controller"""
 50
 51    deployment_ports: list[DeploymentPort]
 52    client: BaseClient
 53    outpost: Outpost
 54    connection: OutpostServiceConnection
 55
 56    def __init__(self, outpost: Outpost, connection: OutpostServiceConnection):
 57        self.outpost = outpost
 58        self.connection = connection
 59        self.logger = get_logger()
 60        self.deployment_ports = []
 61        self.metrics_ports = [
 62            DeploymentPort(9300, "http-metrics", "tcp"),
 63        ]
 64
 65    def up(self):
 66        """Called by scheduled task to reconcile deployment/service/etc"""
 67        raise NotImplementedError
 68
 69    def up_with_logs(self) -> list[LogEvent]:
 70        """Call .up() but capture all log output and return it."""
 71        with capture_logs() as logs:
 72            self.up()
 73        return logs
 74
 75    def down(self):
 76        """Handler to delete everything we've created"""
 77        raise NotImplementedError
 78
 79    def down_with_logs(self) -> list[LogEvent]:
 80        """Call .down() but capture all log output and return it."""
 81        with capture_logs() as logs:
 82            self.down()
 83        return logs
 84
 85    def __enter__(self):
 86        return self
 87
 88    def __exit__(self, exc_type, exc_value, traceback):
 89        """Cleanup after usage"""
 90        if hasattr(self, "client"):
 91            self.client.__exit__(exc_type, exc_value, traceback)
 92
 93    def get_static_deployment(self) -> str:
 94        """Return a static deployment configuration"""
 95        raise NotImplementedError
 96
 97    def get_container_image(self) -> str:
 98        """Get container image to use for this outpost"""
 99        if self.outpost.config.container_image is not None:
100            return self.outpost.config.container_image
101
102        image_name_template: str = CONFIG.get("outposts.container_image_base")
103        return image_name_template % {
104            "type": self.outpost.type,
105            "version": authentik_version(),
106            "build_hash": authentik_build_hash(),
107        }