Skip to content

Document Guardener container image suggestions and chainctl images discover - #4124

Open
tylerpaxton wants to merge 1 commit into
mainfrom
tp.guardener-image-suggestions-docs
Open

tylerpaxton wants to merge 1 commit into
mainfrom
tp.guardener-image-suggestions-docs

Conversation

@tylerpaxton

Copy link
Copy Markdown
Contributor

[ ] Check if this is a typo or other quick fix and ignore the rest :)

Type of change

New documentation.

What should this PR do?

Adds docs for two features that are live but have no Academy page:

  • Guardener container image suggestions (/chainguard/guardener/github/image-suggestions/). Covers .chainguard/images.yaml (enabled, prefer_fips), what Guardener reads per file type, when a review comment carries a one-click edit, and the review limits. Also adds the feature to the Configuration page and the GitHub App index.
  • Find Chainguard replacements with chainctl images discover (/chainguard/containers/migration/migration-tools/images-discover/). Covers scanning a repository, the status column, single-image lookups, how tags are chosen, and JSON output. Until now there was only the generated chainctl reference.

Why are we making this change?

Image suggestions were enabled in production on Sep 29 (chainguard-dev/mono#63103), and Rahul confirmed there are no dedicated docs for chainctl images discover beyond --help.

What are the acceptance criteria?

  • Every behavior described matches the code. Facts were checked against ai-cicd/actions/github/internal/images, internal/imagesconfig, internal/reconciler, and chainctl/pkg/images at mono main (dcefd06391), and the discover output was checked against chainctl 0.2.364.
  • @rahulduvedi to confirm accuracy, especially the one-click edit conditions and the limits.

How should this PR be tested?

  • chainctl images discover in any repository, and chainctl images discover --image nginx:1.29. The status values in the table come from chainctl/pkg/commands/images_discover.go.
  • Image suggestions: the staging demo repo tylerpaxton/cg-guardener-github-app-images-test PR Bump got from 11.8.3 to 11.8.5 #1 shows the review comments and check run described here.

The docs describe released behavior only. Two open mono PRs will change details: Terraform variable-default detection, and comment text that explains why there is no one-click edit. They don't contradict anything on these pages.

🤖 Generated with Claude Code

…scover

Guardener image suggestions are enabled in production, but edu has no page
for them, and `chainctl images discover` has only its generated reference.

- New page: Guardener container image suggestions. Covers
  .chainguard/images.yaml (enabled, prefer_fips), what is read per file type,
  when a comment carries a one-click edit, and the review limits.
- New page: Find Chainguard replacements with chainctl images discover, under
  Migration tools. Covers scanning, the status column, single-image lookups,
  how tags are chosen, and JSON output.
- Configuration and the GitHub App index list the new feature.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@vercel

vercel Bot commented Oct 2, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
chainguard-docs-preview Ready Ready Preview Oct 2, 2026 9:48pm UTC

Request Review

@netlify

netlify Bot commented Oct 2, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for ornate-narwhal-088216 ready!

Name Link
🔨 Latest commit 72cecd8
🔍 Latest deploy log https://app.netlify.com/projects/ornate-narwhal-088216/deploys/6ac026a5058ba40009736986
😎 Deploy Preview https://deploy-preview-4124--ornate-narwhal-088216.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@tylerpaxton
tylerpaxton marked this pull request as ready for review October 2, 2026 22:15
@tylerpaxton
tylerpaxton requested a review from a team as a code owner October 2, 2026 22:15

This branch was successfully deployed

1 active deployment
Preview — 72cecd8e Deployed Oct 2, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant