Skip to content

Commit f442218

Browse files
authored
Add docs for fetching SBOMs (#711)
Add public-facing docs for fetching SBOMs using `src`. <!-- Explain the changes introduced in your PR --> ## Pull Request approval Although pull request approval is not enforced for this repository in order to reduce friction, merging without a review will generate a ticket for the docs team to review your changes. So if possible, have your pull request approved before merging. ## TODO - [x] Add screenshot of version - [x] Make it clear that you don't need to install before fetching SBOMs - [x] Add successful output from command - [x] Update version in examples after release
1 parent 3cc696d commit f442218

File tree

2 files changed

+36
-0
lines changed

2 files changed

+36
-0
lines changed

docs/cli/how-tos/fetch_sboms.mdx

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# How to fetch SBOMs for Sourcegraph
2+
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.
4+
5+
To retrieve the SBOMs for a specific release, you can use the `src` command line interface for Sourcegraph:
6+
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.
14+
```
15+
# Fetch SBOMs for Sourcegraph release 5.9.0
16+
$ src sbom fetch -v 5.9.0
17+
18+
Fetching SBOMs and validating signatures for all 39 images in the Sourcegraph 5.9.0 release...
19+
20+
✅ sourcegraph/appliance
21+
✅ sourcegraph/batcheshelper
22+
✅ sourcegraph/bundled-executor
23+
24+
[...]
25+
26+
🟢 Fetched verified SBOMs for 39 images
27+
28+
Fetched and validated SBOMs have been written to `sourcegraph-sboms/sourcegraph-5.9.0`.
29+
30+
Your Sourcegraph deployment may not use all of these images. Please check your deployment to confirm which images are used.
31+
```
32+
5. Once completed, you can find the set of validated SBOMs under `sourcegraph-sboms/sourcegraph-<version>/`.
33+
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.

docs/cli/how-tos/index.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,5 @@ The following how-tos apply to the `src` command line interface to Sourcegraph:
55
- [Creating an access token](/cli/how-tos/creating_an_access_token)
66
- [Revoking an access token](/cli/how-tos/revoking_an_access_token)
77
- [Managing access tokens](/cli/how-tos/managing_access_tokens)
8+
- [How to fetch SBOMs for Sourcegraph](/cli/how-tos/fetch_sboms)
9+

0 commit comments

Comments
 (0)