postgresql-charms-single-kernel 16.3.14__tar.gz → 16.3.16__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (80) hide show
  1. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/PKG-INFO +1 -1
  2. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/pyproject.toml +2 -2
  3. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/pyproject.toml.orig +2 -2
  4. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/config/literals.py +16 -0
  5. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/core/peer_relation.py +38 -0
  6. postgresql_charms_single_kernel-16.3.16/single_kernel_postgresql/events/observer.py +98 -0
  7. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/managers/config.py +22 -0
  8. postgresql_charms_single_kernel-16.3.16/single_kernel_postgresql/managers/observer.py +152 -0
  9. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/templates/patroni.yml.j2 +6 -2
  10. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/LICENSE +0 -0
  11. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/README.md +0 -0
  12. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/__init__.py +0 -0
  13. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/charmcraft.yaml +0 -0
  14. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/charms/__init__.py +0 -0
  15. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/charms/abstract_charm.py +0 -0
  16. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/charms/k8s_charm.py +0 -0
  17. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/charms/vm_charm.py +0 -0
  18. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/compat/__init__.py +0 -0
  19. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/compat/postgresql.py +0 -0
  20. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/compat/pyproject.toml +0 -0
  21. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/config/__init__.py +0 -0
  22. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/config/enums.py +0 -0
  23. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/config/exceptions.py +0 -0
  24. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/config/locales.py +0 -0
  25. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/config/pyproject.toml +0 -0
  26. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/config/statuses.py +0 -0
  27. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/core/__init__.py +0 -0
  28. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/core/config.py +0 -0
  29. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/core/relation_state.py +0 -0
  30. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/core/s3.py +0 -0
  31. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/core/state.py +0 -0
  32. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/events/__init__.py +0 -0
  33. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/events/async_replication.py +0 -0
  34. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/events/backup.py +0 -0
  35. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/events/database.py +0 -0
  36. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/events/ldap.py +0 -0
  37. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/events/postgresql.py +0 -0
  38. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/events/tls.py +0 -0
  39. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/events/tls_transfer.py +0 -0
  40. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/events/watcher.py +0 -0
  41. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/lib/charms/data_platform_libs/v0/data_interfaces.py +0 -0
  42. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/lib/charms/data_platform_libs/v0/s3.py +0 -0
  43. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/lib/charms/data_platform_libs/v1/data_models.py +0 -0
  44. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/lib/charms/glauth_k8s/v0/ldap.py +0 -0
  45. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/managers/__init__.py +0 -0
  46. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/managers/async_replication.py +0 -0
  47. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/managers/backup.py +0 -0
  48. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/managers/base.py +0 -0
  49. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/managers/cluster.py +0 -0
  50. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/managers/database.py +0 -0
  51. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/managers/k8s.py +0 -0
  52. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/managers/patroni.py +0 -0
  53. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/managers/refresh.py +0 -0
  54. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/managers/restore.py +0 -0
  55. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/managers/tls.py +0 -0
  56. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/scripts/authorisation_rules_observer.py +0 -0
  57. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/scripts/cluster_topology_observer.py +0 -0
  58. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/scripts/raft_observer.py +0 -0
  59. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/scripts/rotate_logs.py +0 -0
  60. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/templates/__init__.py +0 -0
  61. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/templates/k8s/pgbackrest.conf.j2 +0 -0
  62. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/templates/k8s/pgbackrest.logrotate.j2 +0 -0
  63. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/templates/vm/pgbackrest.conf.j2 +0 -0
  64. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/templates/vm/pgbackrest.logrotate.j2 +0 -0
  65. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/utils/__init__.py +0 -0
  66. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/utils/arch.py +0 -0
  67. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/utils/backup.py +0 -0
  68. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/utils/filesystem.py +0 -0
  69. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/utils/postgresql.py +0 -0
  70. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/utils/s3.py +0 -0
  71. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/utils/secret.py +0 -0
  72. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/utils/status.py +0 -0
  73. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/workload/__init__.py +0 -0
  74. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/workload/base.py +0 -0
  75. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/workload/k8s.py +0 -0
  76. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/workload/paths/__init__.py +0 -0
  77. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/workload/paths/base.py +0 -0
  78. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/workload/paths/k8s.py +0 -0
  79. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/workload/paths/vm.py +0 -0
  80. {postgresql_charms_single_kernel-16.3.14 → postgresql_charms_single_kernel-16.3.16}/single_kernel_postgresql/workload/vm.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.3
2
2
  Name: postgresql-charms-single-kernel
3
- Version: 16.3.14
3
+ Version: 16.3.16
4
4
  Summary: Shared and reusable code for PostgreSQL-related charms
5
5
  Author: Canonical Data Platform
6
6
  Author-email: Canonical Data Platform <data-platform@lists.launchpad.net>
@@ -1,7 +1,7 @@
1
1
  [project]
2
2
  name = "postgresql-charms-single-kernel"
3
3
  description = "Shared and reusable code for PostgreSQL-related charms"
4
- version = "16.3.14"
4
+ version = "16.3.16"
5
5
  readme = "README.md"
6
6
  classifiers = [
7
7
  "Development Status :: 3 - Alpha",
@@ -50,7 +50,7 @@ k8s = [
50
50
  db-driver = ["psycopg2>=2.9.10"]
51
51
 
52
52
  [build-system]
53
- requires = ["uv_build>=0.12.1,<0.13.0"]
53
+ requires = ["uv_build>=0.13.0,<0.14.0"]
54
54
  build-backend = "uv_build"
55
55
 
56
56
  [tool.uv]
@@ -4,7 +4,7 @@
4
4
  [project]
5
5
  name = "postgresql-charms-single-kernel"
6
6
  description = "Shared and reusable code for PostgreSQL-related charms"
7
- version = "16.3.14"
7
+ version = "16.3.16"
8
8
  readme = "README.md"
9
9
  license = {file = "LICENSE"}
10
10
  authors = [
@@ -52,7 +52,7 @@ db-driver = [
52
52
  ]
53
53
 
54
54
  [build-system]
55
- requires = ["uv_build>=0.12.1,<0.13.0"]
55
+ requires = ["uv_build>=0.13.0,<0.14.0"]
56
56
  build-backend = "uv_build"
57
57
 
58
58
  [tool.uv]
@@ -33,6 +33,17 @@ SYSTEM_USERS = [BACKUP_USER, MONITORING_USER, REPLICATION_USER, REWIND_USER, USE
33
33
  # Extensions
34
34
  PG_CRON_DATABASE = "postgres"
35
35
 
36
+ # Libraries the charm pins into `shared_preload_libraries`, in load order.
37
+ # ConfigManager renders only the libraries the installed snap actually ships,
38
+ # so an older snap never receives a preload entry it cannot load.
39
+ SHARED_PRELOAD_LIBRARIES = (
40
+ "timescaledb",
41
+ "pgaudit",
42
+ "set_user",
43
+ "pg_stat_statements",
44
+ "pg_cron",
45
+ )
46
+
36
47
  # Paths
37
48
  ## VM Paths
38
49
  BASE_SNAP_DIR = f"/var/snap/{POSTGRESQL_SNAP_NAME}"
@@ -227,3 +238,8 @@ VM_CHARM_NAME = "postgresql"
227
238
  K8S_CHARM_NAME = "postgresql-k8s"
228
239
  K8S_OCI_RESOURCE_NAME = "postgresql-image"
229
240
  LAST_REFRESH_UNIT_STATUS_FILE = ".last_refresh_unit_status.json"
241
+
242
+ # Observers log path
243
+ OBSERVER_K8S_LOG_FILE_PATH = "/var/log/authorisation_rules_observer.log"
244
+ OBSERVER_VM_LOG_FILE_PATH = "/var/log/cluster_topology_observer.log"
245
+ JUJU_RUN_CMD = "/usr/bin/juju-exec"
@@ -101,6 +101,44 @@ class PostgreSQLPeer(PeerRelationState):
101
101
  return
102
102
  self.relation.data[self.unit]["rotate-logs-pid"] = str(value) if value else ""
103
103
 
104
+ @property
105
+ def observer_pid(self) -> int | None:
106
+ """Get the observer PID from the unit peer relation data."""
107
+ if not self.relation:
108
+ return None
109
+ stored = self.relation.data[self.unit].get("observer-pid")
110
+ try:
111
+ return int(stored) if stored else None
112
+ except ValueError:
113
+ return None
114
+
115
+ @observer_pid.setter
116
+ def observer_pid(self, value: int | None) -> None:
117
+ """Set or clear the observer PID in the unit peer relation data."""
118
+ if not self.relation:
119
+ return
120
+ self.relation.data[self.unit]["observer-pid"] = str(value) if value else ""
121
+
122
+ @property
123
+ def authorisation_rules_observer_pid(self) -> int | None:
124
+ """Get the observer PID from the unit peer relation data."""
125
+ if not self.relation:
126
+ return None
127
+ stored = self.relation.data[self.unit].get("authorisation-rules-observer-pid")
128
+ try:
129
+ return int(stored) if stored else None
130
+ except ValueError:
131
+ return None
132
+
133
+ @authorisation_rules_observer_pid.setter
134
+ def authorisation_rules_observer_pid(self, value: int | None) -> None:
135
+ """Set or clear the observer PID in the unit peer relation data."""
136
+ if not self.relation:
137
+ return
138
+ self.relation.data[self.unit]["authorisation-rules-observer-pid"] = (
139
+ str(value) if value else ""
140
+ )
141
+
104
142
  @property
105
143
  def is_blocked_status(self) -> bool:
106
144
  """Returns whether the unit is in a blocked state."""
@@ -0,0 +1,98 @@
1
+ # Copyright 2023 Canonical Ltd.
2
+ # See LICENSE file for licensing details.
3
+ """Observer Event Handler."""
4
+
5
+ import logging
6
+ from datetime import datetime
7
+ from typing import TYPE_CHECKING
8
+
9
+ from ops import CharmEvents, EventBase, EventSource, Object
10
+
11
+ from single_kernel_postgresql.config.enums import Substrates
12
+
13
+ if TYPE_CHECKING:
14
+ from single_kernel_postgresql.charms.abstract_charm import AbstractPostgreSQLCharm
15
+ from single_kernel_postgresql.core.state import CharmState
16
+ from single_kernel_postgresql.events.watcher import WatcherEventsHandler
17
+ from single_kernel_postgresql.managers.async_replication import AsyncReplicationManager
18
+ from single_kernel_postgresql.managers.database import DatabaseManager
19
+ from single_kernel_postgresql.managers.patroni import PatroniManager
20
+ from single_kernel_postgresql.managers.tls import TLSManager
21
+ from single_kernel_postgresql.workload.base import BaseWorkload
22
+
23
+ logger = logging.getLogger(__name__)
24
+
25
+
26
+ class ClusterTopologyChangeEvent(EventBase):
27
+ """A custom event for cluster topology changes."""
28
+
29
+
30
+ class DatabasesChangeEvent(EventBase):
31
+ """A custom event for databases changes."""
32
+
33
+
34
+ class RaftReconnectEvent(EventBase):
35
+ """A custom event for databases changes."""
36
+
37
+
38
+ class ClusterTopologyChangeCharmEvents(CharmEvents):
39
+ """A CharmEvents extension for cluster topology changes.
40
+
41
+ Includes :class:`ClusterTopologyChangeEvent` in those that can be handled.
42
+ """
43
+
44
+ cluster_topology_change = EventSource(ClusterTopologyChangeEvent)
45
+ databases_change = EventSource(DatabasesChangeEvent)
46
+ raft_reconnect = EventSource(RaftReconnectEvent)
47
+
48
+
49
+ class ObserverEventsHandler(Object):
50
+ """Handler for observer script events."""
51
+
52
+ def __init__(
53
+ self,
54
+ charm: "AbstractPostgreSQLCharm",
55
+ workload: "BaseWorkload",
56
+ state: "CharmState",
57
+ async_replication_manager: "AsyncReplicationManager",
58
+ database_manager: "DatabaseManager",
59
+ patroni_manager: "PatroniManager",
60
+ tls_manager: "TLSManager",
61
+ watcher_handler: "WatcherEventsHandler",
62
+ ):
63
+ super().__init__(charm, "observer")
64
+ self.charm = charm
65
+ self.state = state
66
+ self.workload = workload
67
+ self.watcher_handler = watcher_handler
68
+ self.async_replication_manager = async_replication_manager
69
+ self.database_manager = database_manager
70
+ self.patroni_manager = patroni_manager
71
+ self.tls_manager = tls_manager
72
+
73
+ if self.state.substrate == Substrates.VM:
74
+ self.framework.observe(
75
+ self.charm.on.cluster_topology_change, self._on_cluster_topology_change
76
+ )
77
+ self.framework.observe(self.charm.on.databases_change, self._on_databases_change)
78
+
79
+ def _on_databases_change(self, _):
80
+ """Handle databases change event."""
81
+ self.charm.update_config()
82
+ logger.debug("databases changed")
83
+ timestamp = datetime.now()
84
+ self.state.peer.data.update({"timestamp": str(timestamp)})
85
+ logger.debug(f"authorisation rules changed at {timestamp}")
86
+
87
+ def _on_cluster_topology_change(self, _):
88
+ """Updates endpoints and (optionally) certificates when the cluster topology changes."""
89
+ logger.info("Cluster topology changed")
90
+ if self.state.primary_endpoint:
91
+ self.database_manager.update_endpoints(
92
+ online_members=self.patroni_manager.online_cluster_members()
93
+ if self.state.peer.is_app_leader
94
+ else None,
95
+ client_tls_files=self.tls_manager.get_client_tls_files(),
96
+ )
97
+ self.charm.set_primary_status_message()
98
+ self.async_replication_manager.update_async_replication_data()
@@ -9,6 +9,7 @@ Responsible for managing the configuration of the PostgreSQL instance.
9
9
 
10
10
  import importlib.resources
11
11
  import logging
12
+ import pathlib
12
13
  from collections.abc import Callable
13
14
  from functools import cached_property
14
15
  from hashlib import shake_128
@@ -26,8 +27,10 @@ from single_kernel_postgresql.config.exceptions import PostgreSQLCannotConnectEr
26
27
  from single_kernel_postgresql.config.literals import (
27
28
  PG_CRON_DATABASE,
28
29
  PGBACKREST_CONF_FILE,
30
+ POSTGRESQL_SNAP_NAME,
29
31
  POSTGRESQL_STORAGE_PERMISSIONS,
30
32
  REWIND_USER,
33
+ SHARED_PRELOAD_LIBRARIES,
31
34
  USER,
32
35
  )
33
36
  from single_kernel_postgresql.config.statuses import GeneralStatuses
@@ -48,6 +51,16 @@ if TYPE_CHECKING:
48
51
  logger = logging.getLogger(__name__)
49
52
 
50
53
 
54
+ def _snap_provided_libraries() -> set[str]:
55
+ """Libraries shipped by the currently installed PostgreSQL snap."""
56
+ return {
57
+ path.stem
58
+ for path in pathlib.Path(f"/snap/{POSTGRESQL_SNAP_NAME}/current/usr/lib/postgresql").glob(
59
+ "*/lib/*.so"
60
+ )
61
+ }
62
+
63
+
51
64
  class ConfigManager(BaseManager):
52
65
  """PostgreSQL Config Manager.
53
66
 
@@ -699,6 +712,9 @@ class ConfigManager(BaseManager):
699
712
  "extra_replication_endpoints": async_standby_endpoints,
700
713
  }
701
714
  if self.state.substrate == Substrates.VM:
715
+ # The installed snap may predate a library the charm pins (e.g.
716
+ # pg_cron); only preload what the snap actually ships.
717
+ snap_libraries = _snap_provided_libraries()
702
718
  confs.update({
703
719
  "conf_path": str(self.workload.paths.patroni_conf),
704
720
  "log_path": str(self.workload.paths.patroni_logs),
@@ -713,6 +729,10 @@ class ConfigManager(BaseManager):
713
729
  "listen_ips": self.state.listen_ips,
714
730
  "raft_password": self.state.application.raft_password,
715
731
  "watcher": watcher_raft_address,
732
+ "pg_cron_available": "pg_cron" in snap_libraries,
733
+ "shared_preload_libraries": ",".join(
734
+ library for library in SHARED_PRELOAD_LIBRARIES if library in snap_libraries
735
+ ),
716
736
  })
717
737
  perms = 0o600
718
738
  else:
@@ -725,6 +745,8 @@ class ConfigManager(BaseManager):
725
745
  "logs_storage_path": str(self.workload.paths.logs),
726
746
  "pgdata_path": str(self.workload.paths.data),
727
747
  "restoring_backup": backup_id is not None or pitr_target is not None,
748
+ "pg_cron_available": True,
749
+ "shared_preload_libraries": ",".join(SHARED_PRELOAD_LIBRARIES),
728
750
  })
729
751
  perms = 0o644
730
752
  rendered = template.render(**confs)
@@ -0,0 +1,152 @@
1
+ # Copyright 2023 Canonical Ltd.
2
+ # See LICENSE file for licensing details.
3
+
4
+ """Observer scripts manager."""
5
+
6
+ import logging
7
+ import os
8
+ import signal
9
+ import subprocess
10
+ from pathlib import Path
11
+ from sys import version_info
12
+ from typing import TYPE_CHECKING
13
+
14
+ from ops import ActiveStatus
15
+
16
+ from single_kernel_postgresql.config.enums import Substrates
17
+ from single_kernel_postgresql.config.literals import (
18
+ JUJU_RUN_CMD,
19
+ OBSERVER_K8S_LOG_FILE_PATH,
20
+ OBSERVER_VM_LOG_FILE_PATH,
21
+ )
22
+ from single_kernel_postgresql.managers.base import BaseManager
23
+
24
+ if TYPE_CHECKING:
25
+ from single_kernel_postgresql.core.state import CharmState
26
+ from single_kernel_postgresql.workload.base import BaseWorkload
27
+
28
+
29
+ logger = logging.getLogger(__name__)
30
+
31
+
32
+ class ObserverManager(BaseManager):
33
+ """Handles cross substrate observer scripts."""
34
+
35
+ def __init__(self, state: "CharmState", workload: "BaseWorkload") -> None:
36
+ super().__init__(state, workload, "observer_manager")
37
+
38
+ def start_observer(self) -> None:
39
+ """Start the cluster topology observer running in a new process."""
40
+ if (
41
+ not isinstance(self.state.peer.unit.status, ActiveStatus)
42
+ or self.state.peer_relation is None
43
+ ):
44
+ return
45
+ if self.state.substrate == Substrates.VM:
46
+ pid = self.state.peer.observer_pid
47
+ script = "single_kernel_postgresql.scripts.cluster_topology_observer"
48
+ log_file_path = OBSERVER_VM_LOG_FILE_PATH
49
+ else:
50
+ pid = self.state.peer.authorisation_rules_observer_pid
51
+ script = "single_kernel_postgresql.scripts.authorisation_rules_observer"
52
+ log_file_path = OBSERVER_K8S_LOG_FILE_PATH
53
+ if pid:
54
+ # Double check that the PID exists
55
+ try:
56
+ os.kill(pid, 0)
57
+ return
58
+ except OSError:
59
+ pass
60
+ if not self.state.unit_ip:
61
+ logging.info("Cannot start cluster topology observer process: No IP set")
62
+ return
63
+
64
+ logging.info("Starting cluster topology observer process")
65
+
66
+ # We need to trick Juju into thinking that we are not running
67
+ # in a hook context, as Juju will disallow use of juju-run.
68
+ new_env = os.environ.copy()
69
+ if "JUJU_CONTEXT_ID" in new_env:
70
+ new_env.pop("JUJU_CONTEXT_ID")
71
+ # Generate the venv path based on the existing lib path
72
+ for loc in new_env["PYTHONPATH"].split(":"):
73
+ path = Path(loc)
74
+ venv_path = (
75
+ path
76
+ / ".."
77
+ / "venv"
78
+ / "lib"
79
+ / f"python{version_info.major}.{version_info.minor}"
80
+ / "site-packages"
81
+ )
82
+ if path.stem == "lib":
83
+ new_env["PYTHONPATH"] = f"{venv_path.resolve()}:{new_env['PYTHONPATH']}"
84
+ break
85
+
86
+ urls = [self.state.patroni_url] + [
87
+ self.state.patroni_url.replace(self.state.unit_ip, peer)
88
+ for peer in list(self.state.peer_members_ips)
89
+ ]
90
+
91
+ # Input is generated by the charm
92
+ pid = subprocess.Popen( # noqa: S603
93
+ [
94
+ "/usr/bin/python3",
95
+ "-m",
96
+ script,
97
+ ",".join(urls),
98
+ JUJU_RUN_CMD,
99
+ self.state.model.unit.name,
100
+ self.state.framework.charm_dir,
101
+ ],
102
+ # File shouldn't close
103
+ stdout=open(log_file_path, "a"), # noqa: SIM115
104
+ stderr=subprocess.STDOUT,
105
+ env=new_env,
106
+ ).pid
107
+
108
+ if self.state.substrate == Substrates.VM:
109
+ self.state.peer.observer_pid = pid
110
+ else:
111
+ self.state.peer.authorisation_rules_observer_pid = pid
112
+ logging.info(f"Started observer process with PID {pid}")
113
+
114
+ def stop_observer(self):
115
+ """Stop the running observer process if we have previously started it."""
116
+ if self.state.peer_relation is None:
117
+ return
118
+
119
+ if self.state.substrate == Substrates.VM:
120
+ pid = self.state.peer.observer_pid
121
+ else:
122
+ pid = self.state.peer.authorisation_rules_observer_pid
123
+ if pid:
124
+ try:
125
+ os.kill(pid, signal.SIGINT)
126
+ msg = "Stopped running cluster topology observer process with PID {}"
127
+ logging.info(msg.format(pid))
128
+ self.state.peer.observer_pid = None
129
+ except OSError:
130
+ pass
131
+
132
+
133
+ def copy_environment() -> dict[str, str]:
134
+ """Environment variables to pass to a script."""
135
+ new_env = os.environ.copy()
136
+ if "JUJU_CONTEXT_ID" in new_env:
137
+ new_env.pop("JUJU_CONTEXT_ID")
138
+ # Generate the venv path based on the existing lib path
139
+ for loc in new_env["PYTHONPATH"].split(":"):
140
+ path = Path(loc)
141
+ venv_path = (
142
+ path
143
+ / ".."
144
+ / "venv"
145
+ / "lib"
146
+ / f"python{version_info.major}.{version_info.minor}"
147
+ / "site-packages"
148
+ )
149
+ if path.stem == "lib":
150
+ new_env["PYTHONPATH"] = f"{venv_path.resolve()}:{new_env['PYTHONPATH']}"
151
+ break
152
+ return {var: val for var, val in new_env.items() if "JUJU" in var or "PATH" in var}
@@ -122,10 +122,12 @@ bootstrap:
122
122
  log_truncate_on_rotation: 'on'
123
123
  logging_collector: 'on'
124
124
  wal_level: logical
125
- shared_preload_libraries: 'timescaledb,pgaudit,set_user,pg_stat_statements,pg_cron'
125
+ shared_preload_libraries: '{{ shared_preload_libraries }}'
126
+ {%- if pg_cron_available %}
126
127
  cron.database_name: '{{ pg_cron_database }}'
127
128
  cron.use_background_workers: 'on'
128
129
  cron.timezone: 'GMT'
130
+ {%- endif %}
129
131
  session_preload_libraries: 'login_hook'
130
132
  set_user.block_log_statement: 'on'
131
133
  set_user.exit_on_error: 'on'
@@ -188,10 +190,12 @@ postgresql:
188
190
  bin_dir: {{ pg_bin_dir }}
189
191
  data_dir: {{ data_dir }}
190
192
  parameters:
191
- shared_preload_libraries: 'timescaledb,pgaudit,set_user,pg_stat_statements,pg_cron'
193
+ shared_preload_libraries: '{{ shared_preload_libraries }}'
194
+ {%- if pg_cron_available %}
192
195
  cron.database_name: '{{ pg_cron_database }}'
193
196
  cron.use_background_workers: 'on'
194
197
  cron.timezone: 'GMT'
198
+ {%- endif %}
195
199
  session_preload_libraries: 'login_hook'
196
200
  set_user.block_log_statement: 'on'
197
201
  set_user.exit_on_error: 'on'