X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;f=installers%2Fcharm%2Fro%2Fsrc%2Fcharm.py;h=028dc0a4f0c1afd6cd7758fa2c88952fa35cacab;hb=83aed2493a2065cea2e8f25f20728c4292e7ee9e;hp=951f281be542702e69ecdc06bea93fd14487edc4;hpb=996a5604c7d31f3758503b08a426f1f40619b17b;p=osm%2Fdevops.git diff --git a/installers/charm/ro/src/charm.py b/installers/charm/ro/src/charm.py index 951f281b..028dc0a4 100755 --- a/installers/charm/ro/src/charm.py +++ b/installers/charm/ro/src/charm.py @@ -24,14 +24,19 @@ import base64 import logging -from typing import NoReturn, Optional +from typing import Dict, NoReturn, Optional +from charms.kafka_k8s.v0.kafka import KafkaEvents, KafkaRequires from ops.main import main from opslib.osm.charm import CharmedOsmBase, RelationsMissing -from opslib.osm.interfaces.kafka import KafkaClient from opslib.osm.interfaces.mongo import MongoClient from opslib.osm.interfaces.mysql import MysqlClient -from opslib.osm.pod import ContainerV3Builder, FilesV3Builder, PodSpecV3Builder +from opslib.osm.pod import ( + ContainerV3Builder, + FilesV3Builder, + PodRestartPolicy, + PodSpecV3Builder, +) from opslib.osm.validator import ModelValidator, validator logger = logging.getLogger(__name__) @@ -73,6 +78,10 @@ class ConfigModel(ModelValidator): ro_database: str openmano_tenant: str certificates: Optional[str] + image_pull_policy: str + debug_mode: bool + security_context: bool + period_refresh_active: Optional[int] @validator("log_level") def validate_log_level(cls, v): @@ -98,21 +107,57 @@ class ConfigModel(ModelValidator): raise ValueError("Mysql port out of range") return v + @validator("image_pull_policy") + def validate_image_pull_policy(cls, v): + values = { + "always": "Always", + "ifnotpresent": "IfNotPresent", + "never": "Never", + } + v = v.lower() + if v not in values.keys(): + raise ValueError("value must be always, ifnotpresent or never") + return values[v] + @property def certificates_dict(cls): return _extract_certificates(cls.certificates) if cls.certificates else {} + @validator("period_refresh_active") + def validate_vim_refresh_period(cls, v): + if v and v < 60 and v != -1: + raise ValueError( + "Refresh Period is too tight, insert >= 60 seconds or disable using -1" + ) + return v + class RoCharm(CharmedOsmBase): """GrafanaCharm Charm.""" + on = KafkaEvents() + def __init__(self, *args) -> NoReturn: """Prometheus Charm constructor.""" - super().__init__(*args, oci_image="image") - - self.kafka_client = KafkaClient(self, "kafka") - self.framework.observe(self.on["kafka"].relation_changed, self.configure_pod) - self.framework.observe(self.on["kafka"].relation_broken, self.configure_pod) + super().__init__( + *args, + oci_image="image", + vscode_workspace=VSCODE_WORKSPACE, + ) + if self.config.get("debug_mode"): + self.enable_debug_mode( + pubkey=self.config.get("debug_pubkey"), + hostpaths={ + "osm_common": { + "hostpath": self.config.get("debug_common_local_path"), + "container-path": "/usr/lib/python3/dist-packages/osm_common", + }, + **_get_ro_host_paths(self.config.get("debug_ro_local_path")), + }, + ) + self.kafka = KafkaRequires(self) + self.framework.observe(self.on.kafka_available, self.configure_pod) + self.framework.observe(self.on.kafka_broken, self.configure_pod) self.mysql_client = MysqlClient(self, "mysql") self.framework.observe(self.on["mysql"].relation_changed, self.configure_pod) @@ -142,7 +187,7 @@ class RoCharm(CharmedOsmBase): missing_relations = [] if config.enable_ng_ro: - if self.kafka_client.is_missing_data_in_unit(): + if not self.kafka.host or not self.kafka.port: missing_relations.append("kafka") if not config.mongodb_uri and self.mongodb_client.is_missing_data_in_unit(): missing_relations.append("mongodb") @@ -192,11 +237,22 @@ class RoCharm(CharmedOsmBase): # Check relations self._check_missing_dependencies(config) + security_context_enabled = ( + config.security_context if not config.debug_mode else False + ) + # Create Builder for the PodSpec - pod_spec_builder = PodSpecV3Builder() + pod_spec_builder = PodSpecV3Builder( + enable_security_context=security_context_enabled + ) # Build Container - container_builder = ContainerV3Builder(self.app.name, image_info) + container_builder = ContainerV3Builder( + self.app.name, + image_info, + config.image_pull_policy, + run_as_non_root=security_context_enabled, + ) certs_files = self._build_cert_files(config) if certs_files: @@ -224,20 +280,41 @@ class RoCharm(CharmedOsmBase): "OSMRO_LOG_LEVEL": config.log_level, } ) - + if config.period_refresh_active: + container_builder.add_envs( + { + "OSMRO_PERIOD_REFRESH_ACTIVE": config.period_refresh_active, + } + ) if config.enable_ng_ro: + # Add secrets to the pod + mongodb_secret_name = f"{self.app.name}-mongodb-secret" + pod_spec_builder.add_secret( + mongodb_secret_name, + { + "uri": config.mongodb_uri or self.mongodb_client.connection_string, + "commonkey": config.database_commonkey, + }, + ) container_builder.add_envs( { "OSMRO_MESSAGE_DRIVER": "kafka", - "OSMRO_MESSAGE_HOST": self.kafka_client.host, - "OSMRO_MESSAGE_PORT": self.kafka_client.port, + "OSMRO_MESSAGE_HOST": self.kafka.host, + "OSMRO_MESSAGE_PORT": self.kafka.port, # MongoDB configuration "OSMRO_DATABASE_DRIVER": "mongo", - "OSMRO_DATABASE_URI": config.mongodb_uri - or self.mongodb_client.connection_string, - "OSMRO_DATABASE_COMMONKEY": config.database_commonkey, } ) + container_builder.add_secret_envs( + secret_name=mongodb_secret_name, + envs={ + "OSMRO_DATABASE_URI": "uri", + "OSMRO_DATABASE_COMMONKEY": "commonkey", + }, + ) + restart_policy = PodRestartPolicy() + restart_policy.add_secrets(secret_names=(mongodb_secret_name,)) + pod_spec_builder.set_restart_policy(restart_policy) else: container_builder.add_envs( @@ -269,5 +346,120 @@ class RoCharm(CharmedOsmBase): return pod_spec_builder.build() +VSCODE_WORKSPACE = { + "folders": [ + {"path": "/usr/lib/python3/dist-packages/osm_ng_ro"}, + {"path": "/usr/lib/python3/dist-packages/osm_common"}, + {"path": "/usr/lib/python3/dist-packages/osm_ro_plugin"}, + {"path": "/usr/lib/python3/dist-packages/osm_rosdn_arista_cloudvision"}, + {"path": "/usr/lib/python3/dist-packages/osm_rosdn_dpb"}, + {"path": "/usr/lib/python3/dist-packages/osm_rosdn_dynpac"}, + {"path": "/usr/lib/python3/dist-packages/osm_rosdn_floodlightof"}, + {"path": "/usr/lib/python3/dist-packages/osm_rosdn_ietfl2vpn"}, + {"path": "/usr/lib/python3/dist-packages/osm_rosdn_juniper_contrail"}, + {"path": "/usr/lib/python3/dist-packages/osm_rosdn_odlof"}, + {"path": "/usr/lib/python3/dist-packages/osm_rosdn_onos_vpls"}, + {"path": "/usr/lib/python3/dist-packages/osm_rosdn_onosof"}, + {"path": "/usr/lib/python3/dist-packages/osm_rovim_aws"}, + {"path": "/usr/lib/python3/dist-packages/osm_rovim_azure"}, + {"path": "/usr/lib/python3/dist-packages/osm_rovim_gcp"}, + {"path": "/usr/lib/python3/dist-packages/osm_rovim_openstack"}, + {"path": "/usr/lib/python3/dist-packages/osm_rovim_openvim"}, + {"path": "/usr/lib/python3/dist-packages/osm_rovim_vmware"}, + ], + "launch": { + "configurations": [ + { + "module": "osm_ng_ro.ro_main", + "name": "NG RO", + "request": "launch", + "type": "python", + "justMyCode": False, + } + ], + "version": "0.2.0", + }, + "settings": {}, +} + + +def _get_ro_host_paths(ro_host_path: str) -> Dict: + """Get RO host paths""" + return ( + { + "NG-RO": { + "hostpath": f"{ro_host_path}/NG-RO", + "container-path": "/usr/lib/python3/dist-packages/osm_ng_ro", + }, + "RO-plugin": { + "hostpath": f"{ro_host_path}/RO-plugin", + "container-path": "/usr/lib/python3/dist-packages/osm_ro_plugin", + }, + "RO-SDN-arista_cloudvision": { + "hostpath": f"{ro_host_path}/RO-SDN-arista_cloudvision", + "container-path": "/usr/lib/python3/dist-packages/osm_rosdn_arista_cloudvision", + }, + "RO-SDN-dpb": { + "hostpath": f"{ro_host_path}/RO-SDN-dpb", + "container-path": "/usr/lib/python3/dist-packages/osm_rosdn_dpb", + }, + "RO-SDN-dynpac": { + "hostpath": f"{ro_host_path}/RO-SDN-dynpac", + "container-path": "/usr/lib/python3/dist-packages/osm_rosdn_dynpac", + }, + "RO-SDN-floodlight_openflow": { + "hostpath": f"{ro_host_path}/RO-SDN-floodlight_openflow", + "container-path": "/usr/lib/python3/dist-packages/osm_rosdn_floodlightof", + }, + "RO-SDN-ietfl2vpn": { + "hostpath": f"{ro_host_path}/RO-SDN-ietfl2vpn", + "container-path": "/usr/lib/python3/dist-packages/osm_rosdn_ietfl2vpn", + }, + "RO-SDN-juniper_contrail": { + "hostpath": f"{ro_host_path}/RO-SDN-juniper_contrail", + "container-path": "/usr/lib/python3/dist-packages/osm_rosdn_juniper_contrail", + }, + "RO-SDN-odl_openflow": { + "hostpath": f"{ro_host_path}/RO-SDN-odl_openflow", + "container-path": "/usr/lib/python3/dist-packages/osm_rosdn_odlof", + }, + "RO-SDN-onos_openflow": { + "hostpath": f"{ro_host_path}/RO-SDN-onos_openflow", + "container-path": "/usr/lib/python3/dist-packages/osm_rosdn_onosof", + }, + "RO-SDN-onos_vpls": { + "hostpath": f"{ro_host_path}/RO-SDN-onos_vpls", + "container-path": "/usr/lib/python3/dist-packages/osm_rosdn_onos_vpls", + }, + "RO-VIM-aws": { + "hostpath": f"{ro_host_path}/RO-VIM-aws", + "container-path": "/usr/lib/python3/dist-packages/osm_rovim_aws", + }, + "RO-VIM-azure": { + "hostpath": f"{ro_host_path}/RO-VIM-azure", + "container-path": "/usr/lib/python3/dist-packages/osm_rovim_azure", + }, + "RO-VIM-gcp": { + "hostpath": f"{ro_host_path}/RO-VIM-gcp", + "container-path": "/usr/lib/python3/dist-packages/osm_rovim_gcp", + }, + "RO-VIM-openstack": { + "hostpath": f"{ro_host_path}/RO-VIM-openstack", + "container-path": "/usr/lib/python3/dist-packages/osm_rovim_openstack", + }, + "RO-VIM-openvim": { + "hostpath": f"{ro_host_path}/RO-VIM-openvim", + "container-path": "/usr/lib/python3/dist-packages/osm_rovim_openvim", + }, + "RO-VIM-vmware": { + "hostpath": f"{ro_host_path}/RO-VIM-vmware", + "container-path": "/usr/lib/python3/dist-packages/osm_rovim_vmware", + }, + } + if ro_host_path + else {} + ) + + if __name__ == "__main__": main(RoCharm)