docs(Dashboard): Add docs for dashboards (#3655)
@@ -1,7 +1,7 @@
|
||||
# Compliance
|
||||
Prowler allows you to execute checks based on requirements defined in compliance frameworks. By default, it will execute and give you an overview of the status of each compliance framework:
|
||||
|
||||
<img src="../img/compliance.png"/>
|
||||
<img src="./img/compliance/compliance.png"/>
|
||||
|
||||
> You can find CSVs containing detailed compliance results inside the compliance folder within Prowler's output folder.
|
||||
|
||||
@@ -12,7 +12,7 @@ prowler <provider> --compliance <compliance_framework>
|
||||
```
|
||||
Standard results will be shown and additionally the framework information as the sample below for CIS AWS 1.5. For details a CSV file has been generated as well.
|
||||
|
||||
<img src="../img/compliance-cis-sample1.png"/>
|
||||
<img src="./img/compliance/compliance-cis-sample1.png"/>
|
||||
|
||||
## List Available Compliance Frameworks
|
||||
In order to see which compliance frameworks are cover by Prowler, you can use option `--list-compliance`:
|
||||
|
||||
53
docs/tutorials/dashboard.md
Normal file
@@ -0,0 +1,53 @@
|
||||
# Dashboard
|
||||
Prowler allows you to run your own local dashboards using the csv outputs provided by Prowler
|
||||
|
||||
```sh
|
||||
prowler dashboard
|
||||
```
|
||||
|
||||
The banner and additional info about the dashboard will be shown on your console:
|
||||
<img src="./img/dashboard/dashboard-banner.png">
|
||||
|
||||
## Overview Page
|
||||
|
||||
The overview page provides a full impression of your findings obtained from Prowler:
|
||||
|
||||
<img src="./img/dashboard/dashboard-overview.png">
|
||||
|
||||
In this page you can do multiple functions:
|
||||
* Apply filters (Assessment Date / Account / Region)
|
||||
* See wich files has been scaned to generate the dashboard placing your mouse on the `?` icon:
|
||||
<img src="./img/dashboard/dashboard-files-scanned.png">
|
||||
* Download the `Top 25 Failed Findings by Severity` table using the button `DOWNLOAD THIS TABLE AS CSV`
|
||||
|
||||
## Compliance Page
|
||||
|
||||
This page shows all the info related to the compliance selected, you can apply multiple filters depending on your preferences.
|
||||
|
||||
<img src="./img/dashboard/dashboard-compliance.png">
|
||||
|
||||
## S3 Integration
|
||||
|
||||
If you are a Prowler Saas customer and you want to use your data from your S3 bucket, you can run:
|
||||
|
||||
```sh
|
||||
aws s3 cp s3://<your-bucket>/output/csv ./output --recursive
|
||||
```
|
||||
to load the dashboard with the new files.
|
||||
|
||||
## Output Path
|
||||
|
||||
Prowler will use the outputs from the folder `/output` (for common prowler outputs) and `/output/compliance` (for prowler compliance outputs) to generate the dashboard.
|
||||
|
||||
To change the path modify the values `folder_path_overview` or `folder_path_compliance` from `/dashboard/config.py`
|
||||
|
||||
## Output Support
|
||||
|
||||
Prowler dashboard supports the detailed outputs:
|
||||
|
||||
| Provider | V3 | V4 | COMPLIANCE-V3 | COMPLIANCE-V4|
|
||||
|---|---|---|---|---|
|
||||
| AWS | ✅ | ✅ | ✅ | ✅ |
|
||||
| Azure | ❌ | ✅ | ❌ | ✅ |
|
||||
| Kubernetes | ❌ | ✅ | ❌ | ✅ |
|
||||
| GCP | ❌ | ✅ | ❌ | ✅ |
|
||||
|
Before Width: | Height: | Size: 141 KiB After Width: | Height: | Size: 141 KiB |
|
Before Width: | Height: | Size: 93 KiB After Width: | Height: | Size: 93 KiB |
BIN
docs/tutorials/img/dashboard/dashboard-banner.png
Normal file
|
After Width: | Height: | Size: 24 KiB |
BIN
docs/tutorials/img/dashboard/dashboard-compliance.png
Normal file
|
After Width: | Height: | Size: 133 KiB |
BIN
docs/tutorials/img/dashboard/dashboard-files-scanned.png
Normal file
|
After Width: | Height: | Size: 8.9 KiB |
BIN
docs/tutorials/img/dashboard/dashboard-overview.png
Normal file
|
After Width: | Height: | Size: 248 KiB |