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 ContainerV3Builder
, FilesV3Builder
, PodSpecV3Builder
35 from opslib
.osm
.validator
import ModelValidator
, validator
37 logger
= logging
.getLogger(__name__
)
42 def _check_certificate_data(name
: str, content
: str):
43 if not name
or not content
:
44 raise ValueError("certificate name and content must be a non-empty string")
47 def _extract_certificates(certs_config
: str):
50 cert_list
= certs_config
.split(",")
51 for cert
in cert_list
:
52 name
, content
= cert
.split(":")
53 _check_certificate_data(name
, content
)
54 certificates
[name
] = content
58 def decode(content
: str):
59 return base64
.b64decode(content
.encode("utf-8")).decode("utf-8")
62 class ConfigModel(ModelValidator
):
64 database_commonkey
: str
65 mongodb_uri
: Optional
[str]
67 mysql_host
: Optional
[str]
68 mysql_port
: Optional
[int]
69 mysql_user
: Optional
[str]
70 mysql_password
: Optional
[str]
71 mysql_root_password
: Optional
[str]
75 certificates
: Optional
[str]
76 image_pull_policy
: Optional
[str]
78 @validator("log_level")
79 def validate_log_level(cls
, v
):
80 if v
not in {"INFO", "DEBUG"}:
81 raise ValueError("value must be INFO or DEBUG")
84 @validator("certificates")
85 def validate_certificates(cls
, v
):
86 # Raises an exception if it cannot extract the certificates
87 _extract_certificates(v
)
90 @validator("mongodb_uri")
91 def validate_mongodb_uri(cls
, v
):
92 if v
and not v
.startswith("mongodb://"):
93 raise ValueError("mongodb_uri is not properly formed")
96 @validator("mysql_port")
97 def validate_mysql_port(cls
, v
):
98 if v
and (v
<= 0 or v
>= 65535):
99 raise ValueError("Mysql port out of range")
102 @validator("image_pull_policy")
103 def validate_image_pull_policy(cls
, v
):
106 "ifnotpresent": "IfNotPresent",
110 if v
not in values
.keys():
111 raise ValueError("value must be always, ifnotpresent or never")
115 def certificates_dict(cls
):
116 return _extract_certificates(cls
.certificates
) if cls
.certificates
else {}
119 class RoCharm(CharmedOsmBase
):
120 """GrafanaCharm Charm."""
122 def __init__(self
, *args
) -> NoReturn
:
123 """Prometheus Charm constructor."""
127 debug_mode_config_key
="debug_mode",
128 debug_pubkey_config_key
="debug_pubkey",
129 vscode_workspace
=VSCODE_WORKSPACE
,
132 self
.kafka_client
= KafkaClient(self
, "kafka")
133 self
.framework
.observe(self
.on
["kafka"].relation_changed
, self
.configure_pod
)
134 self
.framework
.observe(self
.on
["kafka"].relation_broken
, self
.configure_pod
)
136 self
.mysql_client
= MysqlClient(self
, "mysql")
137 self
.framework
.observe(self
.on
["mysql"].relation_changed
, self
.configure_pod
)
138 self
.framework
.observe(self
.on
["mysql"].relation_broken
, self
.configure_pod
)
140 self
.mongodb_client
= MongoClient(self
, "mongodb")
141 self
.framework
.observe(self
.on
["mongodb"].relation_changed
, self
.configure_pod
)
142 self
.framework
.observe(self
.on
["mongodb"].relation_broken
, self
.configure_pod
)
144 self
.framework
.observe(self
.on
["ro"].relation_joined
, self
._publish
_ro
_info
)
146 def _publish_ro_info(self
, event
):
147 """Publishes RO information.
150 event (EventBase): RO relation event.
152 if self
.unit
.is_leader():
154 "host": self
.model
.app
.name
,
157 for k
, v
in rel_data
.items():
158 event
.relation
.data
[self
.app
][k
] = v
160 def _check_missing_dependencies(self
, config
: ConfigModel
):
161 missing_relations
= []
163 if config
.enable_ng_ro
:
164 if self
.kafka_client
.is_missing_data_in_unit():
165 missing_relations
.append("kafka")
166 if not config
.mongodb_uri
and self
.mongodb_client
.is_missing_data_in_unit():
167 missing_relations
.append("mongodb")
169 if not config
.mysql_host
and self
.mysql_client
.is_missing_data_in_unit():
170 missing_relations
.append("mysql")
171 if missing_relations
:
172 raise RelationsMissing(missing_relations
)
174 def _validate_mysql_config(self
, config
: ConfigModel
):
176 if not config
.mysql_user
:
177 invalid_values
.append("Mysql user is empty")
178 if not config
.mysql_password
:
179 invalid_values
.append("Mysql password is empty")
180 if not config
.mysql_root_password
:
181 invalid_values
.append("Mysql root password empty")
184 raise ValueError("Invalid values: " + ", ".join(invalid_values
))
186 def _build_cert_files(
190 cert_files_builder
= FilesV3Builder()
191 for name
, content
in config
.certificates_dict
.items():
192 cert_files_builder
.add_file(name
, decode(content
), mode
=0o600)
193 return cert_files_builder
.build()
195 def build_pod_spec(self
, image_info
):
197 config
= ConfigModel(**dict(self
.config
))
199 if config
.enable_ng_ro
:
200 if config
.mongodb_uri
and not self
.mongodb_client
.is_missing_data_in_unit():
202 "Mongodb data cannot be provided via config and relation"
205 if config
.mysql_host
and not self
.mysql_client
.is_missing_data_in_unit():
206 raise Exception("Mysql data cannot be provided via config and relation")
208 if config
.mysql_host
:
209 self
._validate
_mysql
_config
(config
)
212 self
._check
_missing
_dependencies
(config
)
214 # Create Builder for the PodSpec
215 pod_spec_builder
= PodSpecV3Builder()
218 container_builder
= ContainerV3Builder(
219 self
.app
.name
, image_info
, config
.image_pull_policy
221 certs_files
= self
._build
_cert
_files
(config
)
224 container_builder
.add_volume_config("certs", "/certs", certs_files
)
226 container_builder
.add_port(name
=self
.app
.name
, port
=PORT
)
227 container_builder
.add_http_readiness_probe(
228 "/ro/" if config
.enable_ng_ro
else "/openmano/tenants",
230 initial_delay_seconds
=10,
235 container_builder
.add_http_liveness_probe(
236 "/ro/" if config
.enable_ng_ro
else "/openmano/tenants",
238 initial_delay_seconds
=600,
243 container_builder
.add_envs(
245 "OSMRO_LOG_LEVEL": config
.log_level
,
249 if config
.enable_ng_ro
:
250 container_builder
.add_envs(
252 "OSMRO_MESSAGE_DRIVER": "kafka",
253 "OSMRO_MESSAGE_HOST": self
.kafka_client
.host
,
254 "OSMRO_MESSAGE_PORT": self
.kafka_client
.port
,
255 # MongoDB configuration
256 "OSMRO_DATABASE_DRIVER": "mongo",
257 "OSMRO_DATABASE_URI": config
.mongodb_uri
258 or self
.mongodb_client
.connection_string
,
259 "OSMRO_DATABASE_COMMONKEY": config
.database_commonkey
,
264 container_builder
.add_envs(
266 "RO_DB_HOST": config
.mysql_host
or self
.mysql_client
.host
,
267 "RO_DB_OVIM_HOST": config
.mysql_host
or self
.mysql_client
.host
,
268 "RO_DB_PORT": config
.mysql_port
or self
.mysql_client
.port
,
269 "RO_DB_OVIM_PORT": config
.mysql_port
or self
.mysql_client
.port
,
270 "RO_DB_USER": config
.mysql_user
or self
.mysql_client
.user
,
271 "RO_DB_OVIM_USER": config
.mysql_user
or self
.mysql_client
.user
,
272 "RO_DB_PASSWORD": config
.mysql_password
273 or self
.mysql_client
.password
,
274 "RO_DB_OVIM_PASSWORD": config
.mysql_password
275 or self
.mysql_client
.password
,
276 "RO_DB_ROOT_PASSWORD": config
.mysql_root_password
277 or self
.mysql_client
.root_password
,
278 "RO_DB_OVIM_ROOT_PASSWORD": config
.mysql_root_password
279 or self
.mysql_client
.root_password
,
280 "RO_DB_NAME": config
.ro_database
,
281 "RO_DB_OVIM_NAME": config
.vim_database
,
282 "OPENMANO_TENANT": config
.openmano_tenant
,
285 container
= container_builder
.build()
287 # Add container to pod spec
288 pod_spec_builder
.add_container(container
)
290 return pod_spec_builder
.build()
295 {"path": "/usr/lib/python3/dist-packages/osm_ng_ro"},
296 {"path": "/usr/lib/python3/dist-packages/osm_common"},
297 {"path": "/usr/lib/python3/dist-packages/osm_ro_plugin"},
298 {"path": "/usr/lib/python3/dist-packages/osm_rosdn_arista_cloudvision"},
299 {"path": "/usr/lib/python3/dist-packages/osm_rosdn_dpb"},
300 {"path": "/usr/lib/python3/dist-packages/osm_rosdn_dynpac"},
301 {"path": "/usr/lib/python3/dist-packages/osm_rosdn_floodlightof"},
302 {"path": "/usr/lib/python3/dist-packages/osm_rosdn_ietfl2vpn"},
303 {"path": "/usr/lib/python3/dist-packages/osm_rosdn_juniper_contrail"},
304 {"path": "/usr/lib/python3/dist-packages/osm_rosdn_odlof"},
305 {"path": "/usr/lib/python3/dist-packages/osm_rosdn_onos_vpls"},
306 {"path": "/usr/lib/python3/dist-packages/osm_rosdn_onosof"},
307 {"path": "/usr/lib/python3/dist-packages/osm_rovim_aws"},
308 {"path": "/usr/lib/python3/dist-packages/osm_rovim_azure"},
309 {"path": "/usr/lib/python3/dist-packages/osm_rovim_fos"},
310 {"path": "/usr/lib/python3/dist-packages/osm_rovim_opennebula"},
311 {"path": "/usr/lib/python3/dist-packages/osm_rovim_openstack"},
312 {"path": "/usr/lib/python3/dist-packages/osm_rovim_openvim"},
313 {"path": "/usr/lib/python3/dist-packages/osm_rovim_vmware"},
318 "module": "osm_ng_ro.ro_main",
330 if __name__
== "__main__":