Skip to content

Commit

Permalink
Extend Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sbernhard committed Apr 9, 2024
1 parent afc6e17 commit 4a5b8cb
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,8 @@ Plugin to
1. install trivy/grype CVE scanners on a host using a Foreman Remote Execution (REX) job
2. run a CVE scan using a REX job, collect the output and generate a Config Report


![image](https://github.com/ATIX-AG/foreman_cve_scanner/assets/25485845/85e3b676-7d90-41e5-bea5-7e0b5f4a685c)

Not finished yet....


*Introdction here*

Expand All @@ -19,11 +16,19 @@ for how to install Foreman plugins

## Usage

*Usage here*
- Run the REX job to install trivy and/or grype
- Run the REX job to scan a host
- Go to the Config Report page for a host to view the scan report

## TODO

*Todo list here*
- Better possiblities to filter the Config Report (maybe an extension to ConfigReport in Foreman)
- Have a scheduled REX Job to scan the hosts
- Make it visible on the Host Details page or on Foreman directly, if a high priority CVE on a host occurs
- Export a CVE scan
- Deliver trivy / grype via Katello
- More tests
- API

## Contributing

Expand Down

0 comments on commit 4a5b8cb

Please sign in to comment.