docs: add container image inventory page#1392
Open
pbanerji-sn wants to merge 4 commits into
Open
Conversation
Introduced a comprehensive guide on container image inventory, detailing features, benefits, and usage instructions.
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
Updated image paths in the container image inventory documentation to reflect the correct directory structure.
Updated the section to clarify how the container image inventory works and what challenges it addresses.
bdemeo12
reviewed
Jun 23, 2026
|
|
||
| Container image inventory is a unified view in the Snyk platform that consolidates all of your container images into a single, manageable list, regardless of where they were scanned. | ||
|
|
||
| Instead of navigating a fragmented set of per-scan Projects, you get one authoritative inventory of unique container image assets, each identified by **Registry + Repository + Config Digest**. A single image scanned from a registry import, from the CLI, and a Kubernetes workload all appear as **one asset** with a single, deduplicated issue count. |
Contributor
There was a problem hiding this comment.
We have identified that an assets true identity is actually: "registry+ rep+ manifest digest+ config digest. We have a ticket to make this change! If we call this out, will it confuse customers ?
I trust your expertise here @pbanerji-sn !
bdemeo12
reviewed
Jun 23, 2026
| | **Unified asset list** | View all unique container images across your Organization or Group in one place | | ||
| | **Deduplicated issue counts** | Issues from multiple scan sources are merged — no more inflated counts | | ||
| | **Version grouping** | Group images by repository to explore the full version history of an image | | ||
| | **Search and filter** | Filter by registry, image repository, tag, image labels, digest, class, and more | |
Contributor
There was a problem hiding this comment.
nit: maybe split up search and filter since they support different fields?
bdemeo12
reviewed
Jun 23, 2026
|
|
||
| Container image inventory identifies each unique image by its **Registry + Repository + Config Digest**. Because this identity is based on the immutable config digest rather than a mutable tag, one image scanned from the CLI, a container registry, and a Kubernetes workload appears as a single asset — not three separate Projects. | ||
|
|
||
| Issues from all scan sources are merged and deduplicated, so you see one count per unique vulnerability rather than inflated totals from overlapping scans. Images are grouped by repository, giving you a version history view where you can compare build dates, risk scores, and issue counts across digests and spot regressions over time. Each asset also surfaces key metadata — tags, inferred base image, test surface, and last scan date — in one place. |
Contributor
There was a problem hiding this comment.
Technically images are grouped by registry/repo... unsure if it is important to call this out though as the language we use in the UX is group by: image repository
bdemeo12
reviewed
Jun 23, 2026
|
|
||
|  | ||
|
|
||
| You can sort the flat view by build date, score, issue count, last scan, class, discovered, or updated — in ascending or descending order — using the sort control in the top-right corner. |
Contributor
There was a problem hiding this comment.
Should we add that this will be extended to the grouped view in the future ?
bdemeo12
reviewed
Jun 23, 2026
|
|
||
|  | ||
|
|
||
| A **search bar** is also available in the top-right corner. Search matches across asset name, image tags, registry, repository, and digests. |
Contributor
There was a problem hiding this comment.
We should probably be more specific here since customers have already raised this. Right now the search feature only does prefix matching, it matches from the start of a string, so typing the middle of a string will not find a match.
bdemeo12
reviewed
Jun 23, 2026
| A **search bar** is also available in the top-right corner. Search matches across asset name, image tags, registry, repository, and digests. | ||
|
|
||
| {% hint style="info" %} | ||
| The search bar matches from the beginning of the asset name field. If you cannot find a specific image, try using the **Repository** or **Image tag** filters instead. |
bdemeo12
reviewed
Jun 23, 2026
bdemeo12
left a comment
bdemeo12
left a comment
Contributor
There was a problem hiding this comment.
LGTM! Just a few nits!!!
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
New documentation page for the Container Image Inventory feature (GA).
Covers:
Screenshot placeholders use
.gitbook/assets/container-inventory-*.pngpaths — images to be added before merge.cc @snyk/docs for review