Skip to content

Auto-update datasheets #241

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions _data/instruments/assetguard.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: Asset Guard
name: AssetGuard
developer: SensorFleet Oy
title: Asset Guard Instrument
title: AssetGuard Instrument
categories:
- Integrity Monitoring
- Asset Tracking
Expand All @@ -11,7 +11,7 @@ description:
has_ui: true
public: true
data_retention_desc:
The Asset Guard Instrument retains the collected information until the
The AssetGuard Instrument retains the collected information until the
Instrument is removed.
performance_desc: Does not generate significant CPU or IO load
network_access_type: passive
Expand All @@ -22,7 +22,7 @@ required_interfaces:
type: mirror-bridge
relations:
- description:
Asset Guard needs to find AssetProbe Instruments in order to receive their
AssetGuard needs to find AssetProbe Instruments in order to receive their
events
instrument_name: AssetProbe
instrument_type: assetprobe
Expand All @@ -38,3 +38,9 @@ produced_event_types:
- match: instruments.assetguard.asset.moved
type: exact
title: Asset moved alert
- match: instruments.assetguard.asset.updated
type: exact
title: Asset updated
- match: instruments.assetguard.assets.details
type: exact
title: All assets and their details
11 changes: 11 additions & 0 deletions _data/instruments/rmgr.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@ produced_event_types:
- match: instruments.rmgr.suricata_ruleset_sent
type: exact
title: New Suricata ruleset was sent
- match: instruments.rmgr.download_processing_status
type: exact
title: Ruleset or IOC processing status update
relations:
- description:
Rule Manager needs at least one Suricata IDS instrument to function. It
Expand All @@ -51,3 +54,11 @@ relations:
- find
- direct_message
required: false
- description:
A Downloader instrument must be present for external rulesources and ioc
feeds to be updated. A health warning will be raised if downloads are
scheduled but no Downloader is available.
instrument_name: Downloader
instrument_type: downloader
permissions:
- find
4 changes: 2 additions & 2 deletions instruments/assetguard/index.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
layout: datasheet
title: Asset Guard Instrument
title: AssetGuard Instrument
description: Automated inventory of the network's assets and alerts about unexpected assets entering the network.
---

Expand Down Expand Up @@ -61,7 +61,7 @@ <h2 id="properties">Properties</h2>
<tr class="odd">
<td>Data retention</td>
<td>
The Asset Guard Instrument retains the collected information until the
The AssetGuard Instrument retains the collected information until the
Instrument is removed.
</td>
</tr>
Expand Down
14 changes: 8 additions & 6 deletions instruments/netflow/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,17 @@
<!-- File is generated automatically, do not edit directly. -->

<p>
Netflow can be used to collect NetFlow information from network traffic. For
introduction to NetFlow, see
Netflow is used to create NetFlow information from listened network traffic.
For introduction to NetFlow, see
<a href="https://en.wikipedia.org/wiki/NetFlow">Wikipedia</a>.
</p>
<p>
The Instrument will listen traffic on mirror-bridge interface and store the
traffic flows (as identified by source and destination IP addresses and
protocol -specific ports) in NetFlow records. These NetFlow records can then
be downloaded from the Instrument using the provided HTTP API.
The Instrument will listen captured traffic on mirror-bridge interface and
store information about observed traffic flows (as identified by source and
destination IP addresses and protocol -specific ports) in NetFlow records.
These NetFlow records can then be downloaded from the Instrument using the
provided HTTP API. The Instrument also provides UI which can be used to view
stored NetFlow records.
</p>
<p>
NetFlow records are stored in NetFlow format version 9 and they are stored in
Expand Down
2 changes: 1 addition & 1 deletion instruments/rmgr/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ <h2 id="properties">Properties</h2>
</tr>
<tr class="even">
<td>Related Instruments</td>
<td>Zeek</td>
<td>Zeek, Downloader</td>
</tr>
<tr class="odd">
<td>Data retention</td>
Expand Down