Skip to content

Commit

Permalink
documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
mmguero committed Apr 9, 2024
1 parent a0fcc31 commit 1a42db0
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 4 deletions.
4 changes: 3 additions & 1 deletion docs/kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -369,7 +369,7 @@ Select authentication method (Basic): 1

Enable index management policies (ILM/ISM) in Arkime? (y / N): n

Should Malcolm delete the oldest database indices and/or PCAP files based on available storage? (y / N): y
Should Malcolm delete the oldest database indices and capture artifacts based on available storage? (y / N): y

Delete the oldest indices when the database exceeds a certain size? (y / N): y

Expand Down Expand Up @@ -411,6 +411,8 @@ Select file extraction behavior (none): 5
3: none
Select file preservation behavior (quarantined): 1

Enter maximum allowed space for Zeek-extracted files (e.g., 250GB) or file system fill threshold (e.g., 90%): 100G

Expose web interface for downloading preserved files? (y / N): y

ZIP downloaded preserved files? (y / N): y
Expand Down
6 changes: 4 additions & 2 deletions docs/malcolm-hedgehog-e2e-iso-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -187,8 +187,8 @@ The [configuration and tuning](malcolm-config.md#ConfigAndTuning) wizard's quest
- This defines how many additional copies of older session indices Arkime should store.
- **How many weeks of history should Arkime keep?",**
- This defines the retention period (in weeks) for `arkime-history` indices.
* **Should Malcolm delete the oldest database indices and/or PCAP files based on available storage?**
- Choose **Y** to proceed to the following related questions about managing the data storage used by Malcolm.
* **Should Malcolm delete the oldest database indices and capture artifacts based on available storage?**
- Choose **Y** to proceed to the following related questions about [managing the data storage](malcolm-config.md#DiskUsage) used by Malcolm.
- **Delete the oldest indices when the database exceeds a certain size?**
- Most of the configuration around OpenSearch [Index State Management](https://opensearch.org/docs/latest/im-plugin/ism/index/) and [Snapshot Management](https://opensearch.org/docs/latest/opensearch/snapshots/sm-dashboards/) can be done in OpenSearch Dashboards. In addition to (or instead of) the OpenSearch index state management operations, Malcolm can also be configured to delete the oldest network session metadata indices when the database exceeds a certain size to prevent filling up all available storage with OpenSearch indices.
- **Should Arkime delete uploaded PCAP files based on available storage?**
Expand Down Expand Up @@ -248,6 +248,8 @@ The [configuration and tuning](malcolm-config.md#ConfigAndTuning) wizard's quest
+ `quarantined`: preserve only flagged files in `./zeek-logs/extract_files/quarantine`
+ `all`: preserve flagged files in `./zeek-logs/extract_files/quarantine` and all other extracted files in `./zeek-logs/extract_files/preserved`
+ `none`: preserve no extracted files
* **Enter maximum allowed space for Zeek-extracted files (e.g., 250GB) or file system fill threshold (e.g., 90%)**
- Files [extracted by Zeek](file-scanning.md#ZeekFileExtraction) can be periodically pruned to ensure the disk storage they consume does not exceed a user-specified threshold. See the documentation on [managing Malcolm's disk usage](malcolm-config.md#DiskUsage) for more information.
* **Expose web interface for downloading preserved files?**
- Answering **Y** enables access to the Zeek-extracted files path through the means of a simple HTTPS directory server at **https://<Malcolm host or IP address>/extracted-files/**. Beware that Zeek-extracted files may contain malware.
* **ZIP downloaded preserved files?**
Expand Down
2 changes: 1 addition & 1 deletion docs/ubuntu-install-example.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ Store PCAP, log and index files in /home/user/Malcolm? (Y / n): y
Enable index management policies (ILM/ISM) in Arkime? (y / N): n
Should Malcolm delete the oldest database indices and/or PCAP files based on available storage? n
Should Malcolm delete the oldest database indices and capture artifacts based on available storage?? n
Automatically analyze all PCAP files with Suricata? (Y / n): y
Expand Down

0 comments on commit 1a42db0

Please sign in to comment.