X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;f=installers%2Fcharm%2Fng-ui%2Fsrc%2Fcharm.py;h=7510a6cbb7c87230a74eb4d2173dcbd6820b670d;hb=ef349d9224f93fcc3eeb7a26f71c6a128ffbf96a;hp=23d316138153c451595a04b9ad9d3b086173f2a3;hpb=081f469ea6358cdd9c6d4c992a7668a2199c8cdc;p=osm%2Fdevops.git diff --git a/installers/charm/ng-ui/src/charm.py b/installers/charm/ng-ui/src/charm.py index 23d31613..7510a6cb 100755 --- a/installers/charm/ng-ui/src/charm.py +++ b/installers/charm/ng-ui/src/charm.py @@ -1,148 +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. +# 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 sys import logging +from typing import Any, Dict, NoReturn +from pydantic import ValidationError -sys.path.append("lib") - -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, -) +from ops.model import ActiveStatus, BlockedStatus, MaintenanceStatus +from oci_image import OCIImageResource, OCIImageResourceError -from glob import glob -from pathlib import Path -from string import Template +from pod_spec import make_pod_spec logger = logging.getLogger(__name__) +NGUI_PORT = 80 -class NGUICharm(CharmBase): - state = StoredState() - def __init__(self, framework, key): - super().__init__(framework, key) - self.state.set_default(spec=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.framework.observe( - # self.on.nbi_relation_joined, self.on_nbi_relation_joined - # ) - - def _apply_spec(self): - # Only apply the spec if this unit is a leader. - if not self.framework.model.unit.is_leader(): - return - new_spec = self.make_pod_spec() - if new_spec == self.state.spec: - return - self.framework.model.pod.set_spec(new_spec) - self.state.spec = new_spec - - def make_pod_spec(self): - config = self.framework.model.config - - ports = [ - {"name": "port", "containerPort": config["port"], "protocol": "TCP",}, - ] - - kubernetes = { - "readinessProbe": { - "tcpSocket": {"port": config["port"]}, - "timeoutSeconds": 5, - "periodSeconds": 5, - "initialDelaySeconds": 10, - }, - "livenessProbe": { - "tcpSocket": {"port": config["port"]}, - "timeoutSeconds": 5, - "initialDelaySeconds": 45, - }, - } - config_spec = { - "port": config["port"], - "server_name": config["server_name"], - "client_max_body_size": config["client_max_body_size"], - "nbi_hostname": config["nbi_hostname"], - "nbi_port": config["nbi_port"], +class ConfigurePodEvent(EventBase): + """Configure Pod event""" + + pass + + +class NgUiEvents(CharmEvents): + """NGUI Events""" + + configure_pod = EventSource(ConfigurePodEvent) + + +class NgUiCharm(CharmBase): + """NGUI Charm.""" + + state = StoredState() + on = NgUiEvents() + + def __init__(self, *args) -> NoReturn: + """NGUI Charm constructor.""" + super().__init__(*args) + + # 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) + + 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 + ) + + # Registering required relation departed events + self.framework.observe( + self.on.nbi_relation_departed, self._on_nbi_relation_departed + ) + + 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, } - 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/*") - }, - }, - ] - logger.debug(files) - spec = { - "version": 2, - "containers": [ - { - "name": self.framework.model.app.name, - "image": "{}".format(config["image"]), - "ports": ports, - "kubernetes": kubernetes, - "files": files, - } - ], + missing_relations = [k for k, v in data_status.items() if not v] + + return ", ".join(missing_relations) + + @property + def relation_state(self) -> Dict[str, Any]: + """Collects relation state configuration for pod spec assembly. + + 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""" - unit = self.model.unit - unit.status = MaintenanceStatus("Applying new pod spec") - self._apply_spec() - unit.status = ActiveStatus("Ready") + self.unit.status = MaintenanceStatus("Assembling pod spec") - def on_start(self, event): - """Called when the charm is being installed""" - unit = self.model.unit - unit.status = MaintenanceStatus("Applying pod spec") - self._apply_spec() - unit.status = ActiveStatus("Ready") + # 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_joined(self, event): - # unit = self.model.unit - # if not unit.is_leader(): - # return - # config = self.framework.model.config - # unit = MaintenanceStatus("Sending connection data") + if self.state.pod_spec != pod_spec: + self.model.pod.set_spec(pod_spec) + self.state.pod_spec = pod_spec - # unit = ActiveStatus("Ready") + self.unit.status = ActiveStatus("ready") if __name__ == "__main__": - main(NGUICharm) + main(NgUiCharm)