feat: use istio-ingress-route interface

Author: Kimonas Sotirchos

metadata.yaml

@@ -23,7 +23,13 @@ provides:
     interface: prometheus_scrape
   grafana-dashboard:
     interface: grafana_dashboard
+  provide-cmr-mesh:
+    interface: cross_model_mesh
+    description: |
+      If this app is generating polciies to provide access to related applications that are cross-model, relate that app to this additional relation to retrieve additional data required for these policies.  This is required because Juju does not natively provide all information required to build these policies when related cross-model.
 requires:
+  istio-ingress-route:
+    interface: istio_ingress_route
   ingress:
     interface: ingress
     schema:
@@ -83,3 +89,13 @@ requires:
   logging:
     interface: loki_push_api
     optional: true
+  # service mesh
+  service-mesh:
+    limit: 1
+    interface: service_mesh
+    description: |
+      Integrate this charm into a service mesh
+  require-cmr-mesh:
+    interface: cross_model_mesh
+    description: |
+      If this app relates to other applications on a charmed service mesh cross-model, use this relation to send that related app additional data needed to automatically generate traffic authorization policies.  This is required because Juju does not natively provide all information required to build these policies when related cross-model.

src/charm.py

@@ -11,6 +11,18 @@
 from charmed_kubeflow_chisme.kubernetes import KubernetesResourceHandler
 from charmed_kubeflow_chisme.lightkube.batch import delete_many
 from charms.grafana_k8s.v0.grafana_dashboard import GrafanaDashboardProvider
+from charms.istio_beacon_k8s.v0.service_mesh import ServiceMeshConsumer
+from charms.istio_ingress_k8s.v0.istio_ingress_route import (
+    BackendRef,
+    HTTPPathMatch,
+    HTTPPathMatchType,
+    HTTPRoute,
+    HTTPRouteMatch,
+    IstioIngressRouteConfig,
+    IstioIngressRouteRequirer,
+    Listener,
+    ProtocolType,
+)
 from charms.kubeflow_dashboard.v0.kubeflow_dashboard_links import (
     DASHBOARD_LINK_LOCATIONS,
     KubeflowDashboardLinksProvider,
@@ -25,7 +37,11 @@
 from ops.charm import CharmBase
 from ops.model import ActiveStatus, BlockedStatus, MaintenanceStatus, WaitingStatus
 from ops.pebble import ChangeError, Layer
-from serialized_data_interface import NoCompatibleVersions, NoVersionsListed, get_interfaces
+from serialized_data_interface import (
+    NoCompatibleVersions,
+    NoVersionsListed,
+    get_interfaces,
+)
 
 from dashboard_links import aggregate_links_as_json
 
@@ -97,13 +113,21 @@ def __init__(self, *args):
         port = ServicePort(int(self._port), name=f"{self.app.name}")
         self.service_patcher = KubernetesServicePatch(self, [port])
 
+        # Ambient Mesh integration
+        self._mesh = ServiceMeshConsumer(self, policies=[])
+        self.ingress = IstioIngressRouteRequirer(
+            self, relation_name="istio-ingress-route"
+        )
+        self._ambient_mesh_ingress()
+
         for event in [
             self.on.install,
             self.on.leader_elected,
             self.on.upgrade_charm,
             self.on.config_changed,
             self.on["kubeflow-profiles"].relation_changed,
             self.on["ingress"].relation_changed,
+            self.ingress.on.ready,
             self.on.kubeflow_dashboard_pebble_ready,
         ]:
             self.framework.observe(event, self.main)
@@ -230,7 +254,9 @@ def _update_layer(self) -> None:
             self.unit.status = MaintenanceStatus("Applying new pebble layer")
             self.container.add_layer(self._container_name, new_layer, combine=True)
             try:
-                self.logger.info("Pebble plan updated with new configuration, replaning")
+                self.logger.info(
+                    "Pebble plan updated with new configuration, replaning"
+                )
                 self.container.replan()
             except ChangeError as e:
                 raise GenericCharmRuntimeError("Failed to replan") from e
@@ -256,14 +282,43 @@ def _handle_ingress(self, interfaces):
                 }
             )
 
+    def _ambient_mesh_ingress(self):
+        # ambient mesh
+        http_listener = Listener(port=80, protocol=ProtocolType.HTTP)
+
+        config = IstioIngressRouteConfig(
+            model=self.model.name,
+            listeners=[http_listener],
+            http_routes=[
+                HTTPRoute(
+                    name="http-ingress",
+                    listener=http_listener,
+                    matches=[
+                        HTTPRouteMatch(
+                            path=HTTPPathMatch(
+                                type=HTTPPathMatchType.PathPrefix, value="/"
+                            )
+                        )
+                    ],
+                    backends=[BackendRef(service=self.app.name, port=self._port)],
+                )
+            ],
+        )
+
+        self.ingress.submit_config(config)
+
     def _check_kf_profiles(self, interfaces):
         kf_profiles = interfaces["kubeflow-profiles"]
 
         if not kf_profiles:
-            raise CheckFailed("Add required relation to kubeflow-profiles", BlockedStatus)
+            raise CheckFailed(
+                "Add required relation to kubeflow-profiles", BlockedStatus
+            )
 
         if not kf_profiles.get_data():
-            raise CheckFailed("Waiting for kubeflow-profiles relation data", WaitingStatus)
+            raise CheckFailed(
+                "Waiting for kubeflow-profiles relation data", WaitingStatus
+            )
 
         return kf_profiles
 
@@ -283,8 +338,12 @@ def _get_dashboard_links(self):
                 links_from_relation=self.dashboard_link_provider.get_dashboard_links(
                     location=location
                 ),
-                additional_link_config=self.model.config[ADDITIONAL_LINKS_CONFIG_NAME[location]],
-                link_order_config=self.model.config[EXTERNAL_LINKS_ORDER_CONFIG_NAME[location]],
+                additional_link_config=self.model.config[
+                    ADDITIONAL_LINKS_CONFIG_NAME[location]
+                ],
+                link_order_config=self.model.config[
+                    EXTERNAL_LINKS_ORDER_CONFIG_NAME[location]
+                ],
                 location=location,
             )
         return links
@@ -315,7 +374,9 @@ def _on_remove(self, _):
         k8s_resources_manifests = self.k8s_resource_handler.render_manifests()
         configmap_manifest = self.configmap_handler.render_manifests()
         try:
-            delete_many(self.k8s_resource_handler.lightkube_client, k8s_resources_manifests)
+            delete_many(
+                self.k8s_resource_handler.lightkube_client, k8s_resources_manifests
+            )
             delete_many(self.configmap_handler.lightkube_client, configmap_manifest)
         except ApiError as e:
             self.logger.warning(f"Failed to delete resources, with error: {e}")