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

Commit

Permalink
docs(general): add capabilities and compatibility information (#1956)
Browse files Browse the repository at this point in the history
* docs(general): update list of tools and add compatibility data

* docs(general): add usage modes

* docs(general): add info on asset discovery and supported filesystems

* docs(general): remove KICS from Vulnerability detection

* Update README.md

Co-authored-by: Bence Csati <113284287+csatib02@users.noreply.github.com>

* docs(general): fix typo

* docs(general): rephrase

* docs(general): rephrase sentence

---------

Co-authored-by: Bence Csati <113284287+csatib02@users.noreply.github.com>
  • Loading branch information
zsoltkacsandi and csatib02 authored Jul 25, 2024
1 parent 758338d commit 9c352dd
Showing 1 changed file with 72 additions and 6 deletions.
78 changes: 72 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,13 @@ Join [VMClarity's Slack channel](https://outshift.slack.com/messages/vmclarity)
- [Why VMClarity?](#why-vmclarity)
- [Getting started](#getting-started)
- [Overview](#overview)
- [Usage modes](#usage-modes)
- [1. VMClarity stack](#1-vmclarity-stack)
- [2. CLI](#2-cli)
- [3. Go module](#3-go-module)
- [Asset discovery](#asset-discovery)
- [Supported filesystems](#supported-filesystems)
- [Architecture](#architecture)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- [Code of Conduct](#code-of-conduct)
Expand Down Expand Up @@ -70,10 +77,11 @@ enabled/disabled on an individual basis. VMClarity normalizes, merges and
provides a robust visualization of the results from these various tools.

These tools include:

- SBOM Generation and Analysis
- [Syft](https://github.com/anchore/syft)
- [Trivy](https://github.com/aquasecurity/trivy)
- [Windows Registry](cli/analyzer/windows)
- [Windows Registry](cli/analyzer/windows)*
- [Cyclonedx-gomod](https://github.com/CycloneDX/cyclonedx-gomod)
- Vulnerability detection
- [Grype](https://github.com/anchore/grype)
Expand All @@ -84,15 +92,73 @@ These tools include:
- [gitleaks](https://github.com/gitleaks/gitleaks)
- Malware
- [ClamAV](https://github.com/Cisco-Talos/clamav)
- [YARA](https://github.com/virustotal/yara)
- Misconfiguration
- [Lynis](https://github.com/CISOfy/lynis)
- [Lynis](https://github.com/CISOfy/lynis)**
- [CIS Docker Benchmark](https://github.com/goodwithtech/dockle)
- [KICS](https://github.com/Checkmarx/kics)
- Rootkits
- [Chkrootkit](https://github.com/Magentron/chkrootkit)
- Security scanning plugins
- [Plugins](plugins)
- [Chkrootkit](https://github.com/Magentron/chkrootkit)**


\* Windows only\
** Linux and MacOS only

## Usage modes

VMClarity can be used multiple ways to fit different needs:

### 1. VMClarity stack

As a complete stack, VMClarity provides an integrated solution to
* discover assets in your environment,
* manage scan configurations, schedule and execute scans,
* visualize the results on a dashboard.

For the deployment instructions visit this page: [Getting started](https://openclarity.io/docs/vmclarity/getting-started/).

### 2. CLI

VMClarity can be used as a standalone command line tool to run the supported scanner tools.

1. Download `vmclarity-cli` from the [GitHub releases page](https://github.com/openclarity/vmclarity/releases/).
2. Create a configuration file, make sure to enable the scanner families you need. An example can be found here: [.families.yaml](https://github.com/openclarity/vmclarity/blob/main/.families.yaml)
3. Execute the following command:

```bash
vmclarity-cli scan --config .families.yaml
```

### 3. Go module

Import the `github.com/openclarity/vmclarity/scanner` package to run a scan with VMClarity’s family manager from your code.

Example: [scan.go](https://github.com/openclarity/vmclarity/blob/94c46f830838416706c2deef71ecce095d706e6a/cli/cmd/scan/scan.go#L121)

## Asset discovery

VMClarity stack supports the automatic discovery of assets in the following providers:

| Provider | Asset types | Scope |
|------------|----------------------------------|-----------------------|
| Docker | Docker containers and images | Local Docker daemon |
| Kubernetes | Docker containers and images | Cluster |
| AWS | Virtual machines (EC2 instances) | Account (all regions) |
| Azure | Virtual machines | Subscription |
| GCP | Virtual machines | Project |

## Supported filesystems

The following filesystem operations are supported on different host types:

| Host | List block devices | Mount Ext2, Ext3, Ext4 | Mount XFS | Mount NTFS |
|---------|--------------------|------------------------|---------------|---------------|
| Linux | Supported | Supported | Supported | Supported |
| Darwin | Supported | Supported | Supported | Supported |
| Windows | Not supported | Not supported | Not supported | Not supported |

A high-level architecture overview is available [here](ARCHITECTURE.md)
# Architecture
A high-level architecture overview is available [here](ARCHITECTURE.md).

# Roadmap
VMClarity project roadmap is available [here](https://github.com/orgs/openclarity/projects/5/views/5).
Expand Down

0 comments on commit 9c352dd

Please sign in to comment.