2 # Copyright 2020 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
24 from typing
import Any
, Dict
, NoReturn
25 from pydantic
import ValidationError
27 from ops
.charm
import CharmBase
, CharmEvents
28 from ops
.framework
import EventBase
, EventSource
, StoredState
29 from ops
.main
import main
30 from ops
.model
import ActiveStatus
, BlockedStatus
, MaintenanceStatus
31 from oci_image
import OCIImageResource
, OCIImageResourceError
33 from pod_spec
import make_pod_spec
35 LOGGER
= logging
.getLogger(__name__
)
40 class ConfigurePodEvent(EventBase
):
41 """Configure Pod event"""
46 class NbiEvents(CharmEvents
):
49 configure_pod
= EventSource(ConfigurePodEvent
)
52 class NbiCharm(CharmBase
):
58 def __init__(self
, *args
) -> NoReturn
:
59 """NBI Charm constructor."""
60 super().__init
__(*args
)
62 # Internal state initialization
63 self
.state
.set_default(pod_spec
=None)
65 # Message bus data initialization
66 self
.state
.set_default(message_host
=None)
67 self
.state
.set_default(message_port
=None)
69 # Database data initialization
70 self
.state
.set_default(database_uri
=None)
72 # Prometheus data initialization
73 self
.state
.set_default(prometheus_host
=None)
74 self
.state
.set_default(prometheus_port
=None)
76 # Keystone data initialization
77 self
.state
.set_default(keystone_host
=None)
78 self
.state
.set_default(keystone_port
=None)
79 self
.state
.set_default(keystone_user_domain_name
=None)
80 self
.state
.set_default(keystone_project_domain_name
=None)
81 self
.state
.set_default(keystone_username
=None)
82 self
.state
.set_default(keystone_password
=None)
83 self
.state
.set_default(keystone_service
=None)
86 self
.image
= OCIImageResource(self
, "image")
88 # Registering regular events
89 self
.framework
.observe(self
.on
.start
, self
.configure_pod
)
90 self
.framework
.observe(self
.on
.config_changed
, self
.configure_pod
)
91 self
.framework
.observe(self
.on
.upgrade_charm
, self
.configure_pod
)
93 # Registering custom internal events
94 self
.framework
.observe(self
.on
.configure_pod
, self
.configure_pod
)
96 # Registering required relation changed events
97 self
.framework
.observe(
98 self
.on
.kafka_relation_changed
, self
._on
_kafka
_relation
_changed
100 self
.framework
.observe(
101 self
.on
.mongodb_relation_changed
, self
._on
_mongodb
_relation
_changed
103 self
.framework
.observe(
104 self
.on
.keystone_relation_changed
, self
._on
_keystone
_relation
_changed
106 self
.framework
.observe(
107 self
.on
.prometheus_relation_changed
, self
._on
_prometheus
_relation
_changed
110 # Registering required relation departed events
111 self
.framework
.observe(
112 self
.on
.kafka_relation_departed
, self
._on
_kafka
_relation
_departed
114 self
.framework
.observe(
115 self
.on
.mongodb_relation_departed
, self
._on
_mongodb
_relation
_departed
117 self
.framework
.observe(
118 self
.on
.keystone_relation_departed
, self
._on
_keystone
_relation
_departed
120 self
.framework
.observe(
121 self
.on
.prometheus_relation_departed
, self
._on
_prometheus
_relation
_departed
124 # Registering provided relation events
125 self
.framework
.observe(self
.on
.nbi_relation_joined
, self
._publish
_nbi
_info
)
127 def _on_kafka_relation_changed(self
, event
: EventBase
) -> NoReturn
:
128 """Reads information about the kafka relation.
131 event (EventBase): Kafka relation event.
133 message_host
= event
.relation
.data
[event
.unit
].get("host")
134 message_port
= event
.relation
.data
[event
.unit
].get("port")
140 self
.state
.message_host
!= message_host
141 or self
.state
.message_port
!= message_port
144 self
.state
.message_host
= message_host
145 self
.state
.message_port
= message_port
146 self
.on
.configure_pod
.emit()
148 def _on_kafka_relation_departed(self
, event
: EventBase
) -> NoReturn
:
149 """Clears data from kafka relation.
152 event (EventBase): Kafka relation event.
154 self
.state
.message_host
= None
155 self
.state
.message_port
= None
156 self
.on
.configure_pod
.emit()
158 def _on_mongodb_relation_changed(self
, event
: EventBase
) -> NoReturn
:
159 """Reads information about the DB relation.
162 event (EventBase): DB relation event.
164 database_uri
= event
.relation
.data
[event
.unit
].get("connection_string")
166 if database_uri
and self
.state
.database_uri
!= database_uri
:
167 self
.state
.database_uri
= database_uri
168 self
.on
.configure_pod
.emit()
170 def _on_mongodb_relation_departed(self
, event
: EventBase
) -> NoReturn
:
171 """Clears data from mongodb relation.
174 event (EventBase): DB relation event.
176 self
.state
.database_uri
= None
177 self
.on
.configure_pod
.emit()
179 def _on_keystone_relation_changed(self
, event
: EventBase
) -> NoReturn
:
180 """Reads information about the keystone relation.
183 event (EventBase): Keystone relation event.
185 keystone_host
= event
.relation
.data
[event
.unit
].get("host")
186 keystone_port
= event
.relation
.data
[event
.unit
].get("port")
187 keystone_user_domain_name
= event
.relation
.data
[event
.unit
].get(
190 keystone_project_domain_name
= event
.relation
.data
[event
.unit
].get(
191 "project_domain_name"
193 keystone_username
= event
.relation
.data
[event
.unit
].get("username")
194 keystone_password
= event
.relation
.data
[event
.unit
].get("password")
195 keystone_service
= event
.relation
.data
[event
.unit
].get("service")
200 and keystone_user_domain_name
201 and keystone_project_domain_name
202 and keystone_username
203 and keystone_password
206 self
.state
.keystone_host
!= keystone_host
207 or self
.state
.keystone_port
!= keystone_port
208 or self
.state
.keystone_user_domain_name
!= keystone_user_domain_name
209 or self
.state
.keystone_project_domain_name
210 != keystone_project_domain_name
211 or self
.state
.keystone_username
!= keystone_username
212 or self
.state
.keystone_password
!= keystone_password
213 or self
.state
.keystone_service
!= keystone_service
216 self
.state
.keystone_host
= keystone_host
217 self
.state
.keystone_port
= keystone_port
218 self
.state
.keystone_user_domain_name
= keystone_user_domain_name
219 self
.state
.keystone_project_domain_name
= keystone_project_domain_name
220 self
.state
.keystone_username
= keystone_username
221 self
.state
.keystone_password
= keystone_password
222 self
.state
.keystone_service
= keystone_service
223 self
.on
.configure_pod
.emit()
225 def _on_keystone_relation_departed(self
, event
: EventBase
) -> NoReturn
:
226 """Clears data from keystone relation.
229 event (EventBase): Keystone relation event.
231 self
.state
.keystone_host
= None
232 self
.state
.keystone_port
= None
233 self
.state
.keystone_user_domain_name
= None
234 self
.state
.keystone_project_domain_name
= None
235 self
.state
.keystone_username
= None
236 self
.state
.keystone_password
= None
237 self
.state
.keystone_service
= None
238 self
.on
.configure_pod
.emit()
240 def _on_prometheus_relation_changed(self
, event
: EventBase
) -> NoReturn
:
241 """Reads information about the prometheus relation.
244 event (EventBase): Prometheus relation event.
246 prometheus_host
= event
.relation
.data
[event
.unit
].get("hostname")
247 prometheus_port
= event
.relation
.data
[event
.unit
].get("port")
253 self
.state
.prometheus_host
!= prometheus_host
254 or self
.state
.prometheus_port
!= prometheus_port
257 self
.state
.prometheus_host
= prometheus_host
258 self
.state
.prometheus_port
= prometheus_port
259 self
.on
.configure_pod
.emit()
261 def _on_prometheus_relation_departed(self
, event
: EventBase
) -> NoReturn
:
262 """Clears data from prometheus relation.
265 event (EventBase): Prometheus relation event.
267 self
.state
.prometheus_host
= None
268 self
.state
.prometheus_port
= None
269 self
.on
.configure_pod
.emit()
271 def _publish_nbi_info(self
, event
: EventBase
) -> NoReturn
:
272 """Publishes NBI information.
275 event (EventBase): NBI relation event.
277 if self
.unit
.is_leader():
279 "host": self
.model
.app
.name
,
280 "port": str(NBI_PORT
),
282 for k
, v
in rel_data
.items():
283 event
.relation
.data
[self
.model
.app
][k
] = v
285 def _missing_relations(self
) -> str:
286 """Checks if there missing relations.
289 str: string with missing relations
292 "kafka": self
.state
.message_host
,
293 "mongodb": self
.state
.database_uri
,
294 "prometheus": self
.state
.prometheus_host
,
297 if self
.model
.config
["auth_backend"] == "keystone":
298 data_status
["keystone"] = self
.state
.keystone_host
300 missing_relations
= [k
for k
, v
in data_status
.items() if not v
]
302 return ", ".join(missing_relations
)
305 def relation_state(self
) -> Dict
[str, Any
]:
306 """Collects relation state configuration for pod spec assembly.
309 Dict[str, Any]: relation state information.
312 "message_host": self
.state
.message_host
,
313 "message_port": self
.state
.message_port
,
314 "database_uri": self
.state
.database_uri
,
315 "prometheus_host": self
.state
.prometheus_host
,
316 "prometheus_port": self
.state
.prometheus_port
,
319 if self
.model
.config
["auth_backend"] == "keystone":
320 relation_state
.update(
322 "keystone_host": self
.state
.keystone_host
,
323 "keystone_port": self
.state
.keystone_port
,
324 "keystone_user_domain_name": self
.state
.keystone_user_domain_name
,
325 "keystone_project_domain_name": self
.state
.keystone_project_domain_name
,
326 "keystone_username": self
.state
.keystone_username
,
327 "keystone_password": self
.state
.keystone_password
,
328 "keystone_service": self
.state
.keystone_service
,
332 return relation_state
334 def configure_pod(self
, event
: EventBase
) -> NoReturn
:
335 """Assemble the pod spec and apply it, if possible.
338 event (EventBase): Hook or Relation event that started the
341 if missing
:= self
._missing
_relations
():
342 self
.unit
.status
= BlockedStatus(
343 f
"Waiting for {missing} relation{'s' if ',' in missing else ''}"
347 if not self
.unit
.is_leader():
348 self
.unit
.status
= ActiveStatus("ready")
351 self
.unit
.status
= MaintenanceStatus("Assembling pod spec")
353 # Fetch image information
355 self
.unit
.status
= MaintenanceStatus("Fetching image information")
356 image_info
= self
.image
.fetch()
357 except OCIImageResourceError
:
358 self
.unit
.status
= BlockedStatus("Error fetching image information")
362 pod_spec
= make_pod_spec(
369 except ValidationError
as exc
:
370 LOGGER
.exception("Config/Relation data validation error")
371 self
.unit
.status
= BlockedStatus(str(exc
))
374 if self
.state
.pod_spec
!= pod_spec
:
375 self
.model
.pod
.set_spec(pod_spec
)
376 self
.state
.pod_spec
= pod_spec
378 self
.unit
.status
= ActiveStatus("ready")
381 if __name__
== "__main__":