2 # Copyright 2021 Canonical Ltd.
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
8 # http://www.apache.org/licenses/LICENSE-2.0
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
16 # For those usages not covered by the Apache License, Version 2.0 please
17 # contact: legal@canonical.com
19 # To get in touch with the maintainers, please contact:
20 # osm-charmers@lists.launchpad.net
23 # pylint: disable=E0213
28 from typing
import NoReturn
, Optional
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 (
39 from opslib
.osm
.validator
import ModelValidator
, validator
42 logger
= logging
.getLogger(__name__
)
45 DEFAULT_MYSQL_DATABASE
= "pol"
48 class ConfigModel(ModelValidator
):
50 mongodb_uri
: Optional
[str]
51 mysql_uri
: Optional
[str]
52 image_pull_policy
: Optional
[str]
54 @validator("log_level")
55 def validate_log_level(cls
, v
):
56 if v
not in {"INFO", "DEBUG"}:
57 raise ValueError("value must be INFO or DEBUG")
60 @validator("mongoddb_uri")
61 def validate_mongodb_uri(cls
, v
):
62 if v
and not v
.startswith("mongodb://"):
63 raise ValueError("mongodb_uri is not properly formed")
66 @validator("mysql_uri")
67 def validate_mysql_uri(cls
, v
):
68 pattern
= re
.compile("^mysql:\/\/.*:.*@.*:\d+\/.*$") # noqa: W605
69 if v
and not pattern
.search(v
):
70 raise ValueError("mysql_uri is not properly formed")
73 @validator("image_pull_policy")
74 def validate_image_pull_policy(cls
, v
):
77 "ifnotpresent": "IfNotPresent",
81 if v
not in values
.keys():
82 raise ValueError("value must be always, ifnotpresent or never")
86 class PolCharm(CharmedOsmBase
):
87 def __init__(self
, *args
) -> NoReturn
:
88 super().__init
__(*args
, oci_image
="image")
90 self
.kafka_client
= KafkaClient(self
, "kafka")
91 self
.framework
.observe(self
.on
["kafka"].relation_changed
, self
.configure_pod
)
92 self
.framework
.observe(self
.on
["kafka"].relation_broken
, self
.configure_pod
)
94 self
.mongodb_client
= MongoClient(self
, "mongodb")
95 self
.framework
.observe(self
.on
["mongodb"].relation_changed
, self
.configure_pod
)
96 self
.framework
.observe(self
.on
["mongodb"].relation_broken
, self
.configure_pod
)
98 self
.mysql_client
= MysqlClient(self
, "mysql")
99 self
.framework
.observe(self
.on
["mysql"].relation_changed
, self
.configure_pod
)
100 self
.framework
.observe(self
.on
["mysql"].relation_broken
, self
.configure_pod
)
102 def _check_missing_dependencies(self
, config
: ConfigModel
):
103 missing_relations
= []
105 if self
.kafka_client
.is_missing_data_in_unit():
106 missing_relations
.append("kafka")
107 if not config
.mongodb_uri
and self
.mongodb_client
.is_missing_data_in_unit():
108 missing_relations
.append("mongodb")
109 if not config
.mysql_uri
and self
.mysql_client
.is_missing_data_in_unit():
110 missing_relations
.append("mysql")
111 if missing_relations
:
112 raise RelationsMissing(missing_relations
)
114 def build_pod_spec(self
, image_info
):
116 config
= ConfigModel(**dict(self
.config
))
118 if config
.mongodb_uri
and not self
.mongodb_client
.is_missing_data_in_unit():
119 raise Exception("Mongodb data cannot be provided via config and relation")
120 if config
.mysql_uri
and not self
.mysql_client
.is_missing_data_in_unit():
121 raise Exception("Mysql data cannot be provided via config and relation")
124 self
._check
_missing
_dependencies
(config
)
126 # Create Builder for the PodSpec
127 pod_spec_builder
= PodSpecV3Builder()
130 container_builder
= ContainerV3Builder(
131 self
.app
.name
, image_info
, config
.image_pull_policy
133 container_builder
.add_port(name
=self
.app
.name
, port
=PORT
)
134 container_builder
.add_envs(
136 # General configuration
137 "ALLOW_ANONYMOUS_LOGIN": "yes",
138 "OSMPOL_GLOBAL_LOGLEVEL": config
.log_level
,
139 # Kafka configuration
140 "OSMPOL_MESSAGE_DRIVER": "kafka",
141 "OSMPOL_MESSAGE_HOST": self
.kafka_client
.host
,
142 "OSMPOL_MESSAGE_PORT": self
.kafka_client
.port
,
143 # Database configuration
144 "OSMPOL_DATABASE_DRIVER": "mongo",
145 "OSMPOL_DATABASE_URI": config
.mongodb_uri
146 or self
.mongodb_client
.connection_string
,
147 "OSMPOL_SQL_DATABASE_URI": config
.mysql_uri
148 or self
.mysql_client
.get_root_uri(DEFAULT_MYSQL_DATABASE
),
151 container
= container_builder
.build()
153 # Add container to pod spec
154 pod_spec_builder
.add_container(container
)
156 return pod_spec_builder
.build()
159 if __name__
== "__main__":