Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs on OpenShift #2357

Merged
merged 2 commits into from
Feb 1, 2025
Merged

Update docs on OpenShift #2357

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2b29320
Update docs on OpenShift
damemi Jan 31, 2025
5942849
Merge branch 'main' into openshift-docs
blumamir Feb 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions docs/setup/installation-options.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
2 changes: 1 addition & 1 deletion docs/setup/system-requirements.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Loading