|
| 1 | +# RHDP Onboarding |
| 2 | + |
| 3 | +This document describes the intended repository layout for RHDP onboarding and how each bootstrap area fits into the GitOps flow for the RAG quickstart. |
| 4 | + |
| 5 | +## Target Directory Structure |
| 6 | + |
| 7 | +```text |
| 8 | +tenant/ |
| 9 | + bootstrap/ # Helm chart to create Argo CD Application for the RAG quickstart |
| 10 | +infra/ |
| 11 | + bootstrap/ # Helm chart to install required cluster operators/infrastructure |
| 12 | +platform/ |
| 13 | + bootstrap/ # Helm chart to create platform CRs and OpenShift UI plugins |
| 14 | +``` |
| 15 | + |
| 16 | +## 1) `tenant/bootstrap` |
| 17 | + |
| 18 | +Purpose: |
| 19 | +- Owns tenant-scoped onboarding for the quickstart. |
| 20 | +- Creates an Argo CD `Application` object. |
| 21 | +- That `Application` points to the RAG chart and drives deployment/sync of the quickstart application. |
| 22 | + |
| 23 | +Typical responsibilities: |
| 24 | +- Argo CD `Application` definition (repo URL, path, revision, destination namespace). |
| 25 | +- Passing Helm values to the RAG chart. |
| 26 | +- Optional tenant-related RBAC needed for reconciliation. |
| 27 | + |
| 28 | +## 2) `infra/bootstrap` |
| 29 | + |
| 30 | +Purpose: |
| 31 | +- Owns cluster/operator prerequisites required by the quickstart. |
| 32 | +- Installs platform services and operators needed before tenant app deployment. |
| 33 | + |
| 34 | +Typical responsibilities: |
| 35 | +- Operator subscriptions or chart-based operator installs. |
| 36 | +- Shared infra dependencies (for example: data science operators, serving stack prerequisites, pipeline dependencies, etc.). |
| 37 | +- Cluster-wide setup needed by multiple tenants. |
| 38 | + |
| 39 | +## 3) `platform/bootstrap` |
| 40 | + |
| 41 | +Purpose: |
| 42 | +- Owns platform-level custom resources and UI integrations. |
| 43 | +- Creates cluster/platform objects that are not tenant app manifests. |
| 44 | + |
| 45 | +Typical responsibilities: |
| 46 | +- Custom resources used by the platform layer. |
| 47 | +- OpenShift console/UI plugins and related configuration. |
| 48 | +- Platform controls and integrations shared across workloads. |
| 49 | + |
| 50 | +## Recommended Flow |
| 51 | + |
| 52 | +1. `infra/bootstrap` provisions required operators and cluster prerequisites. |
| 53 | +2. `platform/bootstrap` applies platform-level CRs/plugins. |
| 54 | +3. `tenant/bootstrap` creates the Argo CD `Application` that deploys the RAG quickstart for a tenant namespace. |
| 55 | + |
| 56 | +This separation keeps ownership clear: |
| 57 | +- Infra team manages prerequisites. |
| 58 | +- Platform team manages shared platform objects and plugins. |
| 59 | +- Tenant/app team manages quickstart app onboarding through GitOps `Application` objects. |
0 commit comments