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
31 from charms
.kafka_k8s
.v0
.kafka
import KafkaEvents
, KafkaRequires
32 from ops
.main
import main
33 from opslib
.osm
.charm
import CharmedOsmBase
, RelationsMissing
34 from opslib
.osm
.interfaces
.keystone
import KeystoneClient
35 from opslib
.osm
.interfaces
.mongo
import MongoClient
36 from opslib
.osm
.interfaces
.prometheus
import PrometheusClient
37 from opslib
.osm
.pod
import (
43 from opslib
.osm
.validator
import ModelValidator
, validator
46 logger
= logging
.getLogger(__name__
)
51 def _check_certificate_data(name
: str, content
: str):
52 if not name
or not content
:
53 raise ValueError("certificate name and content must be a non-empty string")
56 def _extract_certificates(certs_config
: str):
59 cert_list
= certs_config
.split(",")
60 for cert
in cert_list
:
61 name
, content
= cert
.split(":")
62 _check_certificate_data(name
, content
)
63 certificates
[name
] = content
67 def decode(content
: str):
68 return base64
.b64decode(content
.encode("utf-8")).decode("utf-8")
71 class ConfigModel(ModelValidator
):
72 keystone_enabled
: bool
77 database_commonkey
: str
78 mongodb_uri
: Optional
[str]
80 openstack_default_granularity
: int
81 global_request_timeout
: int
82 collector_interval
: int
83 evaluator_interval
: int
87 certificates
: Optional
[str]
88 image_pull_policy
: str
90 security_context
: bool
92 @validator("log_level")
93 def validate_log_level(cls
, v
):
94 if v
not in {"INFO", "DEBUG"}:
95 raise ValueError("value must be INFO or DEBUG")
98 @validator("certificates")
99 def validate_certificates(cls
, v
):
100 # Raises an exception if it cannot extract the certificates
101 _extract_certificates(v
)
104 @validator("mongodb_uri")
105 def validate_mongodb_uri(cls
, v
):
106 if v
and not v
.startswith("mongodb://"):
107 raise ValueError("mongodb_uri is not properly formed")
110 @validator("image_pull_policy")
111 def validate_image_pull_policy(cls
, v
):
114 "ifnotpresent": "IfNotPresent",
118 if v
not in values
.keys():
119 raise ValueError("value must be always, ifnotpresent or never")
123 def certificates_dict(cls
):
124 return _extract_certificates(cls
.certificates
) if cls
.certificates
else {}
127 class MonCharm(CharmedOsmBase
):
130 def __init__(self
, *args
) -> NoReturn
:
134 vscode_workspace
=VSCODE_WORKSPACE
,
136 if self
.config
.get("debug_mode"):
137 self
.enable_debug_mode(
138 pubkey
=self
.config
.get("debug_pubkey"),
141 "hostpath": self
.config
.get("debug_mon_local_path"),
142 "container-path": "/usr/lib/python3/dist-packages/osm_mon",
145 "hostpath": self
.config
.get("debug_n2vc_local_path"),
146 "container-path": "/usr/lib/python3/dist-packages/n2vc",
149 "hostpath": self
.config
.get("debug_common_local_path"),
150 "container-path": "/usr/lib/python3/dist-packages/osm_common",
154 self
.kafka
= KafkaRequires(self
)
155 self
.framework
.observe(self
.on
.kafka_available
, self
.configure_pod
)
156 self
.framework
.observe(self
.on
.kafka_broken
, self
.configure_pod
)
158 self
.mongodb_client
= MongoClient(self
, "mongodb")
159 self
.framework
.observe(self
.on
["mongodb"].relation_changed
, self
.configure_pod
)
160 self
.framework
.observe(self
.on
["mongodb"].relation_broken
, self
.configure_pod
)
162 self
.prometheus_client
= PrometheusClient(self
, "prometheus")
163 self
.framework
.observe(
164 self
.on
["prometheus"].relation_changed
, self
.configure_pod
166 self
.framework
.observe(
167 self
.on
["prometheus"].relation_broken
, self
.configure_pod
170 self
.keystone_client
= KeystoneClient(self
, "keystone")
171 self
.framework
.observe(self
.on
["keystone"].relation_changed
, self
.configure_pod
)
172 self
.framework
.observe(self
.on
["keystone"].relation_broken
, self
.configure_pod
)
174 def _check_missing_dependencies(self
, config
: ConfigModel
):
175 missing_relations
= []
177 if not self
.kafka
.host
or not self
.kafka
.port
:
178 missing_relations
.append("kafka")
179 if not config
.mongodb_uri
and self
.mongodb_client
.is_missing_data_in_unit():
180 missing_relations
.append("mongodb")
181 if self
.prometheus_client
.is_missing_data_in_app():
182 missing_relations
.append("prometheus")
183 if config
.keystone_enabled
:
184 if self
.keystone_client
.is_missing_data_in_app():
185 missing_relations
.append("keystone")
187 if missing_relations
:
188 raise RelationsMissing(missing_relations
)
190 def _build_cert_files(
194 cert_files_builder
= FilesV3Builder()
195 for name
, content
in config
.certificates_dict
.items():
196 cert_files_builder
.add_file(name
, decode(content
), mode
=0o600)
197 return cert_files_builder
.build()
199 def build_pod_spec(self
, image_info
):
201 config
= ConfigModel(**dict(self
.config
))
203 if config
.mongodb_uri
and not self
.mongodb_client
.is_missing_data_in_unit():
204 raise Exception("Mongodb data cannot be provided via config and relation")
207 self
._check
_missing
_dependencies
(config
)
209 security_context_enabled
= (
210 config
.security_context
if not config
.debug_mode
else False
213 # Create Builder for the PodSpec
214 pod_spec_builder
= PodSpecV3Builder(
215 enable_security_context
=security_context_enabled
218 # Add secrets to the pod
219 mongodb_secret_name
= f
"{self.app.name}-mongodb-secret"
220 pod_spec_builder
.add_secret(
223 "uri": config
.mongodb_uri
or self
.mongodb_client
.connection_string
,
224 "commonkey": config
.database_commonkey
,
227 grafana_secret_name
= f
"{self.app.name}-grafana-secret"
228 pod_spec_builder
.add_secret(
231 "url": config
.grafana_url
,
232 "user": config
.grafana_user
,
233 "password": config
.grafana_password
,
237 vca_secret_name
= f
"{self.app.name}-vca-secret"
238 pod_spec_builder
.add_secret(
241 "host": config
.vca_host
,
242 "user": config
.vca_user
,
243 "secret": config
.vca_secret
,
244 "cacert": config
.vca_cacert
,
249 container_builder
= ContainerV3Builder(
252 config
.image_pull_policy
,
253 run_as_non_root
=security_context_enabled
,
255 certs_files
= self
._build
_cert
_files
(config
)
258 container_builder
.add_volume_config("certs", "/certs", certs_files
)
260 container_builder
.add_port(name
=self
.app
.name
, port
=PORT
)
261 container_builder
.add_envs(
263 # General configuration
264 "ALLOW_ANONYMOUS_LOGIN": "yes",
265 "OSMMON_OPENSTACK_DEFAULT_GRANULARITY": config
.openstack_default_granularity
,
266 "OSMMON_GLOBAL_REQUEST_TIMEOUT": config
.global_request_timeout
,
267 "OSMMON_GLOBAL_LOGLEVEL": config
.log_level
,
268 "OSMMON_COLLECTOR_INTERVAL": config
.collector_interval
,
269 "OSMMON_EVALUATOR_INTERVAL": config
.evaluator_interval
,
270 # Kafka configuration
271 "OSMMON_MESSAGE_DRIVER": "kafka",
272 "OSMMON_MESSAGE_HOST": self
.kafka
.host
,
273 "OSMMON_MESSAGE_PORT": self
.kafka
.port
,
274 # Database configuration
275 "OSMMON_DATABASE_DRIVER": "mongo",
276 # Prometheus configuration
277 "OSMMON_PROMETHEUS_URL": f
"http://{self.prometheus_client.hostname}:{self.prometheus_client.port}",
280 prometheus_user
= self
.prometheus_client
.user
281 prometheus_password
= self
.prometheus_client
.password
282 if prometheus_user
and prometheus_password
:
283 container_builder
.add_envs(
285 "OSMMON_PROMETHEUS_USER": prometheus_user
,
286 "OSMMON_PROMETHEUS_PASSWORD": prometheus_password
,
289 container_builder
.add_secret_envs(
290 secret_name
=mongodb_secret_name
,
292 "OSMMON_DATABASE_URI": "uri",
293 "OSMMON_DATABASE_COMMONKEY": "commonkey",
296 container_builder
.add_secret_envs(
297 secret_name
=vca_secret_name
,
299 "OSMMON_VCA_HOST": "host",
300 "OSMMON_VCA_USER": "user",
301 "OSMMON_VCA_SECRET": "secret",
302 "OSMMON_VCA_CACERT": "cacert",
305 container_builder
.add_secret_envs(
306 secret_name
=grafana_secret_name
,
308 "OSMMON_GRAFANA_URL": "url",
309 "OSMMON_GRAFANA_USER": "user",
310 "OSMMON_GRAFANA_PASSWORD": "password",
313 if config
.keystone_enabled
:
314 keystone_secret_name
= f
"{self.app.name}-keystone-secret"
315 pod_spec_builder
.add_secret(
316 keystone_secret_name
,
318 "url": self
.keystone_client
.host
,
319 "user_domain": self
.keystone_client
.user_domain_name
,
320 "project_domain": self
.keystone_client
.project_domain_name
,
321 "service_username": self
.keystone_client
.username
,
322 "service_password": self
.keystone_client
.password
,
323 "service_project": self
.keystone_client
.service
,
326 container_builder
.add_env("OSMMON_KEYSTONE_ENABLED", True)
327 container_builder
.add_secret_envs(
328 secret_name
=keystone_secret_name
,
330 "OSMMON_KEYSTONE_URL": "url",
331 "OSMMON_KEYSTONE_DOMAIN_NAME": "user_domain",
332 "OSMMON_KEYSTONE_PROJECT_DOMAIN_NAME": "project_domain",
333 "OSMMON_KEYSTONE_SERVICE_USER": "service_username",
334 "OSMMON_KEYSTONE_SERVICE_PASSWORD": "service_password",
335 "OSMMON_KEYSTONE_SERVICE_PROJECT": "service_project",
338 container
= container_builder
.build()
341 restart_policy
= PodRestartPolicy()
342 restart_policy
.add_secrets()
343 pod_spec_builder
.set_restart_policy(restart_policy
)
345 # Add container to pod spec
346 pod_spec_builder
.add_container(container
)
348 return pod_spec_builder
.build()
353 {"path": "/usr/lib/python3/dist-packages/osm_mon"},
354 {"path": "/usr/lib/python3/dist-packages/osm_common"},
355 {"path": "/usr/lib/python3/dist-packages/n2vc"},
362 "name": "MON Server",
365 "module": "osm_mon.cmd.mon_server",
369 "name": "MON evaluator",
372 "module": "osm_mon.cmd.mon_evaluator",
376 "name": "MON collector",
379 "module": "osm_mon.cmd.mon_collector",
383 "name": "MON dashboarder",
386 "module": "osm_mon.cmd.mon_dashboarder",
392 if __name__
== "__main__":