Pipeline: Release 4.4.0.stable71 documentation

CybercentreCanada · Oct 31, 2023 · 13298a8 · 13298a8
1 parent 685335b
commit 13298a8
Show file tree

Hide file tree

Showing 49 changed files with 2,322 additions and 2,289 deletions.
diff --git a/docs/odm/messages/alert.md b/docs/odm/messages/alert.md
@@ -4,9 +4,9 @@
 
 | Field | Type | Description | Required | Default |
 | :--- | :--- | :--- | :--- | :--- |
-| msg | [Alert](/assemblyline4_docs/odm/models/alert/#alert) | Message of alert | :material-checkbox-marked-outline: Yes | `None` |
-| msg_loader | Enum | Loader class for messages<br>Values:<br>`"assemblyline.odm.messages.alert.AlertMessage"` | :material-checkbox-marked-outline: Yes | `assemblyline.odm.messages.alert.AlertMessage` |
-| msg_type | Enum | Type of Message<br>Values:<br>`"AlertCreated", "AlertUpdated"` | :material-checkbox-marked-outline: Yes | `AlertCreated` |
-| sender | Keyword | Sender of message | :material-checkbox-marked-outline: Yes | `None` |
+| msg | [Alert](/assemblyline4_docs/odm/models/alert/#alert) | Message of alert | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| msg_loader | Enum | Loader class for messages<br>Values:<br>`"assemblyline.odm.messages.alert.AlertMessage"` | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `assemblyline.odm.messages.alert.AlertMessage` |
+| msg_type | Enum | Type of Message<br>Values:<br>`"AlertCreated", "AlertUpdated"` | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `AlertCreated` |
+| sender | Keyword | Sender of message | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
 
 
diff --git a/docs/odm/messages/alerter_heartbeat.md b/docs/odm/messages/alerter_heartbeat.md
@@ -4,10 +4,10 @@
 
 | Field | Type | Description | Required | Default |
 | :--- | :--- | :--- | :--- | :--- |
-| msg | [Heartbeat](/assemblyline4_docs/odm/messages/alerter_heartbeat/#heartbeat) | Heartbeat message from Alerter | :material-checkbox-marked-outline: Yes | `None` |
-| msg_loader | Enum | Loader class for message<br>Values:<br>`"assemblyline.odm.messages.alerter_heartbeat.AlerterMessage"` | :material-checkbox-marked-outline: Yes | `assemblyline.odm.messages.alerter_heartbeat.AlerterMessage` |
-| msg_type | Enum | Type of message<br>Values:<br>`"AlerterHeartbeat"` | :material-checkbox-marked-outline: Yes | `AlerterHeartbeat` |
-| sender | Keyword | Sender of message | :material-checkbox-marked-outline: Yes | `None` |
+| msg | [Heartbeat](/assemblyline4_docs/odm/messages/alerter_heartbeat/#heartbeat) | Heartbeat message from Alerter | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| msg_loader | Enum | Loader class for message<br>Values:<br>`"assemblyline.odm.messages.alerter_heartbeat.AlerterMessage"` | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `assemblyline.odm.messages.alerter_heartbeat.AlerterMessage` |
+| msg_type | Enum | Type of message<br>Values:<br>`"AlerterHeartbeat"` | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `AlerterHeartbeat` |
+| sender | Keyword | Sender of message | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
 
 
 [comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!)
@@ -16,9 +16,9 @@
 
 | Field | Type | Description | Required | Default |
 | :--- | :--- | :--- | :--- | :--- |
-| instances | Integer | Number of Alerter instances | :material-checkbox-marked-outline: Yes | `None` |
-| metrics | [Metrics](/assemblyline4_docs/odm/messages/alerter_heartbeat/#metrics) | Alert metrics | :material-checkbox-marked-outline: Yes | `None` |
-| queues | [Queues](/assemblyline4_docs/odm/messages/alerter_heartbeat/#queues) | Alert queues | :material-checkbox-marked-outline: Yes | `None` |
+| instances | Integer | Number of Alerter instances | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| metrics | [Metrics](/assemblyline4_docs/odm/messages/alerter_heartbeat/#metrics) | Alert metrics | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| queues | [Queues](/assemblyline4_docs/odm/messages/alerter_heartbeat/#queues) | Alert queues | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
 
 
 [comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!)
@@ -27,11 +27,11 @@
 
 | Field | Type | Description | Required | Default |
 | :--- | :--- | :--- | :--- | :--- |
-| created | Integer | Number of alerts created | :material-checkbox-marked-outline: Yes | `None` |
-| error | Integer | Number of alerts with errors | :material-checkbox-marked-outline: Yes | `None` |
-| received | Integer | Number of alerts received | :material-checkbox-marked-outline: Yes | `None` |
-| updated | Integer | Number of alerts updated | :material-checkbox-marked-outline: Yes | `None` |
-| wait | Integer | Number of alerts waiting for submission to complete | :material-checkbox-marked-outline: Yes | `None` |
+| created | Integer | Number of alerts created | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| error | Integer | Number of alerts with errors | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| received | Integer | Number of alerts received | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| updated | Integer | Number of alerts updated | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| wait | Integer | Number of alerts waiting for submission to complete | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
 
 
 [comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!)
@@ -40,7 +40,7 @@
 
 | Field | Type | Description | Required | Default |
 | :--- | :--- | :--- | :--- | :--- |
-| alert | Integer | Number of alerts in queue | :material-checkbox-marked-outline: Yes | `None` |
-| alert_retry | Integer | Number of alerts in retry queue | :material-checkbox-marked-outline: Yes | `None` |
+| alert | Integer | Number of alerts in queue | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| alert_retry | Integer | Number of alerts in retry queue | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
 
 
diff --git a/docs/odm/messages/archive_heartbeat.md b/docs/odm/messages/archive_heartbeat.md
@@ -4,10 +4,10 @@
 
 | Field | Type | Description | Required | Default |
 | :--- | :--- | :--- | :--- | :--- |
-| msg | [Heartbeat](/assemblyline4_docs/odm/messages/archive_heartbeat/#heartbeat) | Heartbeat message | :material-checkbox-marked-outline: Yes | `None` |
-| msg_loader | Enum | Loader class for message<br>Values:<br>`"assemblyline.odm.messages.archive_heartbeat.ArchiveMessage"` | :material-checkbox-marked-outline: Yes | `assemblyline.odm.messages.archive_heartbeat.ArchiveMessage` |
-| msg_type | Enum | Message type<br>Values:<br>`"ArchiveHeartbeat"` | :material-checkbox-marked-outline: Yes | `ArchiveHeartbeat` |
-| sender | Keyword | Sender of message | :material-checkbox-marked-outline: Yes | `None` |
+| msg | [Heartbeat](/assemblyline4_docs/odm/messages/archive_heartbeat/#heartbeat) | Heartbeat message | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| msg_loader | Enum | Loader class for message<br>Values:<br>`"assemblyline.odm.messages.archive_heartbeat.ArchiveMessage"` | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `assemblyline.odm.messages.archive_heartbeat.ArchiveMessage` |
+| msg_type | Enum | Message type<br>Values:<br>`"ArchiveHeartbeat"` | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `ArchiveHeartbeat` |
+| sender | Keyword | Sender of message | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
 
 
 [comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!)
@@ -16,9 +16,9 @@
 
 | Field | Type | Description | Required | Default |
 | :--- | :--- | :--- | :--- | :--- |
-| instances | Integer | Number of instances | :material-checkbox-marked-outline: Yes | `None` |
-| metrics | [Metrics](/assemblyline4_docs/odm/messages/archive_heartbeat/#metrics) | Archive metrics | :material-checkbox-marked-outline: Yes | `None` |
-| queued | Integer | Number of documents to be archived | :material-checkbox-marked-outline: Yes | `None` |
+| instances | Integer | Number of instances | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| metrics | [Metrics](/assemblyline4_docs/odm/messages/archive_heartbeat/#metrics) | Archive metrics | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| queued | Integer | Number of documents to be archived | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
 
 
 [comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!)
@@ -27,12 +27,12 @@
 
 | Field | Type | Description | Required | Default |
 | :--- | :--- | :--- | :--- | :--- |
-| file | Integer | Number of files archived | :material-checkbox-marked-outline: Yes | `None` |
-| result | Integer | Number of results archived | :material-checkbox-marked-outline: Yes | `None` |
-| submission | Integer | Number of submissions archived | :material-checkbox-marked-outline: Yes | `None` |
-| received | Integer | Number of received archive messages | :material-checkbox-marked-outline: Yes | `None` |
-| exception | Integer | Number of exceptions during archiving | :material-checkbox-marked-outline: Yes | `None` |
-| invalid | Integer | Number of invalid archive type errors during archiving | :material-checkbox-marked-outline: Yes | `None` |
-| not_found | Integer | Number of submission not found failures during archiving | :material-checkbox-marked-outline: Yes | `None` |
+| file | Integer | Number of files archived | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| result | Integer | Number of results archived | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| submission | Integer | Number of submissions archived | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| received | Integer | Number of received archive messages | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| exception | Integer | Number of exceptions during archiving | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| invalid | Integer | Number of invalid archive type errors during archiving | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| not_found | Integer | Number of submission not found failures during archiving | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
 
 
diff --git a/docs/odm/messages/dispatcher_heartbeat.md b/docs/odm/messages/dispatcher_heartbeat.md
@@ -4,10 +4,10 @@
 
 | Field | Type | Description | Required | Default |
 | :--- | :--- | :--- | :--- | :--- |
-| msg | [Heartbeat](/assemblyline4_docs/odm/messages/dispatcher_heartbeat/#heartbeat) | Heartbeat message | :material-checkbox-marked-outline: Yes | `None` |
-| msg_loader | Enum | Loader class for message<br>Values:<br>`"assemblyline.odm.messages.dispatcher_heartbeat.DispatcherMessage"` | :material-checkbox-marked-outline: Yes | `assemblyline.odm.messages.dispatcher_heartbeat.DispatcherMessage` |
-| msg_type | Enum | Type of message<br>Values:<br>`"DispatcherHeartbeat"` | :material-checkbox-marked-outline: Yes | `DispatcherHeartbeat` |
-| sender | Keyword | Sender of message | :material-checkbox-marked-outline: Yes | `None` |
+| msg | [Heartbeat](/assemblyline4_docs/odm/messages/dispatcher_heartbeat/#heartbeat) | Heartbeat message | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| msg_loader | Enum | Loader class for message<br>Values:<br>`"assemblyline.odm.messages.dispatcher_heartbeat.DispatcherMessage"` | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `assemblyline.odm.messages.dispatcher_heartbeat.DispatcherMessage` |
+| msg_type | Enum | Type of message<br>Values:<br>`"DispatcherHeartbeat"` | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `DispatcherHeartbeat` |
+| sender | Keyword | Sender of message | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
 
 
 [comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!)
@@ -16,11 +16,11 @@
 
 | Field | Type | Description | Required | Default |
 | :--- | :--- | :--- | :--- | :--- |
-| inflight | [Inflight](/assemblyline4_docs/odm/messages/dispatcher_heartbeat/#inflight) | Inflight submissions | :material-checkbox-marked-outline: Yes | `None` |
-| instances | Integer | Number of instances | :material-checkbox-marked-outline: Yes | `None` |
-| metrics | [Metrics](/assemblyline4_docs/odm/messages/dispatcher_heartbeat/#metrics) | Dispatcher metrics | :material-checkbox-marked-outline: Yes | `None` |
-| queues | [Queues](/assemblyline4_docs/odm/messages/dispatcher_heartbeat/#queues) | Dispatcher queues | :material-checkbox-marked-outline: Yes | `None` |
-| component | Keyword | Component name | :material-checkbox-marked-outline: Yes | `None` |
+| inflight | [Inflight](/assemblyline4_docs/odm/messages/dispatcher_heartbeat/#inflight) | Inflight submissions | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| instances | Integer | Number of instances | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| metrics | [Metrics](/assemblyline4_docs/odm/messages/dispatcher_heartbeat/#metrics) | Dispatcher metrics | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| queues | [Queues](/assemblyline4_docs/odm/messages/dispatcher_heartbeat/#queues) | Dispatcher queues | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| component | Keyword | Component name | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
 
 
 [comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!)
@@ -29,9 +29,9 @@
 
 | Field | Type | Description | Required | Default |
 | :--- | :--- | :--- | :--- | :--- |
-| max | Integer | Maximum number of submissions | :material-checkbox-marked-outline: Yes | `None` |
-| outstanding | Integer | Number of outstanding submissions | :material-checkbox-marked-outline: Yes | `None` |
-| per_instance | List [Integer] | Number of submissions per Dispatcher instance | :material-checkbox-marked-outline: Yes | `None` |
+| max | Integer | Maximum number of submissions | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| outstanding | Integer | Number of outstanding submissions | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| per_instance | List [Integer] | Number of submissions per Dispatcher instance | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
 
 
 [comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!)
@@ -40,15 +40,15 @@
 
 | Field | Type | Description | Required | Default |
 | :--- | :--- | :--- | :--- | :--- |
-| files_completed | Integer | Number of files completed | :material-checkbox-marked-outline: Yes | `None` |
-| submissions_completed | Integer | Number of submissions completed | :material-checkbox-marked-outline: Yes | `None` |
-| service_timeouts | Integer | Number of service timeouts | :material-checkbox-marked-outline: Yes | `None` |
-| cpu_seconds | PerformanceTimer | CPU time | :material-checkbox-marked-outline: Yes | `None` |
-| cpu_seconds_count | Integer | CPU count | :material-checkbox-marked-outline: Yes | `None` |
-| busy_seconds | PerformanceTimer | Busy CPU time | :material-checkbox-marked-outline: Yes | `None` |
-| busy_seconds_count | Integer | Busy CPU count | :material-checkbox-marked-outline: Yes | `None` |
-| save_queue | Integer | Processed submissions waiting to be saved | :material-checkbox-marked-outline: Yes | `None` |
-| error_queue | Integer | Errors waiting to be saved | :material-checkbox-marked-outline: Yes | `None` |
+| files_completed | Integer | Number of files completed | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| submissions_completed | Integer | Number of submissions completed | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| service_timeouts | Integer | Number of service timeouts | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| cpu_seconds | PerformanceTimer | CPU time | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| cpu_seconds_count | Integer | CPU count | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| busy_seconds | PerformanceTimer | Busy CPU time | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| busy_seconds_count | Integer | Busy CPU count | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| save_queue | Integer | Processed submissions waiting to be saved | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| error_queue | Integer | Errors waiting to be saved | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
 
 
 [comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!)
@@ -57,9 +57,9 @@
 
 | Field | Type | Description | Required | Default |
 | :--- | :--- | :--- | :--- | :--- |
-| ingest | Integer | Number of submissions in ingest queue | :material-checkbox-marked-outline: Yes | `None` |
-| start | List [Integer] | Number of submissions that started | :material-checkbox-marked-outline: Yes | `None` |
-| result | List [Integer] | Number of results in queue | :material-checkbox-marked-outline: Yes | `None` |
-| command | List [Integer] | Number of commands in queue | :material-checkbox-marked-outline: Yes | `None` |
+| ingest | Integer | Number of submissions in ingest queue | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| start | List [Integer] | Number of submissions that started | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| result | List [Integer] | Number of results in queue | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| command | List [Integer] | Number of commands in queue | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |