GithubStar/UA-.NETStandard
1
0
Fork 0
mirror of https://github.com/OPCFoundation/UA-.NETStandard.git synced 2026-10-21 09:06:37 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
fix/diagnostic-delete-nodeversion-master
UA-.NETStandard/docs/README.md
T
Marc Schier 7c965fd636 Capture metadata images and generation-bound session clients (#4752) 
# Description

- Add isolated NodeState reference images, TypeTable graph snapshots,
EncodeableFactory registration forks/views, StringTable mutation
versions/private copies, and ServiceMessageContext mapping-holder
generation tracking. Reference images are lazy for empty nodes;
selected-image clones own independent storage and publication ownership.
- Add the complete generic NodeBrowser continuation-dependency
capability. This does not implement server browse-history retention,
NodeManager read images, or server batch/readiness admission.
- Add optional client binding capture for SessionClient, native Session
and ManagedSession, with managed-lease/native-channel generation
composition. Bindings capture authenticated-session identity, mapping
holders/versions and owned endpoint/policy/configuration observations.
Replacement, reconnect, mapping ABA and disposal permanently invalidate
stale bindings; disposing a binding does not dispose its owner.
- Preserve cancellation and master pooled-response ownership: a rejected
pooled response is released exactly once; an accepted response remains
caller-owned. Keep native transport submission under its replacement
gate and completion outside the gate, without routing ordinary unbound
requests through binding machinery.
- Rename the existing server lookup interface and all actual consumers
with minimal hunks; add focused fixtures, generated FileTypeClient usage
guidance, and package/transport documentation.

**Breaking preview type identity:** the existing 2.0-preview server
lookup `Opc.Ua.ISessionBindingProvider` becomes
`Opc.Ua.IServerSessionBindingProvider`. Server lookup consumers must
update their referenced type and rebuild. This is neither
source-compatible nor binary-additive for that preview type. The new
client capability is optional and adds no mandatory members to existing
ISession/ISessionClient/ITransportChannel contracts. This
preview-to-preview rename is documented in SessionBindings/Transports,
not in the 1.5-to-2.0 MigrationGuide.

**Ownership boundary:** no RequestLifetime changes,
certificate-manager/channel-entry adoption, BaseVariableState changes,
Method-result feature extraction, NodeManager batch/readiness or
browse-history retention, session restoration, registry federation, WoT
conversion, or WoT runtime/planners/events.
DependencyInjection/ResourceIsolation/index changes are lookup/link
closure only. SessionManager's PR hunk changes only its implemented
lookup-interface name; newer master public diagnostic masking is not
replaced.

## Related Issues

_Reference all GitHub issues this PR addresses. If there is no issue
yet, open one and link it here._

_If this is a relatively large or complex change, a design must have
been discussed in the related tracking issue and signed off (which
becomes the Architectural Decision Record (ADR))._

- Part of #4511: user-approved combined groups 5+6 Wave A extraction.
This PR does not close the umbrella or publish Wave B.

## Checklist

_Put an `x` in the boxes that apply. You can complete these step by step
after opening the PR._

- [ ] I have signed the
[CLA](https://opcfoundation.org/license/cla/ContributorLicenseAgreementv1.0.pdf)
and read the
[CONTRIBUTING](https://github.com/OPCFoundation/UA-.NETStandard/blob/master/CONTRIBUTING.md)
doc.
- [ ] I have added tests that prove my fix is effective or that my
feature works and increased code coverage.
- [x] I have added all necessary documentation.
- [x] I have verified that my changes do not introduce (new) build or
analyzer warnings.
- [ ] I ran **all** tests locally using the **UA.slnx** solution against
at least .net **framework** and .net **10**, and all passed.
- [ ] I fixed **all** failing and flaky tests in the CI pipelines and
**all** CodeQL warnings.
- [x] I have addressed **all** PR feedback received.

### Review qualification

Review fixes are published at
**`6b0eb1d5c32a439300fbcaff974b9af8b909161b`**, changing eight
already-owned files. All five received review threads were replied to
and resolved after verification. Factory selector installation and
target-selection-plus-commit share the root publication gate, with
consistent root→image release/capture ordering. TypeTable selector
installation and final mutation routing share its existing gate. Native
bound channel validity uses volatile observations; the two owned XML
defects are corrected.

| Requirement | Evidence |
|---|---|
| Selector installation must not hide TypeTable mutations |
`SelectorInstalledDuringNodePreparationReceivesMutation`: old Add
routing failed on both TFMs; corrected routing passes on both within
**148/148** factory/TypeTable controls |
| Selector installation must not race factory commit routing | Static
common-root-gate/order proof plus baseline-GREEN
`BuilderCapturedBeforeOwnershipUsesSelectedFactory`,
`ViewOwnerReleasePreservesRegistrationsAndAllowsReuse`,
`ViewOwnerReleaseCanRetryAfterPendingPublication`,
`PublicationProtectsPendingAndRetiredFactoryImages` |
| Lock-free validity must observe owner transitions | Static
volatile-read reasoning plus native
`BoundRequestCannotDispatchWhileNativeReplacementIsPendingAsync`,
`BoundResponseRejectsInvalidationAfterNativeDispatchAsync`,
`BoundClientCannotRetryAcrossFaultedManagedEntryReplacementAsync`:
**12/12 each TFM**; Core binding/pooled ownership controls **17/17 each
TFM** |
| Correct owned XML documentation | “an unmanaged” and one multiline
`ReferenceUpdate.Next` summary; scoped whitespace/INFO and build
evidence below |

Factory controls are **not** claimed as a deterministic factory RED, and
public transport controls are **not** claimed as a deterministic
weak-memory RED. No private-lock reflection, artificial production seam,
or source-name assertion was added. The TypeTable RED uses the real
`ILocalNode.NodeClass` callback during node preparation, and both
expected RED receipts/TRX were retained.

All accepted review runs use the unchanged admitted SDK wrapper, normal
project references, sole mutex, one node/no shared compiler, finite
resource guards and canonical short-C build outputs. Source hashes were
frozen per command and matched the committed bytes afterward. SDK
ownership was released **before** commit/push/review replies. No
automatic merge was requested.

Scoped whitespace passed across the four affected projects. Review INFO
classification is **0 owned findings / 13 untouched baseline findings
excluded** (whole-file formatter exits 1,1,0,0); no baseline
RCS1140/RCS0055 expansion or suppression. The final normal net10 public
Client/Core/Types trim/AOT-analyzer closure passed **0 warnings / 0
errors**. This is not a NativeAOT publish/run.

<details>
<summary>Accepted review command payloads and results</summary>

These exact argument payloads were executed through the unchanged
guarded SDK wrapper. `$proof` expands to the protected results-directory
below. Successful explicit builds of the same source preceded the
`--no-build` runs.

```powershell
$proof = 'C:\Users\mschier\.copilot\session-state\a3b74048-c52f-4c87-8773-7a46c9ab0087\files\qualification-review-4752'

# Exit 0: 148 passed, 0 failed
dotnet test tests\Opc.Ua.Types.Tests\Opc.Ua.Types.Tests.csproj -f net48 -p:CustomTestTarget=net48 -p:UseArtifactsOutput=true -p:ArtifactsPath=C:\cp56-a3b7-v2 -nr:false --no-restore --verbosity minimal --filter "FullyQualifiedName~EncodeableFactorySnapshotTests|FullyQualifiedName~TypeTableTests" --logger "trx;LogFileName=review-types-green-net48.trx" --results-directory $proof

# Exit 0: 148 passed, 0 failed
dotnet test tests\Opc.Ua.Types.Tests\Opc.Ua.Types.Tests.csproj -f net10.0 --no-restore --no-build --filter "FullyQualifiedName~EncodeableFactorySnapshotTests|FullyQualifiedName~TypeTableTests" --logger "trx;LogFileName=review-types-green-net10.trx" --results-directory $proof -p:CustomTestTarget=net10.0 -p:UseArtifactsOutput=true -p:ArtifactsPath=C:\cp56-a3b7-v2 -nr:false --verbosity minimal

# The following two per-TFM payloads each exited 0:
# Core: 17/17 net48 and 17/17 net10.0; Client: 12/12 net48 and 12/12 net10.0
foreach ($tfm in @('net48', 'net10.0')) {
    dotnet test tests\Opc.Ua.Core.Tests\Opc.Ua.Core.Tests.csproj -f $tfm --no-restore --no-build --filter "FullyQualifiedName~SessionBindingResponseTests|FullyQualifiedName~SessionBindingContextTests" --logger "trx;LogFileName=review-actual-core-green-$tfm.trx" --results-directory $proof -p:CustomTestTarget=$tfm -p:UseArtifactsOutput=true -p:ArtifactsPath=C:\cp56-a3b7-v2 -nr:false --verbosity minimal
    dotnet test tests\Opc.Ua.Client.Tests\Opc.Ua.Client.Tests.csproj -f $tfm --no-restore --no-build --filter "FullyQualifiedName~BoundRequestCannotDispatchWhileNativeReplacementIsPendingAsync|FullyQualifiedName~BoundResponseRejectsInvalidationAfterNativeDispatchAsync|FullyQualifiedName~BoundClientCannotRetryAcrossFaultedManagedEntryReplacementAsync" --logger "trx;LogFileName=review-actual-client-green-$tfm.trx" --results-directory $proof -p:CustomTestTarget=$tfm -p:UseArtifactsOutput=true -p:ArtifactsPath=C:\cp56-a3b7-v2 -nr:false --verbosity minimal
}

# Exit 0: 0 warnings, 0 errors
dotnet build src\Opc.Ua.Client\Opc.Ua.Client.csproj -f net10.0 -p:CustomTestTarget=net10.0 -p:UseArtifactsOutput=true -p:ArtifactsPath=C:\cp56-a3b7-v2 -nr:false --no-restore --verbosity minimal
```

The six expanded GREEN commands, exact results/TRX hashes and two
expected RED commands are retained in
`qualification-review-4752\qualification-summary.json`, SHA256
`C5E71A4D8D37BAC8803F6DF38B6BCE2B70F3D0AFD5DEC8493FAE9DB440DCFB5A`.
Committed/qualified byte identity is in `publication-identity.json`,
SHA256
`CD9515FE96703F8B241F2B7B9B71F73EF0FF2626C2C8BCCE40307971A8F8E809`.
Per-command raw exits, guards, hashes and reports are retained outside
disposable build roots.

For each record in the protected `format-inputs.json` (Types/Core/Client
libraries and Types.Tests), the recorded Project/Include values expand
these exact payloads:

```powershell
# Workspace properties recorded with the formatter receipts:
$env:CustomTestTarget = 'net10.0'
$env:UseArtifactsOutput = 'true'
$env:ArtifactsPath = 'C:\cp56-a3b7-v2'

# All four exit 0
dotnet format whitespace $Project --no-restore --verify-no-changes --verbosity minimal --include $Include

# Exits 1,1,0,0 due only to untouched baseline findings; owned=0, baseline=13
dotnet format $Project --no-restore --severity info --verify-no-changes --verbosity minimal --report "$proof\formats\review-info-$i" --include $Include
```

Initial fresh matrix evidence remains separately identified and
unchanged: Types274/Core119/Client151/server137 net10;
Types274/Core119/Client151/server135 net48, all passing. Qualification
base remains `0dff94bd378e79b8cf1a47e1aaf340f9b4b40048`; the initial
published head was `9fee4583`. All 16 initial exact command
arrays/results/TRX hashes remain in protected
`qualification-v2\qualification-summary.json`, SHA256
`88E10240C20049B59A3401BE007C6528A85DF2F3DCFAF9D11D908CEF2946DA4E`.

Failures/incidents remain retained rather than relabeled as success:
original disappeared-root historical counts are invalidated; the
large-TRX controller DOM-parser failure is preserved separately from
accepted streaming receipts; the review argument-array
defect/default-D-output controls are preserved but excluded from
canonical review qualification. Correctly separated argument rechecks
produced the accepted short-C Core/Client receipts. The sole SDK wrapper
was not changed.

Full UA.slnx, measured coverage increase, CLA verification, NativeAOT
publication and current-head/master CI/CodeQL remain unclaimed. Actual
merge—not resolved review threads—unlocks Wave B.

</details>
2026-10-13 06:25:43 +02:00

385 lines
19 KiB
Markdown
Raw Permalink Blame History

# OPC UA .NET Standard stack documentation
These guides lead from a first working application to advanced and experimental
capabilities. Follow the numbered stages when you are learning. Choose only the
paths that match your application, or use the contents list to find a feature.
- **New to the SDK?** Start with [Getting started](GettingStarted.md), read
[OPC UA concepts](Concepts.md), then build
[your first information model](FirstModel.md).
- **Upgrading from 1.5.x?** Read [What's New in 2.0](WhatsNewIn2.0.md), then
follow the [Migration Guide](MigrationGuide.md).
- **Contributing to this repository?** See
[Contributing and maintaining the SDK](#contributing-and-maintaining-the-sdk).
## Contents
- [How to use this index](#how-to-use-this-index)
- [1. Get started](#1-get-started)
- [2. Build your application](#2-build-your-application)
- [Client path](#client-path)
- [Server path](#server-path)
- [PubSub path](#pubsub-path)
- [3. Add data types and application services](#3-add-data-types-and-application-services)
- [Data types and models](#data-types-and-models)
- [Application services](#application-services)
- [4. Use companion models](#4-use-companion-models)
- [5. Prepare for production](#5-prepare-for-production)
- [6. Advanced integration, reliability, and scale](#6-advanced-integration-reliability-and-scale)
- [Transports and integration](#transports-and-integration)
- [Session recovery and performance](#session-recovery-and-performance)
- [Security infrastructure and fleet management](#security-infrastructure-and-fleet-management)
- [High availability and deployment](#high-availability-and-deployment)
- [Native AOT publishing](#native-aot-publishing)
- [7. Draft and experimental capabilities](#7-draft-and-experimental-capabilities)
- [Reference and upgrade](#reference-and-upgrade)
- [Contributing and maintaining the SDK](#contributing-and-maintaining-the-sdk)
## How to use this index
Each stage builds on the earlier ones, but you do not need to read every guide.
After stage 1, choose the client, server, or PubSub path. Stages 3 to 7 are
optional; use the guides your application needs. A stage or group names the
knowledge it assumes.
Labels describe the maturity of a package or model:
- **Preview package**: the package family keeps a `-preview` version, even when
the core packages are stable. See [Versioning](DeveloperGuide.md#versioning).
- **Draft model**: the guide implements a working-group draft specification.
Its namespace URIs and NodeIds are provisional.
- **Experimental**: the guide marks the feature as experimental.
These labels are independent of difficulty. An advanced guide can describe a
stable feature, and a released specification can ship in a preview package.
## 1. Get started
Run a client and server, then learn the terms that the other guides use.
- [Getting started](GettingStarted.md) — run the minimal samples, or build a
client and server from NuGet packages.
- [OPC UA concepts](Concepts.md) — applications, endpoints, sessions, the
address space, values, subscriptions, and PubSub.
- [Your first information model](FirstModel.md) — add a model to the Getting
started server, then read, write, and call it from the client.
- [Sample catalogue](Samples.md) — minimal, reference, PubSub, and
companion-model applications.
- [Packages and supported platforms](DeveloperGuide.md#packages-platform-support-and-versioning)
— choose packages and target frameworks.
<a id="ua-core-stack-related"></a>
## 2. Build your application
Choose the path for your application. The paths are independent: for example,
a PubSub application needs neither a client nor a server.
### Client path
Assumes [Getting started](GettingStarted.md).
1. [Dependency injection: client feature](DependencyInjection.md#client-feature)
— configure a client in the .NET Generic Host.
2. [Managed sessions](Sessions.md#3-managedsession--the-connection-state-machine-facade)
— connect, recover from connection loss, and close. To compare the managed
and classic session APIs, see [choosing a session API](Sessions.md#7-putting-it-all-together).
3. [Read, write, and call methods](FirstModel.md#3-use-the-model-from-the-client)
— resolve namespace URIs and browse paths, check the status of each
operation, and call methods through a client generated from the model.
4. [Subscriptions](Subscriptions.md) — callback subscriptions for long-lived
monitoring and streams for short observations.
### Server path
Assumes [Getting started](GettingStarted.md).
1. [Dependency injection: server feature](DependencyInjection.md#server-feature)
— host a server and configure its endpoints, security, and node managers.
2. [Node managers: start with a model](NodeManagers.md#start-with-a-model) —
generate a node manager from your model and attach callbacks.
[Complete method invocation results](NodeManagers.md#complete-method-results-and-diagnostic-forwarding) covers
ordered output values and resolved operation/input diagnostics.
[Your first information model](FirstModel.md) is a complete example.
3. [Runtime NodeSets](RuntimeNodeSets.md#quick-start-examples) — load NodeSet2
models without generated code when models change independently of your
application.
4. [Asynchronous server support](AsyncServerSupport.md) — implement service and
node-manager callbacks asynchronously.
### PubSub path
A PubSub application needs neither a client nor a server, so the Getting
started exercise and the other two paths are optional here.
1. [Concepts: client/server and PubSub](Concepts.md#clientserver-and-pubsub) —
publishers, subscribers, and datasets.
2. [Run a first publisher and subscriber](PubSub.md#run-a-first-publisher-and-subscriber)
— exchange signed and encrypted messages on one computer with the
[reference PubSub sample](../samples/PubSub/ConsoleReferencePubSubClient/README.md).
3. [PubSub guide](PubSub.md) — the fluent builder, hosting, configuration,
encodings, and security.
4. [Transport selection](PubSub.md#transports) — UDP, Ethernet, MQTT, and Kafka.
## 3. Add data types and application services
Assumes the client or server path. Choose the capabilities your application
needs.
### Data types and models
- [Source-generated data types](SourceGeneratedDataTypes.md) — generate
encodeable implementations for your own structures.
- [Complex types](ComplexTypes.md) — decode server-defined structures and
enumerations at run time.
- [Model dependencies](ModelDependencies.md) — compose models that depend on
other models.
- [NodeId assignment](NodeIdAssignment.md) — control the identifiers of nodes
created at run time.
- [Schema generation](SchemaGeneration.md) — produce XSD, BSD, and JSON schemas
for data types.
### Application services
- [State machines](StateMachines.md) — define, drive, and observe state
transitions.
- [Alarms and conditions](AlarmsAndConditions.md) — raise, acknowledge, and
stream alarms. Alarm conditions use state machines, for example for shelving.
- [Historical access](HistoricalAccess.md) — store and read value and event
history.
- [Aggregates](Aggregates.md) — calculate processed history; read historical
access first.
- [File system client](FileSystemClient.md) — transfer files through the
standard file objects.
- [Alias names](AliasNames.md) — find nodes through named aliases.
- [Node management](NodeManagement.md) — let clients add and delete nodes and
references.
- [Model change tracking](ModelChangeTracking.md) — keep client caches current
when the address space changes.
- [NodeSet export](NodeSetExport.md) — export a server's address space to
NodeSet2 XML.
## 4. Use companion models
Companion specifications define models for particular industries and device
types; [Concepts](Concepts.md#information-models-and-companion-specifications)
explains how they relate to the base model. These libraries assume the server
path and, for typed client access, the client path. The packages load the
models that each model depends on.
- [Device Integration](DeviceIntegration.md) (OPC 10000-100) —
devices, topology, and locking.
- [Asset Management Basics](AMB.md) (OPC 10000-110; preview
package) — make devices, machines, pumps or scales manageable assets:
discovery, identification, health alarms, maintenance, documentation links
and locations. Read Device Integration first.
- [Software update](SoftwareUpdate.md) (OPC 10000-100) —
software package storage, installation, and confirmation. Read Device
Integration first.
- [ISA-95](ISA95.md) (OPC 10030 and OPC 10031-4) — the common
model and job control.
- [Positioning](Positioning.md) (OPC 10000-210 and OPC 10000-211; preview
package) — relative frames and geographic positions.
- [Machinery](Machinery.md) (OPC 40001-1, -2, -3, -4 and -101; preview
package) — machines with identification, server-driven state machines,
process values, job management, energy and result transfer, based on the
Industrial Automation, Device Integration, PA-DIM, ECM and ISA-95 models.
- [Pumps](Pumps.md) (OPC 40223; preview package) — pumps and vacuum pumps,
published both as Device Integration devices and as Machinery machines.
- [Machine Vision](Vision.md) (OPC 40100-1 and OPC 40100-2) —
released control, recipes, configurations, results, assets, and condition monitoring,
with Vision/Perception composition and Machinery hosting.
- [Scales](Scales.md) (OPC 40200 and OPC 30050; preview package) — weighing
technology with every scale kind, scale systems, recipes and PackML state
machines, based on the Machinery model.
- [Robotics](Robotics.md) (OPC 40010-1; preview package) — motion-device
systems, based on the Industrial Automation and Device Integration models.
The guide's draft Robot Intent model is listed in [stage 7](#7-draft-and-experimental-capabilities).
- [WoT connectivity](WoTConnectivity.md) (OPC 10100-1; preview package) —
connect Web of Things assets. Its registry extension is listed in stage 7.
For more examples, including the Pumps and Machinery models, see the
[companion-model samples](Samples.md#companion-model-samples).
## 5. Prepare for production
Builds on the certificate trust you used in [Getting started](GettingStarted.md).
Before you deploy a client or server, work through the
[production readiness checklist](ProductionChecklist.md). It links to these
guides for the details:
1. [Certificates](Certificates.md) — certificate stores, trust, and chain
validation.
2. [Identity providers](IdentityProviders.md) — authenticate users on clients
and servers.
3. [Role-based user management](RoleBasedUserManagement.md) — map identities to
roles and permissions.
4. [Certificate manager](CertificateManager.md) — certificate lifecycle,
rotation, and remote updates.
5. [Diagnostics](Diagnostics.md) — logging, metrics, tracing, auditing, and
packet capture.
6. [Rate limiting](RateLimiting.md) — admission limits and busy signals during
connection storms.
7. [Server resource isolation](ResourceIsolation.md) — per-caller limits and
reserved capacity for startup and recovery.
8. [Profiles and facets](Profiles.md) — implemented profiles and platform
boundaries.
9. [Container reference server](ContainerReferenceServer.md) — run the
reference server in a container.
## 6. Advanced integration, reliability, and scale
Each group names the stages it assumes.
### Transports and integration
Assumes the client or server path.
- [Transports](Transports.md) — UA-TCP, HTTPS, and WebSocket transports.
- [REST binding](WebApi.md) — OpenAPI mapping, encoding negotiation, and HTTP
authentication.
- [OPC UA over OpenAPI](OpenApi.md) — serve the OpenAPI document the stack
generates from its REST routes and call the server from generated REST
clients.
- [Reverse Connect](ReverseConnect.md) — server-initiated connections.
- [Session-less invocation](SessionlessInvocation.md) — let clients call
Read, Browse, Call and the other §6.3 Services without a Session.
- [PubSub external-server adapter](PubSub.md#binding-pubsub-to-an-external-opc-ua-server-client-session-adapters)
— bind PubSub to an OPC UA server through a managed client session. Assumes
the client and PubSub paths.
- [PubSub transcoding](PubSub.md#transcoding) — convert encodings, values, and
metadata between PubSub messages.
- [MCP server](McpServer.md) — let AI agents browse, read, write, and diagnose
OPC UA servers.
- [WoT / NodeSet conversion](WoTNodeSetConversion.md) and
[WoT protocol bindings](WotBindings.md) — convert Thing Descriptions and add
protocol bindings. Read WoT connectivity first.
### Session recovery and performance
The subscription guides assume the client path; the sizing guides assume
[Diagnostics](Diagnostics.md).
- [TransferSubscriptions](TransferSubscription.md) — move server subscriptions
to a new session.
- [Durable subscriptions](DurableSubscription.md) — keep subscriptions and
queued notifications while clients are disconnected.
- [Generation-bound session clients](SessionBindings.md) — capture dispatch,
session identity and mapping snapshots without reconnecting to a replacement peer.
- [Server scalability](ServerScalability.md) — sizing limits and bottlenecks.
- [Benchmarks](Benchmarks.md) — measured performance and methodology.
<a id="global-discovery-server-gds"></a>
### Security infrastructure and fleet management
Assumes [stage 5](#5-prepare-for-production).
- [ECC profiles](EccProfiles.md) — elliptic-curve security policies and their
platform requirements.
- [Crypto providers](CryptoProvider.md) — replace the platform cryptography and
keep private keys in hardware.
- [Provisioning mode](ProvisioningMode.md) — configure a new server securely
before exposing application data.
- [Global Discovery Server](GDS.md) — application registration and central
certificate management.
- [GDS sample](../samples/Gds/README.md) — a runnable onboarding workflow.
- [AuthorizationService](AuthorizationService.md) — issue access tokens.
- [KeyCredentialService](KeyCredentialService.md) — manage credentials for
services that are not OPC UA. Its issued-token bridge is listed in stage 7.
### High availability and deployment
Assumes a working single server and [stage 5](#5-prepare-for-production).
- [High availability](HighAvailability.md) (preview package) — redundancy,
failover, and distributed state.
- [Replica-consistent NodeIds](ReplicaNodeIdentity.md) (preview package) — keep
node identifiers identical across replicas; required before replicating an
address space.
- [Kubernetes](Kubernetes.md) (preview package) — cluster deployment,
discovery, readiness, and secrets. Read high availability first.
- [PubSub high availability](PubSubHighAvailability.md) (preview package) —
redundant publishers and subscribers. Assumes the PubSub path.
### Native AOT publishing
Publish an application as a native executable without a JIT compiler; start
with [Native AOT: publish an application](NativeAoT.md#publish-an-application).
Feature-specific guidance:
- [Servers with generated node managers](NodeManagers.md#nativeaot-publishing)
- [Applications hosted with dependency injection](DependencyInjection.md#native-aot)
- [PubSub applications](PubSub.md#native-aot)
## 7. Draft and experimental capabilities
These guides implement working-group drafts or experimental extensions.
Namespace URIs, NodeIds, and APIs can change before the specifications are
published, so evaluate them before you depend on them in production. Each
guide describes its current limitations.
- [xRegistry](XRegistry.md) (draft model; preview package) — the generic
registry base model, resource storage, and federation.
- [AI model management](AI.md) (draft model; preview package) — model
catalogues, deployments, inference, and learning jobs. Builds on xRegistry.
- [Perception model](Vision.md#perception-model) (draft model; optional OpenUSD renderer is preview-only) — capture, media,
feedback, and client workflows.
- [Robot Intent](Robotics.md#robot-intent) (draft model; preview package) —
task-level motion commands. Does not require the Robotics model.
- [OpenUSD](OpenUsd.md) (draft models; preview package) — bind values to OpenUSD
scenes and materialize scenes in the address space.
- [WoT Connectivity 1.1 registry](WoTConnectivity.md#11-wot-connectivity-11-registry-and-materialization-preview)
(draft model; preview package) — registry and materialization. Read WoT
connectivity first.
- [KeyCredential issued-token bridge](KeyCredentialService.md#experimental-keycredential-issued-token-bridge)
(experimental).
These samples combine several draft or preview capabilities. Read the guides
for their models first:
- [Bin picking cell](../samples/Robotics/BinPickingCell/README.md) — Robot
Intent, Vision, and an OpenUSD scene.
- [Visual inspection cell](../samples/Vision/VisualInspectionCell/README.md) —
Vision, AI model management, and ISA-95 job control.
- [WoT aggregation sample](../samples/WotCon/README.md) — load Device
Integration, Machinery, and Pumps models from WoT documents through the WoT
Connectivity 1.1 registry, and bind them to two OPC UA source servers.
- [Generator sample model](../samples/OpenUsd/GeneratorServer/Generators.md)
(draft model) — generating-set simulation and scene composition.
<a id="reference-application-related"></a>
## Reference and upgrade
- [What's New in 2.0](WhatsNewIn2.0.md) — a summary of new capabilities.
- [Migration Guide](MigrationGuide.md) — upgrade from 1.5.378, with
[topic-specific 2.0 guides](migrate/2.0.x/README.md) and
[PubSub migration](migrate/2.0.x/pubsub.md).
- [Reference client](../samples/Reference/ConsoleReferenceClient/README.md) —
command-line configuration and transport profiles.
- [Reference server](../samples/README.md) — hosting and compliance-test setup.
- [Reference PubSub client](../samples/PubSub/ConsoleReferencePubSubClient/README.md)
— publisher, subscriber, and external-adapter modes.
The Windows Forms reference applications are maintained in the
[Samples repository](https://github.com/OPCFoundation/UA-.NETStandard-Samples).
## Contributing and maintaining the SDK
These documents describe building and maintaining this repository, not using
the SDK in an application:
- [Developer Guide](DeveloperGuide.md) — prerequisites, build, tests, and coding
conventions.
- [Continuous integration](DeveloperGuide.md#continuous-integration) —
pipelines and coverage gates.
- [Native AOT test harness](NativeAoT.md#test-harness-overview) — build, run,
and extend the Native AOT compatibility tests.
- [Release process](ReleaseProcess.md) — release branches, versioning,
backports, and recovery.
- [Redundancy sample tests](RedundancySampleTests.md) — process-level failover
and soak validation.
- [Fuzz testing](../fuzzing/Fuzzing.md) — encoder, certificate, and network
campaigns.
Reference in New Issue View Git Blame Copy Permalink