mongo-charms-single-kernel 1.6.11__tar.gz → 1.8.19__tar.gz

{mongo_charms_single_kernel-1.6.11 → mongo_charms_single_kernel-1.8.19}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mongo-charms-single-kernel
-Version: 1.6.11
+Version: 1.8.19
 Summary: Shared and reusable code for Mongo-related charms
 License-Expression: Apache-2.0
 License-File: LICENSE
@@ -12,6 +12,7 @@ Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: System Administrators
 Classifier: Operating System :: POSIX :: Linux
 Requires-Dist: boto3 (>=1.37.12,<1.38.0)
+Requires-Dist: charm-refresh (>=3.1.0.2,<4.0.0.0)
 Requires-Dist: cosl
 Requires-Dist: cryptography
 Requires-Dist: dacite (>=1.9.0,<1.10.0)
@@ -19,7 +20,6 @@ Requires-Dist: data-platform-helpers (>=0.1.7)
 Requires-Dist: deepmerge (>=2.0)
 Requires-Dist: jinja2
 Requires-Dist: jsonschema (>=4.24.0,<4.25.0)
-Requires-Dist: ldap3
 Requires-Dist: lightkube
 Requires-Dist: mypy-boto3-s3 (>=1.37.0,<1.38.0)
 Requires-Dist: ops (>=2.21.1,<2.22.0)
@@ -28,6 +28,7 @@ Requires-Dist: poetry-core (>=2.0)
 Requires-Dist: pydantic (>=2.11.0,<2.12.0)
 Requires-Dist: pydantic-settings
 Requires-Dist: pymongo
+Requires-Dist: python-ldap
 Requires-Dist: pyyaml (>=6.0.2,<6.1.0)
 Requires-Dist: tenacity (>=9.0.0,<9.1.0)
 Project-URL: Bug Tracker, https://github.com/canonical/mongo-single-kernel-library/issues

{mongo_charms_single_kernel-1.6.11 → mongo_charms_single_kernel-1.8.19}/pyproject.toml

@@ -34,12 +34,13 @@ dependencies = [
     "dacite (~=1.9.0)",
     "data-platform-helpers (>=0.1.7)",
     "cosl",  # loki_push_api
-    "ldap3",
     "deepmerge (>=2.0)",
     "boto3 (~=1.37.12)",
-    "mypy-boto3-s3 (~=1.37.0)"
+    "mypy-boto3-s3 (~=1.37.0)",
+    "python-ldap",
+    "charm-refresh (>=3.1.0.2,<4.0.0.0)"
 ]
-version = "1.6.11"
+version = "1.8.19"
 
 [project.urls]
 homepage = "https://github.com/canonical/mongo-single-kernel-library"
@@ -135,11 +136,13 @@ more_itertools = "*"
 httpx = "*"
 boto3 = "^1.37.12"
 mypy-boto3-s3 = "^1.37.0"
+tomli = '*'
+tomli-w = '*'
 
 [tool.ruff]
 target-version = "py310"
 line-length = 100
-exclude = [".git", "__pycache__", ".tox", "build", "dist", "*.egg_info", "venv", "single_kernel_mongo/lib", "tests/integration/applications", "docs"]
+exclude = [".git", "__pycache__", ".tox", "build", "dist", "*.egg_info", "venv", "single_kernel_mongo/lib", "tests/integration/applications"]
 
 [tool.ruff.lint]
 select = ["F", "E", "W", "C", "N", "R", "D", "I001", "UP"]
@@ -178,8 +181,7 @@ omit = [
     "single_kernel_mongo/lib/charms/*",
     "single_kernel_mongo/state/abstract_state.py",
     "single_kernel_mongo/core/operator.py",
-    "*__init__*",
-    "docs"
+    "*__init__*"
 ]
 
 [tool.coverage.report]
@@ -207,7 +209,7 @@ exclude = [
     "tests/charms/*",
     "tests/integration/*",
     "tests/unit/*",
-    "docs/*"
+    "typings[\\/].*"
 ]
 # https://mypy.readthedocs.io/en/stable/command_line.html#cmdoption-mypy-ignore-missing-imports
 ignore_missing_imports = true
@@ -215,4 +217,4 @@ plugins = ["pydantic.mypy"]
 
 [tool.codespell]
 ignore-words=".codespellignore"
-skip="*single_kernel_mongo/lib/*,*single_kernel_mongo/observability_rules/*,*.lock,*tests/integration/applications/**/lib/*,*docs*"
+skip="*single_kernel_mongo/lib/*,*single_kernel_mongo/observability_rules/*,*.lock,*tests/integration/applications/**/lib/*"

{mongo_charms_single_kernel-1.6.11 → mongo_charms_single_kernel-1.8.19}/single_kernel_mongo/abstract_charm.py

@@ -26,6 +26,7 @@ a DB Engine and storage), and the main peer relation name will be
 import logging
 from typing import ClassVar, Generic, TypeVar
 
+import ops.log
 from data_platform_helpers.advanced_statuses.handler import StatusHandler
 from data_platform_helpers.advanced_statuses.models import StatusObject
 from data_platform_helpers.advanced_statuses.protocol import ManagerStatusProtocol
@@ -43,6 +44,8 @@ T = TypeVar("T", bound=MongoConfigModel)
 U = TypeVar("U", bound=OperatorProtocol)
 
 logger = logging.getLogger(__name__)
+logging.getLogger("httpx").setLevel(logging.WARNING)
+logging.getLogger("httpcore").setLevel(logging.WARNING)
 
 
 class AbstractMongoCharm(ManagerStatusProtocol, Generic[T, U], CharmBase):
@@ -69,6 +72,11 @@ class AbstractMongoCharm(ManagerStatusProtocol, Generic[T, U], CharmBase):
         # Init the Juju object Object
         super(Generic, self).__init__(*args)
 
+        root_logger = logging.getLogger()
+        for handler in root_logger.handlers:
+            if isinstance(handler, ops.log.JujuLogHandler):
+                handler.setFormatter(logging.Formatter("{name}:{message}", style="{"))
+
         # Create the operator instance (one of MongoDBOperator or MongosOperator)
         self.operator = self.operator_type(self)
         self.state = self.operator.state
@@ -118,7 +126,7 @@ class AbstractMongoCharm(ManagerStatusProtocol, Generic[T, U], CharmBase):
             return
 
         if self.operator.state.app_peer_data.role == MongoDBRoles.UNKNOWN:
-            self.operator.state.app_peer_data.role = self.parsed_config.role
+            self.operator.state.app_peer_data.role = MongoDBRoles(self.parsed_config.role)
 
     def get_statuses(self, scope: Scope, recompute: bool = False) -> list[StatusObject]:
         """Returns a list of statuses."""

{mongo_charms_single_kernel-1.6.11 → mongo_charms_single_kernel-1.8.19}/single_kernel_mongo/config/literals.py

@@ -6,7 +6,7 @@ This module should contain the literals used in the charms (paths, enums, etc).
 """
 
 from dataclasses import dataclass
-from enum import Enum
+from enum import Enum, IntEnum
 from pathlib import Path
 from typing import Generic, TypeVar
 
@@ -34,44 +34,32 @@ class Scope(str, Enum):
     UNIT = "unit"
 
 
-class MongoPorts(int, Enum):
-    """The default Mongo ports."""
-
-    MONGODB_PORT = 27017
-    MONGOS_PORT = 27018
-
-
-class InternalUsers(str, Enum):
-    """The three allowed internal users."""
+class TLSType(str, Enum):
+    """TLS types."""
 
-    OPERATOR = "operator"
-    BACKUP = "backup"
-    MONITOR = "monitor"
-    LOGROTATE = "logrotate"
+    PEER = "peer"
+    CLIENT = "client"
 
 
-class UnitState(str, Enum):
-    """Unit upgrade state."""
-
-    HEALTHY = "healthy"
-    RESTARTING = "restarting"  # Kubernetes only
-    UPGRADING = "upgrading"  # Machines only
-    OUTDATED = "outdated"  # Machines only
+class MongoPorts(IntEnum):
+    """The default Mongo ports."""
 
+    MONGODB_PORT = 27017
+    MONGOS_PORT = 27018
 
-SECRETS_APP = [f"{user}-password" for user in InternalUsers] + ["keyfile"]
 
+class InternalUsernames(str, Enum):
+    """The allowed internal usernames."""
 
-@dataclass(frozen=True)
-class Snap:
-    """The Snap related information."""
+    CHARMED_OPERATOR = "charmed-operator"
+    CHARMED_BACKUP = "charmed-backup"
+    CHARMED_STATS = "charmed-stats"
+    CHARMED_LOGROTATE = "charmed-logrotate"
 
-    name: str = "charmed-mongodb"
-    channel: str = "6/edge"
-    revision: str = "131"
 
+SECRETS_APP = [f"{username}-password" for username in InternalUsernames] + ["keyfile"]
 
-SNAP = Snap(channel="6/edge", revision="131")
+VERSIONS_FILE = Path("refresh_versions.toml")
 
 T = TypeVar("T", bound=str | int)
 
@@ -109,12 +97,10 @@ MAX_PASSWORD_LENGTH = 4096
 
 PBM_RESTART_DELAY = 5
 
-FEATURE_VERSION_6 = "6.0"
+FEATURE_VERSION = "8.0"
 
 
-OS_REQUIREMENTS = {
-    "vm.max_map_count": "262144",
-}
+OS_REQUIREMENTS = {"vm.max_map_count": "262144", "vm.overcommit_memory": "1"}
 
 TRUST_STORE_PATH = Path("/usr/local/share/ca-certificates")
 
@@ -123,3 +109,4 @@ class TrustStoreFiles(str, Enum):
     """The different files we store in the trust store."""
 
     PBM = "pbm.crt"
+    LDAP = "ldap.crt"

{mongo_charms_single_kernel-1.6.11 → mongo_charms_single_kernel-1.8.19}/single_kernel_mongo/config/models.py

@@ -13,8 +13,11 @@ from importlib import resources as impresources
 from importlib.abc import Traversable
 from pathlib import Path
 
+from data_platform_helpers.advanced_statuses.models import StatusObject
+
 from single_kernel_mongo import observability_rules, templates
 from single_kernel_mongo.config.literals import CharmKind, Substrates
+from single_kernel_mongo.config.statuses import PasswordManagementStatuses
 
 TEMPLATE_DIRECTORY = impresources.files(templates)
 OBSERVABILITY_DIRECTORY = impresources.files(observability_rules)
@@ -59,6 +62,18 @@ class LdapConfig:
 LDAP_CONFIG = LdapConfig()
 
 
+@dataclass(frozen=True)
+class THPConfig:
+    """Configuration for transparent huge tables."""
+
+    service_template: Traversable = TEMPLATE_DIRECTORY / "enable-transparent-huge-pages.service.j2"
+    service_file_path: Path = Path("/etc/systemd/system/enable-transparent-huge-pages.service")
+    service_name = "enable-transparent-huge-pages"
+
+
+THP_CONFIG = THPConfig()
+
+
 @dataclass(frozen=True)
 class AuditLogConfig:
     """Audit log related configuration."""
@@ -89,6 +104,7 @@ VM_PATH = {
         "BIN": "/snap/bin",
         "SHELL": "/snap/bin/charmed-mongodb.mongosh",
         "LICENSES": f"/snap/{SNAP_NAME}/current/licenses",
+        "TEMP": "/tmp",
     }
 }
 K8S_PATH = {
@@ -102,6 +118,7 @@ K8S_PATH = {
         "BIN": "/usr/bin/",
         "SHELL": "/usr/bin/mongosh",
         "LICENSES": "/licenses",
+        "TEMP": "/tmp",
     }
 }
 
@@ -148,3 +165,46 @@ class BackupState(Enum):
     WAITING_TO_SYNC = auto()
     FAILED_TO_CREATE_BUCKET = auto()
     ACTIVE = auto()
+
+
+class PasswordManagementState(Enum):
+    """Password management state that can be mapped to a status."""
+
+    EMPTY = auto()
+    NOT_LEADER = auto()
+    PASSWORD_ON_SHARD = auto()
+    UPGRADE_RUNNING = auto()
+    BACKUP_RUNNING = auto()
+    SECRET_NOT_FOUND = auto()
+    SECRET_NOT_GRANTED = auto()
+    INVALID_CONTENT = auto()
+    NEED_PASSWORD_UPDATE = auto()
+
+
+@dataclass
+class PasswordManagementContext:
+    """Represents the current context of password management for internal users.
+
+    Attributes:
+        state (PasswordManagementState): The state of password management,
+        message (str): Optional human-readable message providing context about the state,
+        system_users (dict[str, str]): A mapping of usernames to passwords if the
+            system-users secret is valid. Empty otherwise.
+    """
+
+    state: PasswordManagementState
+    message: str = ""
+    system_users: dict[str, str] = field(default_factory=dict)
+
+    def map_state_to_status(self) -> list[StatusObject]:
+        """Map from password management state to password management status."""
+        match self.state:
+            case PasswordManagementState.PASSWORD_ON_SHARD:
+                return [PasswordManagementStatuses.PASSWORD_ON_SHARD.value]
+            case PasswordManagementState.SECRET_NOT_GRANTED:
+                return [PasswordManagementStatuses.SECRET_NOT_GRANTED.value]
+            case PasswordManagementState.SECRET_NOT_FOUND:
+                return [PasswordManagementStatuses.SECRET_NOT_FOUND.value]
+            case PasswordManagementState.INVALID_CONTENT:
+                return [PasswordManagementStatuses.INVALID_SYSTEM_USERS.value]
+        return []

{mongo_charms_single_kernel-1.6.11 → mongo_charms_single_kernel-1.8.19}/single_kernel_mongo/config/relations.py

@@ -23,7 +23,6 @@ class RelationNames(str, Enum):
     CONFIG_SERVER = "config-server"
     CLUSTER = "cluster"
     MONGOS_PROXY = "mongos_proxy"
-    UPGRADE_VERSION = "upgrade-version-a"
 
 
 class Scopes(str, Enum):
@@ -36,7 +35,8 @@ class Scopes(str, Enum):
 class ExternalRequirerRelations(str, Enum):
     """The relations we require externally."""
 
-    TLS = "certificates"
+    CLIENT_TLS = "client-certificates"
+    PEER_TLS = "peer-certificates"
     S3_CREDENTIALS = "s3-credentials"
     LDAP = "ldap"
     LDAP_CERT = "ldap-certificate-transfer"