define options in annotation files

This commit is contained in:
Josh Patterson
2026-04-09 10:18:36 -04:00
parent ef3cfc8722
commit 9ec4a26f97
5 changed files with 40 additions and 20 deletions
-6
View File
@@ -11,18 +11,14 @@ global:
regexFailureMessage: You must enter a valid IP address or CIDR. regexFailureMessage: You must enter a valid IP address or CIDR.
mdengine: mdengine:
description: Which engine to use for meta data generation. Options are ZEEK and SURICATA. description: Which engine to use for meta data generation. Options are ZEEK and SURICATA.
regex: ^(ZEEK|SURICATA)$
options: options:
- ZEEK - ZEEK
- SURICATA - SURICATA
regexFailureMessage: You must enter either ZEEK or SURICATA.
global: True global: True
pcapengine: pcapengine:
description: Which engine to use for generating pcap. Currently only SURICATA is supported. description: Which engine to use for generating pcap. Currently only SURICATA is supported.
regex: ^(SURICATA)$
options: options:
- SURICATA - SURICATA
regexFailureMessage: You must enter either SURICATA.
global: True global: True
ids: ids:
description: Which IDS engine to use. Currently only Suricata is supported. description: Which IDS engine to use. Currently only Suricata is supported.
@@ -42,11 +38,9 @@ global:
advanced: True advanced: True
pipeline: pipeline:
description: Sets which pipeline technology for events to use. The use of Kafka requires a Security Onion Pro license. description: Sets which pipeline technology for events to use. The use of Kafka requires a Security Onion Pro license.
regex: ^(REDIS|KAFKA)$
options: options:
- REDIS - REDIS
- KAFKA - KAFKA
regexFailureMessage: You must enter either REDIS or KAFKA.
global: True global: True
advanced: True advanced: True
repo_host: repo_host:
+10 -3
View File
@@ -85,7 +85,10 @@ influxdb:
description: The log level to use for outputting log statements. Allowed values are debug, info, or error. description: The log level to use for outputting log statements. Allowed values are debug, info, or error.
global: True global: True
advanced: false advanced: false
regex: ^(info|debug|error)$ options:
- info
- debug
- error
helpLink: influxdb helpLink: influxdb
metrics-disabled: metrics-disabled:
description: If true, the HTTP endpoint that exposes internal InfluxDB metrics will be inaccessible. description: If true, the HTTP endpoint that exposes internal InfluxDB metrics will be inaccessible.
@@ -140,7 +143,9 @@ influxdb:
description: Determines the type of storage used for secrets. Allowed values are bolt or vault. description: Determines the type of storage used for secrets. Allowed values are bolt or vault.
global: True global: True
advanced: True advanced: True
regex: ^(bolt|vault)$ options:
- bolt
- vault
helpLink: influxdb helpLink: influxdb
session-length: session-length:
description: Number of minutes that a user login session can remain authenticated. description: Number of minutes that a user login session can remain authenticated.
@@ -260,7 +265,9 @@ influxdb:
description: The type of data store to use for HTTP resources. Allowed values are disk or memory. Memory should not be used for production Security Onion installations. description: The type of data store to use for HTTP resources. Allowed values are disk or memory. Memory should not be used for production Security Onion installations.
global: True global: True
advanced: True advanced: True
regex: ^(disk|memory)$ options:
- disk
- memory
helpLink: influxdb helpLink: influxdb
tls-cert: tls-cert:
description: The container path to the certificate to use for TLS encryption of the HTTP requests and responses. description: The container path to the certificate to use for TLS encryption of the HTTP requests and responses.
+13 -3
View File
@@ -131,7 +131,10 @@ kafka:
ssl_x_keystore_x_type: ssl_x_keystore_x_type:
description: The key store file format. description: The key store file format.
title: ssl.keystore.type title: ssl.keystore.type
regex: ^(JKS|PKCS12|PEM)$ options:
- JKS
- PKCS12
- PEM
helpLink: kafka helpLink: kafka
ssl_x_truststore_x_location: ssl_x_truststore_x_location:
description: The trust store file location within the Docker container. description: The trust store file location within the Docker container.
@@ -160,7 +163,11 @@ kafka:
security_x_protocol: security_x_protocol:
description: 'Broker communication protocol. Options are: SASL_SSL, PLAINTEXT, SSL, SASL_PLAINTEXT' description: 'Broker communication protocol. Options are: SASL_SSL, PLAINTEXT, SSL, SASL_PLAINTEXT'
title: security.protocol title: security.protocol
regex: ^(SASL_SSL|PLAINTEXT|SSL|SASL_PLAINTEXT) options:
- SASL_SSL
- PLAINTEXT
- SSL
- SASL_PLAINTEXT
helpLink: kafka helpLink: kafka
ssl_x_keystore_x_location: ssl_x_keystore_x_location:
description: The key store file location within the Docker container. description: The key store file location within the Docker container.
@@ -174,7 +181,10 @@ kafka:
ssl_x_keystore_x_type: ssl_x_keystore_x_type:
description: The key store file format. description: The key store file format.
title: ssl.keystore.type title: ssl.keystore.type
regex: ^(JKS|PKCS12|PEM)$ options:
- JKS
- PKCS12
- PEM
helpLink: kafka helpLink: kafka
ssl_x_truststore_x_location: ssl_x_truststore_x_location:
description: The trust store file location within the Docker container. description: The trust store file location within the Docker container.
+9 -4
View File
@@ -21,8 +21,12 @@ kratos:
description: "Specify the provider type. Required. Valid values are: auth0, generic, github, google, microsoft" description: "Specify the provider type. Required. Valid values are: auth0, generic, github, google, microsoft"
global: True global: True
forcedType: string forcedType: string
regex: "auth0|generic|github|google|microsoft" options:
regexFailureMessage: "Valid values are: auth0, generic, github, google, microsoft" - auth0
- generic
- github
- google
- microsoft
helpLink: oidc helpLink: oidc
client_id: client_id:
description: Specify the client ID, also referenced as the application ID. Required. description: Specify the client ID, also referenced as the application ID. Required.
@@ -43,8 +47,9 @@ kratos:
description: The source of the subject identifier. Typically 'userinfo'. Only used when provider is 'microsoft'. description: The source of the subject identifier. Typically 'userinfo'. Only used when provider is 'microsoft'.
global: True global: True
forcedType: string forcedType: string
regex: me|userinfo options:
regexFailureMessage: "Valid values are: me, userinfo" - me
- userinfo
helpLink: oidc helpLink: oidc
auth_url: auth_url:
description: Provider's auth URL. Required when provider is 'generic'. description: Provider's auth URL. Required when provider is 'generic'.
+7 -3
View File
@@ -64,8 +64,10 @@ suricata:
helpLink: suricata helpLink: suricata
conditional: conditional:
description: Set to "all" to record PCAP for all flows. Set to "alerts" to only record PCAP for Suricata alerts. Set to "tag" to only record PCAP for tagged rules. description: Set to "all" to record PCAP for all flows. Set to "alerts" to only record PCAP for Suricata alerts. Set to "tag" to only record PCAP for tagged rules.
regex: ^(all|alerts|tag)$ options:
regexFailureMessage: You must enter either all, alert or tag. - all
- alerts
- tag
helpLink: suricata helpLink: suricata
dir: dir:
description: Parent directory to store PCAP. description: Parent directory to store PCAP.
@@ -83,7 +85,9 @@ suricata:
advanced: True advanced: True
cluster-type: cluster-type:
advanced: True advanced: True
regex: ^(cluster_flow|cluster_qm)$ options:
- cluster_flow
- cluster_qm
defrag: defrag:
description: Enable defragmentation of IP packets before processing. description: Enable defragmentation of IP packets before processing.
forcedType: bool forcedType: bool