diff --git a/.dockerignore b/.dockerignore index 532fd7711..ee572668a 100644 --- a/.dockerignore +++ b/.dockerignore @@ -3,7 +3,7 @@ bin docs e2e -img +assets installation scanner_boot_test .envrc diff --git a/ARCHITECTURE.md b/ARCHITECTURE.md index e5bc83231..d07cbfe9c 100644 --- a/ARCHITECTURE.md +++ b/ARCHITECTURE.md @@ -51,4 +51,4 @@ the configured analysis on the mounted snapshot, and report the results to the VMClarity API. These results are then processed by the VMClarity backend into findings. -![VMClarity Architecture Overview](img/vmclarity-arch-20230725.svg) +![VMClarity Architecture Overview](assets/vmclarity-arch-20230725.svg) diff --git a/README.md b/README.md index df304a0e4..ec30a886f 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ - - - VMClarity Logo + + + VMClarity Logo [![Slack Invite](https://img.shields.io/badge/Slack-Join-blue?logo=slack)](https://outshift.slack.com/messages/vmclarity) @@ -12,7 +12,7 @@ VMClarity is an open source tool for agentless detection and management of Virtual Machine Software Bill Of Materials (SBOM) and security threats such as vulnerabilities, exploits, malware, rootkits, misconfigurations and leaked secrets. -VMClarity demo +VMClarity demo Join [VMClarity's Slack channel](https://outshift.slack.com/messages/vmclarity) to hear about the latest announcements and upcoming activities. We would love to get your feedback! diff --git a/TOUR.md b/TOUR.md index 87f7ad4e4..fcdac8ecf 100644 --- a/TOUR.md +++ b/TOUR.md @@ -1,6 +1,6 @@ # VMClarity UI Tour Figure 1. VMClarity UI Dashboard -![VMClarity UI Dashboard](img/vmclarity-ui-1.png) +![VMClarity UI Dashboard](assets/vmclarity-ui-1.png) ## Configure Your First Scan @@ -8,31 +8,31 @@ Figure 1. VMClarity UI Dashboard Figure 2. VMClarity UI Scan -VMClarity UI Scan +VMClarity UI Scan - Create a new scan configuration. As shown in Figure 3, click on "New scan configuration". Figure 3. VMClarity Scan Setup Step 1 -VMClarity Scan Setup - Step 1 +VMClarity Scan Setup - Step 1 - In the "New scan config" wizard shown in Figure 4, follow the wizard steps to name the scan, and identify the AWS scope (region, VPC, security groups, etc.). In the example shown in Figure 4, the AWS us-east-2 region, and a specific VPC were identified as well as a specific EC2 instance with the name "vmclarity-demo-vm". Figure 4. VMClarity Scan Setup Step 2 -VMClarity Scan Setup - Step 2 +VMClarity Scan Setup - Step 2 - Next, identify all the scan types you want enabled. As Figure 5 shows, all the available scan types have been enabled. Figure 5. VMClarity Scan Setup Step 3 -VMClarity Scan Setup - Step 3 +VMClarity Scan Setup - Step 3 - Finally, select the scan time and/or frequency of the scans. Figure 6 shows the scan option of "now", but other options include "specific time" and "recurring" (Based on a cron job). Figure 6. VMClarity Scan Setup Step 4 -VMClarity Scan Setup - Step 4 +VMClarity Scan Setup - Step 4 - Once all the scan setup steps have been entered, click on "Save". @@ -40,7 +40,7 @@ In the Scan Configurations tab, you will see the scan config listed as shown in Figure 7. VMClarity Scan Configuration List -VMClarity Scan Config Summary +VMClarity Scan Config Summary Once a scan runs and generates findings, you can browse around the various VMClarity UI features and investigate the security scan reports. @@ -48,8 +48,8 @@ Here are a few of the many scan findings that are available in the VMClarity UI. Figure 8. VMClarity Scan List -VMClarity Scan List +VMClarity Scan List Figure 9. VMClarity Dashboard -VMClarity Dashboard with Findings +VMClarity Dashboard with Findings diff --git a/installation/aws/README.md b/installation/aws/README.md index 65cf5a86d..786ce3376 100644 --- a/installation/aws/README.md +++ b/installation/aws/README.md @@ -24,7 +24,7 @@ The private subnet (VmClarityScannerSubnet) hosts the VM snapshot instances (EC2) that are scanned for security vulnerabilities. Figure 2. VMClarity Cloud Formation Resources -![VMClarity CloudFormation Resources](../../img/vmclarity-cf-basic.svg) +![VMClarity CloudFormation Resources](../../assets/vmclarity-cf-basic.svg) ## Deploy the VMClarity AWS CloudFormation Stack