GitOps Documentation
Contents
GitOps Documentation¶
This JupyterBook is intended to serve as a main resource for all Operate First GitHub Org contributors.
It contains documentation on how to perform GitHub contributor-related tasks and encourages input and contributions from the community. JupyterBook format combines easy readability with efficient methods on how to apply newly acquired knowledge.
Environments¶
If you would like to use one of our clusters, please create an issue here.
MOC¶
The Operate First initiative currently manages two clusters within the MOC environment.
Smaug
cluster for all user workloadsInfra
cluster for cluster management, housing ACM and ArgoCD
EMEA¶
The Operate First community deploys the following cluster within the EMEA region.
Morty
cluster for experimental user workloadsRick
cluster for experimental user workloads
OS-Climate¶
OS-Climate (OSC) provides a unified, open Multimodal Data Processing platform used by OS-Climate members to collect, normalize and integrate climate and ESG data from public and private sources.
OSC cluster for all OSC workloads
Managed Services¶
Operate First manages various applications and services in the environments listed above.
-
We use Grafana for monitoring and dashboards
To request access to Grafana, please file an issue here
-
We manage a multi-tenant deployment of ArgoCD on the MOC Infra cluster
Anyone can be onboarded to this ArgoCD instance and use it to deploy to any cluster managed by Operate First
Console: https://argocd.operate-first.cloud
-
Note: Links are currently outdated as Observatorium is being migrated to Smaug cluster. We will update this document with the new routes once the migration is complete.
We have an instance of Observatorium currently being used to provision Thanos and Loki
Thanos enables long term storage for Prometheus (deployed by ODH)
Anyone can enable their applications deployed on the Smaug cluster to be monitored by this Prometheus instance
To do so, follow the instructions here and make a pull request against this repo
Loki is used to query logs; click here to learn more about sending or retrieving logs using Loki
Thanos: https://thanos-querier-openshift-monitoring.apps.smaug.na.operate-first.cloud
-
We deploy the OpenShift Data Foundation (ODF) operator on the Smaug cluster
ODF provides both persistent volumes and S3 compatible object storage via Rook Operator
Users can deploy their own S3 buckets via ObjectBucketClaims. Visit this page for more information and request an S3 bucket by filing an issue here.
-
We manage an instance of Dex on the Smaug cluster to provide authentication for some of our services
Our Dex instance can also be used to drive authentication for other users. While documents are not yet available for this, experienced users can find the configurations here