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 (
40 from opslib
.osm
.validator
import ModelValidator
, validator
43 logger
= logging
.getLogger(__name__
)
46 DEFAULT_MYSQL_DATABASE
= "pol"
49 class ConfigModel(ModelValidator
):
51 mongodb_uri
: Optional
[str]
52 mysql_uri
: Optional
[str]
53 image_pull_policy
: str
55 security_context
: bool
57 @validator("log_level")
58 def validate_log_level(cls
, v
):
59 if v
not in {"INFO", "DEBUG"}:
60 raise ValueError("value must be INFO or DEBUG")
63 @validator("mongoddb_uri")
64 def validate_mongodb_uri(cls
, v
):
65 if v
and not v
.startswith("mongodb://"):
66 raise ValueError("mongodb_uri is not properly formed")
69 @validator("mysql_uri")
70 def validate_mysql_uri(cls
, v
):
71 pattern
= re
.compile("^mysql:\/\/.*:.*@.*:\d+\/.*$") # noqa: W605
72 if v
and not pattern
.search(v
):
73 raise ValueError("mysql_uri is not properly formed")
76 @validator("image_pull_policy")
77 def validate_image_pull_policy(cls
, v
):
80 "ifnotpresent": "IfNotPresent",
84 if v
not in values
.keys():
85 raise ValueError("value must be always, ifnotpresent or never")
89 class PolCharm(CharmedOsmBase
):
90 def __init__(self
, *args
) -> NoReturn
:
94 debug_mode_config_key
="debug_mode",
95 debug_pubkey_config_key
="debug_pubkey",
96 vscode_workspace
=VSCODE_WORKSPACE
,
99 self
.kafka_client
= KafkaClient(self
, "kafka")
100 self
.framework
.observe(self
.on
["kafka"].relation_changed
, self
.configure_pod
)
101 self
.framework
.observe(self
.on
["kafka"].relation_broken
, self
.configure_pod
)
103 self
.mongodb_client
= MongoClient(self
, "mongodb")
104 self
.framework
.observe(self
.on
["mongodb"].relation_changed
, self
.configure_pod
)
105 self
.framework
.observe(self
.on
["mongodb"].relation_broken
, self
.configure_pod
)
107 self
.mysql_client
= MysqlClient(self
, "mysql")
108 self
.framework
.observe(self
.on
["mysql"].relation_changed
, self
.configure_pod
)
109 self
.framework
.observe(self
.on
["mysql"].relation_broken
, self
.configure_pod
)
111 def _check_missing_dependencies(self
, config
: ConfigModel
):
112 missing_relations
= []
115 self
.kafka_client
.is_missing_data_in_unit()
116 and self
.kafka_client
.is_missing_data_in_app()
118 missing_relations
.append("kafka")
119 if not config
.mongodb_uri
and self
.mongodb_client
.is_missing_data_in_unit():
120 missing_relations
.append("mongodb")
121 if not config
.mysql_uri
and self
.mysql_client
.is_missing_data_in_unit():
122 missing_relations
.append("mysql")
123 if missing_relations
:
124 raise RelationsMissing(missing_relations
)
126 def build_pod_spec(self
, image_info
):
128 config
= ConfigModel(**dict(self
.config
))
130 if config
.mongodb_uri
and not self
.mongodb_client
.is_missing_data_in_unit():
131 raise Exception("Mongodb data cannot be provided via config and relation")
132 if config
.mysql_uri
and not self
.mysql_client
.is_missing_data_in_unit():
133 raise Exception("Mysql data cannot be provided via config and relation")
136 self
._check
_missing
_dependencies
(config
)
138 security_context_enabled
= (
139 config
.security_context
if not config
.debug_mode
else False
142 # Create Builder for the PodSpec
143 pod_spec_builder
= PodSpecV3Builder(
144 enable_security_context
=security_context_enabled
147 # Add secrets to the pod
148 mongodb_secret_name
= f
"{self.app.name}-mongodb-secret"
149 pod_spec_builder
.add_secret(
151 {"uri": config
.mongodb_uri
or self
.mongodb_client
.connection_string
},
153 mysql_secret_name
= f
"{self.app.name}-mysql-secret"
154 pod_spec_builder
.add_secret(
157 "uri": config
.mysql_uri
158 or self
.mysql_client
.get_root_uri(DEFAULT_MYSQL_DATABASE
)
163 container_builder
= ContainerV3Builder(
166 config
.image_pull_policy
,
167 run_as_non_root
=security_context_enabled
,
169 container_builder
.add_port(name
=self
.app
.name
, port
=PORT
)
170 container_builder
.add_envs(
172 # General configuration
173 "ALLOW_ANONYMOUS_LOGIN": "yes",
174 "OSMPOL_GLOBAL_LOGLEVEL": config
.log_level
,
175 # Kafka configuration
176 "OSMPOL_MESSAGE_DRIVER": "kafka",
177 "OSMPOL_MESSAGE_HOST": self
.kafka_client
.host
,
178 "OSMPOL_MESSAGE_PORT": self
.kafka_client
.port
,
179 # Database configuration
180 "OSMPOL_DATABASE_DRIVER": "mongo",
183 container_builder
.add_secret_envs(
184 mongodb_secret_name
, {"OSMPOL_DATABASE_URI": "uri"}
186 container_builder
.add_secret_envs(
187 mysql_secret_name
, {"OSMPOL_SQL_DATABASE_URI": "uri"}
189 container
= container_builder
.build()
191 # Add Pod restart policy
192 restart_policy
= PodRestartPolicy()
193 restart_policy
.add_secrets(
194 secret_names
=(mongodb_secret_name
, mysql_secret_name
)
196 pod_spec_builder
.set_restart_policy(restart_policy
)
198 # Add container to pod spec
199 pod_spec_builder
.add_container(container
)
201 return pod_spec_builder
.build()
206 {"path": "/usr/lib/python3/dist-packages/osm_policy_module"},
207 {"path": "/usr/lib/python3/dist-packages/osm_common"},
217 "module": "osm_policy_module.cmd.policy_module_agent",
225 if __name__
== "__main__":