[DPE-5830] Bump to 24.04 (#495)

Update CI pipeline to enable 24.04 support. Change list: - `charmcraft.yaml` uses charmcraftst124 syntax to enable building on multiple bases - Charm now uses bin commands exposed though the snap: `opensearch.<bin-command>` - `tmpfiles` are now created inside the snap folders so the snap commands are able to access them - small fixes and additions on unit tests - update `juju` version that fixes storage and websockets issues ------------ TODO: After this PR, some tasks will need addressing: - [Migration of CI](https://warthogs.atlassian.net/browse/DPE-6251) to use charmcraft 3 support - [Provider tests bug with the app charm](https://warthogs.atlassian.net/browse/DPE-6252) --------- Co-authored-by: Raul Zamora <[email protected]>
canonical · Dec 19, 2024 · 51bd955 · 51bd955
1 parent c11cd1c
commit 51bd955
Show file tree

Hide file tree

Showing 16 changed files with 626 additions and 549 deletions.
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -16,7 +16,7 @@ on:
 jobs:
   lint:
     name: Lint
-    uses: canonical/data-platform-workflows/.github/workflows/lint.yaml@v22.0.0
+    uses: canonical/data-platform-workflows/.github/workflows/lint.yaml@v23.1.1
 
   unit-test:
     name: Unit test charm
@@ -132,10 +132,11 @@ jobs:
         path:
         - .
         - ./tests/integration/relations/opensearch_provider/application-charm/
-    uses: canonical/data-platform-workflows/.github/workflows/build_charm.yaml@v22.0.0
+    uses: canonical/data-platform-workflows/.github/workflows/build_charm.yaml@beta-charmcraftst124
     with:
       path-to-charm-directory: ${{ matrix.path }}
-      cache: true
+      cache: false
+      # charmcraft-snap-revision: 5303
 
   integration-test:
     strategy:
@@ -153,12 +154,12 @@ jobs:
       - lint
       - unit-test
       - build
-    uses: canonical/data-platform-workflows/.github/workflows/integration_test_charm.yaml@v22.0.0
+    uses: canonical/data-platform-workflows/.github/workflows/integration_test_charm.yaml@v23.1.1
     with:
       juju-agent-version: ${{ matrix.juju.agent }}
       juju-snap-channel: ${{ matrix.juju.snap_channel }}
       _beta_allure_report: ${{ matrix.juju.allure_report }}
-      artifact-prefix: packed-charm-cache-true
+      artifact-prefix: packed-charm-cache-false
       cloud: lxd
     secrets:
       # GitHub appears to redact each line of a multi-line secret

diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -34,13 +34,13 @@ jobs:
 
   build:
     name: Build charm
-    uses: canonical/data-platform-workflows/.github/workflows/build_charm.yaml@v22.0.0
+    uses: canonical/data-platform-workflows/.github/workflows/build_charm.yaml@beta-charmcraftst124
 
   release:
     name: Release charm
     needs:
       - build
-    uses: canonical/data-platform-workflows/.github/workflows/release_charm.yaml@v22.0.0
+    uses: canonical/data-platform-workflows/.github/workflows/release_charm.yaml@beta-charmcraftst124
     with:
       channel: 2/edge
       artifact-prefix: ${{ needs.build.outputs.artifact-prefix }}

diff --git a/charmcraft-24.04.patch b/charmcraft-24.04.patch
@@ -0,0 +1,9 @@
+@@ -2,7 +2,7 @@
+ # See LICENSE file for licensing details.
+
+ type: charm
+-base: [email protected]
++base: [email protected]
+ platforms:
+   amd64:
+ parts:
diff --git a/charmcraft.yaml b/charmcraft.yaml
@@ -2,13 +2,18 @@
 # See LICENSE file for licensing details.
 
 type: charm
-bases:
-  - build-on:
-      - name: "ubuntu"
-        channel: "22.04"
-    run-on:
-      - name: "ubuntu"
-        channel: "22.04"
+# base: [email protected]
+# platforms:
+#   amd64:
+# Use upcoming ST124 syntax
+# To pack this charm, a temporary compatibility wrapper https://github.com/canonical/charmcraftst124
+# is required until ST124 support is added to charmcraft
+# (ST124 syntax is needed to enable multi-base charms with Ubuntu 24.04. We use ST124 syntax across
+# all of our charms [even those that aren't multi base] for consistency and to simplify CI/CD
+# maintenance & tooling)
+platforms:
+  [email protected]:amd64:
+  [email protected]:amd64:
 parts:
   files:
     plugin: dump

diff --git a/lib/charms/opensearch/v0/constants_charm.py b/lib/charms/opensearch/v0/constants_charm.py
@@ -114,7 +114,7 @@
 
 
 # Opensearch Snap revision
-OPENSEARCH_SNAP_REVISION = 58  # Keep in sync with `workload_version` file
+OPENSEARCH_SNAP_REVISION = 62  # Keep in sync with `workload_version` file
 
 # User-face Backup ID format
 OPENSEARCH_BACKUP_ID_FORMAT = "%Y-%m-%dT%H:%M:%SZ"

diff --git a/lib/charms/opensearch/v0/opensearch_distro.py b/lib/charms/opensearch/v0/opensearch_distro.py
@@ -197,23 +197,23 @@ def is_node_up(self, host: Optional[str] = None) -> bool:
             return False
 
     def run_bin(self, bin_script_name: str, args: str = None, stdin: str = None) -> str:
-        """Run opensearch provided bin command, relative to OPENSEARCH_BIN.
+        """Run opensearch provided bin command, through the snap.
 
         Args:
             bin_script_name: opensearch script located in OPENSEARCH_BIN to be executed
             args: arguments passed to the script
             stdin: string input to be passed on the standard input of the subprocess.
         """
-        script_path = f"{self.paths.bin}/{bin_script_name}"
-        return self._run_cmd(script_path, args, stdin=stdin)
+        opensearch_command = f"opensearch.{bin_script_name}"
+        return self._run_cmd(opensearch_command, args, stdin=stdin)
 
     def run_script(self, script_name: str, args: str = None):
         """Run script provided by Opensearch in another directory, relative to OPENSEARCH_HOME."""
         script_path = f"{self.paths.home}/{script_name}"
         if not os.access(script_path, os.X_OK):
             self._run_cmd(f"chmod a+x {script_path}")
 
-        self._run_cmd(f"{script_path}", args)
+        self._run_cmd(f"snap run --shell opensearch.daemon -- {script_path}", args)
 
     def request(  # noqa
         self,

diff --git a/lib/charms/opensearch/v0/opensearch_keystore.py b/lib/charms/opensearch/v0/opensearch_keystore.py
@@ -41,7 +41,7 @@ def __init__(self, charm):
         """Creates the keystore manager class."""
         self._charm = charm
         self._opensearch = charm.opensearch
-        self._keytool = charm.opensearch.paths.jdk + "/bin/keytool"
+        self._keytool = "opensearch.keytool"
         self._keystore = ""
         self._password = None
 
@@ -132,7 +132,7 @@ class OpenSearchKeystore(Keystore):
     def __init__(self, charm):
         """Creates the keystore manager class."""
         super().__init__(charm)
-        self._keytool = "opensearch-keystore"
+        self._keytool = "keystore"
 
     def add(self, entries: Dict[str, str]) -> None:
         """Adds a given key to the "opensearch" keystore."""

diff --git a/lib/charms/opensearch/v0/opensearch_plugin_manager.py b/lib/charms/opensearch/v0/opensearch_plugin_manager.py
@@ -221,7 +221,7 @@ def _install_plugin(self, plugin: OpenSearchPlugin) -> bool:
             if missing_deps:
                 raise OpenSearchPluginMissingDepsError(plugin.name, missing_deps)
 
-            self._opensearch.run_bin("opensearch-plugin", f"install --batch {plugin.name}")
+            self._opensearch.run_bin("plugin", f"install --batch {plugin.name}")
         except KeyError as e:
             raise OpenSearchPluginMissingConfigError(e)
         except OpenSearchCmdError as e:
@@ -418,7 +418,7 @@ def _remove_if_needed(self, plugin: OpenSearchPlugin) -> bool:
     def _remove_plugin(self, plugin: OpenSearchPlugin) -> bool:
         """Remove a plugin without restarting the node."""
         try:
-            self._opensearch.run_bin("opensearch-plugin", f"remove {plugin.name}")
+            self._opensearch.run_bin("plugin", f"remove {plugin.name}")
         except OpenSearchCmdError as e:
             if "not found" in str(e):
                 logger.info(f"Plugin {plugin.name} to be deleted, not found. Continuing...")
@@ -429,6 +429,6 @@ def _remove_plugin(self, plugin: OpenSearchPlugin) -> bool:
     def _installed_plugins(self) -> List[str]:
         """List plugins."""
         try:
-            return self._opensearch.run_bin("opensearch-plugin", "list").split("\n")
+            return self._opensearch.run_bin("plugin", "list").split("\n")
         except OpenSearchCmdError as e:
             raise OpenSearchPluginError("Failed to list plugins: " + str(e))
diff --git a/lib/charms/opensearch/v0/opensearch_tls.py b/lib/charms/opensearch/v0/opensearch_tls.py
@@ -79,7 +79,7 @@ def __init__(
         self.peer_relation = peer_relation
         self.jdk_path = jdk_path
         self.certs_path = certs_path
-        self.keytool = self.jdk_path + "/bin/keytool"
+        self.keytool = "opensearch.keytool"
         self.certs = TLSCertificatesRequiresV3(charm, TLS_RELATION, expiry_notification_time=23)
 
         self.framework.observe(
@@ -513,8 +513,6 @@ def _create_keystore_pwd_if_not_exists(self, scope: Scope, cert_type: CertType,
 
     def store_new_ca(self, secrets: Dict[str, Any]) -> bool:  # noqa: C901
         """Add new CA cert to trust store."""
-        keytool = f"sudo {self.jdk_path}/bin/keytool"
-
         if not (deployment_desc := self.charm.opensearch_peer_cm.deployment_desc()):
             return False
 
@@ -532,7 +530,7 @@ def store_new_ca(self, secrets: Dict[str, Any]) -> bool:  # noqa: C901
 
         try:
             run_cmd(
-                f"""{keytool} -changealias \
+                f"""{self.keytool} -changealias \
                 -alias {alias} \
                 -destalias old-{alias} \
                 -keystore {store_path} \
@@ -549,13 +547,15 @@ def store_new_ca(self, secrets: Dict[str, Any]) -> bool:  # noqa: C901
             ):
                 raise
 
-        with tempfile.NamedTemporaryFile(mode="w+t") as ca_tmp_file:
+        with tempfile.NamedTemporaryFile(
+            mode="w+t", dir=self.charm.opensearch.paths.conf
+        ) as ca_tmp_file:
             ca_tmp_file.write(secrets.get("ca-cert"))
             ca_tmp_file.flush()
 
             try:
                 run_cmd(
-                    f"""{keytool} -importcert \
+                    f"""{self.keytool} -importcert \
                     -trustcacerts \
                     -noprompt \
                     -alias {alias} \
@@ -604,7 +604,6 @@ def read_stored_ca(self, alias: str = "ca") -> Optional[str]:
 
     def remove_old_ca(self) -> None:
         """Remove old CA cert from trust store."""
-        keytool = f"sudo {self.jdk_path}/bin/keytool"
         ca_trust_store = f"{self.certs_path}/ca.p12"
         old_alias = "old-ca"
 
@@ -613,7 +612,7 @@ def remove_old_ca(self) -> None:
 
         try:
             run_cmd(
-                f"""{keytool} \
+                f"""{self.keytool} \
                 -list \
                 -keystore {ca_trust_store} \
                 -storepass {store_pwd} \
@@ -628,7 +627,7 @@ def remove_old_ca(self) -> None:
         old_ca_content = self.read_stored_ca(alias=old_alias)
 
         run_cmd(
-            f"""{keytool} \
+            f"""{self.keytool} \
             -delete \
             -keystore {ca_trust_store} \
             -storepass {store_pwd} \
@@ -672,12 +671,16 @@ def store_new_tls_resources(self, cert_type: CertType, secrets: Dict[str, Any]):
         except OSError:
             pass
 
-        tmp_key = tempfile.NamedTemporaryFile(mode="w+t", suffix=".pem")
+        tmp_key = tempfile.NamedTemporaryFile(
+            mode="w+t", suffix=".pem", dir=self.charm.opensearch.paths.conf
+        )
         tmp_key.write(secrets.get("key"))
         tmp_key.flush()
         tmp_key.seek(0)
 
-        tmp_cert = tempfile.NamedTemporaryFile(mode="w+t", suffix=".cert")
+        tmp_cert = tempfile.NamedTemporaryFile(
+            mode="w+t", suffix=".cert", dir=self.charm.opensearch.paths.conf
+        )
         tmp_cert.write(secrets.get("cert"))
         tmp_cert.flush()
         tmp_cert.seek(0)
@@ -714,7 +717,7 @@ def all_tls_resources_stored(self, only_unit_resources: bool = False) -> bool:
             return False
 
         # to make sure the content is processed correctly by openssl, temporary store it in a file
-        tmp_ca_file = tempfile.NamedTemporaryFile(mode="w+t")
+        tmp_ca_file = tempfile.NamedTemporaryFile(mode="w+t", dir=self.charm.opensearch.paths.conf)
         tmp_ca_file.write(current_ca)
         tmp_ca_file.flush()
         tmp_ca_file.seek(0)
@@ -819,12 +822,12 @@ def reload_tls_certificates(self):
         # using the SSL API requires authentication with app-admin cert and key
         admin_secret = self.charm.secrets.get_object(Scope.APP, CertType.APP_ADMIN.val)
 
-        tmp_cert = tempfile.NamedTemporaryFile(mode="w+t")
+        tmp_cert = tempfile.NamedTemporaryFile(mode="w+t", dir=self.charm.opensearch.paths.conf)
         tmp_cert.write(admin_secret["cert"])
         tmp_cert.flush()
         tmp_cert.seek(0)
 
-        tmp_key = tempfile.NamedTemporaryFile(mode="w+t")
+        tmp_key = tempfile.NamedTemporaryFile(mode="w+t", dir=self.charm.opensearch.paths.conf)
         tmp_key.write(admin_secret["key"])
         tmp_key.flush()
         tmp_key.seek(0)