Add warning when using openshift (#1654)

* Add warning when using openshift

* warnings

* imports

* using the warning kind

* Changelog

* imports

* lint

* .

* Merge main and fix

* CR

* Result

* Update Links

* CR

* /

* lint

changelog.d/1560.added.md

@@ -0,0 +1 @@
+Detect and warn when cluster is openshift

mirrord/cli/src/connection.rs

@@ -91,6 +91,11 @@ where
             .await
             .map_err(CliError::KubernetesApiFailed)?;
 
+        let mut detect_openshift_task = progress.subtask("detecting OpenShift...");
+        if (k8s_api.detect_openshift(&mut detect_openshift_task).await).is_err() {
+            detect_openshift_task.warning("couldn't determine OpenShift");
+        };
+
         let (pod_agent_name, agent_port) = tokio::time::timeout(
             Duration::from_secs(config.agent.startup_timeout),
             k8s_api.create_agent(progress),

mirrord/kube/src/api/kubernetes.rs

@@ -5,7 +5,7 @@ use std::{net::SocketAddr, time::Duration};
 use k8s_openapi::api::core::v1::Pod;
 use kube::{
     config::{KubeConfigOptions, Kubeconfig},
-    Api, Client, Config,
+    Api, Client, Config, Discovery,
 };
 use mirrord_config::{agent::AgentConfig, target::TargetConfig, LayerConfig};
 use mirrord_progress::Progress;
@@ -57,6 +57,22 @@ impl KubernetesAPI {
             target,
         }
     }
+
+    pub async fn detect_openshift<P>(&self, progress: &mut P) -> Result<()>
+    where
+        P: Progress + Send + Sync,
+    {
+        if Discovery::new(self.client.clone())
+            .run()
+            .await?
+            .has_group("route.openshift.io")
+        {
+            progress.warning("mirrord has detected it's running on OpenShift. Due to the default PSP of OpenShift, mirrord may not be able to create the agent. Please refer to the documentation at https://mirrord.dev/docs/overview/faq/#can-i-use-mirrord-with-openshift");
+        } else {
+            progress.success(Some("OpenShift was not detected."))
+        }
+        Ok(())
+    }
 }
 
 impl AgentManagment for KubernetesAPI {