Merge remote-tracking branch 'canorigin/main' into deployment-zero-units

Author: BalabaDmitri

.github/workflows/ci.yaml

@@ -22,7 +22,7 @@ on:
 jobs:
   lint:
     name: Lint
-    uses: canonical/data-platform-workflows/.github/workflows/[email protected].1
+    uses: canonical/data-platform-workflows/.github/workflows/[email protected].2
 
   unit-test:
     name: Unit test charm
@@ -42,7 +42,7 @@ jobs:
 
   build:
     name: Build charm
-    uses: canonical/data-platform-workflows/.github/workflows/[email protected].1
+    uses: canonical/data-platform-workflows/.github/workflows/[email protected].2
     with:
       cache: true
 
@@ -61,7 +61,7 @@ jobs:
       - lint
       - unit-test
       - build
-    uses: canonical/data-platform-workflows/.github/workflows/[email protected].1
+    uses: canonical/data-platform-workflows/.github/workflows/[email protected].2
     with:
       artifact-prefix: ${{ needs.build.outputs.artifact-prefix }}
       cloud: lxd

.github/workflows/release.yaml

@@ -24,14 +24,14 @@ jobs:
 
   build:
     name: Build charm
-    uses: canonical/data-platform-workflows/.github/workflows/[email protected].1
+    uses: canonical/data-platform-workflows/.github/workflows/[email protected].2
 
   release:
     name: Release charm
     needs:
       - ci-tests
       - build
-    uses: canonical/data-platform-workflows/.github/workflows/[email protected].1
+    uses: canonical/data-platform-workflows/.github/workflows/[email protected].2
     with:
       channel: 14/edge
       artifact-prefix: ${{ needs.build.outputs.artifact-prefix }}

.github/workflows/sync_issue_to_jira.yaml

@@ -9,7 +9,7 @@ on:
 jobs:
   sync:
     name: Sync GitHub issue to Jira
-    uses: canonical/data-platform-workflows/.github/workflows/[email protected].1
+    uses: canonical/data-platform-workflows/.github/workflows/[email protected].2
     with:
       jira-base-url: https://warthogs.atlassian.net
       jira-project-key: DPE

CONTRIBUTING.md

@@ -8,8 +8,7 @@ this operator.
 - Generally, before developing enhancements to this charm, you should consider [opening an issue
   ](https://github.com/canonical/postgresql-operator/issues) explaining your use case.
 - If you would like to chat with us about your use-cases or proposed implementation, you can reach
-  us at [public Canonical Data Platform channel](https://chat.charmhub.io/charmhub/channels/data-platform)
-  or [Discourse](https://discourse.charmhub.io/).
+  us using any channel from our [Contacts](https://charmhub.io/postgresql/docs/r-contacts).
 - Familiarising yourself with the [Charmed Operator Framework](https://juju.is/docs/sdk) library
   will help you a lot when working on new features or bug fixes.
 - All enhancements require review before being merged. Code review typically examines
@@ -40,13 +39,45 @@ tox                      # runs 'lint' and 'unit' environments
 
 ## Build charm
 
-Build the charm in this git repository using:
+The build environment assumes that there are preinstalled on the system:
+* [tox](https://tox.wiki/) (version 4+ !!!)
+* [poetry](https://python-poetry.org/)
+* [charmcraft](https://snapcraft.io/charmcraft)
+* [charmcraftcache](https://github.com/canonical/charmcraftcache)
+* [pipx](https://pipx.pypa.io/stable/installation/)
+* [libpq-dev](https://www.postgresql.org/docs/current/libpq.html)
+
+To build the charm it is also necessary at least 5GB of free disk space and
+it is recommended to provide 4+ CPU cores and 8GB+ RAM for a decent build speed.
+
+To install all above build dependencies (assuming you are on Ubuntu 22.04 LTS):
 
 ```shell
-tox run -e build-dev
+sudo snap install charmcraft --classic
+
+sudo snap install lxd # should be pre-installed on 22.04
+lxd init --auto       # init LXD (if never used earlier)
+
+sudo apt update && sudo apt install --yes libpq-dev pipx
+
+sudo apt purge tox # if old tox version is installed from apt
+
+pipx ensurepath
+pipx install tox
+pipx install poetry
+pipx install charmcraftcache
 ```
 
-The tox build environment assumes that there is a preinstalled [poetry](https://python-poetry.org/) on the system.
+Ensure local pip binaries are in your $PATH (otherwise re-login to your shell):
+```shell
+charmcraftcache --help
+```
+
+Build the charm (inside this Git repository):
+
+```shell
+tox run -e build-dev
+```
 
 ### Deploy
 

poetry.lock

@@ -15,7 +15,7 @@ repository = "https://github.com/canonical/postgresql-operator"
 python = "^3.10"
 ops = "^2.12.0"
 cryptography = "^42.0.5"
-boto3 = "^1.34.85"
+boto3 = "^1.34.86"
 pgconnstr = "^1.0.1"
 requests = "^2.31.0"
 tenacity = "^8.2.3"
@@ -66,10 +66,10 @@ optional = true
 
 [tool.poetry.group.integration.dependencies]
 pytest = "^8.1.1"
-pytest-github-secrets = {git = "https://github.com/canonical/data-platform-workflows", tag = "v13.1.1", subdirectory = "python/pytest_plugins/github_secrets"}
+pytest-github-secrets = {git = "https://github.com/canonical/data-platform-workflows", tag = "v13.1.2", subdirectory = "python/pytest_plugins/github_secrets"}
 pytest-operator = "^0.34.0"
-pytest-operator-cache = {git = "https://github.com/canonical/data-platform-workflows", tag = "v13.1.1", subdirectory = "python/pytest_plugins/pytest_operator_cache"}
-pytest-operator-groups = {git = "https://github.com/canonical/data-platform-workflows", tag = "v13.1.1", subdirectory = "python/pytest_plugins/pytest_operator_groups"}
+pytest-operator-cache = {git = "https://github.com/canonical/data-platform-workflows", tag = "v13.1.2", subdirectory = "python/pytest_plugins/pytest_operator_cache"}
+pytest-operator-groups = {git = "https://github.com/canonical/data-platform-workflows", tag = "v13.1.2", subdirectory = "python/pytest_plugins/pytest_operator_groups"}
 # renovate caret doesn't work: https://github.com/renovatebot/renovate/issues/26940
 juju = "<=3.4.0.0"
 boto3 = "*"

pyproject.toml

@@ -1451,6 +1451,14 @@ def _restart(self, event: RunWithLock) -> None:
             self.unit.status = BlockedStatus(error_message)
             return
 
+        try:
+            for attempt in Retrying(wait=wait_fixed(3), stop_after_delay=stop_after_delay(300)):
+                with attempt:
+                    if not self._can_connect_to_postgresql:
+                        assert False
+        except Exception:
+            logger.exception("Unable to reconnect to postgresql")
+
         # Start or stop the pgBackRest TLS server service when TLS certificate change.
         self.backup.start_stop_pgbackrest_service()
 

src/charm.py

@@ -12,6 +12,7 @@
 PEER = "database-peers"
 UPGRADE_RELATION = "upgrade"
 ALL_CLIENT_RELATIONS = [DATABASE, LEGACY_DB, LEGACY_DB_ADMIN]
+ALL_LEGACY_RELATIONS = [LEGACY_DB, LEGACY_DB_ADMIN]
 API_REQUEST_TIMEOUT = 5
 PATRONI_CLUSTER_STATUS_ENDPOINT = "cluster"
 BACKUP_USER = "backup"
@@ -36,7 +37,7 @@
 SNAP_PACKAGES = [
     (
         POSTGRESQL_SNAP_NAME,
-        {"revision": {"aarch64": "110", "x86_64": "111"}, "channel": "14/stable"},
+        {"revision": {"aarch64": "112", "x86_64": "113"}, "channel": "14/stable"},
     )
 ]
 
@@ -68,3 +69,7 @@
 UNIT_SCOPE = "unit"
 
 SECRET_KEY_OVERRIDES = {"ca": "cauth"}
+
+ENDPOINT_SIMULTANEOUSLY_BLOCKING_MESSAGE = (
+    "Please choose one endpoint to use. No need to relate all of them simultaneously!"
+)

src/constants.py

@@ -21,7 +21,12 @@
 from ops.model import ActiveStatus, BlockedStatus, Relation, Unit
 from pgconnstr import ConnectionString
 
-from constants import APP_SCOPE, DATABASE_PORT
+from constants import (
+    ALL_LEGACY_RELATIONS,
+    APP_SCOPE,
+    DATABASE_PORT,
+    ENDPOINT_SIMULTANEOUSLY_BLOCKING_MESSAGE,
+)
 from utils import new_password
 
 logger = logging.getLogger(__name__)
@@ -87,6 +92,20 @@ def _check_for_blocking_relations(self, relation_id: int) -> bool:
                         return True
         return False
 
+    def _check_exist_current_relation(self) -> bool:
+        for r in self.charm.client_relations:
+            if r in ALL_LEGACY_RELATIONS:
+                return True
+        return False
+
+    def _check_multiple_endpoints(self) -> bool:
+        """Checks if there are relations with other endpoints."""
+        is_exist = self._check_exist_current_relation()
+        for relation in self.charm.client_relations:
+            if relation.name not in ALL_LEGACY_RELATIONS and is_exist:
+                return True
+        return False
+
     def _on_relation_changed(self, event: RelationChangedEvent) -> None:
         """Handle the legacy db/db-admin relation changed event.
 
@@ -96,6 +115,10 @@ def _on_relation_changed(self, event: RelationChangedEvent) -> None:
         if not self.charm.unit.is_leader():
             return
 
+        if self._check_multiple_endpoints():
+            self.charm.unit.status = BlockedStatus(ENDPOINT_SIMULTANEOUSLY_BLOCKING_MESSAGE)
+            return
+
         if (
             "cluster_initialised" not in self.charm._peers.data[self.charm.app]
             or not self.charm._patroni.member_started
@@ -277,6 +300,16 @@ def _update_unit_status(self, relation: Relation) -> None:
         ]:
             if not self._check_for_blocking_relations(relation.id):
                 self.charm.unit.status = ActiveStatus()
+        self._update_unit_status_on_blocking_endpoint_simultaneously()
+
+    def _update_unit_status_on_blocking_endpoint_simultaneously(self):
+        """Clean up Blocked status if this is due related of multiple endpoints."""
+        if (
+            self.charm.is_blocked
+            and self.charm.unit.status.message == ENDPOINT_SIMULTANEOUSLY_BLOCKING_MESSAGE
+        ):
+            if not self._check_multiple_endpoints():
+                self.charm.unit.status = ActiveStatus()
 
     def update_endpoints(self, relation: Relation = None) -> None:
         """Set the read/write and read-only endpoints."""

src/relations/db.py

@@ -17,11 +17,16 @@
     PostgreSQLGetPostgreSQLVersionError,
     PostgreSQLListUsersError,
 )
-from ops.charm import CharmBase, RelationBrokenEvent
+from ops.charm import CharmBase, RelationBrokenEvent, RelationChangedEvent
 from ops.framework import Object
 from ops.model import ActiveStatus, BlockedStatus, Relation
 
-from constants import ALL_CLIENT_RELATIONS, APP_SCOPE, DATABASE_PORT
+from constants import (
+    ALL_CLIENT_RELATIONS,
+    APP_SCOPE,
+    DATABASE_PORT,
+    ENDPOINT_SIMULTANEOUSLY_BLOCKING_MESSAGE,
+)
 from utils import new_password
 
 logger = logging.getLogger(__name__)
@@ -48,7 +53,10 @@ def __init__(self, charm: CharmBase, relation_name: str = "database") -> None:
         self.framework.observe(
             charm.on[self.relation_name].relation_broken, self._on_relation_broken
         )
-
+        self.framework.observe(
+            charm.on[self.relation_name].relation_changed,
+            self._on_relation_changed_event,
+        )
         self.charm = charm
 
         # Charm events defined in the database provides charm library.
@@ -190,6 +198,13 @@ def update_endpoints(self, event: DatabaseRequestedEvent = None) -> None:
                 read_only_endpoints,
             )
 
+    def _check_multiple_endpoints(self) -> bool:
+        """Checks if there are relations with other endpoints."""
+        relation_names = {relation.name for relation in self.charm.client_relations}
+        if "database" in relation_names and len(relation_names) > 1:
+            return True
+        return False
+
     def _update_unit_status(self, relation: Relation) -> None:
         """# Clean up Blocked status if it's due to extensions request."""
         if (
@@ -199,6 +214,27 @@ def _update_unit_status(self, relation: Relation) -> None:
             if not self.check_for_invalid_extra_user_roles(relation.id):
                 self.charm.unit.status = ActiveStatus()
 
+        self._update_unit_status_on_blocking_endpoint_simultaneously()
+
+    def _on_relation_changed_event(self, event: RelationChangedEvent) -> None:
+        """Event emitted when the relation has changed."""
+        # Leader only
+        if not self.charm.unit.is_leader():
+            return
+
+        if self._check_multiple_endpoints():
+            self.charm.unit.status = BlockedStatus(ENDPOINT_SIMULTANEOUSLY_BLOCKING_MESSAGE)
+            return
+
+    def _update_unit_status_on_blocking_endpoint_simultaneously(self):
+        """Clean up Blocked status if this is due related of multiple endpoints."""
+        if (
+            self.charm.is_blocked
+            and self.charm.unit.status.message == ENDPOINT_SIMULTANEOUSLY_BLOCKING_MESSAGE
+        ):
+            if not self._check_multiple_endpoints():
+                self.charm.unit.status = ActiveStatus()
+
     def check_for_invalid_extra_user_roles(self, relation_id: int) -> bool:
         """Checks if there are relations with invalid extra user roles.