Newer
Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
#!/usr/bin/env python3
# Copyright 2022 Canonical Ltd.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
#
# For those usages not covered by the Apache License, Version 2.0 please
# contact: legal@canonical.com
#
# To get in touch with the maintainers, please contact:
# osm-charmers@lists.launchpad.net
#
#
# Learn more at: https://juju.is/docs/sdk
"""OSM NBI charm.
See more: https://charmhub.io/osm
"""
import logging
from typing import Any, Dict
from charms.kafka_k8s.v0.kafka import KafkaEvents, KafkaRequires
from charms.nginx_ingress_integrator.v0.ingress import IngressRequires
from charms.observability_libs.v1.kubernetes_service_patch import KubernetesServicePatch
from charms.osm_libs.v0.utils import (
CharmError,
DebugMode,
HostPath,
check_container_ready,
check_service_active,
)
from lightkube.models.core_v1 import ServicePort
from ops.charm import ActionEvent, CharmBase
from ops.framework import StoredState
from ops.main import main
from ops.model import ActiveStatus, Container
from legacy_interfaces import KeystoneClient, MongoClient, PrometheusClient
HOSTPATHS = [
HostPath(
config="nbi-hostpath",
container_path="/usr/lib/python3/dist-packages/osm_nbi",
),
HostPath(
config="common-hostpath",
container_path="/usr/lib/python3/dist-packages/osm_common",
),
]
SERVICE_PORT = 9999
logger = logging.getLogger(__name__)
class OsmNbiCharm(CharmBase):
"""OSM NBI Kubernetes sidecar charm."""
on = KafkaEvents()
_stored = StoredState()
def __init__(self, *args):
super().__init__(*args)
self.ingress = IngressRequires(
self,
{
"service-hostname": self.external_hostname,
"service-name": self.app.name,
"service-port": SERVICE_PORT,
},
)
self.kafka = KafkaRequires(self)
self.mongodb_client = MongoClient(self, "mongodb")
self.prometheus_client = PrometheusClient(self, "prometheus")
self.keystone_client = KeystoneClient(self, "keystone")
self._observe_charm_events()
self.container: Container = self.unit.get_container("nbi")
self.debug_mode = DebugMode(self, self._stored, self.container, HOSTPATHS)
self._patch_k8s_service()
@property
def external_hostname(self) -> str:
"""External hostname property.
Returns:
str: the external hostname from config.
If not set, return the ClusterIP service name.
"""
return self.config.get("external-hostname") or self.app.name
# ---------------------------------------------------------------------------
# Handlers for Charm Events
# ---------------------------------------------------------------------------
def _on_config_changed(self, _) -> None:
"""Handler for the config-changed event."""
try:
self._validate_config()
self._check_relations()
# Check if the container is ready.
# Eventually it will become ready after the first pebble-ready event.
check_container_ready(self.container)
self._configure_service(self.container)
self._update_ingress_config()
# Update charm status
self._on_update_status()
except CharmError as e:
logger.debug(e.message)
self.unit.status = e.status
def _on_update_status(self, _=None) -> None:
"""Handler for the update-status event."""
try:
self._check_relations()
if self.debug_mode.started:
return
check_container_ready(self.container)
check_service_active(self.container, "nbi")
self.unit.status = ActiveStatus()
except CharmError as e:
logger.debug(e.message)
self.unit.status = e.status
def _on_required_relation_broken(self, _) -> None:
"""Handler for the kafka-broken event."""
# Check Pebble has started in the container
try:
check_container_ready(self.container)
check_service_active(self.container, "nbi")
self.container.stop("nbi")
except CharmError:
pass
finally:
self._on_update_status()
def _on_get_debug_mode_information_action(self, event: ActionEvent) -> None:
"""Handler for the get-debug-mode-information action event."""
if not self.debug_mode.started:
event.fail("debug-mode has not started. Hint: juju config nbi debug-mode=true")
return
debug_info = {"command": self.debug_mode.command, "password": self.debug_mode.password}
event.set_results(debug_info)
# ---------------------------------------------------------------------------
# Validation and configuration and more
# ---------------------------------------------------------------------------
def _patch_k8s_service(self) -> None:
port = ServicePort(SERVICE_PORT, name=f"{self.app.name}")
self.service_patcher = KubernetesServicePatch(self, [port])
def _observe_charm_events(self) -> None:
event_handler_mapping = {
# Core lifecycle events
self.on.nbi_pebble_ready: self._on_config_changed,
self.on.config_changed: self._on_config_changed,
self.on.update_status: self._on_update_status,
# Relation events
self.on.kafka_available: self._on_config_changed,
self.on["kafka"].relation_broken: self._on_required_relation_broken,
# Action events
self.on.get_debug_mode_information_action: self._on_get_debug_mode_information_action,
}
for relation in [self.on[rel_name] for rel_name in ["mongodb", "prometheus", "keystone"]]:
event_handler_mapping[relation.relation_changed] = self._on_config_changed
event_handler_mapping[relation.relation_broken] = self._on_required_relation_broken
for event, handler in event_handler_mapping.items():
self.framework.observe(event, handler)
def _validate_config(self) -> None:
"""Validate charm configuration.
Raises:
CharmError: if charm configuration is invalid.
"""
logger.debug("validating charm config")
def _check_relations(self) -> None:
"""Validate charm relations.
Raises:
CharmError: if charm configuration is invalid.
"""
logger.debug("check for missing relations")
missing_relations = []
if not self.kafka.host or not self.kafka.port:
missing_relations.append("kafka")
if self.mongodb_client.is_missing_data_in_unit():
missing_relations.append("mongodb")
if self.prometheus_client.is_missing_data_in_app():
missing_relations.append("prometheus")
if self.keystone_client.is_missing_data_in_app():
missing_relations.append("keystone")
if missing_relations:
relations_str = ", ".join(missing_relations)
one_relation_missing = len(missing_relations) == 1
error_msg = f'need {relations_str} relation{"" if one_relation_missing else "s"}'
logger.warning(error_msg)
raise CharmError(error_msg)
def _update_ingress_config(self) -> None:
"""Update ingress config in relation."""
ingress_config = {
"service-hostname": self.external_hostname,
"max-body-size": self.config["max-body-size"],
}
if "tls-secret-name" in self.config:
ingress_config["tls-secret-name"] = self.config["tls-secret-name"]
logger.debug(f"updating ingress-config: {ingress_config}")
self.ingress.update_config(ingress_config)
def _configure_service(self, container: Container) -> None:
"""Add Pebble layer with the nbi service."""
logger.debug(f"configuring {self.app.name} service")
container.add_layer("nbi", self._get_layer(), combine=True)
container.replan()
def _get_layer(self) -> Dict[str, Any]:
"""Get layer for Pebble."""
return {
"summary": "nbi layer",
"description": "pebble config layer for nbi",
"services": {
"nbi": {
"override": "replace",
"summary": "nbi service",
"command": "python3 -m osm_nbi.nbi",
"startup": "enabled",
"user": "appuser",
"group": "appuser",
"environment": {
# General configuration
"OSMNBI_SERVER_ENABLE_TEST": False,
"OSMNBI_STATIC_DIR": "/app/osm_nbi/html_public",
# Kafka configuration
"OSMNBI_MESSAGE_HOST": self.kafka.host,
"OSMNBI_MESSAGE_PORT": self.kafka.port,
"OSMNBI_MESSAGE_DRIVER": "kafka",
# Database configuration
"OSMNBI_DATABASE_DRIVER": "mongo",
"OSMNBI_DATABASE_URI": self.mongodb_client.connection_string,
"OSMNBI_DATABASE_COMMONKEY": self.config["database-commonkey"],
# Storage configuration
"OSMNBI_STORAGE_DRIVER": "mongo",
"OSMNBI_STORAGE_PATH": "/app/storage",
"OSMNBI_STORAGE_COLLECTION": "files",
"OSMNBI_STORAGE_URI": self.mongodb_client.connection_string,
# Prometheus configuration
"OSMNBI_PROMETHEUS_HOST": self.prometheus_client.hostname,
"OSMNBI_PROMETHEUS_PORT": self.prometheus_client.port,
# Log configuration
"OSMNBI_LOG_LEVEL": self.config["log-level"],
# Authentication environments
"OSMNBI_AUTHENTICATION_BACKEND": "keystone",
"OSMNBI_AUTHENTICATION_AUTH_URL": self.keystone_client.host,
"OSMNBI_AUTHENTICATION_AUTH_PORT": self.keystone_client.port,
"OSMNBI_AUTHENTICATION_USER_DOMAIN_NAME": self.keystone_client.user_domain_name,
"OSMNBI_AUTHENTICATION_PROJECT_DOMAIN_NAME": self.keystone_client.project_domain_name,
"OSMNBI_AUTHENTICATION_SERVICE_USERNAME": self.keystone_client.username,
"OSMNBI_AUTHENTICATION_SERVICE_PASSWORD": self.keystone_client.password,
"OSMNBI_AUTHENTICATION_SERVICE_PROJECT": self.keystone_client.service,
},
}
},
}
if __name__ == "__main__": # pragma: no cover
main(OsmNbiCharm)