Fix bug 1799: Add hostpath mount option in OSM charms
[osm/devops.git] / installers / charm / mon / src / charm.py
index ab6dd2d..7833deb 100755 (executable)
@@ -34,7 +34,12 @@ from opslib.osm.interfaces.kafka import KafkaClient
 from opslib.osm.interfaces.keystone import KeystoneClient
 from opslib.osm.interfaces.mongo import MongoClient
 from opslib.osm.interfaces.prometheus import PrometheusClient
-from opslib.osm.pod import ContainerV3Builder, FilesV3Builder, PodSpecV3Builder
+from opslib.osm.pod import (
+    ContainerV3Builder,
+    FilesV3Builder,
+    PodRestartPolicy,
+    PodSpecV3Builder,
+)
 from opslib.osm.validator import ModelValidator, validator
 
 
@@ -70,6 +75,7 @@ class ConfigModel(ModelValidator):
     vca_secret: str
     vca_cacert: str
     database_commonkey: str
+    mongodb_uri: Optional[str]
     log_level: str
     openstack_default_granularity: int
     global_request_timeout: int
@@ -79,6 +85,9 @@ class ConfigModel(ModelValidator):
     grafana_user: str
     grafana_password: str
     certificates: Optional[str]
+    image_pull_policy: str
+    debug_mode: bool
+    security_context: bool
 
     @validator("log_level")
     def validate_log_level(cls, v):
@@ -92,6 +101,24 @@ class ConfigModel(ModelValidator):
         _extract_certificates(v)
         return v
 
+    @validator("mongodb_uri")
+    def validate_mongodb_uri(cls, v):
+        if v and not v.startswith("mongodb://"):
+            raise ValueError("mongodb_uri is not properly formed")
+        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 {}
@@ -99,8 +126,29 @@ class ConfigModel(ModelValidator):
 
 class MonCharm(CharmedOsmBase):
     def __init__(self, *args) -> NoReturn:
-        super().__init__(*args, oci_image="image")
-
+        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={
+                    "MON": {
+                        "hostpath": self.config.get("debug_mon_local_path"),
+                        "container-path": "/usr/lib/python3/dist-packages/osm_mon",
+                    },
+                    "N2VC": {
+                        "hostpath": self.config.get("debug_n2vc_local_path"),
+                        "container-path": "/usr/lib/python3/dist-packages/n2vc",
+                    },
+                    "osm_common": {
+                        "hostpath": self.config.get("debug_common_local_path"),
+                        "container-path": "/usr/lib/python3/dist-packages/osm_common",
+                    },
+                },
+            )
         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)
@@ -124,9 +172,12 @@ class MonCharm(CharmedOsmBase):
     def _check_missing_dependencies(self, config: ConfigModel):
         missing_relations = []
 
-        if self.kafka_client.is_missing_data_in_unit():
+        if (
+            self.kafka_client.is_missing_data_in_unit()
+            and self.kafka_client.is_missing_data_in_app()
+        ):
             missing_relations.append("kafka")
-        if self.mongodb_client.is_missing_data_in_unit():
+        if not config.mongodb_uri and 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")
@@ -149,15 +200,64 @@ class MonCharm(CharmedOsmBase):
     def build_pod_spec(self, image_info):
         # Validate config
         config = ConfigModel(**dict(self.config))
+
+        if config.mongodb_uri and not self.mongodb_client.is_missing_data_in_unit():
+            raise Exception("Mongodb data cannot be provided via config and relation")
+
         # 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
+        )
+
+        # 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,
+            },
+        )
+        grafana_secret_name = f"{self.app.name}-grafana-secret"
+        pod_spec_builder.add_secret(
+            grafana_secret_name,
+            {
+                "url": config.grafana_url,
+                "user": config.grafana_user,
+                "password": config.grafana_password,
+            },
+        )
+
+        vca_secret_name = f"{self.app.name}-vca-secret"
+        pod_spec_builder.add_secret(
+            vca_secret_name,
+            {
+                "host": config.vca_host,
+                "user": config.vca_user,
+                "secret": config.vca_secret,
+                "cacert": config.vca_cacert,
+            },
+        )
+
         # 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:
             container_builder.add_volume_config("certs", "/certs", certs_files)
+
         container_builder.add_port(name=self.app.name, port=PORT)
         container_builder.add_envs(
             {
@@ -174,38 +274,121 @@ class MonCharm(CharmedOsmBase):
                 "OSMMON_MESSAGE_PORT": self.kafka_client.port,
                 # Database configuration
                 "OSMMON_DATABASE_DRIVER": "mongo",
-                "OSMMON_DATABASE_URI": self.mongodb_client.connection_string,
-                "OSMMON_DATABASE_COMMONKEY": config.database_commonkey,
                 # Prometheus configuration
                 "OSMMON_PROMETHEUS_URL": f"http://{self.prometheus_client.hostname}:{self.prometheus_client.port}",
-                # VCA configuration
-                "OSMMON_VCA_HOST": config.vca_host,
-                "OSMMON_VCA_USER": config.vca_user,
-                "OSMMON_VCA_SECRET": config.vca_secret,
-                "OSMMON_VCA_CACERT": config.vca_cacert,
-                "OSMMON_GRAFANA_URL": config.grafana_url,
-                "OSMMON_GRAFANA_USER": config.grafana_user,
-                "OSMMON_GRAFANA_PASSWORD": config.grafana_password,
             }
         )
-        if config.keystone_enabled:
+        prometheus_user = self.prometheus_client.user
+        prometheus_password = self.prometheus_client.password
+        if prometheus_user and prometheus_password:
             container_builder.add_envs(
                 {
-                    "OSMMON_KEYSTONE_ENABLED": True,
-                    "OSMMON_KEYSTONE_URL": self.keystone_client.host,
-                    "OSMMON_KEYSTONE_DOMAIN_NAME": self.keystone_client.user_domain_name,
-                    "OSMMON_KEYSTONE_PROJECT_DOMAIN_NAME": self.keystone_client.project_domain_name,
-                    "OSMMON_KEYSTONE_SERVICE_USER": self.keystone_client.username,
-                    "OSMMON_KEYSTONE_SERVICE_PASSWORD": self.keystone_client.password,
-                    "OSMMON_KEYSTONE_SERVICE_PROJECT": self.keystone_client.service,
+                    "OSMMON_PROMETHEUS_USER": prometheus_user,
+                    "OSMMON_PROMETHEUS_PASSWORD": prometheus_password,
                 }
             )
-
+        container_builder.add_secret_envs(
+            secret_name=mongodb_secret_name,
+            envs={
+                "OSMMON_DATABASE_URI": "uri",
+                "OSMMON_DATABASE_COMMONKEY": "commonkey",
+            },
+        )
+        container_builder.add_secret_envs(
+            secret_name=vca_secret_name,
+            envs={
+                "OSMMON_VCA_HOST": "host",
+                "OSMMON_VCA_USER": "user",
+                "OSMMON_VCA_SECRET": "secret",
+                "OSMMON_VCA_CACERT": "cacert",
+            },
+        )
+        container_builder.add_secret_envs(
+            secret_name=grafana_secret_name,
+            envs={
+                "OSMMON_GRAFANA_URL": "url",
+                "OSMMON_GRAFANA_USER": "user",
+                "OSMMON_GRAFANA_PASSWORD": "password",
+            },
+        )
+        if config.keystone_enabled:
+            keystone_secret_name = f"{self.app.name}-keystone-secret"
+            pod_spec_builder.add_secret(
+                keystone_secret_name,
+                {
+                    "url": self.keystone_client.host,
+                    "user_domain": self.keystone_client.user_domain_name,
+                    "project_domain": self.keystone_client.project_domain_name,
+                    "service_username": self.keystone_client.username,
+                    "service_password": self.keystone_client.password,
+                    "service_project": self.keystone_client.service,
+                },
+            )
+            container_builder.add_env("OSMMON_KEYSTONE_ENABLED", True)
+            container_builder.add_secret_envs(
+                secret_name=keystone_secret_name,
+                envs={
+                    "OSMMON_KEYSTONE_URL": "url",
+                    "OSMMON_KEYSTONE_DOMAIN_NAME": "user_domain",
+                    "OSMMON_KEYSTONE_PROJECT_DOMAIN_NAME": "project_domain",
+                    "OSMMON_KEYSTONE_SERVICE_USER": "service_username",
+                    "OSMMON_KEYSTONE_SERVICE_PASSWORD": "service_password",
+                    "OSMMON_KEYSTONE_SERVICE_PROJECT": "service_project",
+                },
+            )
         container = container_builder.build()
+
+        # Add restart policy
+        restart_policy = PodRestartPolicy()
+        restart_policy.add_secrets()
+        pod_spec_builder.set_restart_policy(restart_policy)
+
         # Add container to pod spec
         pod_spec_builder.add_container(container)
+
         return pod_spec_builder.build()
 
 
+VSCODE_WORKSPACE = {
+    "folders": [
+        {"path": "/usr/lib/python3/dist-packages/osm_mon"},
+        {"path": "/usr/lib/python3/dist-packages/osm_common"},
+        {"path": "/usr/lib/python3/dist-packages/n2vc"},
+    ],
+    "settings": {},
+    "launch": {
+        "version": "0.2.0",
+        "configurations": [
+            {
+                "name": "MON Server",
+                "type": "python",
+                "request": "launch",
+                "module": "osm_mon.cmd.mon_server",
+                "justMyCode": False,
+            },
+            {
+                "name": "MON evaluator",
+                "type": "python",
+                "request": "launch",
+                "module": "osm_mon.cmd.mon_evaluator",
+                "justMyCode": False,
+            },
+            {
+                "name": "MON collector",
+                "type": "python",
+                "request": "launch",
+                "module": "osm_mon.cmd.mon_collector",
+                "justMyCode": False,
+            },
+            {
+                "name": "MON dashboarder",
+                "type": "python",
+                "request": "launch",
+                "module": "osm_mon.cmd.mon_dashboarder",
+                "justMyCode": False,
+            },
+        ],
+    },
+}
 if __name__ == "__main__":
     main(MonCharm)