GitOps Documentation#

This documentation 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.

Getting started with Operate First#

Visit the Getting Started page on the Operate First website to learn more about the project.

Environments#

If you would like to use one of our clusters, please create an issue. To access clusters, select operate-first from the login screen and authenticate with your GitHub account or get a token for command line access.

MOC#

We manage two clusters within the MOC) environment.

  • Smaug for all user workloads

  • Infra for cluster management, housing ACM and ArgoCD

EMEA#

We manage one cluster within the IONOS environment.

  • Jerry for all user workloads

see operate-first/ionos-openshift for more information.

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.

Managed Services#

Operate First manages various applications and services in the environments listed above.

  • Grafana

    • We use Grafana for monitoring and dashboards

    • To request access to Grafana, please file an issue here

  • Open Data Hub

    • We manage a deployment of Open Data Hub (ODH) on the Smaug cluster and OSC cluster

    • Read more about our deployment of ODH and access our dashboard

  • ArgoCD

    • 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

      • Before being onboarded to ArgoCD, you must be onboarded to the OCP cluster you wish to deploy your applications on

      • Request access to an OCP cluster by filing an issue here and ArgoCD by filing an issue here

    • Console: https://argocd.operate-first.cloud

  • Observatorium

    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

  • OpenShift Data Foundation

    • 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.

  • Dex OIDC Provider

    • 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

Command line access#

If you want to access the cluster via the command line, login to a cluster and visit the command-line-tools navigation item under the ? dropdown menu.

Personal token#

You can use your personal token for testing and ad-hoc scripts, but it will expire in ~24 hours.

  1. Login to the web console using operate-first single sign on login

  2. Copy the token from the User dropdown menu

  3. Use this token as your oauth bearer token

    • Eg:

curl --insecure -H "Authorization: Bearer sha256~zGN...CyEnmU" "https://api.jerry.ionos.emea.operate-first.cloud:6443/apis/user.openshift.io/v1/users/~"