-
Notifications
You must be signed in to change notification settings - Fork 317
Open
Description
Description
Create a new reference documentation page at /reference/internals/storage-engine/ for both InfluxDB 3 Core and Enterprise that explains the storage engine architecture.
Requirements
File Structure
content/influxdb3/core/reference/internals/storage-engine.md
content/influxdb3/enterprise/reference/internals/storage-engine.md
Or use shared content:
content/shared/influxdb3-internals-reference/storage-engine.md
Content to Include
-
Storage engine overview
- Built in Rust on top of Apache Arrow and DataFusion
- Real-time, columnar database optimized for time series data
- Supports infinite tag cardinality
-
Storage engine diagram - Architecture diagram showing Core/Enterprise components
-
Storage engine components:
- Catalog: Metadata service that tracks schema details and data location in object storage, providing essential information for both writers and queriers
- Object store: Storage layer for persisted time series data
- Compactor: Processes and compresses data to optimize storage
- Write-ahead log (WAL): Temporary cache for recently written points
- Processing engine: Python virtual machine embedded within InfluxDB 3 for executing plugins in response to triggers
-
Node modes {{% show-in "enterprise" %}}
- Explain operational modes for Enterprise multi-node clusters:
- Ingest nodes
- Query nodes
- Compactor nodes
- Process nodes
- All-in-one nodes (default)
{{% /show-in %}}
- Explain operational modes for Enterprise multi-node clusters:
Related Pages
Link to:
/influxdb3/enterprise/get-started/multi-server/(for node modes)/influxdb3/enterprise/reference/config-options/(formodeconfiguration)/influxdb3/core/get-started/process/(Processing engine)/influxdb3/enterprise/get-started/process/(Processing engine)/influxdb3/core/reference/internals/authentication/(catalog and _internal database)/influxdb3/enterprise/reference/internals/authentication/(catalog and _internal database)
Acceptance Criteria
- New storage-engine.md pages created for Core and Enterprise (or shared)
- Content describes the Core/Enterprise architecture accurately
- Diagram shows Core/Enterprise-specific components (if needed)
- Node modes section included for Enterprise only (using
show-inshortcode) - Processing engine component described
- Links to related documentation pages
- Follows docs-v2 style guidelines
Metadata
Metadata
Assignees
Labels
No labels