HYPERFLEET-1186 - docs: Use the OCI artifact for the release chart#197
HYPERFLEET-1186 - docs: Use the OCI artifact for the release chart#197sherine-k wants to merge 1 commit into
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
📝 WalkthroughSummary by CodeRabbitRelease Notes
Walkthrough
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Registry hardcoding note — no CWE, but flag it: Both files now hardcode 🚥 Pre-merge checks | ✅ 11✅ Passed checks (11 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
✨ Simplify code
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Risk Score: 0 —
|
| Signal | Detail | Points |
|---|---|---|
| PR size | 16 lines | +0 |
| Sensitive paths | none | +0 |
Computed by hyperfleet-risk-scorer
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/deployment.md`:
- Line 9: Update line 9 in docs/deployment.md to reflect the actual registry
where the HyperFleet Adapter Helm chart is currently published. Replace the
registry path from
`oci://quay.io/redhat-services-prod/hyperfleet-tenant/hyperfleet/hyperfleet-adapter-chart`
with the correct current registry
`oci://quay.io/redhat-user-workloads/hyperfleet-tenant/hyperfleet/hyperfleet-adapter-chart`
where the Tekton build pipeline actually publishes the chart, or add a
clarifying note indicating that the production registry path is pending
availability from the Konflux team and provide the working development registry
path that users should currently use.
In `@README.md`:
- Line 37: The README.md documents the REGISTRY as
quay.io/redhat-services-prod/hyperfleet-tenant/hyperfleet, but the Makefile's
test-helm target hardcodes the old registry path
openshift-hyperfleet/hyperfleet-adapter in the --set image.repository argument.
Update the test-helm target (lines 105-150) to replace the hardcoded
image.repository value with the documented registry path from README.md to
ensure consistency between documentation and test validation, preventing users
from using undocumented or untested image references.
- Line 31: The README.md documentation at line 31 references a make target
`install-adapters` that does not exist in the Makefile. Either add the missing
`install-adapters` target to the Makefile (following the pattern of existing
targets like `install` and `install-hooks`), or update the documentation in
README.md line 31 to reference an actual existing make target from the Makefile.
Ensure consistency between documented make targets and those actually defined in
the Makefile.
- Around line 31-40: The README.md documentation specifies a registry namespace
for deployments that does not match the hardcoded registry values in the
Makefile for the hyperfleet-api and hyperfleet-sentinel components. Update the
REGISTRY environment variable documentation in README.md (around line 36) to
accurately reflect the actual registry namespaces used in the Makefile by the
hyperfleet-api, hyperfleet-sentinel, and hyperfleet-adapter components, ensuring
consistency across all component deployments to prevent image pull/push
failures.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Central YAML (base), Organization UI (inherited)
Review profile: CHILL
Plan: Enterprise
Run ID: b155f908-9929-4fa9-a586-5c4c23cfff6a
📒 Files selected for processing (2)
README.mddocs/deployment.md
🔗 Linked repositories identified
CodeRabbit considers these linked repositories for cross-repo context during reviews:
openshift-hyperfleet/architecture(manual)openshift-hyperfleet/hyperfleet-api(manual)openshift-hyperfleet/hyperfleet-sentinel(manual)openshift-hyperfleet/hyperfleet-adapter(manual)openshift-hyperfleet/hyperfleet-broker(manual)
|
|
||
| ## Configuration Overview | ||
|
|
||
| The HyperFleet Adapter Helm chart is released as an oci artifact at : oci://quay.io/redhat-services-prod/hyperfleet-tenant/hyperfleet/hyperfleet-adapter-chart. |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Check for Makefile and CI/CD configuration
echo "=== Makefile targets ==="
cat -n Makefile | grep -i "chart\|helm" || echo "No chart/helm targets found"
echo -e "\n=== Repository structure ==="
find . -type f -name "Makefile" -o -name ".konfluxci.yaml" -o -name ".tekton*" | head -20
echo -e "\n=== Tekton/Konflux pipeline files ==="
if [ -d ".tekton" ]; then ls -la .tekton/; fi
if [ -f ".konfluxci.yaml" ]; then cat .konfluxci.yaml; fi
echo -e "\n=== Chart directory ==="
if [ -d "charts" ] || [ -d "helm" ]; then find . -type d \( -name "charts" -o -name "helm" \) -exec ls -la {} \;; fi
echo -e "\n=== Build/push targets in Makefile ==="
cat Makefile | grep -A 5 "\.PHONY.*push\|\.PHONY.*build" | head -50Repository: openshift-hyperfleet/hyperfleet-adapter
Length of output: 3839
🏁 Script executed:
#!/bin/bash
echo "=== hyperfleet-adapter-chart-push.yaml ==="
cat -n .tekton/hyperfleet-adapter-chart-push.yaml | head -200
echo -e "\n=== Checking for registry/image configuration in pipeline ==="
grep -n "quay.io\|registry\|IMAGE\|ARTIFACT" .tekton/hyperfleet-adapter-chart-push.yaml | head -30Repository: openshift-hyperfleet/hyperfleet-adapter
Length of output: 11067
🏁 Script executed:
#!/bin/bash
echo "=== hyperfleet-adapter-tag.yaml (check for promotion logic) ==="
cat -n .tekton/hyperfleet-adapter-tag.yaml | grep -A 5 -B 5 "quay.io\|services-prod\|user-workloads" | head -100
echo -e "\n=== docs/deployment.md context around line 9 ==="
cat -n docs/deployment.md | sed -n '1,30p'
echo -e "\n=== Checking for any promotion/release documentation ==="
find . -type f \( -name "*.md" -o -name "*.yaml" \) | xargs grep -l "services-prod\|user-workloads" 2>/dev/nullRepository: openshift-hyperfleet/hyperfleet-adapter
Length of output: 6818
🏁 Script executed:
#!/bin/bash
echo "=== README.md (check for release/registry info) ==="
cat README.md | grep -A 10 -B 2 "services-prod\|user-workloads\|registry\|release\|chart" | head -80Repository: openshift-hyperfleet/hyperfleet-adapter
Length of output: 1606
🏁 Script executed:
#!/bin/bash
echo "=== Searching architecture repo for registry promotion/release patterns ==="
grep -r "services-prod\|user-workloads" --include="*.md" hyperfleet/ 2>/dev/null | head -30
echo -e "\n=== Release process documentation ==="
cat -n hyperfleet/docs/release/hyperfleet-release-process.md 2>/dev/null | grep -A 5 -B 5 "services-prod\|chart" | head -100Repository: openshift-hyperfleet/architecture
Length of output: 11113
Line 9: Helm chart not published to documented registry — deployment will fail.
The Tekton build pipeline publishes the chart to quay.io/redhat-user-workloads/hyperfleet-tenant/hyperfleet/hyperfleet-adapter-chart (development registry), but docs/deployment.md directs users to oci://quay.io/redhat-services-prod/hyperfleet-tenant/hyperfleet/hyperfleet-adapter-chart (production registry). Architecture documentation confirms charts should land at services-prod, but notes this is "pending a managed release pipeline for external registries from the Konflux team." Update docs/deployment.md to reflect the actual current registry, or add a note that the production registry path is not yet available. Operators following this guide will encounter artifact-not-found errors.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/deployment.md` at line 9, Update line 9 in docs/deployment.md to reflect
the actual registry where the HyperFleet Adapter Helm chart is currently
published. Replace the registry path from
`oci://quay.io/redhat-services-prod/hyperfleet-tenant/hyperfleet/hyperfleet-adapter-chart`
with the correct current registry
`oci://quay.io/redhat-user-workloads/hyperfleet-tenant/hyperfleet/hyperfleet-adapter-chart`
where the Tekton build pipeline actually publishes the chart, or add a
clarifying note indicating that the production registry path is pending
availability from the Konflux team and provide the working development registry
path that users should currently use.
| | `make install-adapters` | Install sample Hyperfleet Adapters | | ||
| | `make status` | Verify the deployment | | ||
|
|
||
| Make sure you define the following environment variables: | ||
| * `HELMFILE_ENV`: accepted values : `kind`, `gcp` | ||
| * `NAMESPACE`: namespace where HyperFleet components will be deployed | ||
| * `REGISTRY`: The registry namespace from which to pull the images. `quay.io/openshift-hyperfleet` for released images | ||
| * `REGISTRY`: The registry namespace from which to pull the images. `quay.io/redhat-services-prod/hyperfleet-tenant/hyperfleet` for released images | ||
| * `API_IMAGE_TAG`: image tag for `hyperfleet-api` container image | ||
| * `SENTINEL_IMAGE_TAG`: image tag for `hyperfleet-sentinel` container image | ||
| * `ADAPTER_IMAGE_TAG`: image tag for `hyperfleet-adapter` container image |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Check what changed in README.md in this PR (get file size first)
wc -l README.md
head -50 README.mdRepository: openshift-hyperfleet/hyperfleet-adapter
Length of output: 2814
🏁 Script executed:
#!/bin/bash
# Verify hyperfleet-api Makefile still uses old registry
grep -n "IMAGE_REGISTRY" Makefile | head -5Repository: openshift-hyperfleet/hyperfleet-api
Length of output: 417
🏁 Script executed:
#!/bin/bash
# Verify hyperfleet-sentinel Makefile still uses old registry
grep -n "IMAGE_REGISTRY" Makefile | head -5Repository: openshift-hyperfleet/hyperfleet-sentinel
Length of output: 414
Supply chain inconsistency: Registry namespace mismatch across components will cause image pull/push failures post-merge.
Adapter documentation (line 39) instructs deployments to use quay.io/redhat-services-prod/hyperfleet-tenant/hyperfleet, but hyperfleet-api (Makefile:43) and hyperfleet-sentinel (Makefile:36) retain hardcoded IMAGE_REGISTRY ?= quay.io/openshift-hyperfleet. Adapters will deploy from the new registry while API and Sentinel default to building/pushing from the old registry. Coordinate Makefile updates in both components or explicitly document the staggered migration timeline to prevent inconsistent registry access across the platform.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` around lines 31 - 40, The README.md documentation specifies a
registry namespace for deployments that does not match the hardcoded registry
values in the Makefile for the hyperfleet-api and hyperfleet-sentinel
components. Update the REGISTRY environment variable documentation in README.md
(around line 36) to accurately reflect the actual registry namespaces used in
the Makefile by the hyperfleet-api, hyperfleet-sentinel, and hyperfleet-adapter
components, ensuring consistency across all component deployments to prevent
image pull/push failures.
Source: Linked repositories
| * `HELMFILE_ENV`: accepted values : `kind`, `gcp` | ||
| * `NAMESPACE`: namespace where HyperFleet components will be deployed | ||
| * `REGISTRY`: The registry namespace from which to pull the images. `quay.io/openshift-hyperfleet` for released images | ||
| * `REGISTRY`: The registry namespace from which to pull the images. `quay.io/redhat-services-prod/hyperfleet-tenant/hyperfleet` for released images |
There was a problem hiding this comment.
Line 37: Registry mismatch between documented environment variable and Makefile test harness.
README documents REGISTRY: quay.io/redhat-services-prod/hyperfleet-tenant/hyperfleet, but the Makefile's test-helm target (lines 105–150) hardcodes --set image.repository=openshift-hyperfleet/hyperfleet-adapter (old registry path). This creates a contract violation: users following the new registry docs will use image references that the build pipeline never validated. Coordinate the Makefile test targets to use the documented registry.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` at line 37, The README.md documents the REGISTRY as
quay.io/redhat-services-prod/hyperfleet-tenant/hyperfleet, but the Makefile's
test-helm target hardcodes the old registry path
openshift-hyperfleet/hyperfleet-adapter in the --set image.repository argument.
Update the test-helm target (lines 105-150) to replace the hardcoded
image.repository value with the documented registry path from README.md to
ensure consistency between documentation and test validation, preventing users
from using undocumented or untested image references.
1 participant
Summary
Updates the references to images and charts to the (konflux) registry references for released artifacts
Test Plan
make test-allpassesmake lintpassesmake test-helm(if applicable)