Skip to content

Commit 12d577f

Browse files
committed
fix(docs): remove unsupported gateway.toml field and v1.5 targets
ocsf_schema_version is a runtime setting (openshell settings set), not a gateway TOML field. Remove the gateway.toml example and gateway-config.mdx reference that would cause startup rejection. Mark v1.5 downgrade targets as unsupported since the allow-list only accepts "1.1" and "1.3". Signed-off-by: Adel Zaalouk <[email protected]>
1 parent da10094 commit 12d577f

2 files changed

Lines changed: 7 additions & 17 deletions

File tree

‎docs/observability/ocsf-json-export.mdx‎

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -157,14 +157,9 @@ Or per-sandbox:
157157
openshell settings set my-sandbox --key ocsf_schema_version --value "1.3"
158158
```
159159

160-
The setting can also be configured in `gateway.toml`:
161-
162-
```toml
163-
[openshell.gateway]
164-
ocsf_schema_version = "1.1"
165-
```
160+
The setting takes effect on the next poll cycle, by default every 10 seconds. No sandbox restart is required.
166161

167-
When set, the JSONL layer applies the following transformations:
162+
Supported target versions are `1.1` and `1.3`. When set, the JSONL layer applies the following transformations:
168163

169164
- Strips fields added after the target version: `ai_model`, `container`, `observation_point_id`
170165
- Removes unknown profile names from `metadata.profiles`: `ai_operation`, `container`
@@ -178,8 +173,8 @@ When unset or empty, no downgrade is applied and events are written at the curre
178173
|---|---|---|
179174
| AWS Security Lake | v1.1.0 | `1.1` |
180175
| Splunk CIM Add-On | v1.1-v1.3 | `1.1` or `1.3` |
181-
| CrowdStrike FDR | v1.5.0 | `1.5` |
182-
| Datadog Cloud SIEM | v1.5.0 (selectable) | `1.5` if needed |
176+
| CrowdStrike FDR | v1.5.0 | Not yet supported |
177+
| Datadog Cloud SIEM | v1.5.0 (selectable) | Not yet supported |
183178

184179
<Note>
185180
The core OCSF event structure (class UIDs, activity IDs, HTTP/network fields) is identical across v1.1 through v1.7. The differences are all profile-gated additions, so downgrading does not lose security-relevant data.
@@ -191,9 +186,9 @@ The JSONL file can be shipped to any tool that accepts OCSF-formatted data:
191186

192187
| Tool | Integration Path |
193188
|---|---|
194-
| Splunk | Use the [Splunk OCSF Add-on](https://splunkbase.splunk.com/app/6943) to ingest OCSF JSONL files. Set `ocsf_schema_version = "1.3"` for CIM Add-On compatibility. |
195-
| Amazon Security Lake | OCSF is the native schema for Security Lake. Set `ocsf_schema_version = "1.1"` for v1.1.0 compatibility. |
196-
| CrowdStrike FDR | Ship JSONL files to Falcon Data Replicator. Set `ocsf_schema_version = "1.5"` for v1.5.0 compatibility. |
189+
| Splunk | Use the [Splunk OCSF Add-on](https://splunkbase.splunk.com/app/6943) to ingest OCSF JSONL files. Set `ocsf_schema_version` to `1.3` for CIM Add-On compatibility. |
190+
| Amazon Security Lake | OCSF is the native schema for Security Lake. Set `ocsf_schema_version` to `1.1` for v1.1.0 compatibility. |
191+
| CrowdStrike FDR | Ship JSONL files to Falcon Data Replicator. v1.5 downgrade target is not yet supported. |
197192
| Elastic | Use Filebeat to ship JSONL files with the OCSF field mappings. |
198193
| Custom pipelines | Parse the JSONL file with `jq`, Python, or any JSON-capable tool. |
199194

‎docs/reference/gateway-config.mdx‎

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -75,11 +75,6 @@ metrics_bind_address = "0.0.0.0:9090"
7575

7676
log_level = "info"
7777

78-
# Target OCSF schema version for JSONL downgrade. When set, the JSONL layer
79-
# strips fields and profiles that don't exist in the target version. Empty or
80-
# unset means no downgrade. Use "1.1" for AWS Security Lake, "1.3" for Splunk.
81-
# ocsf_schema_version = "1.1"
82-
8378
# When empty, the gateway auto-detects Kubernetes, then Podman, then Docker.
8479
# VM is never auto-detected and requires an explicit entry here.
8580
compute_drivers = ["kubernetes"]

0 commit comments

Comments
 (0)