Skip to content

Commit 9cf1914

Browse files
committed
docs: replace transactional-engine references with orchestration engine
Update architecture.md, configuration.md, examples.md, getting-started.md, README.md, and data-jobs guide to reflect the consolidation of lib-transactional-engine into fireflyframework-orchestration.
1 parent b1d8bcb commit 9cf1914

7 files changed

Lines changed: 43 additions & 57 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,11 @@ The starter features abstract controller and service base classes that eliminate
4444
- Job execution result persistence and audit trails
4545
- CQRS auto-configuration for command/query integration
4646
- EDA auto-configuration for event-driven data processing
47-
- Transactional engine integration for saga-based data flows
47+
- Orchestration engine integration for saga-based data flows
4848
- Resilience patterns with circuit breaker and retry decorators
4949
- Observability with Micrometer metrics and distributed tracing
5050
- Enrichment caching with configurable cache key generation
51-
- Step event bridge for transactional engine coordination
51+
- Orchestration engine support (Saga, TCC, Workflow)
5252
- Persistence auto-configuration for job results and audit entries
5353

5454
## Requirements

docs/common/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ These topics are relevant whether you're building data jobs, data enrichers, or
4646
- Enrichment configuration
4747
- EDA (Event-Driven Architecture) configuration
4848
- CQRS configuration
49-
- Transactional engine configuration
49+
- Orchestration engine configuration
5050
- Observability configuration
5151
- Resiliency configuration
5252

docs/common/architecture.md

Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ The `fireflyframework-starter-data` starter is built on **Hexagonal Architecture
6060
│ │ │ DataJobController (REST API Port) │ │ │
6161
│ │ │ JobOrchestrator (Orchestration Port) │ │ │
6262
│ │ │ EventPublisher (EDA Port) │ │ │
63-
│ │ │ StepEventPublisher (SAGA Port) │ │
63+
│ │ │ OrchestrationEventPublisher (Orchestration Port) │ │
6464
│ │ └─────────────────────────────────────────────┘ │ │
6565
│ │ │ │
6666
│ │ DOMAIN CORE │ │
@@ -87,7 +87,7 @@ The `fireflyframework-starter-data` starter is built on **Hexagonal Architecture
8787
#### Outbound Ports (Driven)
8888
- **JobOrchestrator** - Interface for workflow orchestration
8989
- **EventPublisher** - Interface for event publishing
90-
- **StepEventPublisher** - Interface for SAGA step events
90+
- **OrchestrationEventPublisher** - Interface for orchestration events
9191
- Defines what the application needs
9292
- Implemented by infrastructure adapters
9393

@@ -105,9 +105,7 @@ config/
105105
├── EdaAutoConfiguration # Event-driven architecture
106106
├── JobOrchestrationAutoConfiguration # Job orchestration setup
107107
├── JobOrchestrationProperties # Configuration properties
108-
├── StepBridgeConfiguration # SAGA step event bridge
109-
├── StepEventsProperties # Step event configuration
110-
└── TransactionalEngineAutoConfiguration # SAGA support
108+
└── OrchestrationAutoConfiguration # Orchestration engine support
111109
```
112110

113111
**Key Features:**
@@ -269,13 +267,13 @@ public interface JobResultMapper<S, T> {
269267
}
270268
```
271269

272-
### 7. Step Events Layer
270+
### 7. Orchestration Events Layer
273271

274-
SAGA integration bridge:
272+
Orchestration engine integration:
275273

276274
```
277-
stepevents/
278-
└── StepEventPublisherBridge # Bridges SAGA to EDA
275+
orchestration/
276+
└── EventGateway # Bridges orchestration events to EDA (provided by fireflyframework-orchestration)
279277
```
280278

281279
---
@@ -296,8 +294,8 @@ stepevents/
296294
│ └────────────┬───────────────────────────────┘ │
297295
│ │ │
298296
│ ┌────────────▼───────────────────────────────┐ │
299-
│ │ StepEventPublisherBridge │ │
300-
│ │ - SAGA step events │ │
297+
│ │ Orchestration EventGateway │ │
298+
│ │ - Orchestration step events │ │
301299
│ │ - Metadata enrichment │ │
302300
│ └────────────┬───────────────────────────────┘ │
303301
└───────────────┼─────────────────────────────────────────┘
@@ -325,7 +323,7 @@ stepevents/
325323

326324
**Integration Points:**
327325
- Job lifecycle events published to EDA
328-
- SAGA step events bridged to EDA
326+
- Orchestration step events bridged to EDA
329327
- Configurable topics and routing
330328
- Automatic metadata enrichment
331329

@@ -359,33 +357,34 @@ stepevents/
359357
- **Queries** - Read state (CHECK, COLLECT, RESULT)
360358
- Enables independent scaling of read/write operations
361359

362-
### Integration with lib-transactional-engine
360+
### Integration with Orchestration Engine
363361

364362
```
365363
┌─────────────────────────────────────────────────────────┐
366-
lib-transactional-engine
364+
fireflyframework-orchestration
367365
│ │
368366
│ ┌────────────────────────────────────────────┐ │
369-
│ │ SAGA Orchestrator │ │
367+
│ │ Orchestration Engine (Saga, TCC, Workflow)│ │
370368
│ │ - Step execution │ │
371369
│ │ - Compensation logic │ │
372370
│ │ - Transaction coordination │ │
373371
│ └────────────┬───────────────────────────────┘ │
374372
│ │ │
375-
│ │ Step Events
373+
│ │ Orchestration Events │
376374
│ ▼ │
377375
│ ┌────────────────────────────────────────────┐ │
378-
│ │ StepEventPublisher (interface) │ │
376+
│ │ OrchestrationEventPublisher (interface) │ │
377+
│ │ EventGateway (bridges to EDA) │ │
379378
│ └────────────────────────────────────────────┘ │
380379
└───────────────┼─────────────────────────────────────────┘
381380
382381
383382
┌─────────────────────────────────────────────────────────┐
384-
│ fireflyframework-starter-data
383+
│ fireflyframework-starter-data │
385384
│ │
386385
│ ┌────────────────────────────────────────────┐ │
387-
│ │ StepEventPublisherBridge │ │
388-
│ │ (implements StepEventPublisher) │ │
386+
│ │ Consumes orchestration events │ │
387+
│ │ (EventGateway bridges to EDA) │ │
389388
│ │ - Enriches with data context │ │
390389
│ │ - Routes to EDA infrastructure │ │
391390
│ └────────────┬───────────────────────────────┘ │
@@ -531,7 +530,7 @@ stepevents/
531530
**Purpose:** Decouple abstraction from implementation
532531

533532
**Implementation:**
534-
- `StepEventPublisherBridge` bridges SAGA to EDA
533+
- `EventGateway` bridges orchestration events to EDA
535534
- Allows independent evolution of both sides
536535
- Transparent integration
537536

docs/common/configuration.md

Lines changed: 13 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Complete configuration reference for `fireflyframework-starter-data` starter.
99
- [Job Orchestration](#job-orchestration)
1010
- [EDA Integration](#eda-integration)
1111
- [CQRS Integration](#cqrs-integration)
12-
- [Transactional Engine](#transactional-engine)
12+
- [Orchestration Engine](#orchestration-engine)
1313
- [Step Events](#step-events)
1414
- [Configuration Examples](#configuration-examples)
1515

@@ -27,7 +27,7 @@ firefly:
2727
eda: # Event-Driven Architecture settings
2828
cqrs: # CQRS pattern settings
2929
orchestration: # Job orchestration settings
30-
transactional: # SAGA/transactional settings
30+
orchestration: # Orchestration engine settings
3131
stepevents: # Step event bridge settings
3232
eda: # fireflyframework-eda configuration
3333
```
@@ -47,8 +47,8 @@ firefly:
4747
enabled: true # Enable CQRS integration (default: true)
4848
orchestration:
4949
enabled: true # Enable job orchestration (default: true)
50-
transactional:
51-
enabled: false # Enable SAGA support (default: true)
50+
orchestration:
51+
enabled: false # Enable orchestration engine (default: true)
5252
```
5353
5454
**Notes:**
@@ -255,32 +255,19 @@ No additional configuration needed - separation is built into the interfaces.
255255

256256
---
257257

258-
## Transactional Engine
258+
## Orchestration Engine
259259

260260
### Basic Configuration
261261

262-
```yaml
263-
firefly:
264-
data:
265-
transactional:
266-
enabled: true
267-
```
268-
269-
### SAGA Configuration
270-
271-
When using SAGAs for distributed transactions:
262+
The `fireflyframework-orchestration` module is auto-configured via `firefly.orchestration` properties. It consolidates Saga, TCC, and Workflow patterns into a single module with its own `EventGateway` for EDA bridging.
272263

273264
```yaml
274265
firefly:
275-
transactional:
276-
saga:
277-
enabled: true
278-
default-timeout: 30m
279-
max-retries: 3
280-
compensation-timeout: 5m
266+
orchestration:
267+
enabled: true
281268
```
282269

283-
**Note:** This configuration is from `lib-transactional-engine`. See that library's documentation for complete options.
270+
**Note:** See the `fireflyframework-orchestration` module documentation for complete options including Saga, TCC, and Workflow configuration.
284271

285272
---
286273

@@ -348,8 +335,8 @@ firefly:
348335
orchestrator-type: MOCK # Use mock for development
349336
publish-job-events: true
350337
job-events-topic: dev-job-events
351-
transactional:
352-
enabled: false # Disable SAGAs in dev
338+
orchestration:
339+
enabled: false # Disable orchestration in dev
353340
354341
eda:
355342
publishers:
@@ -397,7 +384,7 @@ firefly:
397384
dag-id-prefix: customer_data
398385
verify-ssl: true
399386
max-concurrent-dag-runs: 20
400-
transactional:
387+
orchestration:
401388
enabled: true
402389
403390
stepevents:
@@ -475,7 +462,7 @@ firefly:
475462
enabled: true
476463
orchestrator-type: MOCK # Use mock orchestrator
477464
publish-job-events: false # Don't publish events
478-
transactional:
465+
orchestration:
479466
enabled: false
480467
481468
logging:

docs/common/examples.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -492,7 +492,7 @@ public class CustomerDataEventListener {
492492

493493
## SAGA Integration
494494

495-
> **Note**: This example demonstrates integration with `lib-transactional-engine` (SAGA orchestrator). The `SagaOrchestrator`, `Saga`, and `Step` classes are from that library, not from fireflyframework-starter-data. This starter provides `StepEventPublisherBridge` to publish step events to the SAGA engine.
495+
> **Note**: This example demonstrates integration with `fireflyframework-orchestration` (orchestration engine). The `SagaEngine`, `Saga`, and `Step` classes are from that module, not from fireflyframework-starter-data. The orchestration module provides its own `EventGateway` for EDA bridging.
496496
497497
### Example 8: Multi-Step Data Processing SAGA
498498

@@ -501,8 +501,8 @@ public class CustomerDataEventListener {
501501
@Slf4j
502502
public class DataProcessingSagaService {
503503

504-
// SagaOrchestrator is from lib-transactional-engine
505-
private final SagaOrchestrator sagaOrchestrator;
504+
// SagaEngine is from fireflyframework-orchestration
505+
private final SagaEngine sagaEngine;
506506
private final DataJobService dataJobService;
507507
// These are your application services
508508
private final DataTransformationService transformationService;
@@ -533,7 +533,7 @@ public class DataProcessingSagaService {
533533
.build())
534534
.build();
535535

536-
return sagaOrchestrator.execute(saga)
536+
return sagaEngine.execute(saga)
537537
.map(result -> result.getSagaId())
538538
.doOnSuccess(sagaId ->
539539
log.info("SAGA completed successfully: {}", sagaId))

docs/common/getting-started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -154,8 +154,8 @@ firefly:
154154
password: airflow
155155
dag-id-prefix: my_service
156156

157-
# Enable transactional engine (optional)
158-
transactional:
157+
# Enable orchestration engine (optional)
158+
orchestration:
159159
enabled: false
160160

161161
# Step events configuration (if using SAGAs)

docs/data-jobs/guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1576,7 +1576,7 @@ All jobs automatically get:
15761576

15771577
### Overview
15781578

1579-
For workflows that require distributed transactions or step-level coordination, integrate with Firefly's transactional engine and event-driven architecture.
1579+
For workflows that require distributed transactions or step-level coordination, integrate with Firefly's orchestration engine and event-driven architecture.
15801580

15811581
### Event Publishing
15821582

0 commit comments

Comments
 (0)