Merge pull request #75 from opendatahub-io/zhao-doc

docs: use OCI chart v0.2.0 and RHOAI images as default for deploy-rhoai

Author: yizhaodev

docs/guides/deploy-rhoai.md

@@ -987,10 +987,11 @@ oc create secret generic batch-gateway-secrets \
 <summary>Install batch-gateway</summary>
 
 ```bash
-IMAGE_TAG=odh-stable
-APISERVER_REPO=quay.io/opendatahub/odh-llm-d-batch-gateway-apiserver
-PROCESSOR_REPO=quay.io/opendatahub/odh-llm-d-batch-gateway-processor
-GC_REPO=quay.io/opendatahub/odh-llm-d-batch-gateway-gc
+CHART_VERSION=0.2.0
+IMAGE_TAG=rhoai-3.5-ea.2
+APISERVER_REPO=quay.io/rhoai/odh-llm-d-batch-gateway-apiserver-rhel9
+PROCESSOR_REPO=quay.io/rhoai/odh-llm-d-batch-gateway-processor-rhel9
+GC_REPO=quay.io/rhoai/odh-llm-d-batch-gateway-gc-rhel9
 ```
 
 ```bash
@@ -1000,8 +1001,10 @@ INTERNAL_GW_SVC=$(oc get svc -n openshift-ingress \
     -o jsonpath='{.items[0].metadata.name}')
 MODEL_URL="http://${INTERNAL_GW_SVC}.openshift-ingress.svc.cluster.local/${LLM_NS}/${ISVC_NAME}"
 
-# Install batch-gateway
-helm upgrade --install batch-gateway ./charts/batch-gateway \
+# Install batch-gateway from OCI chart
+helm upgrade --install batch-gateway \
+    oci://ghcr.io/llm-d-incubation/charts/batch-gateway \
+    --version ${CHART_VERSION} \
     --namespace ${BATCH_NS} \
     --set "apiserver.image.repository=${APISERVER_REPO}" \
     --set "apiserver.image.tag=${IMAGE_TAG}" \

examples/deploy-demo/common.sh

@@ -578,7 +578,8 @@ install_batch_gateway() {
 
     local chart version_args=()
     if [ -n "${BATCH_RELEASE_VERSION}" ]; then
-        chart="oci://ghcr.io/llm-d/charts/batch-gateway"
+        # TODO: pre-graduation location; update to ghcr.io/llm-d in the next release
+        chart="oci://ghcr.io/llm-d-incubation/charts/batch-gateway"
         version_args=(--version "${BATCH_RELEASE_VERSION#v}")
     elif [ "${BATCH_DEV_VERSION}" = "local" ]; then
         local repo_root
@@ -628,7 +629,20 @@ install_batch_gateway() {
         fi
     done
     if [ "${mismatch}" = "true" ]; then
-        warn "Image tags do not match expected version."
+        die "Image tags do not match expected version."
+    fi
+
+    # Verify OCI chart version for release installs
+    if [ -n "${BATCH_RELEASE_VERSION}" ]; then
+        local installed_ver
+        installed_ver=$(helm get metadata "${BATCH_HELM_RELEASE}" -n "${BATCH_NAMESPACE}" -o json 2>/dev/null \
+            | jq -r '.version // empty')
+        local expected_ver="${BATCH_RELEASE_VERSION#v}"
+        if [ "${installed_ver}" = "${expected_ver}" ]; then
+            log "Verified: OCI chart version ${installed_ver} matches release ${BATCH_RELEASE_VERSION}"
+        else
+            die "Chart version '${installed_ver}' does not match expected '${expected_ver}'"
+        fi
     fi
 
     log "batch-gateway installed."

examples/deploy-demo/deploy-rhoai.md

@@ -57,10 +57,11 @@ Batch-route has no authorization — model-level authz is enforced downstream wh
 
 | Mode | Command |
 |------|---------|
-| Local chart (default) | `bash examples/deploy-demo/deploy-rhoai.sh install` |
-| Specific commit | `BATCH_DEV_VERSION=1f925ff bash examples/deploy-demo/deploy-rhoai.sh install` |
-| Released OCI chart | `BATCH_RELEASE_VERSION=v0.1.0 bash examples/deploy-demo/deploy-rhoai.sh install` |
-| Specific batch-gateway images | `BATCH_IMAGE_TAG=rhoai-3.5-ea.2` <br> `BATCH_APISERVER_REPO=quay.io/rhoai/odh-llm-d-batch-gateway-apiserver-rhel9` <br> `BATCH_PROCESSOR_REPO=quay.io/rhoai/odh-llm-d-batch-gateway-processor-rhel9` <br> `BATCH_GC_REPO=quay.io/rhoai/odh-llm-d-batch-gateway-gc-rhel9` <br> `bash examples/deploy-demo/deploy-rhoai.sh install` |
+| OCI chart v0.2.0 + RHOAI images (default) | `bash examples/deploy-demo/deploy-rhoai.sh install` |
+| Different OCI chart version | `BATCH_RELEASE_VERSION=v0.3.0 bash examples/deploy-demo/deploy-rhoai.sh install` |
+| Specific commit (dev chart) | `BATCH_DEV_VERSION=1f925ff bash examples/deploy-demo/deploy-rhoai.sh install` |
+| Local chart | `BATCH_DEV_VERSION=local bash examples/deploy-demo/deploy-rhoai.sh install` |
+| Custom batch-gateway images | `BATCH_IMAGE_TAG=my-tag` <br> `BATCH_APISERVER_REPO=my-registry/apiserver` <br> `BATCH_PROCESSOR_REPO=my-registry/processor` <br> `BATCH_GC_REPO=my-registry/gc` <br> `bash examples/deploy-demo/deploy-rhoai.sh install` |
 
 > `BATCH_RELEASE_VERSION` and `BATCH_DEV_VERSION` cannot be used together.
 
@@ -132,12 +133,12 @@ Use that only on **ephemeral or dedicated** demo clusters. See [issue #309](http
 | Variable | Default | Scope | Description |
 |----------|---------|-------|-------------|
 | `BATCH_HELM_RELEASE` | `batch-gateway` | all | Helm release name |
-| `BATCH_RELEASE_VERSION` | — | all | Install from released OCI chart (e.g. `v1.0.0`). Cannot be used with `BATCH_DEV_VERSION` |
-| `BATCH_DEV_VERSION` | `local` | all | Image tag / commit SHA. `local` uses local chart + `latest` image. Cannot be used with `BATCH_RELEASE_VERSION` |
-| `BATCH_IMAGE_TAG` | — | all | Override image tag for all components. Takes precedence over `BATCH_RELEASE_VERSION` / `BATCH_DEV_VERSION` derived tags |
-| `BATCH_APISERVER_REPO` | — | all | Override apiserver image repository |
-| `BATCH_PROCESSOR_REPO` | — | all | Override processor image repository |
-| `BATCH_GC_REPO` | — | all | Override gc image repository |
+| `BATCH_RELEASE_VERSION` | `v0.2.0` | all | OCI chart version. Cannot be used with `BATCH_DEV_VERSION` |
+| `BATCH_DEV_VERSION` | — | all | Commit SHA for dev chart. Overrides `BATCH_RELEASE_VERSION`. `local` uses local chart |
+| `BATCH_IMAGE_TAG` | `rhoai-3.5-ea.2` | all | Image tag for all components. Takes precedence over version-derived tags |
+| `BATCH_APISERVER_REPO` | `quay.io/rhoai/odh-llm-d-batch-gateway-apiserver-rhel9` | all | Apiserver image repository |
+| `BATCH_PROCESSOR_REPO` | `quay.io/rhoai/odh-llm-d-batch-gateway-processor-rhel9` | all | Processor image repository |
+| `BATCH_GC_REPO` | `quay.io/rhoai/odh-llm-d-batch-gateway-gc-rhel9` | all | GC image repository |
 | `BATCH_DB_TYPE` | `postgresql` | all | Database backend: `postgresql` or `redis` |
 | `BATCH_STORAGE_TYPE` | `s3` | all | File storage: `fs` or `s3` |
 | `DEMO_TLS_INSECURE_SKIP_VERIFY` | `1` | all | Disables TLS certificate verification for processor → model gateway and Istio Gateway → batch apiserver (**demo/lab only**, [CWE-295](https://cwe.mitre.org/data/definitions/295.html)). Default `1` since demo scripts use self-signed certs. Set to `0` if you have trusted CA certs. |

examples/deploy-demo/deploy-rhoai.sh

@@ -21,6 +21,14 @@ set -euo pipefail
 SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
 REPO_ROOT="$(cd "${SCRIPT_DIR}/../.." && pwd)"
 
+# RHOAI defaults: upstream OCI chart v0.2.0 with RHOAI container images.
+# Set before sourcing common.sh so its validation picks them up.
+BATCH_RELEASE_VERSION="${BATCH_RELEASE_VERSION:-v0.2.0}"
+BATCH_IMAGE_TAG="${BATCH_IMAGE_TAG:-rhoai-3.5-ea.2}"
+BATCH_APISERVER_REPO="${BATCH_APISERVER_REPO:-quay.io/rhoai/odh-llm-d-batch-gateway-apiserver-rhel9}"
+BATCH_PROCESSOR_REPO="${BATCH_PROCESSOR_REPO:-quay.io/rhoai/odh-llm-d-batch-gateway-processor-rhel9}"
+BATCH_GC_REPO="${BATCH_GC_REPO:-quay.io/rhoai/odh-llm-d-batch-gateway-gc-rhel9}"
+
 source "${SCRIPT_DIR}/common.sh"
 
 # ── Configuration ────────────────────────────────────────────────────────────
@@ -1576,12 +1584,12 @@ usage() {
     echo "  MODEL_NAME       Model name for simulator (default: facebook/opt-125m)"
     echo "  MODEL_REPLICAS   Number of replicas (default: 1)"
     echo "  SIM_IMAGE        Simulator image (default: ghcr.io/llm-d/llm-d-inference-sim:v0.7.1)"
-    echo "  BATCH_IMAGE_TAG        Batch gateway image tag (default: from values.yaml)"
-    echo "  BATCH_APISERVER_REPO   Apiserver image repo (default: from values.yaml)"
-    echo "  BATCH_PROCESSOR_REPO   Processor image repo (default: from values.yaml)"
-    echo "  BATCH_GC_REPO          GC image repo (default: from values.yaml)"
-    echo "  BATCH_DEV_VERSION      Batch gateway commit SHA for dev chart (default: local)"
-    echo "  BATCH_RELEASE_VERSION  Install released OCI chart (e.g. v1.0.0)"
+    echo "  BATCH_RELEASE_VERSION  OCI chart version (default: v0.2.0)"
+    echo "  BATCH_IMAGE_TAG        Batch gateway image tag (default: rhoai-3.5-ea.2)"
+    echo "  BATCH_APISERVER_REPO   Apiserver image repo (default: quay.io/rhoai/odh-llm-d-batch-gateway-apiserver-rhel9)"
+    echo "  BATCH_PROCESSOR_REPO   Processor image repo (default: quay.io/rhoai/odh-llm-d-batch-gateway-processor-rhel9)"
+    echo "  BATCH_GC_REPO          GC image repo (default: quay.io/rhoai/odh-llm-d-batch-gateway-gc-rhel9)"
+    echo "  BATCH_DEV_VERSION      Batch gateway commit SHA for dev chart (overrides BATCH_RELEASE_VERSION)"
     echo "  BATCH_DB_TYPE          Database: postgresql or redis (default: postgresql)"
     echo "  BATCH_STORAGE_TYPE     File storage: fs or s3 (default: s3)"
     echo "  ENABLE_FLOW_CONTROL   Enable GIE flow control (default: true)"