mirror of
https://github.com/OPCFoundation/UA-.NETStandard.git
synced 2026-10-21 17:16:16 +08:00
5899354441
# Description Remove stock phrasing and correct misleading or inconsistent technical documentation. The initial two passes covered 367 Markdown files, followed by an interactive review of 169 editorial flags. The U5 interpretation originally deferred in that review has since received the upstream Mantis answer recorded by #4843; remaining server/spec follow-ups stay explicit in the CTT log. - Correct package responsibilities, migration steps, API names, ownership, protocol descriptions and links. Keep bundled migration guides synchronized. Preserve historical conclusions as historical records with separate re-check notes. - Provide at least two rendered TOC levels throughout `docs/`. Convert appropriate architecture figures to Mermaid without changing code examples, transcripts or historical quotations. - Address the October 19 feedback with concrete setup/migration instructions, corrected certificate paths and PubSub names, shorter repeated caveats, consistent XML comments, and a full review of the Concepts guide. Retain #4839's API corrections. - Integrate #4841's runtime/performance guidance and review incoming/recent prose. Preserve dated measurements rather than claiming new benchmark runs; clarify allocation ratios, startup-only processor settings, JIT warm-up and the benchmark commit's scope. Missing raw measurement artifacts and repeat ranges remain tracked by #4842. - Merge master through `e8c5d800a` in `32c6394b7`. Resolve the CTT log conflict using the updated Mantis states and OPC answers, retaining historical framing and re-checks for C28/C32/C43. - Address the latest naming/index feedback in `adb5bf693`: rename the guides to `docs/WotCon.md` and `docs/WotNodeSetConversion.md`; move the provider and DataType-declaration contracts into the conversion guide and remove `docs/WoT.md`. Rename `samples/DI` to `samples/Di` and `samples/Isa95` to `samples/ISA95`. Add content-index READMEs to Di, FluentApi, ISA95, Lds and PubSub; update solution entries, project references, Docker/CI paths, test fixture paths and documentation links with exact casing. **WoT guide scope.** This branch retains the detailed conversion guide that #4758 had replaced with an anchor stub. Conversion limits, verified document sets, preservation rules and provider ownership now live together in `WotNodeSetConversion.md`; binding/runtime guidance remains in `WotBindings.md` and `WotCon.md`. The design-rationale/test-ledger prose was shortened, the oversized argument-table cell moved into its section, and existing anchors preserved. **SDK policy is a separate, explicit user-directed change.** `global.json` sets a stable minimum of `10.0.400`, `rollForward: latestMajor`, and `allowPrerelease: false`. Newer major SDKs are permitted; CI's explicit SDK pins are unchanged. README, GettingStarted, DeveloperGuide and Recycling instructions reflect the possible analyzer differences. The image-contract regression fix accepts compatible stable SDK images instead of requiring exact equality with the floor. The latest four rename/index threads are resolved after publication. Three older threads remain open: universal obsolete-removal timing, unconditional nonce-strength wording, and a blanket Vision NativeAOT claim. Existing implementation/evidence constraints are explained in their inline replies. The two-level TOCs remain as requested. ## Validation - `git diff --check` and staged diff checks: passed. The untouched upstream AutoID NodeSet retains its provenance bytes, including two existing license-header trailing spaces. - `.\.azurepipelines\validate-migration-plugin.ps1`: passed; 15 bundled migration documents and manifests synchronized. - Documentation/path validation: **101** documents retain two rendered TOC levels (**2,228** entries), with idempotent formatting. **52** new relative links and their anchors passed exact-case checks. No tracked references to the old guide/sample paths remain. Both relocated provider-contract sections are preserved in the destination. - `dotnet sln UA.slnx list`: passed; shows the renamed Di/ISA95 projects and the existing FluentApi/Lds/PubSub projects. Updated solution and pump ProjectReference paths also passed exact-case existence checks. - Latest focused commands, run from the repository root: ```powershell # Passed: 61 channel send-order and reconnect tests. dotnet test tests\Opc.Ua.Core.Tests\Opc.Ua.Core.Tests.csproj -p:CustomTestTarget=net10.0 --filter 'FullyQualifiedName~UaSCBinaryChannelSendOrderTests|FullyQualifiedName~TcpReconnectKeyAgreementTests' --verbosity minimal # Passed: 5 pump datasheet tests; builds the renamed pump sample. dotnet test tests\Opc.Ua.Di.Tests\Opc.Ua.Di.Tests.csproj -p:CustomTestTarget=net10.0 --filter 'FullyQualifiedName~PumpDatasheetConformanceTests' --verbosity minimal # Passed: 4 repository NodeSet path/round-trip tests, including the moved pump models. dotnet test tests\Opc.Ua.Types.Tests\Opc.Ua.Types.Tests.csproj -p:CustomTestTarget=net10.0 --filter 'FullyQualifiedName~RepositorySourceSurvivesSerializedLinkedPartitionsAsync' --verbosity minimal # Passed: build, zero warnings/errors. dotnet build samples\ISA95\MinimalIsa95Server\MinimalIsa95Server.csproj -p:CustomTestTarget=net10.0 -f net10.0 --verbosity minimal # Passed: dependent sample-test project build, zero warnings/errors. dotnet build tests\Opc.Ua.WotCon.Samples.Tests\Opc.Ua.WotCon.Samples.Tests.csproj -p:CustomTestTarget=net10.0 -f net10.0 --verbosity minimal ``` Earlier focused integration checks passed 2,620 tests across AutoID, event queues/scheduling, source generation, MCP/package profiles and WoT. Both reviewed Mermaid diagrams rendered locally without network access. These checks are not a full solution run. The full solution has **not** been rerun for this review. Earlier `dotnet test UA.slnx -p:CustomTestTarget=net10.0 --verbosity quiet` did not pass: three AOT projects rejected VSTest and 20 Vision tests failed during graphics initialization with `OutOfMemoryException`. Remaining long-running tests were stopped at the user's request. A focused Vision rerun passed 558 tests and reproduced those 20 failures. The earlier `dotnet test UA.slnx -p:CustomTestTarget=net48 --verbosity quiet` was blocked by the former SDK pin and was not retried after the policy change. The user approved proceeding with those limitations documented; current remote CI is not claimed green. ## Related Issues - Follow-up #4842 tracks the requested 2.0.2+ benchmark/tuning and diagnostic-tool documentation refresh. #4841 supplies documentation and earlier results, not all newly requested measurements. - #4758 explains the conversion guide's earlier consolidation; the current provider contracts are now consolidated into `WotNodeSetConversion.md`. - #4839 supplies the reviewed API corrections; #4843 supplies the updated CTT issue record. - The original prose cleanup and SDK policy were user-requested without a source issue. No new runtime architecture is introduced by these documentation edits. ## 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. - [ ] 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. - [ ] I have addressed **all** PR feedback received. --------- Co-authored-by: Roman Ettlinger <romanett98@gmail.com> Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
105 lines
4.3 KiB
Docker
105 lines
4.3 KiB
Docker
# ModelManagementServer container image.
|
|
#
|
|
# Multi-stage, framework-dependent build on the .NET AzureLinux 3 base
|
|
# images, following samples/Di/PumpDeviceIntegrationServer/Dockerfile.
|
|
#
|
|
# IMPORTANT: the build context MUST be the repository ROOT (not this
|
|
# folder), because the project pulls in the whole source tree. Build it
|
|
# like this:
|
|
#
|
|
# # from the repository root:
|
|
# docker build -f samples/AI/ModelManagementServer/Dockerfile \
|
|
# -t modelmanagementserver:local .
|
|
#
|
|
# The final image runs as a non-root user and listens on 0.0.0.0:62640
|
|
# (override host/port via the `host` / `port` environment variables).
|
|
|
|
FROM --platform=$BUILDPLATFORM mcr.microsoft.com/dotnet/sdk:10.0-azurelinux3.0 AS build
|
|
WORKDIR /src
|
|
|
|
# JIT is disabled for the source generators unless W^X is turned off on
|
|
# some kernels; match the existing sample Dockerfiles.
|
|
ENV DOTNET_EnableWriteXorExecute=0
|
|
|
|
# Copy the full repository. The project pulls in many transitive
|
|
# ProjectReferences, a source-generator analyzer, and an AdditionalFiles
|
|
# NodeSet2 XML input, so a per-csproj copy list would be fragile.
|
|
COPY . .
|
|
|
|
# Fail fast with a clear message when the build context is not the
|
|
# repository root (UA.slnx is the root marker).
|
|
RUN test -f UA.slnx || { \
|
|
echo ''; \
|
|
echo 'ERROR: build the repository ROOT as the Docker context, not this folder.'; \
|
|
echo ' The image needs the full source tree (src/, tools/).'; \
|
|
echo ''; \
|
|
echo ' From the repository root run:'; \
|
|
echo ' docker build -f samples/AI/ModelManagementServer/Dockerfile -t modelmanagementserver .'; \
|
|
echo ''; \
|
|
exit 1; \
|
|
}
|
|
|
|
# The project imports use lower-case tools/, but the repository directory is
|
|
# Tools/. Windows hides the difference; the Linux container does not.
|
|
RUN if [ ! -d tools ] && [ -d Tools ]; then ln -s Tools tools; fi
|
|
|
|
# MSBuild in the Linux SDK needs a Unix separator and stable logical names here
|
|
# so the source generator embeds the design resources it reads during publish.
|
|
RUN sed -i 's#<EmbeddedResource Include="Design\\\*">#<EmbeddedResource Include="Design/*" LogicalName="Opc.Ua.SourceGeneration.Design.%(Filename)%(Extension)">#' \
|
|
Tools/Opc.Ua.SourceGeneration.Core/Opc.Ua.SourceGeneration.Core.csproj
|
|
|
|
ARG Version
|
|
ARG SimpleVersion
|
|
ARG InformationalVersion
|
|
|
|
RUN dotnet restore "samples/AI/ModelManagementServer/ModelManagementServer.csproj" \
|
|
--force -p:NoHttps=true
|
|
|
|
# PublishAot is off for this sample. The workload-identity credential path
|
|
# resolves tokens through a library that serialises by reflection, which the
|
|
# AOT analyzer warns on and this repository builds warnings as errors. Nothing
|
|
# in the OPC UA surface needs AOT; see the sample README.
|
|
RUN dotnet publish "samples/AI/ModelManagementServer/ModelManagementServer.csproj" \
|
|
--no-restore \
|
|
-c Release \
|
|
-f net10.0 \
|
|
-p:PublishAot=false \
|
|
-p:NoHttps=true \
|
|
-p:Dockerbuild=true \
|
|
-p:Version=${Version} \
|
|
-p:AssemblyVersion=${SimpleVersion} \
|
|
-p:FileVersion=${Version} \
|
|
-p:InformationalVersion=${InformationalVersion} \
|
|
-o /app/publish
|
|
|
|
FROM --platform=$BUILDPLATFORM mcr.microsoft.com/dotnet/runtime:10.0-azurelinux3.0 AS layout
|
|
|
|
# Azure Linux forces the SymCrypt OpenSSL provider as the default for all
|
|
# EVP operations. SymCrypt's ECDSA SignHash path rejects the self-signing
|
|
# call the OPC UA stack makes when creating its ECC application-instance
|
|
# certificate. Clearing the forced default lets the standard OpenSSL
|
|
# default provider handle ECDSA.
|
|
COPY --from=build /app/publish /layout/app/
|
|
RUN mkdir -p /openssl /layout/app/pki /layout/run/secrets/ai \
|
|
&& cp -p /etc/pki/tls/openssl.cnf /openssl/openssl.cnf \
|
|
&& sed -i 's/^default_properties = .*/default_properties = ""/' /openssl/openssl.cnf \
|
|
&& chown -R $APP_UID:0 /layout/app /layout/run/secrets/ai \
|
|
&& chmod -R g=u /layout/app /layout/run/secrets/ai
|
|
|
|
FROM mcr.microsoft.com/dotnet/runtime:10.0-azurelinux3.0-distroless-extra AS final
|
|
COPY --from=layout /openssl/openssl.cnf /etc/pki/tls/openssl.cnf
|
|
COPY --from=layout /layout/ /
|
|
WORKDIR /app
|
|
ENV HOME=/app
|
|
|
|
USER $APP_UID
|
|
|
|
# Bind to all interfaces so the endpoint is reachable from outside the
|
|
# container. Override with `-e host=...` / `-e port=...`.
|
|
ENV host=0.0.0.0 \
|
|
port=62640
|
|
|
|
EXPOSE 62640
|
|
|
|
ENTRYPOINT ["dotnet", "ModelManagementServer.dll"]
|