Skip to content

Commit 9f4de92

Browse files
valdarvaldar
authored
Updated charts/README.md taking in account the new structure of the ./charts directory. (opendatahub-io#75)
1 parent 6f331a1 commit 9f4de92

1 file changed

Lines changed: 63 additions & 47 deletions

File tree

‎charts/README.md‎

Lines changed: 63 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,32 @@
1-
# xKS Operator Helm Charts
1+
# Helm Charts
22

3-
Helm charts for deploying dependent operators on vanilla Kubernetes (xKS) clusters without OLM.
4-
These charts are extracted from Red Hat operator bundles and deploy operators with hardcoded namespaces.
3+
Helm charts for deploying Red Hat AI (RHAI) operators and their dependencies on OpenShift and vanilla Kubernetes (xKS) clusters.
54

65
## Charts
76

7+
### Main Charts
8+
9+
| Chart | Platform | Description | Docs |
10+
|-------|----------|-------------|------|
11+
| [`rhai-on-openshift-chart`](rhai-on-openshift-chart/) | OpenShift | ODH/RHOAI dependencies and component configurations via OLM | [README](rhai-on-openshift-chart/README.md) |
12+
| [`rhai-on-xks-chart`](rhai-on-xks-chart/) | Vanilla Kubernetes (xKS) | RHAI operator and cloud manager components (non-OLM) | [README](rhai-on-xks-chart/README.md) |
13+
14+
### Dependency Charts
15+
16+
Extracted from Red Hat operator bundles for deploying operators on vanilla Kubernetes without OLM. These are used by `rhai-on-xks-chart`.
17+
818
| Chart | Version | Namespace | Description |
919
|-------|---------|-----------|-------------|
10-
| `cert-manager-operator` | v1.18.1 | `cert-manager-operator` / `cert-manager` | Red Hat cert-manager Operator |
11-
| `gateway-api` | v1.4.0 | cluster-scoped | [Kubernetes Gateway API](https://github.com/kubernetes-sigs/gateway-api) CRDs |
12-
| `lws-operator` | 1.0 | `openshift-lws-operator` | Leader-Worker-Set Operator |
13-
| `sail-operator` | 3.2.1 (Istio up to v1.27.3) | `istio-system` | Red Hat Sail (Istio) Operator |
20+
| [`cert-manager-operator`](dependencies/cert-manager-operator/) | v1.18.1 | `cert-manager-operator` / `cert-manager` | Red Hat cert-manager Operator |
21+
| [`gateway-api`](dependencies/gateway-api/) | v1.4.0 | cluster-scoped | [Kubernetes Gateway API](https://github.com/kubernetes-sigs/gateway-api) CRDs |
22+
| [`lws-operator`](dependencies/lws-operator/) | 1.0 | `openshift-lws-operator` | Leader-Worker-Set Operator |
23+
| [`sail-operator`](dependencies/sail-operator/) | 3.2.1 (Istio up to v1.27.3) | `istio-system` | Red Hat Sail (Istio) Operator |
24+
25+
---
1426

15-
## Pre-Install Steps
27+
The rest of this document covers the **dependency charts** (standalone installation and maintenance). For the main charts, see their individual READMEs linked above.
28+
29+
## Pre-Install Steps (Dependency Charts)
1630

1731
### Infrastructure CRD and CR (required for cert-manager-operator)
1832

@@ -58,18 +72,18 @@ subjects:
5872
EOF
5973
```
6074

61-
## Installation
75+
## Installation (Dependency Charts)
6276

6377
```bash
64-
helm install cert-manager-operator charts/cert-manager-operator/
65-
helm install gateway-api charts/gateway-api/
66-
helm install lws-operator charts/lws-operator/
67-
helm install sail-operator charts/sail-operator/
78+
helm install cert-manager-operator charts/dependencies/cert-manager-operator/
79+
helm install gateway-api charts/dependencies/gateway-api/
80+
helm install lws-operator charts/dependencies/lws-operator/
81+
helm install sail-operator charts/dependencies/sail-operator/
6882
```
6983

7084
Each operator chart creates its own namespace from `values.yaml` defaults. The `gateway-api` chart is cluster-scoped (CRDs only) and does not create a namespace.
7185

72-
## Post-Install Steps
86+
## Post-Install Steps (Dependency Charts)
7387

7488
### 1. Pull Secrets (if using registry.redhat.io images)
7589

@@ -200,7 +214,41 @@ kubectl annotate validatingwebhookconfiguration istio-validator-istio-system sai
200214

201215
## Updating Charts
202216

203-
### Operator charts (bundle-derived)
217+
### RHAI On XKS Helm Chart
218+
219+
See the [`rhai-on-xks-chart` README](rhai-on-xks-chart/README.md) for installation and usage details.
220+
221+
The chart generates its templates from the [opendatahub-operator](https://github.com/opendatahub-io/opendatahub-operator) repository using kustomize and [helmtemplate-generator](https://github.com/davidebianchi/helmtemplate-generator). It also generates cloud-specific (Azure, CoreWeave) cloudmanager templates.
222+
223+
**Prerequisites:** `go`, `kustomize`, and access to the ODH `opendatahub-operator` git repo.
224+
225+
**Update from the default branch (rhoai-3.4):**
226+
227+
```bash
228+
./charts/rhai-on-xks-chart/scripts/update-bundle.sh 3.4.0-ea.2
229+
```
230+
231+
**Update from a specific branch:**
232+
233+
```bash
234+
./charts/rhai-on-xks-chart/scripts/update-bundle.sh 3.5.0 --branch rhoai-3.5
235+
```
236+
237+
**Update from a local opendatahub-operator checkout** (skips cloning):
238+
239+
```bash
240+
./charts/rhai-on-xks-chart/scripts/update-bundle.sh v2.19.0 --odh-operator-dir /path/to/opendatahub-operator
241+
```
242+
243+
The script:
244+
245+
1. Clones (or uses a local) opendatahub-operator repo and runs `make manifests-all`
246+
2. Builds kustomize manifests from `config/rhaii/rhoai/default/`
247+
3. Pipes them through `helmtemplate-generator` to produce Helm templates
248+
4. Repeats for each cloudmanager target (Azure, CoreWeave) from `config/cloudmanager/<cloud>/rhoai/`
249+
5. Updates `Chart.yaml` with the new `appVersion`
250+
251+
### Dependency Operator Charts (bundle-derived)
204252

205253
Each operator chart under `charts/dependencies/` includes an `update-bundle.sh` script that extracts fresh manifests from Red Hat operator bundles.
206254

@@ -248,35 +296,3 @@ The script downloads CRDs from the [kubernetes-sigs/gateway-api](https://github.
248296
helm lint charts/dependencies/gateway-api/
249297
make chart-snapshots
250298
```
251-
252-
### RHAI On XKS Helm Chart
253-
254-
The `rhai-on-xks-helm-chart` generates its templates from the [opendatahub-operator](https://github.com/opendatahub-io/opendatahub-operator) repository using kustomize and [helmtemplate-generator](https://github.com/davidebianchi/helmtemplate-generator). It also generates cloud-specific (Azure, CoreWeave) cloudmanager templates.
255-
256-
**Prerequisites:** `go`, `kustomize`, and access to the ODH `opendatahub-operator` git repo.
257-
258-
**Update from the default branch (rhoai-3.4):**
259-
260-
```bash
261-
./charts/rhai-on-xks-chart/scripts/update-bundle.sh 3.4.0-ea.2
262-
```
263-
264-
**Update from a specific branch:**
265-
266-
```bash
267-
./charts/rhai-on-xks-chart/scripts/update-bundle.sh 3.5.0 --branch rhoai-3.5
268-
```
269-
270-
**Update from a local opendatahub-operator checkout** (skips cloning):
271-
272-
```bash
273-
./charts/rhai-on-xks-chart/scripts/update-bundle.sh v2.19.0 --odh-operator-dir /path/to/opendatahub-operator
274-
```
275-
276-
The script:
277-
278-
1. Clones (or uses a local) opendatahub-operator repo and runs `make manifests-all`
279-
2. Builds kustomize manifests from `config/rhaii/rhoai/default/`
280-
3. Pipes them through `helmtemplate-generator` to produce Helm templates
281-
4. Repeats for each cloudmanager target (Azure, CoreWeave) from `config/cloudmanager/<cloud>/rhoai/`
282-
5. Updates `Chart.yaml` with the new `appVersion`

0 commit comments

Comments
 (0)