2 # Copyright 2022 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 # Learn more at: https://juju.is/docs/sdk
27 See more: https://charmhub.io/osm
32 from typing
import Any
, Dict
34 from charms
.data_platform_libs
.v0
.data_interfaces
import DatabaseRequires
35 from charms
.kafka_k8s
.v0
.kafka
import KafkaEvents
, KafkaRequires
36 from charms
.observability_libs
.v1
.kubernetes_service_patch
import KubernetesServicePatch
37 from charms
.osm_libs
.v0
.utils
import (
41 check_container_ready
,
44 from charms
.osm_ro
.v0
.ro
import RoProvides
45 from lightkube
.models
.core_v1
import ServicePort
46 from ops
.charm
import ActionEvent
, CharmBase
, RelationJoinedEvent
47 from ops
.framework
import StoredState
48 from ops
.main
import main
49 from ops
.model
import ActiveStatus
, Container
52 "NG-RO": "/usr/lib/python3/dist-packages/osm_ng_ro",
53 "RO-plugin": "/usr/lib/python3/dist-packages/osm_ro_plugin",
54 "RO-SDN-arista_cloudvision": "/usr/lib/python3/dist-packages/osm_rosdn_arista_cloudvision",
55 "RO-SDN-dpb": "/usr/lib/python3/dist-packages/osm_rosdn_dpb",
56 "RO-SDN-dynpac": "/usr/lib/python3/dist-packages/osm_rosdn_dynpac",
57 "RO-SDN-floodlight_openflow": "/usr/lib/python3/dist-packages/osm_rosdn_floodlightof",
58 "RO-SDN-ietfl2vpn": "/usr/lib/python3/dist-packages/osm_rosdn_ietfl2vpn",
59 "RO-SDN-juniper_contrail": "/usr/lib/python3/dist-packages/osm_rosdn_juniper_contrail",
60 "RO-SDN-odl_openflow": "/usr/lib/python3/dist-packages/osm_rosdn_odlof",
61 "RO-SDN-onos_openflow": "/usr/lib/python3/dist-packages/osm_rosdn_onosof",
62 "RO-SDN-onos_vpls": "/usr/lib/python3/dist-packages/osm_rosdn_onos_vpls",
63 "RO-VIM-aws": "/usr/lib/python3/dist-packages/osm_rovim_aws",
64 "RO-VIM-azure": "/usr/lib/python3/dist-packages/osm_rovim_azure",
65 "RO-VIM-gcp": "/usr/lib/python3/dist-packages/osm_rovim_gcp",
66 "RO-VIM-openstack": "/usr/lib/python3/dist-packages/osm_rovim_openstack",
67 "RO-VIM-openvim": "/usr/lib/python3/dist-packages/osm_rovim_openvim",
68 "RO-VIM-vmware": "/usr/lib/python3/dist-packages/osm_rovim_vmware",
73 container_path
="/usr/lib/python3/dist-packages/",
74 submodules
=ro_host_paths
,
77 config
="common-hostpath",
78 container_path
="/usr/lib/python3/dist-packages/osm_common",
82 USER
= GROUP
= "appuser"
84 logger
= logging
.getLogger(__name__
)
87 def decode(content
: str):
88 """Base64 decoding of a string."""
89 return base64
.b64decode(content
.encode("utf-8")).decode("utf-8")
92 class OsmRoCharm(CharmBase
):
93 """OSM RO Kubernetes sidecar charm."""
97 _stored
= StoredState()
99 def __init__(self
, *args
):
100 super().__init
__(*args
)
101 self
._stored
.set_default(certificates
=set())
102 self
.kafka
= KafkaRequires(self
)
103 self
.mongodb_client
= DatabaseRequires(self
, "mongodb", database_name
="osm")
104 self
._observe
_charm
_events
()
105 self
._patch
_k
8s
_service
()
106 self
.ro
= RoProvides(self
)
107 self
.container
: Container
= self
.unit
.get_container("ro")
108 self
.debug_mode
= DebugMode(self
, self
._stored
, self
.container
, HOSTPATHS
)
110 # ---------------------------------------------------------------------------
111 # Handlers for Charm Events
112 # ---------------------------------------------------------------------------
114 def _on_config_changed(self
, _
) -> None:
115 """Handler for the config-changed event."""
117 self
._validate
_config
()
118 self
._check
_relations
()
119 # Check if the container is ready.
120 # Eventually it will become ready after the first pebble-ready event.
121 check_container_ready(self
.container
)
123 self
._configure
_certificates
()
124 if not self
.debug_mode
.started
:
125 self
._configure
_service
()
126 self
._update
_ro
_relation
()
128 # Update charm status
129 self
._on
_update
_status
()
130 except CharmError
as e
:
131 logger
.debug(e
.message
)
132 self
.unit
.status
= e
.status
134 def _on_update_status(self
, _
=None) -> None:
135 """Handler for the update-status event."""
137 self
._validate
_config
()
138 self
._check
_relations
()
139 check_container_ready(self
.container
)
140 if self
.debug_mode
.started
:
142 check_service_active(self
.container
, self
.service_name
)
143 self
.unit
.status
= ActiveStatus()
144 except CharmError
as e
:
145 logger
.debug(e
.message
)
146 self
.unit
.status
= e
.status
148 def _on_required_relation_broken(self
, _
) -> None:
149 """Handler for the kafka-broken event."""
151 check_container_ready(self
.container
)
152 check_service_active(self
.container
, "ro")
153 self
.container
.stop("ro")
157 self
._on
_update
_status
()
159 def _update_ro_relation(self
, event
: RelationJoinedEvent
= None) -> None:
160 """Handler for the ro-relation-joined event."""
162 if self
.unit
.is_leader():
163 check_container_ready(self
.container
)
164 check_service_active(self
.container
, "ro")
165 self
.ro
.set_host_info(
166 self
.app
.name
, SERVICE_PORT
, event
.relation
if event
else None
168 except CharmError
as e
:
169 self
.unit
.status
= e
.status
171 def _on_get_debug_mode_information_action(self
, event
: ActionEvent
) -> None:
172 """Handler for the get-debug-mode-information action event."""
173 if not self
.debug_mode
.started
:
175 f
"debug-mode has not started. Hint: juju config {self.app.name} debug-mode=true"
179 debug_info
= {"command": self
.debug_mode
.command
, "password": self
.debug_mode
.password
}
180 event
.set_results(debug_info
)
182 # ---------------------------------------------------------------------------
183 # Validation and configuration and more
184 # ---------------------------------------------------------------------------
186 def _patch_k8s_service(self
) -> None:
187 port
= ServicePort(SERVICE_PORT
, name
=f
"{self.app.name}")
188 self
.service_patcher
= KubernetesServicePatch(self
, [port
])
190 def _observe_charm_events(self
) -> None:
191 event_handler_mapping
= {
192 # Core lifecycle events
193 self
.on
.ro_pebble_ready
: self
._on
_config
_changed
,
194 self
.on
.config_changed
: self
._on
_config
_changed
,
195 self
.on
.update_status
: self
._on
_update
_status
,
197 self
.on
.kafka_available
: self
._on
_config
_changed
,
198 self
.on
["kafka"].relation_broken
: self
._on
_required
_relation
_broken
,
199 self
.mongodb_client
.on
.database_created
: self
._on
_config
_changed
,
200 self
.on
["mongodb"].relation_broken
: self
._on
_required
_relation
_broken
,
201 self
.on
.ro_relation_joined
: self
._update
_ro
_relation
,
203 self
.on
.get_debug_mode_information_action
: self
._on
_get
_debug
_mode
_information
_action
,
206 for event
, handler
in event_handler_mapping
.items():
207 self
.framework
.observe(event
, handler
)
209 def _is_database_available(self
) -> bool:
211 return self
.mongodb_client
.is_resource_created()
215 def _validate_config(self
) -> None:
216 """Validate charm configuration.
219 CharmError: if charm configuration is invalid.
221 logger
.debug("validating charm config")
222 if self
.config
["log-level"].upper() not in [
230 raise CharmError("invalid value for log-level option")
232 refresh_period
= self
.config
.get("period_refresh_active")
233 if refresh_period
and refresh_period
< 60 and refresh_period
!= -1:
235 "Refresh Period is too tight, insert >= 60 seconds or disable using -1"
238 def _check_relations(self
) -> None:
239 """Validate charm relations.
242 CharmError: if charm configuration is invalid.
244 logger
.debug("check for missing relations")
245 missing_relations
= []
247 if not self
.kafka
.host
or not self
.kafka
.port
:
248 missing_relations
.append("kafka")
249 if not self
._is
_database
_available
():
250 missing_relations
.append("mongodb")
252 if missing_relations
:
253 relations_str
= ", ".join(missing_relations
)
254 one_relation_missing
= len(missing_relations
) == 1
255 error_msg
= f
'need {relations_str} relation{"" if one_relation_missing else "s"}'
256 logger
.warning(error_msg
)
257 raise CharmError(error_msg
)
259 def _configure_certificates(self
) -> None:
260 """Push certificates to the RO container."""
261 if not (certificate_config
:= self
.config
.get("certificates")):
264 certificates_list
= certificate_config
.split(",")
265 updated_certificates
= set()
267 for certificate
in certificates_list
:
268 if ":" not in certificate
:
270 name
, content
= certificate
.split(":")
271 content
= decode(content
)
280 updated_certificates
.add(name
)
281 self
._stored
.certificates
.add(name
)
282 logger
.info(f
"certificate {name} pushed successfully")
284 stored_certificates
= {c
for c
in self
._stored
.certificates
}
285 for certificate_to_remove
in stored_certificates
.difference(updated_certificates
):
286 self
.container
.remove_path(f
"/certs/{certificate_to_remove}")
287 self
._stored
.certificates
.remove(certificate_to_remove
)
288 logger
.info(f
"certificate {certificate_to_remove} removed successfully")
290 def _configure_service(self
) -> None:
291 """Add Pebble layer with the ro service."""
292 logger
.debug(f
"configuring {self.app.name} service")
293 self
.container
.add_layer("ro", self
._get
_layer
(), combine
=True)
294 self
.container
.replan()
296 def _get_layer(self
) -> Dict
[str, Any
]:
297 """Get layer for Pebble."""
299 "summary": "ro layer",
300 "description": "pebble config layer for ro",
303 "override": "replace",
304 "summary": "ro service",
305 "command": "python3 -u -m osm_ng_ro.ro_main",
306 "startup": "enabled",
310 # General configuration
311 "OSMRO_LOG_LEVEL": self
.config
["log-level"].upper(),
312 # Kafka configuration
313 "OSMRO_MESSAGE_HOST": self
.kafka
.host
,
314 "OSMRO_MESSAGE_PORT": self
.kafka
.port
,
315 "OSMRO_MESSAGE_DRIVER": "kafka",
316 # Database configuration
317 "OSMRO_DATABASE_DRIVER": "mongo",
318 "OSMRO_DATABASE_URI": self
._get
_mongodb
_uri
(),
319 "OSMRO_DATABASE_COMMONKEY": self
.config
["database-commonkey"],
320 # Storage configuration
321 "OSMRO_STORAGE_DRIVER": "mongo",
322 "OSMRO_STORAGE_PATH": "/app/storage",
323 "OSMRO_STORAGE_COLLECTION": "files",
324 "OSMRO_STORAGE_URI": self
._get
_mongodb
_uri
(),
325 "OSMRO_PERIOD_REFRESH_ACTIVE": self
.config
.get("period_refresh_active")
332 def _get_mongodb_uri(self
):
333 return list(self
.mongodb_client
.fetch_relation_data().values())[0]["uris"]
336 if __name__
== "__main__": # pragma: no cover