docs: image version management for deployments#433
Conversation
|
Warning Review limit reached
Next review available in: 48 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (5)
📝 WalkthroughWalkthroughChangesThe documentation now covers version manifest resolution, offline configuration, image formats and overrides, validation, persistence, and image upgrades. Manifest loading also adds default-image fallback and a Container Image Management
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
Up to standards ✅🟢 Issues
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs/using/image-management.md (1)
38-40: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low valueSpecify a language for fenced code blocks.
To improve syntax highlighting and avoid linter warnings, consider specifying a language (like
text) for these code blocks.
docs/using/image-management.md#L38-L40: appendtextto the opening backticks.docs/using/image-management.md#L194-L196: appendtextto the opening backticks.🤖 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/using/image-management.md` around lines 38 - 40, Specify the text language on both fenced code blocks in docs/using/image-management.md at lines 38-40 and 194-196 by appending text to each opening fence.Source: Linters/SAST tools
🤖 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/using/upgrade-db.md`:
- Around line 187-189: Replace the curly single quotes in the shell commands
with standard straight single quotes: update the URL at docs/using/upgrade-db.md
lines 187-189 and the header value and data payload at lines 215-221.
---
Nitpick comments:
In `@docs/using/image-management.md`:
- Around line 38-40: Specify the text language on both fenced code blocks in
docs/using/image-management.md at lines 38-40 and 194-196 by appending text to
each opening fence.
🪄 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: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: db7363d6-ffc6-4c6b-ac10-9cf33627f171
📒 Files selected for processing (5)
docs/installation/configuration.mddocs/installation/installation.mddocs/using/image-management.mddocs/using/upgrade-db.mdmkdocs.yml
| ```sh | ||
| curl ‘http://host-3:3000/v1/databases/example?include=available_upgrades’ | ||
| ``` |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Use standard straight quotes in shell commands.
Typographic (curly) single quotes (‘ and ’) in code blocks will cause syntax errors in most shells if copied and pasted directly. Please replace them with standard straight single quotes (').
docs/using/upgrade-db.md#L187-L189: replace the curly quotes around the URL with straight single quotes.docs/using/upgrade-db.md#L215-L221: replace the curly quotes around the header value and data payload with straight single quotes.
📍 Affects 1 file
docs/using/upgrade-db.md#L187-L189(this comment)docs/using/upgrade-db.md#L215-L221
🤖 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/using/upgrade-db.md` around lines 187 - 189, Replace the curly single
quotes in the shell commands with standard straight single quotes: update the
URL at docs/using/upgrade-db.md lines 187-189 and the header value and data
payload at lines 215-221.
8d97c68 to
4dcf39f
Compare
4dcf39f to
0364836
Compare
| === "curl" | ||
|
|
||
| ```sh | ||
| curl ‘http://host-3:3000/v1/databases/example?include=available_upgrades’ |
There was a problem hiding this comment.
Curly quotes in the upgrade-db.md curl examples The new examples use smart quotes instead of straight quotes, so if someone copies and pastes them into a shell they will fail. Example lines: curl 'http://host-3:3000/v1/databases/example?include=available_upgrades', the -H header, and the --data body all use curly quotes. Replace them with normal straight quotes like the image-management.md examples already do.
| | `etcd_server.client_port` | `PGEDGE_ETCD_SERVER__CLIENT_PORT` | int | `2379` | The port that the embedded Etcd server will listen on for client connections. | | | ||
| | `etcd_client.log_level` | `PGEDGE_ETCD_CLIENT__LOG_LEVEL` | string | `fatal` | The log level for Etcd client operations performed by this Control Plane server. | | | ||
| | `docker_swarm.image_repository_host` | `PGEDGE_DOCKER_SWARM__IMAGE_REPOSITORY_HOST` | string | `ghcr.io/pgedge` | The base URL of pgEdge Docker images. | | | ||
| | `docker_swarm.manifest_url` | `PGEDGE_DOCKER_SWARM__MANIFEST_URL` | string | pgEdge hosted manifest URL | Overrides the default version manifest URL. Set to an internal endpoint for air-gapped deployments or a staging URL for pre-release image testing. When set, the embedded binary manifest is still used as a last-resort fallback. | | |
There was a problem hiding this comment.
Can you verify if its correct?
2 participants
Summary
This PR adds end-user and internal documentation explaining how the Control Plane manages container images, including the version manifest, custom image overrides, validation rules, available upgrades, and offline/air-gapped deployment configuration.
Changes
docs/using/image-management.md— full image lifecycle: manifest resolution order, checking available upgrades, per-database and per-node image overrides, digest-pinned images, validation rules with error examples, and image persistence behaviourdocs/installation/configuration.md— adddocker_swarm.manifest_urlanddocker_swarm.manifest_pathto the optional settings tabledocs/installation/installation.md— add "Version Manifest" section covering offline/air-gapped setup viamanifest_pathandmanifest_urldocs/using/upgrade-db.md— add "Image Upgrades" section with?include=available_upgradesandPOST /v1/databases/{id}/upgradeexamplesmkdocs.yml— register the new page in the nav under "Using Control Plane"internal-design-docs/control-plane/2026-07-15-testing-version-manifest.md— runbook for adding new manifest entries, local dev testing, publishing to downloads.pgedge.com, and a validation checklistTesting
Verification Details
Checklist
PLAT-673