Marc Schier
44560fd3aa
Implements **#3942** (Apache Kafka transport for PubSub, OPC UA Part 14 Annex B.2) with HA publishers & subscribers (**#3924**, Part 14 §9.1.6). ## Kafka transport (Part 14 Annex B.2) New `Opc.Ua.PubSub.Kafka` library mirroring the MQTT broker transport and the existing `IPubSubTransport`/`IPubSubTransportFactory` + injectable-adapter pattern: - Profiles `pubsub-kafka-uadp` / `pubsub-kafka-json` (library-local `KafkaProfiles`); `kafka://` / `kafkas://` addresses. - Reuses the existing `Broker*TransportDataType` types (`QueueName` = topic, `MetaDataQueueName` = metadata topic, `ResourceUri`/`AuthenticationProfileUri` = auth, `RequestedDeliveryGuarantee` = QoS) — no new DataTypes, matching the spec. - Normative `content-type` record header (`application/opcua+uadp` / `application/json`); QoS → producer acks/idempotence; SASL/TLS auth with passwords resolved via `ISecretRegistry`. - `AddKafkaTransport()` DI (JSON + UADP factories), `KafkaConnectionOptions` (bootstrap servers, GroupId, security, delivery guarantee, offset policy). ### Dual-source client by TFM (AOT + broad TFM support) Via the `IKafkaClientAdapter` seam: - **net10.0 → Dekaf** (pure-managed, no native dependency) ⇒ the library is `IsAotCompatible` and Kafka runs in the **NativeAOT-published** sample directly. - **net472 / net48 / netstandard2.1 / net8.0 / net9.0 → Confluent.Kafka** (mature, native librdkafka). **NativeAOT publish of `ConsoleReferencePubSubClient` (win-x64) was validated end-to-end**: a 26.9 MB native binary with the Kafka/Dekaf transport and **zero IL2xxx/IL3xxx trim/AOT warnings**. ## Field promotion to broker headers (builds on #3956) Now that the PubSub transcoders (#3956) are on `master`, `KafkaBrokerTransport` implements the `IPubSubHeaderTransport` capability: transcoded DataSet fields selected via `PromoteFields(...)` (fluent) or the `PromoteFields` / `PromotedFieldPrefix` route options are surfaced as **Kafka record headers** — the broker-layer analogue of the Part 14 PromotedFields concept, with *copy* semantics (the fields remain in the encoded payload). The normative `content-type` header is unaffected and values are invariant-formatted strings. This reuses the existing `KafkaMessage.Headers` channel (already emitted by both the Dekaf and Confluent adapters), so only the transport gained the capability. Covered by `KafkaHeaderTransportTests` (net10.0 Dekaf + net48 Confluent) and documented in `Docs/PubSub.md` under "Promoting fields to broker headers". ## High availability (#3924, §9.1.6) Transport-agnostic, additive, and **behaviour-neutral by default**: - `IPubSubActivationCoordinator` (per-component Active/Standby + `RoleChanged`) with the default no-op `AlwaysActiveCoordinator`. - `IPubSubLeaseStore` + `InMemoryPubSubLeaseStore` (monotonic fencing tokens) and `LeaseActivationCoordinator` (leader election with per-component renew/acquire loops). - Runtime wiring: `PubSubApplication` starts/stops the coordinator with the app; `WriterGroup`/`ReaderGroup` gate at the enable/pause boundary — Standby pauses publishing/dispatch, Active resumes. No-op under the default coordinator, so existing behaviour is unchanged. - Kafka HA: consumer `GroupId` drives Kafka-native subscriber failover; `AtLeastOnce`/`ExactlyOnce` enable idempotent producing for active-publisher handover. - DI: `WithActivationCoordinator(...)` / `WithLeaseStore(...)`. ## Samples & docs Kafka profiles (`KafkaUadp`/`KafkaJson`) added to the publisher & subscriber samples; new `Docs/PubSubKafka.md` (config, DI, auth, QoS, AOT note) linked from `Docs/README.md` + the `Docs/PubSub.md` transport table. ## Tests & validation - `Opc.Ua.PubSub.Kafka.Tests`: 82 tests, **80.28% line coverage** on the Kafka source, using a `FakeKafkaClientAdapter` over an in-memory topic bus. A **Testcontainers.Kafka** integration test runs a real produce→consume round-trip and `Assert.Ignore`-skips when Docker is unavailable. - HA failover tests (`PubSubActivationFailoverTests`): leader election + failover, fencing-token monotonicity, writer/reader standby gating (deterministic, `FakeTimeProvider`). - `Opc.Ua.PubSub.Tests`: **1134 passed / 0 failed** (1130 existing + 4 new). - Full `UA.slnx` net10 build: 0 errors; the only warnings are pre-existing CA warnings in unrelated test projects (new code is 0-warning). net48 (Confluent path) validated for the transport + test project. ### Dependencies (approved) - `Dekaf` (MIT, pure-managed, net10-only) and `Confluent.Kafka` 2.15.0 (Apache-2.0) + `librdkafka.redist` (BSD-2). - Test-only `Testcontainers.Kafka` 4.13.0 (MIT). - Dekaf's net10 package required bumping the `Microsoft.Extensions.*` / `System.*` 10.0.8 servicing family to 10.0.9. Closes #3942
OPC UA .NET Standard Stack
🆕 This is version 2.0 of the OPC UA .NET Standard Stack (current
master).Looking for the supported 1.x release? It lives on the
master378branch (last release:1.5.378). All new feature work happens here onmaster;master378continues to receive security and critical-bug fixes for the 1.x line.
The official OPC Foundation reference implementation of OPC UA for .NET — a certified, cross-platform stack with client, server, PubSub, GDS, complex types, and source-generated tooling. Used in production across industrial control, manufacturing, energy, and IoT systems.
📦 What it is
- A full-stack OPC UA implementation — Core / Client / Server / PubSub / GDS / LDS / Complex Types / Device Integration libraries built on .NET, with UA-TCP and HTTPS transports.
- Cross-platform — runs on .NET 10, .NET 9, .NET 8 (LTS), .NET Framework 4.8, and .NET Standard 2.1; ships Native-AOT-friendly assemblies.
- Certified for compliance — the reference server has been certified through an OPC Foundation Certification Test Lab and is continuously verified against the latest Compliance Test Tool (CTT).
- Companion-spec coverage — Part 9 (Alarms & Conditions), Part 11 (Historical Access), Part 13 (Aggregates), Part 16 (State Machines), Part 17 (Alias Names), Part 18 (Role Management), Part 20 (File Transfer), Part 100 (Device Integration), OPC 10100-1 (WoT Connectivity).
- Modern developer surface — first-class
Microsoft.Extensions.DependencyInjectionhosting (services.AddOpcUa()), fluent server + client builders, source-generated NodeManagers and DataTypes, and an MCP server so LLMs / Copilot can drive an OPC UA client.
For the full feature breakdown see OPC UA Profiles and Facets and the What's New in 2.0 tour.
🚀 Getting started
You need the .NET 10 SDK to build the repo. From the repository root:
dotnet restore UA.slnx
dotnet build UA.slnx
For the supported target frameworks and platform notes see
Platform Support. The official NuGet packages
are published to nuget.org under the OPCFoundation.NetStandard
prefix — the meta package
OPCFoundation.NetStandard.Opc.Ua
pulls in everything, or pick the split
OPCFoundation.NetStandard.Opc.Ua.Core / .Client / .Server /
.Bindings.Https packages directly. Preview builds for every successful
master build are available in the
Azure DevOps opcua-preview feed.
Sample applications
Each sample has its own README.md with build and run instructions.
Reference applications
- Console Reference Server — the certified reference server (with Quickstarts, CTT, and Mono configs). Also ships as a Docker container.
- Console Reference Client — cross-platform reference client demonstrating sessions, subscriptions, browsing, and method calls.
- Console LDS Server — a standalone
Local Discovery Server built on
Opc.Ua.Lds.Server. - MCP Server — Model Context Protocol server that exposes OPC UA client operations as MCP tools, so an LLM / Copilot can browse, read, write, subscribe, and call methods on any OPC UA server.
PubSub samples
- Console Reference PubSub Client —
one executable with
publisher,subscriber, andexternal(external-server adapter) modes across the supported transport profiles.
Minimal / Device-Integration samples
- Minimal Calc Server — minimal server built on the source-generated NodeManager pipeline (Calc model).
- Minimal Boiler Server — minimal Boiler-model server with the fluent state-machine builder; Native-AOT publishable.
- Pump Device Integration Server —
minimal Device Integration (Part 100) server using
Opc.Ua.Di.Server's fluent builder.
More sample projects are maintained in the companion OPC UA .NET Samples repository.
🔧 Migrating from 1.5.378 to 2.0
The 2.0 release introduces breaking API changes, and comes with a full prescriptive migration guide that links to per-area documentation covering telemetry, packages, source generation, types, encoders, node states, identity, certificates, configuration, sessions / subscriptions, alarms / model change, and TimeProvider.
Most of the mechanical migration work is automated:
OPCFoundation.NetStandard.Opc.Ua.MigrationAnalyzerNuGet — install it in your project to get analyzer warnings (UA0001–UA0022)- one-click code fixes for the patterns in the guide. Setup steps are in the package's NugetREADME.md.
- Migration agent skill — the
opcua-v20-migrationskill walks Copilot / Claude / any coding agent through installing the NuGet, runningdotnet format analyzersto apply auto-fixes, and handling the small residual manual patterns. The skill knows which sub-doc to load for each symptom so it stays context-efficient.
If you are still on 1.x and not ready to upgrade, stay on the
master378
branch — it continues to receive security and critical-bug fixes.
🤝 Contributing and license
Community contributions are welcome. Fork the repository, make your changes on a branch, and open a pull request; see CONTRIBUTING.md for the contribution workflow.
Contributors must sign the OPC Foundation Contributor License Agreement (CLA). The CLA "I AGREE" gate is presented automatically on your first PR.
The project is licensed under the OPC Foundation MIT License. Report security vulnerabilities via the process documented in SECURITY.md.
📚 Further reading
- Documentation index — every per-feature doc with a one-line description.
- What's New in 2.0 — narrative tour of the 1.5.378 → 2.0 changes grouped by theme and layer.
- OPC UA Profiles and Facets — facets / transports / security policies the stack implements.
- Migration Guide — prescriptive
per-version migration reference (links to
Docs/migrate/2.0.x/). - OPC UA Online Reference — the official OPC 10000 series specification index.
- OPC UA .NET Samples — companion repository with more sample applications.
- Preview NuGet feed — prerelease builds from Azure DevOps.