Adding NG-LCM charm
Creation of a charm for deploying the existing LCM OCI, but running
a different main() and providing Temporal configuration data
Change-Id: Ibbd636a0dcd9dfde987f83bfee11783080a79155
Signed-off-by: Mark Beierl <mark.beierl@canonical.com>
diff --git a/installers/charm/osm-nglcm/src/charm.py b/installers/charm/osm-nglcm/src/charm.py
new file mode 100755
index 0000000..6773aa8
--- /dev/null
+++ b/installers/charm/osm-nglcm/src/charm.py
@@ -0,0 +1,269 @@
+#!/usr/bin/env python3
+# Copyright 2022 Canonical Ltd.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+#
+# For those usages not covered by the Apache License, Version 2.0 please
+# contact: legal@canonical.com
+#
+# To get in touch with the maintainers, please contact:
+# osm-charmers@lists.launchpad.net
+#
+#
+# Learn more at: https://juju.is/docs/sdk
+
+"""OSM LCM charm.
+
+See more: https://charmhub.io/osm
+"""
+
+import logging
+from typing import Any, Dict
+
+from charms.osm_libs.v0.utils import (
+ CharmError,
+ DebugMode,
+ HostPath,
+ check_container_ready,
+ check_service_active,
+)
+from charms.osm_temporal.v0.temporal import TemporalRequires
+from charms.osm_vca_integrator.v0.vca import VcaDataChangedEvent, VcaRequires
+from ops.charm import ActionEvent, CharmBase, CharmEvents
+from ops.framework import EventSource, StoredState
+from ops.main import main
+from ops.model import ActiveStatus, Container
+
+from legacy_interfaces import MongoClient
+
+HOSTPATHS = [
+ HostPath(
+ config="lcm-hostpath",
+ container_path="/usr/lib/python3/dist-packages/osm_lcm",
+ ),
+ HostPath(
+ config="common-hostpath",
+ container_path="/usr/lib/python3/dist-packages/osm_common",
+ ),
+ HostPath(
+ config="n2vc-hostpath",
+ container_path="/usr/lib/python3/dist-packages/n2vc",
+ ),
+]
+
+logger = logging.getLogger(__name__)
+
+
+class LcmEvents(CharmEvents):
+ """LCM events."""
+
+ vca_data_changed = EventSource(VcaDataChangedEvent)
+
+
+class OsmNGLcmCharm(CharmBase):
+ """OSM LCM Kubernetes sidecar charm."""
+
+ container_name = "nglcm"
+ service_name = "nglcm"
+ on = LcmEvents()
+ _stored = StoredState()
+
+ def __init__(self, *args):
+ super().__init__(*args)
+ self.vca = VcaRequires(self)
+ self.temporal = TemporalRequires(self)
+ self.mongodb_client = MongoClient(self, "mongodb")
+ self._observe_charm_events()
+ self.container: Container = self.unit.get_container(self.container_name)
+ self.debug_mode = DebugMode(self, self._stored, self.container, HOSTPATHS)
+
+ # ---------------------------------------------------------------------------
+ # Handlers for Charm Events
+ # ---------------------------------------------------------------------------
+
+ def _on_config_changed(self, _) -> None:
+ """Handler for the config-changed event."""
+ try:
+ self._validate_config()
+ self._check_relations()
+ # Check if the container is ready.
+ # Eventually it will become ready after the first pebble-ready event.
+ check_container_ready(self.container)
+ if not self.debug_mode.started:
+ self._configure_service(self.container)
+
+ # Update charm status
+ self._on_update_status()
+ except CharmError as e:
+ logger.debug(e.message)
+ self.unit.status = e.status
+
+ def _on_update_status(self, _=None) -> None:
+ """Handler for the update-status event."""
+ try:
+ self._validate_config()
+ self._check_relations()
+ check_container_ready(self.container)
+ if self.debug_mode.started:
+ return
+ check_service_active(self.container, self.service_name)
+ self.unit.status = ActiveStatus()
+ except CharmError as e:
+ logger.debug(e.message)
+ self.unit.status = e.status
+
+ def _on_required_relation_broken(self, _) -> None:
+ """Handler for required relation-broken events."""
+ try:
+ check_container_ready(self.container)
+ check_service_active(self.container, self.service_name)
+ self.container.stop(self.container_name)
+ except CharmError:
+ pass
+ self._on_update_status()
+
+ def _on_get_debug_mode_information_action(self, event: ActionEvent) -> None:
+ """Handler for the get-debug-mode-information action event."""
+ if not self.debug_mode.started:
+ event.fail(
+ f"debug-mode has not started. Hint: juju config {self.app.name} debug-mode=true"
+ )
+ return
+
+ debug_info = {"command": self.debug_mode.command, "password": self.debug_mode.password}
+ event.set_results(debug_info)
+
+ # ---------------------------------------------------------------------------
+ # Validation, configuration and more
+ # ---------------------------------------------------------------------------
+
+ def _validate_config(self) -> None:
+ """Validate charm configuration.
+
+ Raises:
+ CharmError: if charm configuration is invalid.
+ """
+ logger.debug("validating charm config")
+ if self.config["log-level"].upper() not in [
+ "TRACE",
+ "DEBUG",
+ "INFO",
+ "WARN",
+ "ERROR",
+ "FATAL",
+ ]:
+ raise CharmError("invalid value for log-level option")
+
+ def _observe_charm_events(self) -> None:
+ event_handler_mapping = {
+ # Core lifecycle events
+ self.on.nglcm_pebble_ready: self._on_config_changed,
+ self.on.config_changed: self._on_config_changed,
+ self.on.update_status: self._on_update_status,
+ # Relation events
+ self.on["mongodb"].relation_changed: self._on_config_changed,
+ self.on["mongodb"].relation_broken: self._on_required_relation_broken,
+ self.on["temporal"].relation_changed: self._on_config_changed,
+ self.on["temporal"].relation_broken: self._on_required_relation_broken,
+ self.on.vca_data_changed: self._on_config_changed,
+ self.on["vca"].relation_broken: self._on_config_changed,
+ # Action events
+ self.on.get_debug_mode_information_action: self._on_get_debug_mode_information_action,
+ }
+ for event, handler in event_handler_mapping.items():
+ self.framework.observe(event, handler)
+
+ def _check_relations(self) -> None:
+ """Validate charm relations.
+
+ Raises:
+ CharmError: if charm configuration is invalid.
+ """
+ logger.debug("check for missing relations")
+ missing_relations = []
+
+ if self.mongodb_client.is_missing_data_in_unit():
+ missing_relations.append("mongodb")
+ if not self.temporal.host or not self.temporal.port:
+ missing_relations.append("temporal")
+
+ if missing_relations:
+ relations_str = ", ".join(missing_relations)
+ one_relation_missing = len(missing_relations) == 1
+ error_msg = f'need {relations_str} relation{"" if one_relation_missing else "s"}'
+ logger.warning(error_msg)
+ raise CharmError(error_msg)
+
+ def _configure_service(self, container: Container) -> None:
+ """Add Pebble layer with the lcm service."""
+ logger.debug(f"configuring {self.app.name} service")
+ container.add_layer("nglcm", self._get_layer(), combine=True)
+ container.replan()
+
+ def _get_layer(self) -> Dict[str, Any]:
+ """Get layer for Pebble."""
+ environments = {
+ # General configuration
+ "OSMLCM_GLOBAL_LOGLEVEL": self.config["log-level"].upper(),
+ # Database configuration
+ "OSMLCM_DATABASE_DRIVER": "mongo",
+ "OSMLCM_DATABASE_URI": self.mongodb_client.connection_string,
+ "OSMLCM_DATABASE_COMMONKEY": self.config["database-commonkey"],
+ # Storage configuration
+ "OSMLCM_STORAGE_DRIVER": "mongo",
+ "OSMLCM_STORAGE_PATH": "/app/storage",
+ "OSMLCM_STORAGE_COLLECTION": "files",
+ "OSMLCM_STORAGE_URI": self.mongodb_client.connection_string,
+ "OSMLCM_VCA_HELM_CA_CERTS": self.config["helm-ca-certs"],
+ "OSMLCM_VCA_STABLEREPOURL": self.config["helm-stable-repo-url"],
+ # Temporal configuration
+ "OSMLCM_TEMPORAL_HOST": self.temporal.host,
+ "OSMLCM_TEMPORAL_PORT": self.temporal.port,
+ }
+ # Vca configuration
+ if self.vca.data:
+ environments["OSMLCM_VCA_ENDPOINTS"] = self.vca.data.endpoints
+ environments["OSMLCM_VCA_USER"] = self.vca.data.user
+ environments["OSMLCM_VCA_PUBKEY"] = self.vca.data.public_key
+ environments["OSMLCM_VCA_SECRET"] = self.vca.data.secret
+ environments["OSMLCM_VCA_CACERT"] = self.vca.data.cacert
+ if self.vca.data.lxd_cloud:
+ environments["OSMLCM_VCA_CLOUD"] = self.vca.data.lxd_cloud
+
+ if self.vca.data.k8s_cloud:
+ environments["OSMLCM_VCA_K8S_CLOUD"] = self.vca.data.k8s_cloud
+ for key, value in self.vca.data.model_configs.items():
+ env_name = f'OSMLCM_VCA_MODEL_CONFIG_{key.upper().replace("-","_")}'
+ environments[env_name] = value
+
+ layer_config = {
+ "summary": "nglcm layer",
+ "description": "pebble config layer for nglcm",
+ "services": {
+ self.service_name: {
+ "override": "replace",
+ "summary": "nslcm service",
+ "command": "python3 -m osm_lcm.nglcm -c /usr/lib/python3/dist-packages/osm_lcm/lcm.cfg",
+ "startup": "enabled",
+ "user": "appuser",
+ "group": "appuser",
+ "environment": environments,
+ }
+ },
+ }
+ logger.info(f"Layer: {layer_config}")
+ return layer_config
+
+
+if __name__ == "__main__": # pragma: no cover
+ main(OsmNGLcmCharm)
diff --git a/installers/charm/osm-nglcm/src/legacy_interfaces.py b/installers/charm/osm-nglcm/src/legacy_interfaces.py
new file mode 100644
index 0000000..d56f31d
--- /dev/null
+++ b/installers/charm/osm-nglcm/src/legacy_interfaces.py
@@ -0,0 +1,107 @@
+#!/usr/bin/env python3
+# Copyright 2022 Canonical Ltd.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+#
+# For those usages not covered by the Apache License, Version 2.0 please
+# contact: legal@canonical.com
+#
+# To get in touch with the maintainers, please contact:
+# osm-charmers@lists.launchpad.net
+#
+# flake8: noqa
+
+import ops
+
+
+class BaseRelationClient(ops.framework.Object):
+ """Requires side of a Kafka Endpoint"""
+
+ def __init__(
+ self, charm: ops.charm.CharmBase, relation_name: str, mandatory_fields: list = []
+ ):
+ super().__init__(charm, relation_name)
+ self.relation_name = relation_name
+ self.mandatory_fields = mandatory_fields
+ self._update_relation()
+
+ def get_data_from_unit(self, key: str):
+ if not self.relation:
+ # This update relation doesn't seem to be needed, but I added it because apparently
+ # the data is empty in the unit tests.
+ # In reality, the constructor is called in every hook.
+ # In the unit tests when doing an update_relation_data, apparently it is not called.
+ self._update_relation()
+ if self.relation:
+ for unit in self.relation.units:
+ data = self.relation.data[unit].get(key)
+ if data:
+ return data
+
+ def get_data_from_app(self, key: str):
+ if not self.relation or self.relation.app not in self.relation.data:
+ # This update relation doesn't seem to be needed, but I added it because apparently
+ # the data is empty in the unit tests.
+ # In reality, the constructor is called in every hook.
+ # In the unit tests when doing an update_relation_data, apparently it is not called.
+ self._update_relation()
+ if self.relation and self.relation.app in self.relation.data:
+ data = self.relation.data[self.relation.app].get(key)
+ if data:
+ return data
+
+ def is_missing_data_in_unit(self):
+ return not all([self.get_data_from_unit(field) for field in self.mandatory_fields])
+
+ def is_missing_data_in_app(self):
+ return not all([self.get_data_from_app(field) for field in self.mandatory_fields])
+
+ def _update_relation(self):
+ self.relation = self.framework.model.get_relation(self.relation_name)
+
+
+class MongoClient(BaseRelationClient):
+ """Requires side of a Mongo Endpoint"""
+
+ mandatory_fields_mapping = {
+ "reactive": ["connection_string"],
+ "ops": ["replica_set_uri", "replica_set_name"],
+ }
+
+ def __init__(self, charm: ops.charm.CharmBase, relation_name: str):
+ super().__init__(charm, relation_name, mandatory_fields=[])
+
+ @property
+ def connection_string(self):
+ if self.is_opts():
+ replica_set_uri = self.get_data_from_unit("replica_set_uri")
+ replica_set_name = self.get_data_from_unit("replica_set_name")
+ return f"{replica_set_uri}?replicaSet={replica_set_name}"
+ else:
+ return self.get_data_from_unit("connection_string")
+
+ def is_opts(self):
+ return not self.is_missing_data_in_unit_ops()
+
+ def is_missing_data_in_unit(self):
+ return self.is_missing_data_in_unit_ops() and self.is_missing_data_in_unit_reactive()
+
+ def is_missing_data_in_unit_ops(self):
+ return not all(
+ [self.get_data_from_unit(field) for field in self.mandatory_fields_mapping["ops"]]
+ )
+
+ def is_missing_data_in_unit_reactive(self):
+ return not all(
+ [self.get_data_from_unit(field) for field in self.mandatory_fields_mapping["reactive"]]
+ )