Skip to content

Commit e2e156e

Browse files
committed
Update SBOM docs to align with signature verification
1 parent 3e492f2 commit e2e156e

File tree

1 file changed

+21
-11
lines changed

1 file changed

+21
-11
lines changed

docs/cli/how-tos/fetch_sboms.mdx

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,26 @@
11
# How to fetch SBOMs for Sourcegraph
22

3-
Sourcegraph publishes a Software Bill of Materials (SBOM) for each of its container images. The SBOMs for each Sourcegraph release are signed, and stored in our container registry alongside our published container images.
3+
Sourcegraph generates and cryptographically signs a Software Bill of Materials (SBOM) for each container image in every release. These SBOMs are stored in our container registry alongside their corresponding images.
44

5-
To retrieve the SBOMs for a specific release, you can use the `src` command line interface for Sourcegraph:
5+
Use the Sourcegraph CLI (`src`) to fetch SBOMs for a specific release.
66

7-
1. Install `src` by following the [Quickstart](../quickstart.mdx).
8-
2. Install `cosign` by following the [Installation Guide](https://docs.sigstore.dev/cosign/system_config/installation/).
9-
3. Identify the version of Sourcegraph your require SBOMs for. This may be a [recent release](../../CHANGELOG.mdx), or your instance's current version.
10-
1. SBOMs are only available for Sourcegraph release 5.9.0 and later.
11-
2. Find your instance's current version by checking your deployment, or by visiting the Settings page on your Sourcegraph instance and checking the version shown in the bottom left corner.
12-
![](https://storage.googleapis.com/sourcegraph-assets/docs/images/settings/view-version-scaled.png)
13-
4. Run `src sbom fetch -v <version>` to fetch SBOMs for all containers in this release. `src` will automatically validate that all SBOMs were signed by Sourcegraph.
7+
## Prerequisites
8+
9+
1. Install `src` following the [Quickstart](../quickstart.mdx).
10+
11+
2. Install `cosign` following the [Installation Guide](https://docs.sigstore.dev/cosign/system_config/installation/).
12+
13+
## Fetching SBOMs
14+
15+
1. Determine the Sourcegraph version to verify. Use either a [recent release](../../CHANGELOG.mdx) or your instance's current version.
16+
17+
> **Note:** SBOMs are only available only for Sourcegraph release 5.9.0 and later.
18+
19+
To find your instance's current version, check your deployment or view the Settings page on your Sourcegraph instance (version shown in bottom left corner).
20+
21+
![Version location in settings](https://storage.googleapis.com/sourcegraph-assets/docs/images/settings/view-version-scaled.png)
22+
23+
2. Run `src sbom fetch -v <version>` to fetch SBOMs for all containers in this release. `src` will automatically validate that all SBOMs were signed by Sourcegraph.
1424
```
1525
# Fetch SBOMs for Sourcegraph release 5.9.0
1626
$ src sbom fetch -v 5.9.0
@@ -29,6 +39,6 @@ To retrieve the SBOMs for a specific release, you can use the `src` command line
2939
3040
Your Sourcegraph deployment may not use all of these images. Please check your deployment to confirm which images are used.
3141
```
32-
5. Once completed, you can find the set of validated SBOMs under `sourcegraph-sboms/sourcegraph-<version>/`.
42+
3. Once completed, find the set of validated SBOMs under `sourcegraph-sboms/sourcegraph-<version>/`.
3343

34-
**Note:** `src sbom fetch` will retrieve SBOMs for **all** containers that make up a Sourcegraph release. Your Sourcegraph instance will use only a subset of these containers - please check your deployment to determine which SBOM files are relevant to your deployment.
44+
**Important:** `src sbom fetch` will retrieve SBOMs for **all** containers that make up a Sourcegraph release. Your Sourcegraph instance will use only a subset of these containers - please check your deployment to determine which SBOM files are relevant to your deployment.

0 commit comments

Comments
 (0)