From b9574726902676bdc7f1aad4b0e6a47ab2727035 Mon Sep 17 00:00:00 2001 From: sherine-k Date: Fri, 19 Jun 2026 11:06:24 +0200 Subject: [PATCH] HYPERFLEET-1186 - docs: Use the OCI artifact for the release chart --- docs/api-operator-guide.md | 2 +- docs/authentication.md | 4 +++- docs/config.md | 4 +++- docs/deployment.md | 45 +++++++++++++++++--------------------- docs/runbook.md | 4 ++-- 5 files changed, 29 insertions(+), 30 deletions(-) diff --git a/docs/api-operator-guide.md b/docs/api-operator-guide.md index 95ffd5df..9436958d 100644 --- a/docs/api-operator-guide.md +++ b/docs/api-operator-guide.md @@ -825,7 +825,7 @@ Choose your database deployment strategy based on your environment: - [ ] Deploy using Helm: ```bash - helm install hyperfleet-api ./charts/ \ + helm install hyperfleet-api oci://quay.io/redhat-services-prod/hyperfleet-tenant/hyperfleet/hyperfleet-api-chart: \ --namespace hyperfleet-system \ --create-namespace \ --values custom-values.yaml diff --git a/docs/authentication.md b/docs/authentication.md index 6fbc50d5..23880a78 100644 --- a/docs/authentication.md +++ b/docs/authentication.md @@ -233,9 +233,11 @@ config: Deploy: ```bash -helm install hyperfleet-api ./charts/ --values values.yaml +helm install hyperfleet-api oci://quay.io/redhat-services-prod/hyperfleet-tenant/hyperfleet/hyperfleet-api-chart: --values values.yaml ``` +> **Note:** You may also choose to install from the ./charts folder, if you've cloned this repository locally. + ## Troubleshooting ### Common Issues diff --git a/docs/config.md b/docs/config.md index b6957993..6fbc8bb3 100644 --- a/docs/config.md +++ b/docs/config.md @@ -14,11 +14,13 @@ hyperfleet-api serve --config=config.yaml **Production (Kubernetes):** ```bash -helm install hyperfleet-api ./charts/ \ +helm install hyperfleet-api oci://quay.io/redhat-services-prod/hyperfleet-tenant/hyperfleet/hyperfleet-api-chart: \ --set 'config.adapters.required.cluster={validation,dns}' \ --set 'config.adapters.required.nodepool={validation}' ``` +> **Note:** You may also choose to install from the ./charts folder, if you've cloned this repository locally. + See [Configuration Examples](#configuration-examples) for complete setup. --- diff --git a/docs/deployment.md b/docs/deployment.md index 2ed12119..694c385e 100644 --- a/docs/deployment.md +++ b/docs/deployment.md @@ -15,14 +15,7 @@ Before deploying, ensure you have: - **PostgreSQL database** — either: - An external managed instance (Cloud SQL, RDS, Azure Database) for production, or - The chart's built-in PostgreSQL pod for evaluation and testing -- **Container image** — a released hyperfleet-api image, a pre-built image from your registry, or build your own: - ```bash - make image \ - IMAGE_REGISTRY=quay.io/yourorg \ - IMAGE_TAG=v1.0.0 - - podman push quay.io/yourorg/hyperfleet-api:v1.0.0 - ``` +- **Container image** — a released hyperfleet-api image, a pre-built image from your registry, or build your own. See [development.md](./development.md) for more. --- @@ -35,20 +28,22 @@ The fastest path to a running deployment. This uses the chart's built-in Postgre | Value | What to set | Example | |-------|-------------|---------| | `image.registry` | Container registry domain | `quay.io` | -| `image.repository` | Organization and image name | `openshift-hyperfleet/hyperfleet-api` | +| `image.repository` | Organization and image name | `redhat-services-prod/hyperfleet-tenant/hyperfleet/hyperfleet-api` | | `image.tag` | Image version | `v1.0.0` | **Deploy:** ```bash -helm install hyperfleet-api ./charts/ \ +helm install hyperfleet-api oci://quay.io/redhat-services-prod/hyperfleet-tenant/hyperfleet/hyperfleet-api-chart: \ --namespace hyperfleet-system \ --create-namespace \ --set image.registry=quay.io \ - --set image.repository=openshift-hyperfleet/hyperfleet-api \ - --set image.tag=v1.0.0 + --set image.repository=redhat-services-prod/hyperfleet-tenant/hyperfleet/hyperfleet-api \ + --set image.tag= ``` +> **Note:** You may also choose to install from the ./charts folder, if you've cloned this repository locally. + **Verify:** ```bash @@ -80,12 +75,12 @@ kubectl create secret generic hyperfleet-db-external \ ### Step 2: Deploy with external database ```bash -helm install hyperfleet-api ./charts/ \ +helm install hyperfleet-api oci://quay.io/redhat-services-prod/hyperfleet-tenant/hyperfleet/hyperfleet-api-chart: \ --namespace hyperfleet-system \ --create-namespace \ --set image.registry=quay.io \ - --set image.repository=openshift-hyperfleet/hyperfleet-api \ - --set image.tag=v1.0.0 \ + --set image.repository=redhat-services-prod/hyperfleet-tenant/hyperfleet/hyperfleet-api \ + --set image.tag= \ --set database.postgresql.enabled=false \ --set database.external.enabled=true \ --set database.external.secretName=hyperfleet-db-external @@ -158,10 +153,10 @@ The chart injects database credentials as environment variables using `secretKey JWT authentication is **disabled by default** in the Helm chart. To enable it, set the `config.server.jwt.*` properties, like so: ```bash -helm install hyperfleet-api ./charts/ \ +helm install hyperfleet-api oci://quay.io/redhat-services-prod/hyperfleet-tenant/hyperfleet/hyperfleet-api-chart: \ --namespace hyperfleet-system \ --set image.registry=quay.io \ - --set image.repository=openshift-hyperfleet/hyperfleet-api \ + --set image.repository=redhat-services-prod/hyperfleet-tenant/hyperfleet/hyperfleet-api \ --set image.tag=v1.0.0 \ --set config.server.jwt.enabled=true \ --set config.server.jwt.issuer_url=https://your-idp.example.com/auth/realms/your-realm \ @@ -261,7 +256,7 @@ When enabled, the chart creates (or references) a ConfigMap with the schema, mou ### Upgrade ```bash -helm upgrade hyperfleet-api ./charts/ \ +helm upgrade hyperfleet-api oci://quay.io/redhat-services-prod/hyperfleet-tenant/hyperfleet/hyperfleet-api-chart: \ --namespace hyperfleet-system \ --set image.tag=v1.1.0 ``` @@ -281,8 +276,8 @@ For repeatable deployments, create a `values.yaml` file: ```yaml image: registry: quay.io - repository: openshift-hyperfleet/hyperfleet-api - tag: v1.0.0 + repository: redhat-services-prod/hyperfleet-tenant/hyperfleet/hyperfleet-api + tag: config: server: @@ -322,7 +317,7 @@ resources: ``` ```bash -helm install hyperfleet-api ./charts/ \ +helm install hyperfleet-api oci://quay.io/redhat-services-prod/hyperfleet-tenant/hyperfleet/hyperfleet-api-chart: \ --namespace hyperfleet-system \ --values values.yaml ``` @@ -404,7 +399,7 @@ The deployment includes: kubectl scale deployment hyperfleet-api --replicas=3 --namespace hyperfleet-system # Via Helm -helm upgrade hyperfleet-api ./charts/ \ +helm upgrade hyperfleet-api oci://quay.io/redhat-services-prod/hyperfleet-tenant/hyperfleet/hyperfleet-api-chart: \ --namespace hyperfleet-system \ --set replicaCount=3 ``` @@ -419,11 +414,11 @@ Prometheus metrics are available at `http://:9090/metrics`. ```bash # Enable ServiceMonitor -helm install hyperfleet-api ./charts/ \ +helm install hyperfleet-api oci://quay.io/redhat-services-prod/hyperfleet-tenant/hyperfleet/hyperfleet-api-chart: \ --namespace hyperfleet-system \ --set image.registry=quay.io \ - --set image.repository=openshift-hyperfleet/hyperfleet-api \ - --set image.tag=v1.0.0 \ + --set image.repository=redhat-services-prod/hyperfleet-tenant/hyperfleet/hyperfleet-api \ + --set image.tag= \ --set serviceMonitor.enabled=true # With custom Prometheus selector labels diff --git a/docs/runbook.md b/docs/runbook.md index fdc8768c..6abb3e63 100644 --- a/docs/runbook.md +++ b/docs/runbook.md @@ -162,10 +162,10 @@ To manually run migrations (rarely needed): ```bash # Run a one-off migration job kubectl run hyperfleet-migrate --rm -it \ - --image=quay.io/openshift-hyperfleet/hyperfleet-api:latest \ + --image=quay.io/redhat-services-prod/hyperfleet-tenant/hyperfleet/hyperfleet-api: \ --restart=Never \ -n hyperfleet-system \ - --overrides='{"spec":{"containers":[{"name":"hyperfleet-migrate","image":"quay.io/openshift-hyperfleet/hyperfleet-api:latest","command":["/app/hyperfleet-api","migrate"],"volumeMounts":[{"name":"secrets","mountPath":"/build/secrets","readOnly":true}]}],"volumes":[{"name":"secrets","secret":{"secretName":"hyperfleet-db-external"}}]}}' \ + --overrides='{"spec":{"containers":[{"name":"hyperfleet-migrate","image":"quay.io/redhat-services-prod/hyperfleet-tenant/hyperfleet/hyperfleet-api:","command":["/app/hyperfleet-api","migrate"],"volumeMounts":[{"name":"secrets","mountPath":"/build/secrets","readOnly":true}]}],"volumes":[{"name":"secrets","secret":{"secretName":"hyperfleet-db-external"}}]}}' \ -- /app/hyperfleet-api migrate ```