Skip to content
This repository has been archived by the owner on Oct 14, 2024. It is now read-only.

Commit

Permalink
Update Scanner VM debugging docs in README
Browse files Browse the repository at this point in the history
  • Loading branch information
Tehsmash authored and Sam Betts committed Feb 7, 2023
1 parent 7ce80a5 commit 05d8549
Showing 1 changed file with 34 additions and 8 deletions.
42 changes: 34 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,40 @@
# VMClarity

VMClarity is a tool for agentless detection and management of Virtual Machine
Software Bill Of Materials (SBOM) and vulnerabilities

To install vmclarity in your AWS account [Click Here](https://eu-central-1.console.aws.amazon.com/cloudformation/home?region=eu-central-1#/stacks/create/review?templateUrl=https://raw.githubusercontent.com/openclarity/vmclarity/main/installation/aws/VmClarity.cfn&stackName=VmClarity)

# How to debug the scanner VM
By default, the scanner VM instance is created w/o a key pair and a public ip, in order to set it follow the instructions below:
1. SSH into the VMClarity server VM
2. Update `/etc/vmclarity/config.env` with `SCANNER_KEY_PAIR_NAME=<your key pair name>`
3. Restart the VMClarity service (`sudo systemctl restart vmclarity.service`)
4. Create a new scan.
5. After the scanner VM was created, add an inbound rule to allow inbound SSH.
6. SSH into the scanner VM with your key pair.
## Table of Contents

- [How to debug the Scanner VMs](#how-to-debug-the-scanner-vms)
- [AWS](#debug-scanner-VM-on-AWS)

## How to debug the Scanner VMs

How to debug the Scanner VMs can differ per provider these are documented
below.

### Debug Scanner VM on AWS

On AWS VMClarity is configured to create the Scanner VMs with the same key-pair
that the VMClarity server has. The Scanner VMs run in a private network,
however the VMClarity Server can be used as a bastion/jump host to reach them
via SSH.

```
ssh -i <key-pair private key> -J ubuntu@<vmclarity server public IP> ubuntu@<scanner VM private IP address>
```

Once SSH access has been established, the status of the VM's start up
configuration can be debugged by checking the cloud-init logs:

```
sudo journalctl -u cloud-final
```

And the vmclarity-scanner service logs:

```
sudo journalctl -u vmclarity-scanner
```

0 comments on commit 05d8549

Please sign in to comment.