Update docs on OpenShift (#2357)

To be published with v1.0.146 and blog post odigos-io/landing-page#163 Co-authored-by: Amir Blum <[email protected]>
odigos-io · Feb 1, 2025 · c4519ad · c4519ad
1 parent 5160dda
commit c4519ad
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 1 deletion.
diff --git a/docs/setup/installation-options.mdx b/docs/setup/installation-options.mdx
@@ -38,3 +38,40 @@ List all containers to be ignored with **helm chart**:
 ```shell
 helm install odigos odigos/odigos --set ignoreContainer=<container1>,<container2>
 ```
+
+## OpenShift Installation
+
+Installing on OpenShift requires additional settings that can be
+configured based on your installation mode:
+
+<Tabs>
+  <Tab title="Odigos CLI">
+       Run the Odigos CLI with the `--openshift` flag:
+
+       ```shell
+       odigos install --openshift
+       ```
+  </Tab>
+  <Tab title="Helm Chart">
+       Set `openshift.enabled=true` in `Values.yaml`:
+
+       ```yaml
+       openshift
+         enabled: true
+       ```
+  </Tab>
+</Tabs>
+
+OpenShift installation does the following:
+
+* Uses [Red Hat certified component container images](https://odigos.io/blog/openshift-certified)
+* Configures required SELinux permissions for pods to access auto-instrumentation agents on RHEL nodes
+* Configures RBAC permissions for Odigos components required by default in OpenShift clusters
+
+By default, the `--openshift` flag will pull Odigos component images
+from `registry.connect.redhat.com/odigos`. These images are based on
+[Red Hat's Universal Base Image
+9](https://catalog.redhat.com/software/base-images) and denoted with
+the `-ubi9` suffix. These images are also hosted on the Odigos
+DockerHub registry, which you can deploy by setting `--openshift` with
+`--image-prefix docker.io/keyval`.
diff --git a/docs/setup/system-requirements.mdx b/docs/setup/system-requirements.mdx
@@ -24,7 +24,7 @@ This allows users to maintain observability on nodes that meet the requirements
 - [Kind](https://kind.sigs.k8s.io)
 - [Minikube](https://minikube.sigs.k8s.io/docs/start)
 - [K3s](https://k3s.io)
+- [Red Hat OpenShift](https://www.redhat.com/en/technologies/cloud-computing/openshift) (see [how to install on OpenShift](/setup/installation-options#openshift-installation))
 - [Amazon Elastic Kubernetes Service (EKS)](https://aws.amazon.com/eks/)
 - [Google Kubernetes Engine (GKE)](https://cloud.google.com/kubernetes-engine)
 - [Azure Kubernetes Service (AKS)](https://azure.microsoft.com/en-us/products/kubernetes-service)
-- [Red Hat OpenShift](https://www.redhat.com/en/technologies/cloud-computing/openshift)