Skip to content

Commit 029ad98

Browse files
committed
Add initial public SBOM fetching instructions
1 parent ca7368c commit 029ad98

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

docs/cli/how-tos/fetch_sboms.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# How to Fetch SBOMs for Sourcegraph
2+
3+
Sourcegraph publishes Software Bill of Materials (SBOM) for all 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.md).
8+
2. Install `cosign` by following the [Installation Guide](https://docs.sigstore.dev/cosign/system_config/installation/).
9+
3. Identify your Sourcegraph instance's version - you can do this by checking your deployment, or visiting the Settings page on your Sourcegraph instance at and checking the version shown in the bottom left corner.
10+
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.
11+
```bash
12+
# Fetch SBOMs for Sourcegraph release 5.8.123
13+
$ src sbom fetch -v 5.8.123
14+
```
15+
5. Once completed, you can find the set of validated SBOMs under `sourcegraph-sboms/sourcegraph-<version>/`.
16+
17+
**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.

0 commit comments

Comments
 (0)