Skip to content

Commit 979de85

Browse files
committed
Docker SBOM plugin migration to Docker Scout
Signed-off-by: CrazyMax <1951866+crazy-max@users.noreply.github.com>
1 parent 73c3ead commit 979de85

2 files changed

Lines changed: 16 additions & 19 deletions

File tree

content/guides/cpp/security.md

Lines changed: 7 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -13,41 +13,28 @@ aliases:
1313

1414
- You have a [Git client](https://git-scm.com/downloads). The examples in this section use a command-line based Git client, but you can use any client.
1515
- You have a Docker Desktop installed, with containerd enabled for pulling and storing images (it's a checkbox in **Settings** > **General**). Otherwise, if you use Docker Engine:
16-
- You have the [Docker SBOM CLI plugin](https://github.com/docker/sbom-cli-plugin) installed. To install it on Docker Engine, use the following command:
17-
18-
```bash
19-
$ curl -sSfL https://raw.githubusercontent.com/docker/sbom-cli-plugin/main/install.sh | sh -s --
20-
```
21-
2216
- You have the [Docker Scout CLI plugin](https://docs.docker.com/scout/install/) installed. To install it on Docker Engine, use the following command:
2317

2418
```bash
2519
$ curl -sSfL https://raw.githubusercontent.com/docker/scout-cli/main/install.sh | sh -s --
2620
```
27-
21+
2822
- You have [containerd enabled](https://docs.docker.com/engine/storage/containerd/) for Docker Engine.
2923

3024
## Overview
3125

32-
This section walks you through extracting Software Bill of Materials (SBOMs) from a C++ Docker image using the Docker SBOM CLI plugin. SBOMs provide a detailed list of all the components in a software package, including their versions and licenses. You can use SBOMs to track the provenance of your software and ensure that it complies with your organization's security and licensing policies.
26+
This section walks you through extracting Software Bill of Materials (SBOMs) from a C++ Docker image using Docker Scout. SBOMs provide a detailed list of all the components in a software package, including their versions and licenses. You can use SBOMs to track the provenance of your software and ensure that it complies with your organization's security and licensing policies.
3327
3428
## Generate an SBOM
3529
3630
Here we will use the Docker image that we built in the [Create a multi-stage build for your C++ application](/guides/language/cpp/multistage/) guide. If you haven't already built the image, follow the steps in that guide to build the image.
3731
The image is named `hello`. To generate an SBOM for the `hello` image, run the following command:
3832

3933
```bash
40-
$ docker sbom hello
34+
$ docker scout sbom --format list hello
4135
```
4236

4337
The command will say "No packages discovered". This is because the final image is a scratch image and doesn't have any packages.
44-
Let's try again with Docker Scout:
45-
46-
```bash
47-
$ docker scout sbom --format=list hello
48-
```
49-
50-
This command will tell you the same thing.
5138
5239
## Generate an SBOM attestation
5340
@@ -85,12 +72,13 @@ $ docker buildx build --sbom=true -t hello:sbom .
8572
This command will build the image and generate an SBOM attestation. You can verify that the SBOM is attached to the image by running the following command:
8673

8774
```bash
88-
$ docker scout sbom --format=list hello:sbom
75+
$ docker scout sbom --format list hello:sbom
8976
```
9077

91-
Note that the normal `docker sbom` command will not load the SBOM attestation.
78+
Docker Scout reads the SBOM attestation when one is available, so this command reports packages from the build-stage metadata instead of indexing only the final scratch image filesystem.
9279

9380
## Summary
9481

9582
In this section, you learned how to generate SBOM attestation for a C++ Docker image during the build process.
96-
The normal image scanners will not be able to generate SBOMs from scratch images.
83+
Image scanners that inspect only the final filesystem may not identify packages in scratch images.
84+
Use SBOM attestations to preserve package metadata from the build.

content/manuals/retired.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -212,6 +212,15 @@ v1 is no longer maintained, and users should migrate to Compose v2.
212212

213213
[Compose v2 Documentation](/manuals/compose/_index.md)
214214

215+
### Docker SBOM CLI plugin
216+
217+
The Docker SBOM CLI plugin provided the `docker sbom` command for generating
218+
and viewing software bill of materials (SBOMs) for container images. The plugin
219+
is discontinued. Use [`docker scout sbom`](/reference/cli/docker/scout/sbom/)
220+
for SBOM generation and inspection.
221+
222+
[See Docker SBOM CLI plugin release notes for migration guidance](https://github.com/docker/sbom-cli-plugin/releases/tag/v0.7.0)
223+
215224
### InfraKit
216225

217226
InfraKit was an open-source toolkit designed to manage declarative

0 commit comments

Comments
 (0)