Add data

This topic describes how to add vulnerability scan reports or Software Bill of Materials (SBoM) files to the Supply Chain Security Tools - Store.

Supported formats and file types

Currently, only CycloneDX XML and JSON files are accepted.

Source commits and image files have been tested. Additional file types may work, but are not fully supported (for example, JAR files).

Note: If you are not using a source commit or image file, you must ensure the component.version field in the CycloneDX file is non-null.

Generate a CycloneDX file

A CycloneDX file is needed to post data. Supply Chain Security Tools - Scan outputs CycloneDX files automatically. For more information, see Supply Chain Security Tools - Scan.

To generate a file to post manually, use Grype or another tool in the CycloneDX Tool Center.

To use Grype to scan an image and generate an image report in CycloneDX format:

  1. Install Grype.

  2. Scan the image and generate a report by running:

    grype REPO:TAG -o cyclonedx > IMAGE-CVE-REPORT
    

    Where:

    • REPO is the name of your repository
    • TAG is the name of a tag
    • IMAGE-CVE-REPORT is the resulting file name of the Grype image scan report

    For example:

    $ grype docker.io/checkr/flagr:1.1.12 -o cyclonedx > image-cve-report
     ✔ Vulnerability DB        [updated]
     ✔ Parsed image
     ✔ Cataloged packages      [21 packages]
     ✔ Scanned image           [8 vulnerabilities]
    

Add data with the Tanzu Insight plug-in

Use the following commands to add data:

  • image add
  • source add

Note: If you are not using a source commit or image file, you can select either option.

Example #1: Add an image report

To use a CycloneDX-formatted image report:

  1. Run:

    tanzu insight image add --cyclonedxtype TYPE --path IMAGE-CVE-REPORT
    

    Where:

    • TYPE specifies XML or JSON, the two supported file types
    • IMAGE-CVE-REPORT is the location of a Cyclone DX formatted file

    For example:

    $ tanzu insight image add --cyclonedxtype xml --path downloads/image-cve-report
    Image report created.
    

Note: The Metadata Store only stores a subset of CycloneDX file data. Support for more data might be added in the future.

Example #2: Add a source report

To use a CycloneDX-formatted source report:

  1. Run:

    tanzu insight source add --cyclonedxtype TYPE --path SOURCE-CVE-REPORT
    

    Where:

    • TYPE specifies XML or JSON, the two supported file types
    • SOURCE-CVE-REPORT is the location of a Cyclone DX formatted file

    For example:

    $ tanzu insight source add --cyclonedxtype json --path source-cve-report
    Source report created.
    

Note: Supply Chain Security Tools - Store only stores a subset of a CycloneDX file’s data. Support for more data might be added in the future.

check-circle-line exclamation-circle-line close-line
Scroll to top icon