https://github.com/redhat-na-ssa/demo-ai-gitops-catalog
A catalog for demos in GitOps on OpenShift
https://github.com/redhat-na-ssa/demo-ai-gitops-catalog
ai data-science gitops kustomization kustomize machine-learning openshift
Last synced: 6 months ago
JSON representation
A catalog for demos in GitOps on OpenShift
- Host: GitHub
- URL: https://github.com/redhat-na-ssa/demo-ai-gitops-catalog
- Owner: redhat-na-ssa
- License: mit
- Created: 2022-11-14T00:25:32.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2026-01-21T18:11:43.000Z (6 months ago)
- Last Synced: 2026-01-22T04:22:48.992Z (6 months ago)
- Topics: ai, data-science, gitops, kustomization, kustomize, machine-learning, openshift
- Language: HTML
- Homepage: https://redhat-na-ssa.github.io/demo-ai-gitops-catalog/
- Size: 1.87 MB
- Stars: 18
- Watchers: 7
- Forks: 16
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Maintainers: MAINTAINERS
Awesome Lists containing this project
README
# OpenShift Demo GitOps Catalog
[](https://github.com/redhat-na-ssa/demo-ai-gitops-catalog/actions/workflows/spellcheck.yaml)
[](https://github.com/redhat-na-ssa/demo-ai-gitops-catalog/actions/workflows/linting.yaml)
This project is a catalog of configurations used to provision infrastructure, on
OpenShift, that supports machine learning (ML) and artificial intelligence (AI) workloads.
The intention of this repository is to help support practical use of OpenShift for AI / ML workloads and provide a catalog of configurations / demos / workshops.
Please look at the [GitOps Catalog](https://github.com/redhat-cop/gitops-catalog) if you only need to automate an operator install.
In this repo, look at various [kustomized configs](components/cluster-configs) and [argo apps](components/argocd/apps) for ideas.
For issues with `oc apply -k` see the [known issues](#known-issues) section below.
## Prerequisites - Get a cluster
- OpenShift 4.14+
- role: `cluster-admin` - for all [demo](demos) or [cluster](clusters) configs
- role: `self-provisioner` - for namespaced components
[Red Hat Demo Platform](https://demo.redhat.com) Options (Tested)
NOTE: The node sizes below are the **recommended minimum** to select for provisioning
- AWS with OpenShift Open Environment
- 1 x Control Plane - `m6a.2xlarge`
- 0 x Workers - `m6a.2xlarge`
- One Node OpenShift
- 1 x Control Plane - `m6a.2xlarge`
- OpenShift GitOps Blank Environment
- 1 x Control Plane - `16 cores`, `64Gi`
## Getting Started
### Install the [OpenShift Web Terminal](https://docs.openshift.com/container-platform/4.12/web_console/web_terminal/installing-web-terminal.html)
The following icon should appear in the top right of the OpenShift web console after you have installed the operator. Clicking this icon launches the web terminal.
NOTE: Reload the page in your browser if you do not see the icon after installing the operator.
## Make the enhanced web terminal permanent
```sh
# apply the enhanced web terminal
oc apply -k https://github.com/redhat-na-ssa/demo-ai-gitops-catalog/demos/components/install-web-terminal
# delete old web terminal
$(wtoctl | grep 'oc delete')
```
NOTE: The following commands are available in an enhanced web terminal.
---
## Apply Configurations / Demos
Some basic cluster config
```sh
# scale your machinesets
# this will set all machinesets to replica 2
ocp_machineset_scale 2
# isolate your control plane nodes to not run work
ocp_control_nodes_not_schedulable
```
Pick a demo you want to deploy:
```sh
# setup a dev spaces demo /w gpu
apply_firmly demos/overlays/devspaces-nvidia-gpu-autoscale
```
```sh
# setup a rhoai demo /w gpu
apply_firmly demos/overlays/rhoai-workshop-ready
```
---
### ALTERNATIVE - Use a local environment / shell
1. Verify you are logged into your cluster using `oc`.
1. Clone this repository
NOTE: See the [tools section below](#tools) for more info
```sh
# verify oc login
oc whoami
# git clone this repo
git clone https://github.com/redhat-na-ssa/demo-ai-gitops-catalog
cd demo-ai-gitops-catalog
# load functions into a bash shell
. scripts/functions.sh
```
### Alternative - running `bootstrap.sh`
Running `scripts/bootstrap.sh` will allow you to select common options. This is a work in progress.
This script handles configurations that are not fully declarative, require imperative steps, or require user interaction.
## Cherry Picking Configurations
Various kustomized [app configs](components/app-configs) and [cluster configs](components/cluster-configs) can be applied individually.
[Operator installs](components/operators/) can be done quickly via `oc` - similar to the [GitOps Catalog](https://github.com/redhat-cop/gitops-catalog).
`oc apply -k` and `apply_firmly` can be used interchangeably in the examples below:
```sh
# setup htpasswd based login
oc apply -k components/cluster-configs/login/overlays/htpasswd
# disable self provisioner in cluster
oc apply -k components/cluster-configs/rbac/overlays/no-self-provisioner
# install minio w/ minio namespace
oc apply -k components/app-configs/minio/overlays/with-namespace
# install the nfs provisioner
oc apply -k components/app-configs/nfs-provisioner/overlays/default
```
Examples with operators that require CRDs
```sh
# setup serverless w/ instance
apply_firmly components/operators/serverless-operator/aggregate/default
# setup acs with a minimal configuration
apply_firmly components/operators/rhacs-operator/aggregate/minimal
```
## Common functions
Common operational tasks are provided in the [scripts library](scripts/library/). You can run individual [functions](scripts/functions.sh) in a `bash` shell:
NOTE: These functions are available in an [enhanced web terminal](components/operators/web-terminal/instance/overlays/enhanced/kustomization.yaml) - see [install above](#install-the-openshift-web-terminal)
```sh
# load functions
. scripts/functions.sh
get_functions
```
### Workshops
This is currently under development
```sh
# load functions
. scripts/wip/workshop_functions.sh
# setup workshop with 25 users
workshop_setup 25
```
## Known Issues
`oc apply -k` commands may fail on the first try.
This is inherent to how Kubernetes handles [custom resources (CR)](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) - A CR must be created **after it has been defined** via a [custom resource definition (CRD)](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#customresourcedefinitions).
The solution... re-run the command until it succeeds.
The function `apply_firmly` is interchangeable with `oc apply -k` and is similar to the following shell command:
```sh
until oc apply -k < path to kustomization.yaml >; do : ; done
```
### Referencing this Catalog
***This repo is currently subject to frequent, breaking changes!***
Always reference with a commit hash or tag
```sh
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization
resources:
- https://github.com/redhat-na-ssa/demo-ai-gitops-catalog/components/app-configs/nvidia-gpu-verification/overlays/toleration-replicas-6?ref=v0.09
```
## Development
### Tools
The following cli tools are required:
- `bash`, `git`
- `oc` - Download [mac](https://formulae.brew.sh/formula/openshift-cli), [linux](https://mirror.openshift.com/pub/openshift-v4/clients/ocp), [windows](https://mirror.openshift.com/pub/openshift-v4/clients/ocp/stable/openshift-client-windows.zip)
- `kubectl` (optional) - Included in `oc` bundle
- `kustomize` (optional) - Download [mac](https://formulae.brew.sh/formula/kustomize), [linux](https://github.com/kubernetes-sigs/kustomize/releases)
NOTE: `bash`, `git`, and `oc` are available in the [OpenShift Web Terminal](https://docs.openshift.com/container-platform/4.12/web_console/web_terminal/installing-web-terminal.html)
The following are used to encrypt secrets and are optional:
- `age` - [Info](https://github.com/FiloSottile/age)
- `sops` - [Info](https://github.com/getsops/sops)
### Contributing
Please run the following before submitting a PR / commit
```sh
scripts/lint.sh
```
## Additional Info
### Internal Docs
- [Local Docs](docs)
- [Notes Dump](docs/notes/)
## External Links
- [GitOps Catalog](https://github.com/redhat-cop/gitops-catalog)
- [Helm Chart Catalog](https://github.com/redhat-cop/helm-charts)
- [Enhanced Web Terminal Container](https://github.com/redhat-na-ssa/ocp-web-terminal-enhanced)
- [AI Pilot Gitops](https://github.com/redhat-na-stp-ai-practice/openshift-ai-pilot-gitops)
- [ArgoCD - Example](https://github.com/gnunn-gitops/cluster-config)
- [ArgoCD - Patterns](https://github.com/gnunn-gitops/standards)
- [OpenShift - Automation](https://github.com/jharmison-redhat/openshift-setup)