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, Optional
  28
  29 from ops.main import main
  30 from opslib.osm.charm import CharmedOsmBase, RelationsMissing
  31 from opslib.osm.interfaces.kafka import KafkaClient
  32 from opslib.osm.interfaces.mongo import MongoClient
  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 = 9999
  43
  44
  45 class ConfigModel(ModelValidator):
  46     database_commonkey: str
  47     mongodb_uri: Optional[str]
  48     log_level: str
  49
  50     @validator("log_level")
  51     def validate_log_level(cls, v):
  52         if v not in {"INFO", "DEBUG"}:
  53             raise ValueError("value must be INFO or DEBUG")
  54         return v
  55
  56     @validator("mongodb_uri")
  57     def validate_mongodb_uri(cls, v):
  58         if v and not v.startswith("mongodb://"):
  59             raise ValueError("mongodb_uri is not properly formed")
  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 not config.mongodb_uri and 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
  90         if config.mongodb_uri and not self.mongodb_client.is_missing_data_in_unit():
  91             raise Exception("Mongodb data cannot be provided via config and relation")
  92
  93         # Check relations
  94         self._check_missing_dependencies(config)
  95
  96         # Create Builder for the PodSpec
  97         pod_spec_builder = PodSpecV3Builder()
  98
  99         # Build Container
 100         container_builder = ContainerV3Builder(self.app.name, image_info)
 101         container_builder.add_port(name=self.app.name, port=PORT)
 102         container_builder.add_envs(
 103             {
 104                 # General configuration
 105                 "ALLOW_ANONYMOUS_LOGIN": "yes",
 106                 "OSMPLA_GLOBAL_LOG_LEVEL": config.log_level,
 107                 # Kafka configuration
 108                 "OSMPLA_MESSAGE_DRIVER": "kafka",
 109                 "OSMPLA_MESSAGE_HOST": self.kafka_client.host,
 110                 "OSMPLA_MESSAGE_PORT": self.kafka_client.port,
 111                 # Database configuration
 112                 "OSMPLA_DATABASE_DRIVER": "mongo",
 113                 "OSMPLA_DATABASE_URI": config.mongodb_uri
 114                 or self.mongodb_client.connection_string,
 115                 "OSMPLA_DATABASE_COMMONKEY": config.database_commonkey,
 116             }
 117         )
 118
 119         container = container_builder.build()
 120
 121         # Add container to pod spec
 122         pod_spec_builder.add_container(container)
 123
 124         return pod_spec_builder.build()
 125
 126
 127 if __name__ == "__main__":
 128     main(PlaCharm)