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
30 from ops
.main
import main
31 from opslib
.osm
.charm
import CharmedOsmBase
, RelationsMissing
32 from opslib
.osm
.interfaces
.http
import HttpClient
33 from opslib
.osm
.interfaces
.kafka
import KafkaClient
34 from opslib
.osm
.interfaces
.mongo
import MongoClient
35 from opslib
.osm
.pod
import ContainerV3Builder
, PodRestartPolicy
, PodSpecV3Builder
36 from opslib
.osm
.validator
import ModelValidator
, validator
39 logger
= logging
.getLogger(__name__
)
44 class ConfigModel(ModelValidator
):
45 vca_host
: Optional
[str]
46 vca_port
: Optional
[int]
47 vca_user
: Optional
[str]
48 vca_secret
: Optional
[str]
49 vca_pubkey
: Optional
[str]
50 vca_cacert
: Optional
[str]
51 vca_cloud
: Optional
[str]
52 vca_k8s_cloud
: Optional
[str]
53 database_commonkey
: str
54 mongodb_uri
: Optional
[str]
56 vca_apiproxy
: Optional
[str]
57 # Model-config options
58 vca_model_config_agent_metadata_url
: Optional
[str]
59 vca_model_config_agent_stream
: Optional
[str]
60 vca_model_config_apt_ftp_proxy
: Optional
[str]
61 vca_model_config_apt_http_proxy
: Optional
[str]
62 vca_model_config_apt_https_proxy
: Optional
[str]
63 vca_model_config_apt_mirror
: Optional
[str]
64 vca_model_config_apt_no_proxy
: Optional
[str]
65 vca_model_config_automatically_retry_hooks
: Optional
[bool]
66 vca_model_config_backup_dir
: Optional
[str]
67 vca_model_config_cloudinit_userdata
: Optional
[str]
68 vca_model_config_container_image_metadata_url
: Optional
[str]
69 vca_model_config_container_image_stream
: Optional
[str]
70 vca_model_config_container_inherit_properties
: Optional
[str]
71 vca_model_config_container_networking_method
: Optional
[str]
72 vca_model_config_default_series
: Optional
[str]
73 vca_model_config_default_space
: Optional
[str]
74 vca_model_config_development
: Optional
[bool]
75 vca_model_config_disable_network_management
: Optional
[bool]
76 vca_model_config_egress_subnets
: Optional
[str]
77 vca_model_config_enable_os_refresh_update
: Optional
[bool]
78 vca_model_config_enable_os_upgrade
: Optional
[bool]
79 vca_model_config_fan_config
: Optional
[str]
80 vca_model_config_firewall_mode
: Optional
[str]
81 vca_model_config_ftp_proxy
: Optional
[str]
82 vca_model_config_http_proxy
: Optional
[str]
83 vca_model_config_https_proxy
: Optional
[str]
84 vca_model_config_ignore_machine_addresses
: Optional
[bool]
85 vca_model_config_image_metadata_url
: Optional
[str]
86 vca_model_config_image_stream
: Optional
[str]
87 vca_model_config_juju_ftp_proxy
: Optional
[str]
88 vca_model_config_juju_http_proxy
: Optional
[str]
89 vca_model_config_juju_https_proxy
: Optional
[str]
90 vca_model_config_juju_no_proxy
: Optional
[str]
91 vca_model_config_logforward_enabled
: Optional
[bool]
92 vca_model_config_logging_config
: Optional
[str]
93 vca_model_config_lxd_snap_channel
: Optional
[str]
94 vca_model_config_max_action_results_age
: Optional
[str]
95 vca_model_config_max_action_results_size
: Optional
[str]
96 vca_model_config_max_status_history_age
: Optional
[str]
97 vca_model_config_max_status_history_size
: Optional
[str]
98 vca_model_config_net_bond_reconfigure_delay
: Optional
[str]
99 vca_model_config_no_proxy
: Optional
[str]
100 vca_model_config_provisioner_harvest_mode
: Optional
[str]
101 vca_model_config_proxy_ssh
: Optional
[bool]
102 vca_model_config_snap_http_proxy
: Optional
[str]
103 vca_model_config_snap_https_proxy
: Optional
[str]
104 vca_model_config_snap_store_assertions
: Optional
[str]
105 vca_model_config_snap_store_proxy
: Optional
[str]
106 vca_model_config_snap_store_proxy_url
: Optional
[str]
107 vca_model_config_ssl_hostname_verification
: Optional
[bool]
108 vca_model_config_test_mode
: Optional
[bool]
109 vca_model_config_transmit_vendor_metrics
: Optional
[bool]
110 vca_model_config_update_status_hook_interval
: Optional
[str]
111 vca_stablerepourl
: Optional
[str]
112 vca_helm_ca_certs
: Optional
[str]
113 image_pull_policy
: str
115 security_context
: bool
117 @validator("log_level")
118 def validate_log_level(cls
, v
):
119 if v
not in {"INFO", "DEBUG"}:
120 raise ValueError("value must be INFO or DEBUG")
123 @validator("mongodb_uri")
124 def validate_mongodb_uri(cls
, v
):
125 if v
and not v
.startswith("mongodb://"):
126 raise ValueError("mongodb_uri is not properly formed")
129 @validator("image_pull_policy")
130 def validate_image_pull_policy(cls
, v
):
133 "ifnotpresent": "IfNotPresent",
137 if v
not in values
.keys():
138 raise ValueError("value must be always, ifnotpresent or never")
142 class LcmCharm(CharmedOsmBase
):
143 def __init__(self
, *args
) -> NoReturn
:
147 debug_mode_config_key
="debug_mode",
148 debug_pubkey_config_key
="debug_pubkey",
149 vscode_workspace
=VSCODE_WORKSPACE
,
151 self
.kafka_client
= KafkaClient(self
, "kafka")
152 self
.framework
.observe(self
.on
["kafka"].relation_changed
, self
.configure_pod
)
153 self
.framework
.observe(self
.on
["kafka"].relation_broken
, self
.configure_pod
)
155 self
.mongodb_client
= MongoClient(self
, "mongodb")
156 self
.framework
.observe(self
.on
["mongodb"].relation_changed
, self
.configure_pod
)
157 self
.framework
.observe(self
.on
["mongodb"].relation_broken
, self
.configure_pod
)
159 self
.ro_client
= HttpClient(self
, "ro")
160 self
.framework
.observe(self
.on
["ro"].relation_changed
, self
.configure_pod
)
161 self
.framework
.observe(self
.on
["ro"].relation_broken
, self
.configure_pod
)
163 def _check_missing_dependencies(self
, config
: ConfigModel
):
164 missing_relations
= []
166 if self
.kafka_client
.is_missing_data_in_unit():
167 missing_relations
.append("kafka")
168 if not config
.mongodb_uri
and self
.mongodb_client
.is_missing_data_in_unit():
169 missing_relations
.append("mongodb")
170 if self
.ro_client
.is_missing_data_in_app():
171 missing_relations
.append("ro")
173 if missing_relations
:
174 raise RelationsMissing(missing_relations
)
176 def build_pod_spec(self
, image_info
):
178 config
= ConfigModel(**dict(self
.config
))
180 if config
.mongodb_uri
and not self
.mongodb_client
.is_missing_data_in_unit():
181 raise Exception("Mongodb data cannot be provided via config and relation")
184 self
._check
_missing
_dependencies
(config
)
186 security_context_enabled
= (
187 config
.security_context
if not config
.debug_mode
else False
190 # Create Builder for the PodSpec
191 pod_spec_builder
= PodSpecV3Builder(
192 enable_security_context
=security_context_enabled
195 # Add secrets to the pod
196 lcm_secret_name
= f
"{self.app.name}-lcm-secret"
197 pod_spec_builder
.add_secret(
200 "uri": config
.mongodb_uri
or self
.mongodb_client
.connection_string
,
201 "commonkey": config
.database_commonkey
,
202 "helm_ca_certs": config
.vca_helm_ca_certs
,
207 container_builder
= ContainerV3Builder(
210 config
.image_pull_policy
,
211 run_as_non_root
=security_context_enabled
,
213 container_builder
.add_port(name
=self
.app
.name
, port
=PORT
)
214 container_builder
.add_envs(
216 # General configuration
217 "ALLOW_ANONYMOUS_LOGIN": "yes",
218 "OSMLCM_GLOBAL_LOGLEVEL": config
.log_level
,
220 "OSMLCM_RO_HOST": self
.ro_client
.host
,
221 "OSMLCM_RO_PORT": self
.ro_client
.port
,
222 "OSMLCM_RO_TENANT": "osm",
223 # Kafka configuration
224 "OSMLCM_MESSAGE_DRIVER": "kafka",
225 "OSMLCM_MESSAGE_HOST": self
.kafka_client
.host
,
226 "OSMLCM_MESSAGE_PORT": self
.kafka_client
.port
,
227 # Database configuration
228 "OSMLCM_DATABASE_DRIVER": "mongo",
229 # Storage configuration
230 "OSMLCM_STORAGE_DRIVER": "mongo",
231 "OSMLCM_STORAGE_PATH": "/app/storage",
232 "OSMLCM_STORAGE_COLLECTION": "files",
233 "OSMLCM_VCA_STABLEREPOURL": config
.vca_stablerepourl
,
236 container_builder
.add_secret_envs(
237 secret_name
=lcm_secret_name
,
239 "OSMLCM_DATABASE_URI": "uri",
240 "OSMLCM_DATABASE_COMMONKEY": "commonkey",
241 "OSMLCM_STORAGE_URI": "uri",
242 "OSMLCM_VCA_HELM_CA_CERTS": "helm_ca_certs",
246 vca_secret_name
= f
"{self.app.name}-vca-secret"
247 pod_spec_builder
.add_secret(
250 "host": config
.vca_host
,
251 "port": str(config
.vca_port
),
252 "user": config
.vca_user
,
253 "pubkey": config
.vca_pubkey
,
254 "secret": config
.vca_secret
,
255 "cacert": config
.vca_cacert
,
256 "cloud": config
.vca_cloud
,
257 "k8s_cloud": config
.vca_k8s_cloud
,
260 container_builder
.add_secret_envs(
261 secret_name
=vca_secret_name
,
264 "OSMLCM_VCA_HOST": "host",
265 "OSMLCM_VCA_PORT": "port",
266 "OSMLCM_VCA_USER": "user",
267 "OSMLCM_VCA_PUBKEY": "pubkey",
268 "OSMLCM_VCA_SECRET": "secret",
269 "OSMLCM_VCA_CACERT": "cacert",
270 "OSMLCM_VCA_CLOUD": "cloud",
271 "OSMLCM_VCA_K8S_CLOUD": "k8s_cloud",
274 if config
.vca_apiproxy
:
275 container_builder
.add_env("OSMLCM_VCA_APIPROXY", config
.vca_apiproxy
)
277 model_config_envs
= {
278 f
"OSMLCM_{k.upper()}": v
279 for k
, v
in self
.config
.items()
280 if k
.startswith("vca_model_config")
282 if model_config_envs
:
283 container_builder
.add_envs(model_config_envs
)
284 container
= container_builder
.build()
286 # Add container to pod spec
287 pod_spec_builder
.add_container(container
)
290 restart_policy
= PodRestartPolicy()
291 restart_policy
.add_secrets()
292 pod_spec_builder
.set_restart_policy(restart_policy
)
294 return pod_spec_builder
.build()
299 {"path": "/usr/lib/python3/dist-packages/osm_lcm"},
300 {"path": "/usr/lib/python3/dist-packages/osm_n2vc"},
301 {"path": "/usr/lib/python3/dist-packages/osm_common"},
311 "module": "osm_lcm.lcm",
319 if __name__
== "__main__":
323 # class ConfigurePodEvent(EventBase):
324 # """Configure Pod event"""
329 # class LcmEvents(CharmEvents):
332 # configure_pod = EventSource(ConfigurePodEvent)
335 # class LcmCharm(CharmBase):
338 # state = StoredState()
341 # def __init__(self, *args) -> NoReturn:
342 # """LCM Charm constructor."""
343 # super().__init__(*args)
345 # # Internal state initialization
346 # self.state.set_default(pod_spec=None)
348 # # Message bus data initialization
349 # self.state.set_default(message_host=None)
350 # self.state.set_default(message_port=None)
352 # # Database data initialization
353 # self.state.set_default(database_uri=None)
355 # # RO data initialization
356 # self.state.set_default(ro_host=None)
357 # self.state.set_default(ro_port=None)
359 # self.port = LCM_PORT
360 # self.image = OCIImageResource(self, "image")
362 # # Registering regular events
363 # self.framework.observe(self.on.start, self.configure_pod)
364 # self.framework.observe(self.on.config_changed, self.configure_pod)
365 # self.framework.observe(self.on.upgrade_charm, self.configure_pod)
367 # # Registering custom internal events
368 # self.framework.observe(self.on.configure_pod, self.configure_pod)
370 # # Registering required relation events
371 # self.framework.observe(
372 # self.on.kafka_relation_changed, self._on_kafka_relation_changed
374 # self.framework.observe(
375 # self.on.mongodb_relation_changed, self._on_mongodb_relation_changed
377 # self.framework.observe(
378 # self.on.ro_relation_changed, self._on_ro_relation_changed
381 # # Registering required relation broken events
382 # self.framework.observe(
383 # self.on.kafka_relation_broken, self._on_kafka_relation_broken
385 # self.framework.observe(
386 # self.on.mongodb_relation_broken, self._on_mongodb_relation_broken
388 # self.framework.observe(
389 # self.on.ro_relation_broken, self._on_ro_relation_broken
392 # def _on_kafka_relation_changed(self, event: EventBase) -> NoReturn:
393 # """Reads information about the kafka relation.
396 # event (EventBase): Kafka relation event.
398 # message_host = event.relation.data[event.unit].get("host")
399 # message_port = event.relation.data[event.unit].get("port")
405 # self.state.message_host != message_host
406 # or self.state.message_port != message_port
409 # self.state.message_host = message_host
410 # self.state.message_port = message_port
411 # self.on.configure_pod.emit()
413 # def _on_kafka_relation_broken(self, event: EventBase) -> NoReturn:
414 # """Clears data from kafka relation.
417 # event (EventBase): Kafka relation event.
419 # self.state.message_host = None
420 # self.state.message_port = None
421 # self.on.configure_pod.emit()
423 # def _on_mongodb_relation_changed(self, event: EventBase) -> NoReturn:
424 # """Reads information about the DB relation.
427 # event (EventBase): DB relation event.
429 # database_uri = event.relation.data[event.unit].get("connection_string")
431 # if database_uri and self.state.database_uri != database_uri:
432 # self.state.database_uri = database_uri
433 # self.on.configure_pod.emit()
435 # def _on_mongodb_relation_broken(self, event: EventBase) -> NoReturn:
436 # """Clears data from mongodb relation.
439 # event (EventBase): DB relation event.
441 # self.state.database_uri = None
442 # self.on.configure_pod.emit()
444 # def _on_ro_relation_changed(self, event: EventBase) -> NoReturn:
445 # """Reads information about the RO relation.
448 # event (EventBase): Keystone relation event.
450 # ro_host = event.relation.data[event.unit].get("host")
451 # ro_port = event.relation.data[event.unit].get("port")
456 # and (self.state.ro_host != ro_host or self.state.ro_port != ro_port)
458 # self.state.ro_host = ro_host
459 # self.state.ro_port = ro_port
460 # self.on.configure_pod.emit()
462 # def _on_ro_relation_broken(self, event: EventBase) -> NoReturn:
463 # """Clears data from ro relation.
466 # event (EventBase): Keystone relation event.
468 # self.state.ro_host = None
469 # self.state.ro_port = None
470 # self.on.configure_pod.emit()
472 # def _missing_relations(self) -> str:
473 # """Checks if there missing relations.
476 # str: string with missing relations
479 # "kafka": self.state.message_host,
480 # "mongodb": self.state.database_uri,
481 # "ro": self.state.ro_host,
484 # missing_relations = [k for k, v in data_status.items() if not v]
486 # return ", ".join(missing_relations)
489 # def relation_state(self) -> Dict[str, Any]:
490 # """Collects relation state configuration for pod spec assembly.
493 # Dict[str, Any]: relation state information.
496 # "message_host": self.state.message_host,
497 # "message_port": self.state.message_port,
498 # "database_uri": self.state.database_uri,
499 # "ro_host": self.state.ro_host,
500 # "ro_port": self.state.ro_port,
503 # return relation_state
505 # def configure_pod(self, event: EventBase) -> NoReturn:
506 # """Assemble the pod spec and apply it, if possible.
509 # event (EventBase): Hook or Relation event that started the
512 # if missing := self._missing_relations():
513 # self.unit.status = BlockedStatus(
514 # "Waiting for {0} relation{1}".format(
515 # missing, "s" if "," in missing else ""
520 # if not self.unit.is_leader():
521 # self.unit.status = ActiveStatus("ready")
524 # self.unit.status = MaintenanceStatus("Assembling pod spec")
526 # # Fetch image information
528 # self.unit.status = MaintenanceStatus("Fetching image information")
529 # image_info = self.image.fetch()
530 # except OCIImageResourceError:
531 # self.unit.status = BlockedStatus("Error fetching image information")
535 # pod_spec = make_pod_spec(
538 # self.relation_state,
539 # self.model.app.name,
542 # except ValueError as exc:
543 # logger.exception("Config/Relation data validation error")
544 # self.unit.status = BlockedStatus(str(exc))
547 # if self.state.pod_spec != pod_spec:
548 # self.model.pod.set_spec(pod_spec)
549 # self.state.pod_spec = pod_spec
551 # self.unit.status = ActiveStatus("ready")
554 # if __name__ == "__main__":