docs(self-managed): document upstream supporting images#371
Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughThe version catalog maps Alpine Kubernetes and NATS artifacts to Docker Hub registries. Manifests document upstream image overrides, and BDD coverage adds block substitution plus a single-cluster Helmfile workflow that renders, installs, and verifies the upstream images. ChangesUpstream image documentation and validation
Estimated code review effort: 3 (Moderate) | ~25 minutes Sequence Diagram(s)sequenceDiagram
participant BDDFeature
participant ScenarioContext
participant Helmfile
participant Kubernetes
BDDFeature->>ScenarioContext: substitute upstream image blocks
ScenarioContext->>Helmfile: render and install selected releases
Helmfile->>Kubernetes: deploy workloads
Kubernetes-->>BDDFeature: return image references
🚥 Pre-merge checks | ✅ 3 | ❌ 2❌ Failed checks (2 warnings)
✅ Passed checks (3 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
ea8ca3e to
d0f5741
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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/user/manifest.md`:
- Around line 76-78: Update the documentation around global.imagePullSecrets to
explain that it references existing Kubernetes Secret names rather than
embedding registry credentials, require the Secret to exist in each workload
namespace, and show the expected list shape such as [{name:
"my-registry-secret"}].
🪄 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: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 593b40b1-bc11-43fe-a2cd-19f3ef360d73
📒 Files selected for processing (2)
docs/user/manifest.mddocs/version-catalog/main.yaml
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/version-catalog/main.yaml
d0f5741 to
7a19e7a
Compare
Signed-off-by: Stephanie Baum <sbaum@nvidia.com>
7a19e7a to
dd9237e
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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/superpowers/issues/2026-07-22-single-cluster-upstream-images.md`:
- Around line 146-151: Update the workflow summary to explicitly mention that
the feature installs the `name=nats-auth-callout-service` selector, alongside
the existing dependency, `ess-api`, and `api` prerequisites. Keep the
description consistent with BDD-UPSTREAM-014 and preserve the existing scope of
the single-cluster Helmfile bring-up.
🪄 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: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: f8c1cb57-6363-450d-bcac-437bb885f412
📒 Files selected for processing (13)
docs/superpowers/issues/2026-07-22-single-cluster-upstream-images.mddocs/superpowers/specs/2026-07-22-single-cluster-upstream-images-design.mddocs/user/manifest.mddocs/v0.6.1-rc/manifest.mdtests/bdd/PLAN.mdtests/bdd/PLAN_DESTRUCTIVE_CLEANUP.mdtests/bdd/README.mdtests/bdd/dsl/yamledit.gotests/bdd/dsl/yamledit_test.gotests/bdd/features/single-cluster-helmfile-upstream-images.featuretests/bdd/godog_test.gotests/bdd/steps/file_steps.gotests/bdd/steps/steps_test.go
🚧 Files skipped from review as they are similar to previous changes (2)
- docs/user/manifest.md
- docs/v0.6.1-rc/manifest.md
TL;DR
Document how self-managed deployments can pull supporting images directly
from upstream registries. Point the NATS configuration reloader and
alpine-k8smanifest entries to their public Docker Hub distributions in bothdev docs and the
0.6.1-rcsnapshot.Additional Details (optional for docs, build, test, refactor, ci, chore, style, and revert PRs)
The artifact manifest previously listed both supporting images under the NVCF
Early Access registry even though they can be consumed directly from their
public upstream repositories.
This change:
and the three
alpine-k8sconsumers in the self-managed stackdocker.io/natsio/nats-server-config-reloader:0.23.0anddocker.io/alpine/k8s:1.36.1as their distributionssynchronized
0.6.1-rcdocumentation snapshotNo third-party dependency versions changed. License review and NOTICE updates
are not required for this documentation-only change.
For the Reviewer
Review the upstream override examples and generated manifest distribution
paths for both supporting images.
For QA (optional for docs, build, test, refactor, ci, chore, style, and revert PRs)
QA is not needed. Validation performed:
go test -C tools/docs-version-sync ./...tools/docs-version-sync0.6.1-rcmanifests./tools/ci/check-docsgit diff --checkThe remote catalog refresh remains advisory because the migrated repository no
longer contains the root marker expected by the sync command. Local generated
content and Fern validation passed.
Issues
Closes #370
Checklist
Summary by CodeRabbit
Documentation
Tests