2a8c110d1ac902d4aef50fbf28f1999d2fa3aaed
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
27 from typing
import NoReturn
, Optional
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
.interfaces
.mysql
import MysqlClient
34 from opslib
.osm
.pod
import (
40 from opslib
.osm
.validator
import ModelValidator
, validator
42 logger
= logging
.getLogger(__name__
)
47 def _check_certificate_data(name
: str, content
: str):
48 if not name
or not content
:
49 raise ValueError("certificate name and content must be a non-empty string")
52 def _extract_certificates(certs_config
: str):
55 cert_list
= certs_config
.split(",")
56 for cert
in cert_list
:
57 name
, content
= cert
.split(":")
58 _check_certificate_data(name
, content
)
59 certificates
[name
] = content
63 def decode(content
: str):
64 return base64
.b64decode(content
.encode("utf-8")).decode("utf-8")
67 class ConfigModel(ModelValidator
):
69 database_commonkey
: str
70 mongodb_uri
: Optional
[str]
72 mysql_host
: Optional
[str]
73 mysql_port
: Optional
[int]
74 mysql_user
: Optional
[str]
75 mysql_password
: Optional
[str]
76 mysql_root_password
: Optional
[str]
80 certificates
: Optional
[str]
81 image_pull_policy
: str
83 security_context
: bool
85 @validator("log_level")
86 def validate_log_level(cls
, v
):
87 if v
not in {"INFO", "DEBUG"}:
88 raise ValueError("value must be INFO or DEBUG")
91 @validator("certificates")
92 def validate_certificates(cls
, v
):
93 # Raises an exception if it cannot extract the certificates
94 _extract_certificates(v
)
97 @validator("mongodb_uri")
98 def validate_mongodb_uri(cls
, v
):
99 if v
and not v
.startswith("mongodb://"):
100 raise ValueError("mongodb_uri is not properly formed")
103 @validator("mysql_port")
104 def validate_mysql_port(cls
, v
):
105 if v
and (v
<= 0 or v
>= 65535):
106 raise ValueError("Mysql port out of range")
109 @validator("image_pull_policy")
110 def validate_image_pull_policy(cls
, v
):
113 "ifnotpresent": "IfNotPresent",
117 if v
not in values
.keys():
118 raise ValueError("value must be always, ifnotpresent or never")
122 def certificates_dict(cls
):
123 return _extract_certificates(cls
.certificates
) if cls
.certificates
else {}
126 class RoCharm(CharmedOsmBase
):
127 """GrafanaCharm Charm."""
129 def __init__(self
, *args
) -> NoReturn
:
130 """Prometheus Charm constructor."""
134 debug_mode_config_key
="debug_mode",
135 debug_pubkey_config_key
="debug_pubkey",
136 vscode_workspace
=VSCODE_WORKSPACE
,
139 self
.kafka_client
= KafkaClient(self
, "kafka")
140 self
.framework
.observe(self
.on
["kafka"].relation_changed
, self
.configure_pod
)
141 self
.framework
.observe(self
.on
["kafka"].relation_broken
, self
.configure_pod
)
143 self
.mysql_client
= MysqlClient(self
, "mysql")
144 self
.framework
.observe(self
.on
["mysql"].relation_changed
, self
.configure_pod
)
145 self
.framework
.observe(self
.on
["mysql"].relation_broken
, self
.configure_pod
)
147 self
.mongodb_client
= MongoClient(self
, "mongodb")
148 self
.framework
.observe(self
.on
["mongodb"].relation_changed
, self
.configure_pod
)
149 self
.framework
.observe(self
.on
["mongodb"].relation_broken
, self
.configure_pod
)
151 self
.framework
.observe(self
.on
["ro"].relation_joined
, self
._publish
_ro
_info
)
153 def _publish_ro_info(self
, event
):
154 """Publishes RO information.
157 event (EventBase): RO relation event.
159 if self
.unit
.is_leader():
161 "host": self
.model
.app
.name
,
164 for k
, v
in rel_data
.items():
165 event
.relation
.data
[self
.app
][k
] = v
167 def _check_missing_dependencies(self
, config
: ConfigModel
):
168 missing_relations
= []
170 if config
.enable_ng_ro
:
171 if self
.kafka_client
.is_missing_data_in_unit():
172 missing_relations
.append("kafka")
173 if not config
.mongodb_uri
and self
.mongodb_client
.is_missing_data_in_unit():
174 missing_relations
.append("mongodb")
176 if not config
.mysql_host
and self
.mysql_client
.is_missing_data_in_unit():
177 missing_relations
.append("mysql")
178 if missing_relations
:
179 raise RelationsMissing(missing_relations
)
181 def _validate_mysql_config(self
, config
: ConfigModel
):
183 if not config
.mysql_user
:
184 invalid_values
.append("Mysql user is empty")
185 if not config
.mysql_password
:
186 invalid_values
.append("Mysql password is empty")
187 if not config
.mysql_root_password
:
188 invalid_values
.append("Mysql root password empty")
191 raise ValueError("Invalid values: " + ", ".join(invalid_values
))
193 def _build_cert_files(
197 cert_files_builder
= FilesV3Builder()
198 for name
, content
in config
.certificates_dict
.items():
199 cert_files_builder
.add_file(name
, decode(content
), mode
=0o600)
200 return cert_files_builder
.build()
202 def build_pod_spec(self
, image_info
):
204 config
= ConfigModel(**dict(self
.config
))
206 if config
.enable_ng_ro
:
207 if config
.mongodb_uri
and not self
.mongodb_client
.is_missing_data_in_unit():
209 "Mongodb data cannot be provided via config and relation"
212 if config
.mysql_host
and not self
.mysql_client
.is_missing_data_in_unit():
213 raise Exception("Mysql data cannot be provided via config and relation")
215 if config
.mysql_host
:
216 self
._validate
_mysql
_config
(config
)
219 self
._check
_missing
_dependencies
(config
)
221 security_context_enabled
= (
222 config
.security_context
if not config
.debug_mode
else False
225 # Create Builder for the PodSpec
226 pod_spec_builder
= PodSpecV3Builder(
227 enable_security_context
=security_context_enabled
231 container_builder
= ContainerV3Builder(
234 config
.image_pull_policy
,
235 run_as_non_root
=security_context_enabled
,
237 certs_files
= self
._build
_cert
_files
(config
)
240 container_builder
.add_volume_config("certs", "/certs", certs_files
)
242 container_builder
.add_port(name
=self
.app
.name
, port
=PORT
)
243 container_builder
.add_http_readiness_probe(
244 "/ro/" if config
.enable_ng_ro
else "/openmano/tenants",
246 initial_delay_seconds
=10,
251 container_builder
.add_http_liveness_probe(
252 "/ro/" if config
.enable_ng_ro
else "/openmano/tenants",
254 initial_delay_seconds
=600,
259 container_builder
.add_envs(
261 "OSMRO_LOG_LEVEL": config
.log_level
,
265 if config
.enable_ng_ro
:
266 # Add secrets to the pod
267 mongodb_secret_name
= f
"{self.app.name}-mongodb-secret"
268 pod_spec_builder
.add_secret(
271 "uri": config
.mongodb_uri
or self
.mongodb_client
.connection_string
,
272 "commonkey": config
.database_commonkey
,
275 container_builder
.add_envs(
277 "OSMRO_MESSAGE_DRIVER": "kafka",
278 "OSMRO_MESSAGE_HOST": self
.kafka_client
.host
,
279 "OSMRO_MESSAGE_PORT": self
.kafka_client
.port
,
280 # MongoDB configuration
281 "OSMRO_DATABASE_DRIVER": "mongo",
284 container_builder
.add_secret_envs(
285 secret_name
=mongodb_secret_name
,
287 "OSMRO_DATABASE_URI": "uri",
288 "OSMRO_DATABASE_COMMONKEY": "commonkey",
291 restart_policy
= PodRestartPolicy()
292 restart_policy
.add_secrets(secret_names
=(mongodb_secret_name
,))
293 pod_spec_builder
.set_restart_policy(restart_policy
)
296 container_builder
.add_envs(
298 "RO_DB_HOST": config
.mysql_host
or self
.mysql_client
.host
,
299 "RO_DB_OVIM_HOST": config
.mysql_host
or self
.mysql_client
.host
,
300 "RO_DB_PORT": config
.mysql_port
or self
.mysql_client
.port
,
301 "RO_DB_OVIM_PORT": config
.mysql_port
or self
.mysql_client
.port
,
302 "RO_DB_USER": config
.mysql_user
or self
.mysql_client
.user
,
303 "RO_DB_OVIM_USER": config
.mysql_user
or self
.mysql_client
.user
,
304 "RO_DB_PASSWORD": config
.mysql_password
305 or self
.mysql_client
.password
,
306 "RO_DB_OVIM_PASSWORD": config
.mysql_password
307 or self
.mysql_client
.password
,
308 "RO_DB_ROOT_PASSWORD": config
.mysql_root_password
309 or self
.mysql_client
.root_password
,
310 "RO_DB_OVIM_ROOT_PASSWORD": config
.mysql_root_password
311 or self
.mysql_client
.root_password
,
312 "RO_DB_NAME": config
.ro_database
,
313 "RO_DB_OVIM_NAME": config
.vim_database
,
314 "OPENMANO_TENANT": config
.openmano_tenant
,
317 container
= container_builder
.build()
319 # Add container to pod spec
320 pod_spec_builder
.add_container(container
)
322 return pod_spec_builder
.build()
327 {"path": "/usr/lib/python3/dist-packages/osm_ng_ro"},
328 {"path": "/usr/lib/python3/dist-packages/osm_common"},
329 {"path": "/usr/lib/python3/dist-packages/osm_ro_plugin"},
330 {"path": "/usr/lib/python3/dist-packages/osm_rosdn_arista_cloudvision"},
331 {"path": "/usr/lib/python3/dist-packages/osm_rosdn_dpb"},
332 {"path": "/usr/lib/python3/dist-packages/osm_rosdn_dynpac"},
333 {"path": "/usr/lib/python3/dist-packages/osm_rosdn_floodlightof"},
334 {"path": "/usr/lib/python3/dist-packages/osm_rosdn_ietfl2vpn"},
335 {"path": "/usr/lib/python3/dist-packages/osm_rosdn_juniper_contrail"},
336 {"path": "/usr/lib/python3/dist-packages/osm_rosdn_odlof"},
337 {"path": "/usr/lib/python3/dist-packages/osm_rosdn_onos_vpls"},
338 {"path": "/usr/lib/python3/dist-packages/osm_rosdn_onosof"},
339 {"path": "/usr/lib/python3/dist-packages/osm_rovim_aws"},
340 {"path": "/usr/lib/python3/dist-packages/osm_rovim_azure"},
341 {"path": "/usr/lib/python3/dist-packages/osm_rovim_fos"},
342 {"path": "/usr/lib/python3/dist-packages/osm_rovim_opennebula"},
343 {"path": "/usr/lib/python3/dist-packages/osm_rovim_openstack"},
344 {"path": "/usr/lib/python3/dist-packages/osm_rovim_openvim"},
345 {"path": "/usr/lib/python3/dist-packages/osm_rovim_vmware"},
350 "module": "osm_ng_ro.ro_main",
362 if __name__
== "__main__":