Skip to content

Add Orleans Transport Layer Security (TLS) documentation#49512

Merged
meaghanlewis merged 12 commits intomainfrom
copilot/add-orleans-tls-documentation
Mar 11, 2026
Merged

Add Orleans Transport Layer Security (TLS) documentation#49512
meaghanlewis merged 12 commits intomainfrom
copilot/add-orleans-tls-documentation

Conversation

Copy link
Contributor

Copilot AI commented Oct 28, 2025

  • Create new documentation article for Orleans TLS configuration
  • Add article to table of contents (toc.yml)
  • Create code snippets folder structure
  • Create C# sample code for silo TLS configuration
  • Create C# sample code for client TLS configuration
  • Test and validate all code snippets compile
  • Add ai-usage frontmatter to indicate AI-assisted content
  • Review and finalize documentation
  • Address code review feedback: Remove explicit protocol version setting to align with best practice of using OS defaults
  • Address PR comments:
    • Removed all Visual Basic examples
    • Updated code to use context.HostingEnvironment.IsDevelopment() instead of manual environment variable check
    • Added mTLS acronym to article title and description
    • Updated title to include "Orleans" product name
  • Add solution file and README to ensure samples build properly
Original prompt

This section details on the original issue you should resolve

<issue_title>[New article]: Orleans TLS documentation</issue_title>
<issue_description>### Proposed topic or title

Configuring Transport Layer Security (TLS) in Microsoft Orleans

Location in table of contents.

dotnet/orleans/host/

Reason for the article

Developers need to learn how to configure mutual TLS to secure deployments. There is an existing sample here, but full docs are needed.

Article abstract

Learn how to configure mTLS in Orleans to secure network communication between hosts.

Relevant searches

No response</issue_description>

<agent_instructions>Look at samples (https://github.com/dotnet/samples/tree/main/orleans/TransportLayerSecurity), Orleans code (https://github.com/dotnet/orleans), and API docs to see what needs to be considered. Read online docs for best practices such as https://learn.microsoft.com/en-us/dotnet/framework/network-programming/tls</agent_instructions>

Comments on the Issue (you are @copilot in this section)


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.


Internal previews

📄 File 🔗 Preview link
docs/orleans/host/transport-layer-security.md Orleans Transport Layer Security (TLS)
docs/orleans/toc.yml docs/orleans/toc

Copilot AI and others added 2 commits October 28, 2025 18:56
Co-authored-by: ReubenBond <203839+ReubenBond@users.noreply.github.com>
Co-authored-by: ReubenBond <203839+ReubenBond@users.noreply.github.com>
Copilot AI changed the title [WIP] Add documentation for configuring TLS in Orleans Add Orleans Transport Layer Security (TLS) documentation Oct 28, 2025
Copilot AI requested a review from ReubenBond October 28, 2025 19:04
@ReubenBond
Copy link
Member

@copilot please address the comments I left and address the failed GitHub Actions checks.

… update title

Co-authored-by: ReubenBond <203839+ReubenBond@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Oct 28, 2025

@copilot please address the comments I left and address the failed GitHub Actions checks.

Addressed all feedback in commit 3b308aa:

  • Removed all VB examples
  • Updated to use context.HostingEnvironment.IsDevelopment()
  • Added mTLS acronym to title and description
  • Updated title to "Orleans Transport Layer Security (TLS)"

All code examples compile successfully.

@ReubenBond
Copy link
Member

@copilot make sure the samples build

Copilot AI and others added 2 commits October 28, 2025 19:57
Co-authored-by: ReubenBond <203839+ReubenBond@users.noreply.github.com>
Co-authored-by: ReubenBond <203839+ReubenBond@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Oct 28, 2025

@copilot make sure the samples build

Verified samples build successfully. Added solution file in commit 1c0c8a9 and README in commit 07d6f8c for easier building. Both projects compile without errors or warnings.

@meaghanlewis meaghanlewis marked this pull request as ready for review March 11, 2026 16:49
Copilot AI review requested due to automatic review settings March 11, 2026 16:49
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds new Orleans documentation and accompanying snippet projects to show how to configure Transport Layer Security (TLS), including mutual TLS (mTLS) scenarios, for silo-to-silo and client-to-silo communication.

Changes:

  • Adds a new Orleans hosting article covering TLS configuration patterns, best practices, and references.
  • Updates the Orleans TOC to include the new TLS article.
  • Introduces buildable C# snippet projects for silo and client TLS configuration examples.

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 11 comments.

Show a summary per file
File Description
docs/orleans/toc.yml Adds the new TLS article entry under Orleans host documentation.
docs/orleans/host/transport-layer-security.md New how-to article describing TLS/mTLS configuration for Orleans silos and clients.
docs/orleans/host/snippets/transport-layer-security/csharp/SiloExample/SiloExample.csproj Adds a silo snippet project to compile TLS configuration examples.
docs/orleans/host/snippets/transport-layer-security/csharp/SiloExample/Program.cs Adds silo TLS example code blocks referenced by the article.
docs/orleans/host/snippets/transport-layer-security/csharp/ClientExample/ClientExample.csproj Adds a client snippet project to compile TLS configuration examples.
docs/orleans/host/snippets/transport-layer-security/csharp/ClientExample/Program.cs Adds client TLS example code blocks referenced by the article.
docs/orleans/host/snippets/transport-layer-security/.gitignore Ignores build outputs for the new snippet projects.

You can also share your feedback on Copilot code review. Take the survey.

meaghanlewis and others added 4 commits March 11, 2026 10:01
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Make the transport-layer-security snippets self-contained and runnable,
correct the client TLS callback guidance, and add sample README/solution.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Clarify why the runnable TLS sample loads the generated certificate into
user key storage and refresh the sample README before rerunning CI.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Snippets5000 failed because the transport-layer-security root contained
both a solution and per-project csproj files, making project discovery
ambiguous. Remove the extra solution and keep the README aligned with
direct per-project builds.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@meaghanlewis meaghanlewis merged commit efa296b into main Mar 11, 2026
11 checks passed
@meaghanlewis meaghanlewis deleted the copilot/add-orleans-tls-documentation branch March 11, 2026 22:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[New article]: Orleans TLS documentation

4 participants