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
:
91 debug_mode_config_key
="debug_mode",
92 debug_pubkey_config_key
="debug_pubkey",
93 vscode_workspace
=VSCODE_WORKSPACE
,
96 self
.kafka_client
= KafkaClient(self
, "kafka")
97 self
.framework
.observe(self
.on
["kafka"].relation_changed
, self
.configure_pod
)
98 self
.framework
.observe(self
.on
["kafka"].relation_broken
, self
.configure_pod
)
100 self
.mongodb_client
= MongoClient(self
, "mongodb")
101 self
.framework
.observe(self
.on
["mongodb"].relation_changed
, self
.configure_pod
)
102 self
.framework
.observe(self
.on
["mongodb"].relation_broken
, self
.configure_pod
)
104 self
.mysql_client
= MysqlClient(self
, "mysql")
105 self
.framework
.observe(self
.on
["mysql"].relation_changed
, self
.configure_pod
)
106 self
.framework
.observe(self
.on
["mysql"].relation_broken
, self
.configure_pod
)
108 def _check_missing_dependencies(self
, config
: ConfigModel
):
109 missing_relations
= []
111 if self
.kafka_client
.is_missing_data_in_unit():
112 missing_relations
.append("kafka")
113 if not config
.mongodb_uri
and self
.mongodb_client
.is_missing_data_in_unit():
114 missing_relations
.append("mongodb")
115 if not config
.mysql_uri
and self
.mysql_client
.is_missing_data_in_unit():
116 missing_relations
.append("mysql")
117 if missing_relations
:
118 raise RelationsMissing(missing_relations
)
120 def build_pod_spec(self
, image_info
):
122 config
= ConfigModel(**dict(self
.config
))
124 if config
.mongodb_uri
and not self
.mongodb_client
.is_missing_data_in_unit():
125 raise Exception("Mongodb data cannot be provided via config and relation")
126 if config
.mysql_uri
and not self
.mysql_client
.is_missing_data_in_unit():
127 raise Exception("Mysql data cannot be provided via config and relation")
130 self
._check
_missing
_dependencies
(config
)
132 # Create Builder for the PodSpec
133 pod_spec_builder
= PodSpecV3Builder()
136 container_builder
= ContainerV3Builder(
137 self
.app
.name
, image_info
, config
.image_pull_policy
139 container_builder
.add_port(name
=self
.app
.name
, port
=PORT
)
140 container_builder
.add_envs(
142 # General configuration
143 "ALLOW_ANONYMOUS_LOGIN": "yes",
144 "OSMPOL_GLOBAL_LOGLEVEL": config
.log_level
,
145 # Kafka configuration
146 "OSMPOL_MESSAGE_DRIVER": "kafka",
147 "OSMPOL_MESSAGE_HOST": self
.kafka_client
.host
,
148 "OSMPOL_MESSAGE_PORT": self
.kafka_client
.port
,
149 # Database configuration
150 "OSMPOL_DATABASE_DRIVER": "mongo",
151 "OSMPOL_DATABASE_URI": config
.mongodb_uri
152 or self
.mongodb_client
.connection_string
,
153 "OSMPOL_SQL_DATABASE_URI": config
.mysql_uri
154 or self
.mysql_client
.get_root_uri(DEFAULT_MYSQL_DATABASE
),
157 container
= container_builder
.build()
159 # Add container to pod spec
160 pod_spec_builder
.add_container(container
)
162 return pod_spec_builder
.build()
167 {"path": "/usr/lib/python3/dist-packages/osm_policy_module"},
168 {"path": "/usr/lib/python3/dist-packages/osm_common"},
178 "module": "osm_policy_module.cmd.policy_module_agent",
186 if __name__
== "__main__":