Support of WG4 OpenFronthaul Management-Plane VES
[oam.git] / code / container-analysis / README.md
1 # Container Analysis
2
3 This directory contains a script to output Software Bill of Materials (SBOM)tree and vulnerabilities of running docker images.
4
5 ## Prerequisites
6
7 The script depend on the [Syft](https://github.com/anchore/syft) project and the [Grype](https://github.com/anchore/grype) project.
8
9 ### Installing syft
10
11 ```
12 curl -sSfL https://raw.githubusercontent.com/anchore/syft/main/install.sh | sh -s -- -b /usr/local/bin
13 ```
14
15 ### Installing grype
16
17 ```
18 curl -sSfL https://raw.githubusercontent.com/anchore/grype/main/install.sh | sh -s -- -b /usr/local/bin
19 ```
20
21 ## Usage
22
23 Once your docker containers are up and running just use:
24
25 ```
26 ./container-analysis.sh
27 ```
28
29 Note: It takes time ...
30
31 You will find the results in the 'out' folder.
32
33 ### Viewer
34
35 If you would like to see a kind of summary, please run:
36
37 ```
38 cd viewer
39 npm install
40 npm start
41 ```
42
43 ... and view in your browser 
44
45 ```
46 http://localhost:3000
47 ```