Documentation
This folder contains the main documentation set for Pipelinez.
Start Here
- Overview architectural overview of the current runtime
- Generated API Reference browsable API documentation generated from public XML docs
- API Stability public API compatibility policy and maintainer workflow
Getting Started
- In-Memory Pipeline first end-to-end pipeline without external infrastructure
- Kafka Pipeline first Kafka-backed pipeline using the example Docker workflow
- Azure Service Bus Pipeline first Azure Service Bus queue-backed pipeline shape
- RabbitMQ Pipeline first RabbitMQ queue-backed pipeline shape
- PostgreSQL Destination first PostgreSQL-backed destination and dead-letter pipeline shape
- SQL Server Destination first SQL Server-backed destination and dead-letter pipeline shape
Guides
- Lifecycle
- Error Handling
- Retry
- Dead-Lettering
- Flow Control
- Distributed Execution
- Performance
- Operational Tooling
Transport Docs
Operations
Architecture
- Runtime
- Kafka Internals
- Azure Service Bus Internals
- RabbitMQ Internals
- PostgreSQL Internals
- SQL Server Internals
- Testing
Installation Note
The public packages are available on NuGet.org:
PipelinezPipelinez.KafkaPipelinez.AzureServiceBusPipelinez.RabbitMQPipelinez.PostgreSqlPipelinez.SqlServer
Install with:
dotnet add package Pipelinez
dotnet add package Pipelinez.Kafka
dotnet add package Pipelinez.AzureServiceBus
dotnet add package Pipelinez.RabbitMQ
dotnet add package Pipelinez.PostgreSql
dotnet add package Pipelinez.SqlServer
Public releases are configured through tag-based GitHub Actions and NuGet Trusted Publishing.
All public packages also ship XML IntelliSense documentation so API descriptions show up directly in supported IDEs. The same XML documentation is used to generate the public API reference at https://kenberg75.github.io/Pipelinez/api/Pipelinez.Core.html.