X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;f=installers%2Fcharm%2Fng-ui%2Fsrc%2Fcharm.py;h=7510a6cbb7c87230a74eb4d2173dcbd6820b670d;hb=ef349d9224f93fcc3eeb7a26f71c6a128ffbf96a;hp=6f5ca5b50d8f137c0d8070887f1817d9bb17f7d8;hpb=f96d1cf00d281325f915bd966c28013243a31c10;p=osm%2Fdevops.git diff --git a/installers/charm/ng-ui/src/charm.py b/installers/charm/ng-ui/src/charm.py index 6f5ca5b5..7510a6cb 100755 --- a/installers/charm/ng-ui/src/charm.py +++ b/installers/charm/ng-ui/src/charm.py @@ -1,209 +1,194 @@ #!/usr/bin/env python3 -# Copyright 2020 Canonical Ltd. +# Copyright 2020 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 +# 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 +# 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. - -import base64 -from glob import glob +# 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 +## + import logging -from pathlib import Path -from string import Template -import sys +from typing import Any, Dict, NoReturn +from pydantic import ValidationError -from ops.charm import CharmBase -from ops.framework import StoredState, Object +from ops.charm import CharmBase, CharmEvents +from ops.framework import EventBase, EventSource, StoredState from ops.main import main -from ops.model import ( - ActiveStatus, - MaintenanceStatus, - BlockedStatus, - ModelError, - WaitingStatus, -) +from ops.model import ActiveStatus, BlockedStatus, MaintenanceStatus +from oci_image import OCIImageResource, OCIImageResourceError +from pod_spec import make_pod_spec logger = logging.getLogger(__name__) +NGUI_PORT = 80 + + +class ConfigurePodEvent(EventBase): + """Configure Pod event""" + + pass + + +class NgUiEvents(CharmEvents): + """NGUI Events""" + + configure_pod = EventSource(ConfigurePodEvent) + + +class NgUiCharm(CharmBase): + """NGUI Charm.""" -class NGUICharm(CharmBase): state = StoredState() + on = NgUiEvents() + + def __init__(self, *args) -> NoReturn: + """NGUI Charm constructor.""" + super().__init__(*args) - def __init__(self, framework, key): - super().__init__(framework, key) - self.state.set_default(spec=None) + # Internal state initialization + self.state.set_default(pod_spec=None) + + # North bound interface initialization self.state.set_default(nbi_host=None) self.state.set_default(nbi_port=None) - # Observe Charm related events - self.framework.observe(self.on.config_changed, self.on_config_changed) - self.framework.observe(self.on.start, self.on_start) - self.framework.observe(self.on.upgrade_charm, self.on_upgrade_charm) + self.http_port = NGUI_PORT + self.image = OCIImageResource(self, "image") + + # Registering regular events + self.framework.observe(self.on.start, self.configure_pod) + self.framework.observe(self.on.config_changed, self.configure_pod) + # self.framework.observe(self.on.upgrade_charm, self.configure_pod) + + # Registering custom internal events + self.framework.observe(self.on.configure_pod, self.configure_pod) + + # Registering required relation changed events self.framework.observe( - self.on.nbi_relation_changed, self.on_nbi_relation_changed + self.on.nbi_relation_changed, self._on_nbi_relation_changed ) - # SSL Certificate path - self.ssl_folder = "/certs" - self.ssl_crt_name = "ssl_certificate.crt" - self.ssl_key_name = "ssl_certificate.key" - - def _apply_spec(self): - # Only apply the spec if this unit is a leader. - unit = self.model.unit - if not unit.is_leader(): - unit.status = ActiveStatus("ready") - return - if not self.state.nbi_host or not self.state.nbi_port: - unit.status = WaitingStatus("Waiting for NBI") - return - unit.status = MaintenanceStatus("Applying new pod spec") + # Registering required relation departed events + self.framework.observe( + self.on.nbi_relation_departed, self._on_nbi_relation_departed + ) - new_spec = self.make_pod_spec() - if new_spec == self.state.spec: - unit.status = ActiveStatus("ready") - return - self.framework.model.pod.set_spec(new_spec) - self.state.spec = new_spec - unit.status = ActiveStatus("ready") - - def make_pod_spec(self): - config = self.framework.model.config - - config_spec = { - "http_port": config["port"], - "https_port": config["https_port"], - "server_name": config["server_name"], - "client_max_body_size": config["client_max_body_size"], - "nbi_host": self.state.nbi_host or config["nbi_host"], - "nbi_port": self.state.nbi_port or config["nbi_port"], - "ssl_crt": "", - "ssl_crt_key": "", + def _on_nbi_relation_changed(self, event: EventBase) -> NoReturn: + """Reads information about the nbi relation. + + Args: + event (EventBase): NBI relation event. + """ + data_loc = event.unit if event.unit else event.app + logger.error(dict(event.relation.data)) + nbi_host = event.relation.data[data_loc].get("host") + nbi_port = event.relation.data[data_loc].get("port") + + if ( + nbi_host + and nbi_port + and (self.state.nbi_host != nbi_host or self.state.nbi_port != nbi_port) + ): + self.state.nbi_host = nbi_host + self.state.nbi_port = nbi_port + self.on.configure_pod.emit() + + def _on_nbi_relation_departed(self, event: EventBase) -> NoReturn: + """Clears data from nbi relation. + + Args: + event (EventBase): NBI relation event. + """ + self.state.nbi_host = None + self.state.nbi_port = None + self.on.configure_pod.emit() + + def _missing_relations(self) -> str: + """Checks if there missing relations. + + Returns: + str: string with missing relations + """ + data_status = { + "nbi": self.state.nbi_host, } - ssl_certificate = None - ssl_certificate_key = None - ssl_enabled = False - - if "ssl_certificate" in config and "ssl_certificate_key" in config: - # Get bytes of cert and key - cert_b = base64.b64decode(config["ssl_certificate"]) - key_b = base64.b64decode(config["ssl_certificate_key"]) - # Decode key and cert - ssl_certificate = cert_b.decode("utf-8") - ssl_certificate_key = key_b.decode("utf-8") - # Get paths - cert_path = "{}/{}".format(self.ssl_folder, self.ssl_crt_name) - key_path = "{}/{}".format(self.ssl_folder, self.ssl_key_name) - - config_spec["port"] = "{} ssl".format(config["https_port"]) - config_spec["ssl_crt"] = "ssl_certificate {};".format(cert_path) - config_spec["ssl_crt_key"] = "ssl_certificate_key {};".format(key_path) - ssl_enabled = True - else: - config_spec["ssl_crt"] = "" - config_spec["ssl_crt_key"] = "" - - files = [ - { - "name": "configuration", - "mountPath": "/etc/nginx/sites-available/", - "files": { - Path(filename) - .name: Template(Path(filename).read_text()) - .substitute(config_spec) - for filename in glob("files/*") - }, - } - ] - port = config["https_port"] if ssl_enabled else config["port"] - ports = [ - { - "name": "port", - "containerPort": port, - "protocol": "TCP", - }, - ] - - kubernetes = { - "readinessProbe": { - "tcpSocket": {"port": port}, - "timeoutSeconds": 5, - "periodSeconds": 5, - "initialDelaySeconds": 10, - }, - "livenessProbe": { - "tcpSocket": {"port": port}, - "timeoutSeconds": 5, - "initialDelaySeconds": 45, - }, - } + missing_relations = [k for k, v in data_status.items() if not v] - if ssl_certificate and ssl_certificate_key: - files.append( - { - "name": "ssl", - "mountPath": self.ssl_folder, - "files": { - self.ssl_crt_name: ssl_certificate, - self.ssl_key_name: ssl_certificate_key, - }, - } - ) + return ", ".join(missing_relations) + + @property + def relation_state(self) -> Dict[str, Any]: + """Collects relation state configuration for pod spec assembly. - logger.debug(files) - - spec = { - "version": 2, - "containers": [ - { - "name": self.framework.model.app.name, - "imageDetails": { - "imagePath": config["image"], - "username": config["image_username"], - "password": config["image_password"], - }, - "ports": ports, - "kubernetes": kubernetes, - "files": files, - } - ], + Returns: + Dict[str, Any]: relation state information. + """ + relation_state = { + "nbi_host": self.state.nbi_host, + "nbi_port": self.state.nbi_port, } + return relation_state + + def configure_pod(self, event: EventBase) -> NoReturn: + """Assemble the pod spec and apply it, if possible. + + Args: + event (EventBase): Hook or Relation event that started the + function. + """ + if missing := self._missing_relations(): + self.unit.status = BlockedStatus( + f"Waiting for {missing} relation{'s' if ',' in missing else ''}" + ) + return - return spec + if not self.unit.is_leader(): + self.unit.status = ActiveStatus("ready") + return - def on_config_changed(self, event): - """Handle changes in configuration""" - self._apply_spec() + self.unit.status = MaintenanceStatus("Assembling pod spec") - def on_start(self, event): - """Called when the charm is being installed""" - self._apply_spec() + # Fetch image information + try: + self.unit.status = MaintenanceStatus("Fetching image information") + image_info = self.image.fetch() + except OCIImageResourceError: + self.unit.status = BlockedStatus("Error fetching image information") + return - def on_upgrade_charm(self, event): - """Upgrade the charm.""" - unit = self.model.unit - unit.status = MaintenanceStatus("Upgrading charm") - self.on_start(event) + try: + pod_spec = make_pod_spec( + image_info, + self.config, + self.relation_state, + self.model.app.name, + ) + except ValidationError as exc: + logger.exception("Config/Relation data validation error") + self.unit.status = BlockedStatus(str(exc)) + return - def on_nbi_relation_changed(self, event): - nbi_host = event.relation.data[event.unit].get("host") - nbi_port = event.relation.data[event.unit].get("port") - if nbi_host and self.state.nbi_host != nbi_host: - self.state.nbi_host = nbi_host - if nbi_port and self.state.nbi_port != nbi_port: - self.state.nbi_port = nbi_port - self._apply_spec() + if self.state.pod_spec != pod_spec: + self.model.pod.set_spec(pod_spec) + self.state.pod_spec = pod_spec + + self.unit.status = ActiveStatus("ready") if __name__ == "__main__": - main(NGUICharm) + main(NgUiCharm)