installers/charm/pol/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 import re
  28 from typing import NoReturn, Optional
  29
  30 from ops.main import main
  31 from opslib.osm.charm import CharmedOsmBase, RelationsMissing
  32 from opslib.osm.interfaces.kafka import KafkaClient
  33 from opslib.osm.interfaces.mongo import MongoClient
  34 from opslib.osm.interfaces.mysql import MysqlClient
  35 from opslib.osm.pod import (
  36     ContainerV3Builder,
  37     PodRestartPolicy,
  38     PodSpecV3Builder,
  39 )
  40 from opslib.osm.validator import ModelValidator, validator
  41
  42
  43 logger = logging.getLogger(__name__)
  44
  45 PORT = 9999
  46 DEFAULT_MYSQL_DATABASE = "pol"
  47
  48
  49 class ConfigModel(ModelValidator):
  50     log_level: str
  51     mongodb_uri: Optional[str]
  52     mysql_uri: Optional[str]
  53     image_pull_policy: str
  54
  55     @validator("log_level")
  56     def validate_log_level(cls, v):
  57         if v not in {"INFO", "DEBUG"}:
  58             raise ValueError("value must be INFO or DEBUG")
  59         return v
  60
  61     @validator("mongoddb_uri")
  62     def validate_mongodb_uri(cls, v):
  63         if v and not v.startswith("mongodb://"):
  64             raise ValueError("mongodb_uri is not properly formed")
  65         return v
  66
  67     @validator("mysql_uri")
  68     def validate_mysql_uri(cls, v):
  69         pattern = re.compile("^mysql:\/\/.*:.*@.*:\d+\/.*$")  # noqa: W605
  70         if v and not pattern.search(v):
  71             raise ValueError("mysql_uri is not properly formed")
  72         return v
  73
  74     @validator("image_pull_policy")
  75     def validate_image_pull_policy(cls, v):
  76         values = {
  77             "always": "Always",
  78             "ifnotpresent": "IfNotPresent",
  79             "never": "Never",
  80         }
  81         v = v.lower()
  82         if v not in values.keys():
  83             raise ValueError("value must be always, ifnotpresent or never")
  84         return values[v]
  85
  86
  87 class PolCharm(CharmedOsmBase):
  88     def __init__(self, *args) -> NoReturn:
  89         super().__init__(
  90             *args,
  91             oci_image="image",
  92             debug_mode_config_key="debug_mode",
  93             debug_pubkey_config_key="debug_pubkey",
  94             vscode_workspace=VSCODE_WORKSPACE,
  95         )
  96
  97         self.kafka_client = KafkaClient(self, "kafka")
  98         self.framework.observe(self.on["kafka"].relation_changed, self.configure_pod)
  99         self.framework.observe(self.on["kafka"].relation_broken, self.configure_pod)
 100
 101         self.mongodb_client = MongoClient(self, "mongodb")
 102         self.framework.observe(self.on["mongodb"].relation_changed, self.configure_pod)
 103         self.framework.observe(self.on["mongodb"].relation_broken, self.configure_pod)
 104
 105         self.mysql_client = MysqlClient(self, "mysql")
 106         self.framework.observe(self.on["mysql"].relation_changed, self.configure_pod)
 107         self.framework.observe(self.on["mysql"].relation_broken, self.configure_pod)
 108
 109     def _check_missing_dependencies(self, config: ConfigModel):
 110         missing_relations = []
 111
 112         if self.kafka_client.is_missing_data_in_unit():
 113             missing_relations.append("kafka")
 114         if not config.mongodb_uri and self.mongodb_client.is_missing_data_in_unit():
 115             missing_relations.append("mongodb")
 116         if not config.mysql_uri and self.mysql_client.is_missing_data_in_unit():
 117             missing_relations.append("mysql")
 118         if missing_relations:
 119             raise RelationsMissing(missing_relations)
 120
 121     def build_pod_spec(self, image_info):
 122         # Validate config
 123         config = ConfigModel(**dict(self.config))
 124
 125         if config.mongodb_uri and not self.mongodb_client.is_missing_data_in_unit():
 126             raise Exception("Mongodb data cannot be provided via config and relation")
 127         if config.mysql_uri and not self.mysql_client.is_missing_data_in_unit():
 128             raise Exception("Mysql data cannot be provided via config and relation")
 129
 130         # Check relations
 131         self._check_missing_dependencies(config)
 132
 133         # Create Builder for the PodSpec
 134         pod_spec_builder = PodSpecV3Builder()
 135
 136         # Add secrets to the pod
 137         mongodb_secret_name = f"{self.app.name}-mongodb-secret"
 138         pod_spec_builder.add_secret(
 139             mongodb_secret_name,
 140             {"uri": config.mongodb_uri or self.mongodb_client.connection_string},
 141         )
 142         mysql_secret_name = f"{self.app.name}-mysql-secret"
 143         pod_spec_builder.add_secret(
 144             mysql_secret_name,
 145             {
 146                 "uri": config.mysql_uri
 147                 or self.mysql_client.get_root_uri(DEFAULT_MYSQL_DATABASE)
 148             },
 149         )
 150
 151         # Build Container
 152         container_builder = ContainerV3Builder(
 153             self.app.name, image_info, config.image_pull_policy
 154         )
 155         container_builder.add_port(name=self.app.name, port=PORT)
 156         container_builder.add_envs(
 157             {
 158                 # General configuration
 159                 "ALLOW_ANONYMOUS_LOGIN": "yes",
 160                 "OSMPOL_GLOBAL_LOGLEVEL": config.log_level,
 161                 # Kafka configuration
 162                 "OSMPOL_MESSAGE_DRIVER": "kafka",
 163                 "OSMPOL_MESSAGE_HOST": self.kafka_client.host,
 164                 "OSMPOL_MESSAGE_PORT": self.kafka_client.port,
 165                 # Database configuration
 166                 "OSMPOL_DATABASE_DRIVER": "mongo",
 167             }
 168         )
 169         container_builder.add_secret_envs(
 170             mongodb_secret_name, {"OSMPOL_DATABASE_URI": "uri"}
 171         )
 172         container_builder.add_secret_envs(
 173             mysql_secret_name, {"OSMPOL_SQL_DATABASE_URI": "uri"}
 174         )
 175         container = container_builder.build()
 176
 177         # Add Pod restart policy
 178         restart_policy = PodRestartPolicy()
 179         restart_policy.add_secrets(
 180             secret_names=(mongodb_secret_name, mysql_secret_name)
 181         )
 182         pod_spec_builder.set_restart_policy(restart_policy)
 183
 184         # Add container to pod spec
 185         pod_spec_builder.add_container(container)
 186
 187         return pod_spec_builder.build()
 188
 189
 190 VSCODE_WORKSPACE = {
 191     "folders": [
 192         {"path": "/usr/lib/python3/dist-packages/osm_policy_module"},
 193         {"path": "/usr/lib/python3/dist-packages/osm_common"},
 194     ],
 195     "settings": {},
 196     "launch": {
 197         "version": "0.2.0",
 198         "configurations": [
 199             {
 200                 "name": "POL",
 201                 "type": "python",
 202                 "request": "launch",
 203                 "module": "osm_policy_module.cmd.policy_module_agent",
 204                 "justMyCode": False,
 205             }
 206         ],
 207     },
 208 }
 209
 210
 211 if __name__ == "__main__":
 212     main(PolCharm)