Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,13 @@ jobs:
- name: Run tests
run: cargo test --all --verbose

- name: Validate promoted example configs
run: |
cargo run --quiet --bin streamforge-validate -- examples/configs/config.example.yaml
cargo run --quiet --bin streamforge-validate -- examples/redpanda/selective-replication.yaml
cargo run --quiet --bin streamforge-validate -- examples/production/pii-redaction.yaml
cargo run --quiet --bin streamforge-validate -- examples/production/cdc-to-datalake.yaml

- name: Run clippy
run: cargo clippy --all-targets --all-features -- -D warnings

Expand Down
457 changes: 70 additions & 387 deletions README.md

Large diffs are not rendered by default.

23 changes: 23 additions & 0 deletions docs/COMPATIBILITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: Compatibility
nav_order: 5
---

# Compatibility

## Broker Targets

| Target | Status | Notes |
|--------|--------|-------|
| Apache Kafka | Primary | Baseline deployment target |
| Redpanda | Compatibility target | Validate visible examples and docs against Kafka-compatible APIs |

## Validation Expectations

- Validate published standalone StreamForge config examples with `streamforge-validate`
- Validate Kubernetes and operator examples with their own schema and apply checks
- Document any broker-specific caveats instead of implying perfect parity

## Current Compatibility Promise

StreamForge is Kafka-first, and Redpanda is a compatibility target for Kafka-compatible replication workflows. Support claims should stay scoped to the visible example and validation matrix in the repo. If a workflow depends on broker-specific features outside that matrix, document the limitation before claiming support.
Loading
Loading