rm: Add details of new DISABLE_SBOM container CI variable

Signed-off-by: Andy Doan <[email protected]>
foundriesio · May 29, 2024 · 23d1ffc · 23d1ffc
1 parent 5bdf234
commit 23d1ffc
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/source/reference-manual/factory/factory-definition.rst b/source/reference-manual/factory/factory-definition.rst
@@ -292,6 +292,13 @@ Optionally, use a custom version of ci-scripts_ to perform CI builds.
 
     **Default:** master
 
+Variables
+^^^^^^^^^
+
+* **DISABLE_SBOM**:
+               With this variable set to ``1``, container CI builds will skip the SBOM generation step.
+               Reference: :ref:`sbom`.
+
 
 .. # define a hard line break for HTML
 .. |br| raw:: html

diff --git a/source/reference-manual/factory/sboms.rst b/source/reference-manual/factory/sboms.rst
@@ -44,6 +44,8 @@ Syft Artifacts
 Container builds produce an SPDX file for each container/architecture.
 This will look like ``hub.foundries.io/<FACTORY>/shellhttpd/arm64.sdpx.json``.
 
+Customers may disable generating SBOMs for containers by setting the environment variable ``DISABLE_SBOM=1`` in their :ref:`ref-factory-definition`.
+
 Working With SBOMs
 ------------------