 We use a piece of software called Collector Server to host and manage all our available collectors. If you want us to host this collector for you, get in touch with us and we will guide you through the configuration.  This data collector can be run in any machine that has the Docker service available because it should be executed as a docker container. The following sections explain how to prepare all the required setup for having the data collector running. StructureThe following directory structure should be created for use when running the Rapid7 InsightVM collector: <any_directory>
└── devo-collectors/
└── rapid7_insightvm/
├── certs/
│ ├── chain.crt
│ ├── <your_domain>.key
│ └── <your_domain>.crt
└── config/
└── config-insightvm.yaml |
Devo credentialsIn Devo, go to Administration → Credentials → X.509 Certificates, download the Certificate, Private key and Chain CA and save them in <any directory>/devo-collectors/rapid7_insightvm/certs. Learn more about security credentials in Devo here.  Editing the config-insightvm.yaml fileIn the config-insightvm.yaml file, replace the <short_unique_identifier>, <user>, <password>, <server>, and <port> values with the proper ones. globals:
debug: false
id: not_used
name: rapid7_insightvm
persistence:
type: filesystem # File system persistence ON
config:
directory_name: state # Directory where the persistence will be saved in case of using filesystem
outputs:
devo_1: # Cloud Devo config EU (for US use collector-us.devo.io)
type: devo_platform
config:
address: collector-us.devo.io
port: 443
type: SSL
chain: chain.crt
cert: your_domain.crt
key: your_domain.key
inputs:
rapid7:
id: <short_unique_identifier> # The value of this field will be used internally for having independent persistence areas
enabled: true
requests_per_second: 5 # Setup how many request API por second
credentials:
user: <user> # InsightVM on-premises user used to retrieve the data
password: <password> # InsightVM on-premises user's password
server: <server_ip or name> # InsightVM on-premises server ip or name
port: <insightvm port, default 3780> # InsightVM on-premises server port
services: # Services available for this collector are vulnerabilities, assets, sites and scans
vulnerabilities:
request_period_in_seconds: 60 # Setting up time interval between API requests. 60 sec is recommended for vulnerabilities. 86400 or more for the other services.
page_size: 100 # OPTIONAL, retrieving pagination size, only used to improve performance
custom_tag: "my.app.insightvm.vulnerabilities" # OPTIONAL, devo custom tag
assets:
request_period_in_seconds: 86400
page_size: 100
custom_tag: "my.app.insightvm.assets"
sites:
request_period_in_seconds: 86400
page_size: 100
custom_tag: "my.app.insightvm.sites"
scans:
request_period_in_seconds: 86400
page_size: 100
custom_tag: "my.app.insightvm.scans" |
Optional fields custom_tag:Used to send retrieved data to a custom table (my.app). Use it only if you want to define your own synthesis, or send data to a custom parser. If this field is not present, events are sent to the default tables vuln.rapid7.insightvm.<>
page_size: Size of the batch that is retrieved in every iteration of the collector. Use it if you need to improve your bandwidth usage.
|
Download the Docker imageThe collector should be deployed as a Docker container. Download the Docker image of the collector as a .tgz file by clicking the link in the following table: Use the following command to add the Docker image to the system: gunzip -c <image_file>-<version>.tgz | docker load |
Once the Docker image is imported, it will show the real name of the Docker image (including version info). Replace <version> with a proper value. |
DockerExecute the following command on the root directory <any_directory>/devo-collectors/rapid7_insightvm/ docker run
--name collector-<product_name>
--volume $PWD/certs:/devo-collector/certs
--volume $PWD/config:/devo-collector/config
--volume $PWD/state:/devo-collector/state
--env CONFIG_FILE=config.yaml
--rm
--interactive
--tty
<image_name>:<version> |
Replace <version> with a proper value. |
Docker ComposeThe following Docker Compose file can be used to execute the Docker container. It must be created in the <any_directory>/devo-collectors/<product_name>/ directory. version: '3'
services:
collector-<product_name>:
image: <image_name>:${IMAGE_VERSION:-latest}
container_name: collector-<product_name>
volumes:
- ./certs:/devo-collector/certs
- ./config:/devo-collector/config
- ./credentials:/devo-collector/credentials
- ./state:/devo-collector/state
environment:
- CONFIG_FILE=${CONFIG_FILE:-config.yaml} |
To run the container using docker-compose, execute the following command from the <any_directory>/devo-collectors/<product_name>/ directory: IMAGE_VERSION=<version> docker-compose up -d |
Replace <product_name>, <image_name> and <version> with the proper values. |
| 
