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
26 from ops
.charm
import CharmBase
, CharmEvents
27 from ops
.framework
import EventBase
, EventSource
, StoredState
28 from ops
.main
import main
29 from ops
.model
import ActiveStatus
, BlockedStatus
, MaintenanceStatus
30 from oci_image
import OCIImageResource
, OCIImageResourceError
32 from pod_spec
import make_pod_spec
34 logger
= logging
.getLogger(__name__
)
39 class ConfigurePodEvent(EventBase
):
40 """Configure Pod event"""
45 class NbiEvents(CharmEvents
):
48 configure_pod
= EventSource(ConfigurePodEvent
)
51 class NbiCharm(CharmBase
):
57 def __init__(self
, *args
) -> NoReturn
:
58 """NBI Charm constructor."""
59 super().__init
__(*args
)
61 # Internal state initialization
62 self
.state
.set_default(pod_spec
=None)
64 # Message bus data initialization
65 self
.state
.set_default(message_host
=None)
66 self
.state
.set_default(message_port
=None)
68 # Database data initialization
69 self
.state
.set_default(database_uri
=None)
71 # Prometheus data initialization
72 self
.state
.set_default(prometheus_host
=None)
73 self
.state
.set_default(prometheus_port
=None)
75 # Keystone data initialization
76 self
.state
.set_default(keystone_host
=None)
77 self
.state
.set_default(keystone_port
=None)
78 self
.state
.set_default(keystone_user_domain_name
=None)
79 self
.state
.set_default(keystone_project_domain_name
=None)
80 self
.state
.set_default(keystone_username
=None)
81 self
.state
.set_default(keystone_password
=None)
82 self
.state
.set_default(keystone_service
=None)
85 self
.image
= OCIImageResource(self
, "image")
87 # Registering regular events
88 self
.framework
.observe(self
.on
.start
, self
.configure_pod
)
89 self
.framework
.observe(self
.on
.config_changed
, self
.configure_pod
)
90 self
.framework
.observe(self
.on
.upgrade_charm
, self
.configure_pod
)
92 # Registering custom internal events
93 self
.framework
.observe(self
.on
.configure_pod
, self
.configure_pod
)
95 # Registering required relation changed events
96 self
.framework
.observe(
97 self
.on
.kafka_relation_changed
, self
._on
_kafka
_relation
_changed
99 self
.framework
.observe(
100 self
.on
.mongodb_relation_changed
, self
._on
_mongodb
_relation
_changed
102 self
.framework
.observe(
103 self
.on
.keystone_relation_changed
, self
._on
_keystone
_relation
_changed
105 self
.framework
.observe(
106 self
.on
.prometheus_relation_changed
, self
._on
_prometheus
_relation
_changed
109 # Registering required relation departed events
110 self
.framework
.observe(
111 self
.on
.kafka_relation_departed
, self
._on
_kafka
_relation
_departed
113 self
.framework
.observe(
114 self
.on
.mongodb_relation_departed
, self
._on
_mongodb
_relation
_departed
116 self
.framework
.observe(
117 self
.on
.keystone_relation_departed
, self
._on
_keystone
_relation
_departed
119 self
.framework
.observe(
120 self
.on
.prometheus_relation_departed
, self
._on
_prometheus
_relation
_departed
123 # Registering provided relation events
124 self
.framework
.observe(self
.on
.nbi_relation_joined
, self
._publish
_nbi
_info
)
126 def _on_kafka_relation_changed(self
, event
: EventBase
) -> NoReturn
:
127 """Reads information about the kafka relation.
130 event (EventBase): Kafka relation event.
132 data_loc
= event
.unit
if event
.unit
else event
.app
134 message_host
= event
.relation
.data
[data_loc
].get("host")
135 message_port
= event
.relation
.data
[data_loc
].get("port")
141 self
.state
.message_host
!= message_host
142 or self
.state
.message_port
!= message_port
145 self
.state
.message_host
= message_host
146 self
.state
.message_port
= int(message_port
)
147 self
.on
.configure_pod
.emit()
149 def _on_kafka_relation_departed(self
, event
: EventBase
) -> NoReturn
:
150 """Clears data from kafka relation.
153 event (EventBase): Kafka relation event.
155 self
.state
.message_host
= None
156 self
.state
.message_port
= None
157 self
.on
.configure_pod
.emit()
159 def _on_mongodb_relation_changed(self
, event
: EventBase
) -> NoReturn
:
160 """Reads information about the DB relation.
163 event (EventBase): DB relation event.
165 data_loc
= event
.unit
if event
.unit
else event
.app
167 database_uri
= event
.relation
.data
[data_loc
].get("connection_string")
169 if database_uri
and self
.state
.database_uri
!= database_uri
:
170 self
.state
.database_uri
= database_uri
171 self
.on
.configure_pod
.emit()
173 def _on_mongodb_relation_departed(self
, event
: EventBase
) -> NoReturn
:
174 """Clears data from mongodb relation.
177 event (EventBase): DB relation event.
179 self
.state
.database_uri
= None
180 self
.on
.configure_pod
.emit()
182 def _on_keystone_relation_changed(self
, event
: EventBase
) -> NoReturn
:
183 """Reads information about the keystone relation.
186 event (EventBase): Keystone relation event.
188 data_loc
= event
.unit
if event
.unit
else event
.app
190 keystone_host
= event
.relation
.data
[data_loc
].get("host")
191 keystone_port
= event
.relation
.data
[data_loc
].get("port")
192 keystone_user_domain_name
= event
.relation
.data
[data_loc
].get(
195 keystone_project_domain_name
= event
.relation
.data
[data_loc
].get(
196 "project_domain_name"
198 keystone_username
= event
.relation
.data
[data_loc
].get("username")
199 keystone_password
= event
.relation
.data
[data_loc
].get("password")
200 keystone_service
= event
.relation
.data
[data_loc
].get("service")
205 and keystone_user_domain_name
206 and keystone_project_domain_name
207 and keystone_username
208 and keystone_password
211 self
.state
.keystone_host
!= keystone_host
212 or self
.state
.keystone_port
!= keystone_port
213 or self
.state
.keystone_user_domain_name
!= keystone_user_domain_name
214 or self
.state
.keystone_project_domain_name
215 != keystone_project_domain_name
216 or self
.state
.keystone_username
!= keystone_username
217 or self
.state
.keystone_password
!= keystone_password
218 or self
.state
.keystone_service
!= keystone_service
221 self
.state
.keystone_host
= keystone_host
222 self
.state
.keystone_port
= int(keystone_port
)
223 self
.state
.keystone_user_domain_name
= keystone_user_domain_name
224 self
.state
.keystone_project_domain_name
= keystone_project_domain_name
225 self
.state
.keystone_username
= keystone_username
226 self
.state
.keystone_password
= keystone_password
227 self
.state
.keystone_service
= keystone_service
228 self
.on
.configure_pod
.emit()
230 def _on_keystone_relation_departed(self
, event
: EventBase
) -> NoReturn
:
231 """Clears data from keystone relation.
234 event (EventBase): Keystone relation event.
236 self
.state
.keystone_host
= None
237 self
.state
.keystone_port
= None
238 self
.state
.keystone_user_domain_name
= None
239 self
.state
.keystone_project_domain_name
= None
240 self
.state
.keystone_username
= None
241 self
.state
.keystone_password
= None
242 self
.state
.keystone_service
= None
243 self
.on
.configure_pod
.emit()
245 def _on_prometheus_relation_changed(self
, event
: EventBase
) -> NoReturn
:
246 """Reads information about the prometheus relation.
249 event (EventBase): Prometheus relation event.
251 data_loc
= event
.unit
if event
.unit
else event
.app
253 prometheus_host
= event
.relation
.data
[data_loc
].get("hostname")
254 prometheus_port
= event
.relation
.data
[data_loc
].get("port")
260 self
.state
.prometheus_host
!= prometheus_host
261 or self
.state
.prometheus_port
!= prometheus_port
264 self
.state
.prometheus_host
= prometheus_host
265 self
.state
.prometheus_port
= int(prometheus_port
)
266 self
.on
.configure_pod
.emit()
268 def _on_prometheus_relation_departed(self
, event
: EventBase
) -> NoReturn
:
269 """Clears data from prometheus relation.
272 event (EventBase): Prometheus relation event.
274 self
.state
.prometheus_host
= None
275 self
.state
.prometheus_port
= None
276 self
.on
.configure_pod
.emit()
278 def _publish_nbi_info(self
, event
: EventBase
) -> NoReturn
:
279 """Publishes NBI information.
282 event (EventBase): NBI relation event.
285 "host": self
.model
.app
.name
,
286 "port": str(NBI_PORT
),
288 for k
, v
in rel_data
.items():
289 event
.relation
.data
[self
.unit
][k
] = v
291 def _missing_relations(self
) -> str:
292 """Checks if there missing relations.
295 str: string with missing relations
298 "kafka": self
.state
.message_host
,
299 "mongodb": self
.state
.database_uri
,
300 "prometheus": self
.state
.prometheus_host
,
303 if self
.model
.config
["auth_backend"] == "keystone":
304 data_status
["keystone"] = self
.state
.keystone_host
306 missing_relations
= [k
for k
, v
in data_status
.items() if not v
]
308 return ", ".join(missing_relations
)
311 def relation_state(self
) -> Dict
[str, Any
]:
312 """Collects relation state configuration for pod spec assembly.
315 Dict[str, Any]: relation state information.
318 "message_host": self
.state
.message_host
,
319 "message_port": self
.state
.message_port
,
320 "database_uri": self
.state
.database_uri
,
321 "prometheus_host": self
.state
.prometheus_host
,
322 "prometheus_port": self
.state
.prometheus_port
,
325 if self
.model
.config
["auth_backend"] == "keystone":
326 relation_state
.update(
328 "keystone_host": self
.state
.keystone_host
,
329 "keystone_port": self
.state
.keystone_port
,
330 "keystone_user_domain_name": self
.state
.keystone_user_domain_name
,
331 "keystone_project_domain_name": self
.state
.keystone_project_domain_name
,
332 "keystone_username": self
.state
.keystone_username
,
333 "keystone_password": self
.state
.keystone_password
,
334 "keystone_service": self
.state
.keystone_service
,
338 return relation_state
340 def configure_pod(self
, event
: EventBase
) -> NoReturn
:
341 """Assemble the pod spec and apply it, if possible.
344 event (EventBase): Hook or Relation event that started the
347 if missing
:= self
._missing
_relations
():
348 self
.unit
.status
= BlockedStatus(
349 f
"Waiting for {missing} relation{'s' if ',' in missing else ''}"
353 if not self
.unit
.is_leader():
354 self
.unit
.status
= ActiveStatus("ready")
357 self
.unit
.status
= MaintenanceStatus("Assembling pod spec")
359 # Fetch image information
361 self
.unit
.status
= MaintenanceStatus("Fetching image information")
362 image_info
= self
.image
.fetch()
363 except OCIImageResourceError
:
364 self
.unit
.status
= BlockedStatus("Error fetching image information")
368 pod_spec
= make_pod_spec(
375 except ValueError as exc
:
376 logger
.exception("Config/Relation data validation error")
377 self
.unit
.status
= BlockedStatus(str(exc
))
380 if self
.state
.pod_spec
!= pod_spec
:
381 self
.model
.pod
.set_spec(pod_spec
)
382 self
.state
.pod_spec
= pod_spec
384 self
.unit
.status
= ActiveStatus("ready")
387 if __name__
== "__main__":