From 2b293206fd619fff40d82446df5486b84d23fe8a Mon Sep 17 00:00:00 2001 From: Mike Dame Date: Fri, 31 Jan 2025 14:12:51 -0500 Subject: [PATCH] Update docs on OpenShift --- docs/setup/installation-options.mdx | 37 +++++++++++++++++++++++++++++ docs/setup/system-requirements.mdx | 2 +- 2 files changed, 38 insertions(+), 1 deletion(-) diff --git a/docs/setup/installation-options.mdx b/docs/setup/installation-options.mdx index 31dd3e6d53..5854f872de 100644 --- 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=, ``` + +## OpenShift Installation + +Installing on OpenShift requires additional settings that can be +configured based on your installation mode: + + + + Run the Odigos CLI with the `--openshift` flag: + + ```shell + odigos install --openshift + ``` + + + Set `openshift.enabled=true` in `Values.yaml`: + + ```yaml + openshift + enabled: true + ``` + + + +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 index 929821f542..a7f5a1ee64 100644 --- 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)