installers/charm/ro/src/charm.py

   1 #!/usr/bin/env python3
   2 # Copyright 2021 Canonical Ltd.
   3 #
   4 # Licensed under the Apache License, Version 2.0 (the "License"); you may
   5 # not use this file except in compliance with the License. You may obtain
   6 # a copy of the License at
   7 #
   8 #         http://www.apache.org/licenses/LICENSE-2.0
   9 #
  10 # Unless required by applicable law or agreed to in writing, software
  11 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  12 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  13 # License for the specific language governing permissions and limitations
  14 # under the License.
  15 #
  16 # For those usages not covered by the Apache License, Version 2.0 please
  17 # contact: legal@canonical.com
  18 #
  19 # To get in touch with the maintainers, please contact:
  20 # osm-charmers@lists.launchpad.net
  21 ##
  22
  23 # pylint: disable=E0213
  24
  25 import logging
  26 from typing import NoReturn
  27
  28 from ops.main import main
  29 from opslib.osm.charm import CharmedOsmBase, RelationsMissing
  30 from opslib.osm.interfaces.kafka import KafkaClient
  31 from opslib.osm.interfaces.mongo import MongoClient
  32 from opslib.osm.interfaces.mysql import MysqlClient
  33 from opslib.osm.pod import (
  34     ContainerV3Builder,
  35     PodSpecV3Builder,
  36 )
  37 from opslib.osm.validator import ModelValidator, validator
  38
  39
  40 logger = logging.getLogger(__name__)
  41
  42 PORT = 9090
  43
  44
  45 class ConfigModel(ModelValidator):
  46     enable_ng_ro: bool
  47     database_commonkey: str
  48     log_level: str
  49     vim_database: str
  50     ro_database: str
  51     openmano_tenant: str
  52
  53     @validator("log_level")
  54     def validate_log_level(cls, v):
  55         if v not in {"INFO", "DEBUG"}:
  56             raise ValueError("value must be INFO or DEBUG")
  57         return v
  58
  59
  60 class RoCharm(CharmedOsmBase):
  61     """GrafanaCharm Charm."""
  62
  63     def __init__(self, *args) -> NoReturn:
  64         """Prometheus Charm constructor."""
  65         super().__init__(*args, oci_image="image")
  66
  67         self.kafka_client = KafkaClient(self, "kafka")
  68         self.framework.observe(self.on["kafka"].relation_changed, self.configure_pod)
  69         self.framework.observe(self.on["kafka"].relation_broken, self.configure_pod)
  70
  71         self.mysql_client = MysqlClient(self, "mysql")
  72         self.framework.observe(self.on["mysql"].relation_changed, self.configure_pod)
  73         self.framework.observe(self.on["mysql"].relation_broken, self.configure_pod)
  74
  75         self.mongodb_client = MongoClient(self, "mongodb")
  76         self.framework.observe(self.on["mongodb"].relation_changed, self.configure_pod)
  77         self.framework.observe(self.on["mongodb"].relation_broken, self.configure_pod)
  78
  79         self.framework.observe(self.on["ro"].relation_joined, self._publish_ro_info)
  80
  81     def _publish_ro_info(self, event):
  82         """Publishes RO information.
  83
  84         Args:
  85             event (EventBase): RO relation event.
  86         """
  87         if self.unit.is_leader():
  88             rel_data = {
  89                 "host": self.model.app.name,
  90                 "port": str(PORT),
  91             }
  92             for k, v in rel_data.items():
  93                 event.relation.data[self.app][k] = v
  94
  95     def _check_missing_dependencies(self, config: ConfigModel):
  96         missing_relations = []
  97
  98         if config.enable_ng_ro:
  99             if self.kafka_client.is_missing_data_in_unit():
 100                 missing_relations.append("kafka")
 101             if self.mongodb_client.is_missing_data_in_unit():
 102                 missing_relations.append("mongodb")
 103         else:
 104             if self.mysql_client.is_missing_data_in_unit():
 105                 missing_relations.append("mysql")
 106         if missing_relations:
 107             raise RelationsMissing(missing_relations)
 108
 109     def build_pod_spec(self, image_info):
 110         # Validate config
 111         config = ConfigModel(**dict(self.config))
 112         # Check relations
 113         self._check_missing_dependencies(config)
 114         # Create Builder for the PodSpec
 115         pod_spec_builder = PodSpecV3Builder()
 116         # Build Container
 117         container_builder = ContainerV3Builder(self.app.name, image_info)
 118         container_builder.add_port(name=self.app.name, port=PORT)
 119         container_builder.add_http_readiness_probe(
 120             "/ro/" if config.enable_ng_ro else "/openmano/tenants",
 121             PORT,
 122             initial_delay_seconds=10,
 123             period_seconds=10,
 124             timeout_seconds=5,
 125             failure_threshold=3,
 126         )
 127         container_builder.add_http_liveness_probe(
 128             "/ro/" if config.enable_ng_ro else "/openmano/tenants",
 129             PORT,
 130             initial_delay_seconds=600,
 131             period_seconds=10,
 132             timeout_seconds=5,
 133             failure_threshold=3,
 134         )
 135         container_builder.add_envs(
 136             {
 137                 "OSMRO_LOG_LEVEL": config.log_level,
 138             }
 139         )
 140         if config.enable_ng_ro:
 141             container_builder.add_envs(
 142                 {
 143                     "OSMRO_MESSAGE_DRIVER": "kafka",
 144                     "OSMRO_MESSAGE_HOST": self.kafka_client.host,
 145                     "OSMRO_MESSAGE_PORT": self.kafka_client.port,
 146                     # MongoDB configuration
 147                     "OSMRO_DATABASE_DRIVER": "mongo",
 148                     "OSMRO_DATABASE_URI": self.mongodb_client.connection_string,
 149                     "OSMRO_DATABASE_COMMONKEY": config.database_commonkey,
 150                 }
 151             )
 152
 153         else:
 154             container_builder.add_envs(
 155                 {
 156                     "RO_DB_HOST": self.mysql_client.host,
 157                     "RO_DB_OVIM_HOST": self.mysql_client.host,
 158                     "RO_DB_PORT": self.mysql_client.port,
 159                     "RO_DB_OVIM_PORT": self.mysql_client.port,
 160                     "RO_DB_USER": self.mysql_client.user,
 161                     "RO_DB_OVIM_USER": self.mysql_client.user,
 162                     "RO_DB_PASSWORD": self.mysql_client.password,
 163                     "RO_DB_OVIM_PASSWORD": self.mysql_client.password,
 164                     "RO_DB_ROOT_PASSWORD": self.mysql_client.root_password,
 165                     "RO_DB_OVIM_ROOT_PASSWORD": self.mysql_client.root_password,
 166                     "RO_DB_NAME": config.ro_database,
 167                     "RO_DB_OVIM_NAME": config.vim_database,
 168                     "OPENMANO_TENANT": config.openmano_tenant,
 169                 }
 170             )
 171         container = container_builder.build()
 172         # Add container to pod spec
 173         pod_spec_builder.add_container(container)
 174         return pod_spec_builder.build()
 175
 176
 177 if __name__ == "__main__":
 178     main(RoCharm)