installers/charm/pla/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
  26 import logging
  27 from typing import NoReturn
  28
  29 from ops.main import main
  30
  31 from opslib.osm.charm import CharmedOsmBase, RelationsMissing
  32
  33 from opslib.osm.pod import (
  34     ContainerV3Builder,
  35     PodSpecV3Builder,
  36 )
  37
  38 from opslib.osm.validator import (
  39     ModelValidator,
  40     validator,
  41 )
  42
  43 from opslib.osm.interfaces.kafka import KafkaClient
  44 from opslib.osm.interfaces.mongo import MongoClient
  45
  46
  47 logger = logging.getLogger(__name__)
  48
  49 PORT = 9999
  50
  51
  52 class ConfigModel(ModelValidator):
  53     database_commonkey: str
  54     log_level: str
  55
  56     @validator("log_level")
  57     def validate_log_level(cls, v):
  58         if v not in {"INFO", "DEBUG"}:
  59             raise ValueError("value must be INFO or DEBUG")
  60         return v
  61
  62
  63 class PlaCharm(CharmedOsmBase):
  64     def __init__(self, *args) -> NoReturn:
  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.mongodb_client = MongoClient(self, "mongodb")
  72         self.framework.observe(self.on["mongodb"].relation_changed, self.configure_pod)
  73         self.framework.observe(self.on["mongodb"].relation_broken, self.configure_pod)
  74
  75     def _check_missing_dependencies(self, config: ConfigModel):
  76         missing_relations = []
  77
  78         if self.kafka_client.is_missing_data_in_unit():
  79             missing_relations.append("kafka")
  80         if self.mongodb_client.is_missing_data_in_unit():
  81             missing_relations.append("mongodb")
  82
  83         if missing_relations:
  84             raise RelationsMissing(missing_relations)
  85
  86     def build_pod_spec(self, image_info):
  87         # Validate config
  88         config = ConfigModel(**dict(self.config))
  89         # Check relations
  90         self._check_missing_dependencies(config)
  91         # Create Builder for the PodSpec
  92         pod_spec_builder = PodSpecV3Builder()
  93         # Build Container
  94         container_builder = ContainerV3Builder(self.app.name, image_info)
  95         container_builder.add_port(name=self.app.name, port=PORT)
  96         container_builder.add_envs(
  97             {
  98                 # General configuration
  99                 "ALLOW_ANONYMOUS_LOGIN": "yes",
 100                 "OSMPLA_GLOBAL_LOG_LEVEL": config.log_level,
 101                 # Kafka configuration
 102                 "OSMPLA_MESSAGE_DRIVER": "kafka",
 103                 "OSMPLA_MESSAGE_HOST": self.kafka_client.host,
 104                 "OSMPLA_MESSAGE_PORT": self.kafka_client.port,
 105                 # Database configuration
 106                 "OSMPLA_DATABASE_DRIVER": "mongo",
 107                 "OSMPLA_DATABASE_URI": self.mongodb_client.connection_string,
 108                 "OSMPLA_DATABASE_COMMONKEY": config.database_commonkey,
 109             }
 110         )
 111
 112         container = container_builder.build()
 113         # Add container to pod spec
 114         pod_spec_builder.add_container(container)
 115         return pod_spec_builder.build()
 116
 117
 118 if __name__ == "__main__":
 119     main(PlaCharm)