Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document Kestrel breaking changes, new API and new config in 5.0 #26141

Closed
halter73 opened this issue Sep 21, 2020 · 4 comments
Closed

Document Kestrel breaking changes, new API and new config in 5.0 #26141

halter73 opened this issue Sep 21, 2020 · 4 comments
Assignees
Labels
area-networking Includes servers, yarp, json patch, bedrock, websockets, http client factory, and http abstractions Docs This issue tracks updating documentation feature-kestrel
Milestone

Comments

@halter73
Copy link
Member

We need to update/write conceptual docs to reflect breaking changes, new API and new config in 5.0.

  1. New kestrel event counters (Added some kestrel event counters #21649)
    a) Related: Add docs on the EventCounters emitted by ASP.NET Core AspNetCore.Docs#18272
  2. PEM support ([HTTPS] Adds PEM support for Kestrel #23584)
    a) Related: Add section for loading PEM keys AspNetCore.Docs#19113
  3. Automatic config reload (Kestrel reloadable endpoint config #21072 & Enable Kestrel config reload in ConfigureWebHostDefaults #22528)
  4. SNI from config (Kestrel SNI from config #24286)
  5. Async ServerOptionsSelectionCallback UseHttps() overload (Add async ServerOptionsSelectionCallback UseHttps overload #25390)
  6. Use platform-default TLS/SSL protocol versions by default (Use default SslProtocols in Kestrel #22437)
  7. Obsolete the Libuv transport (Obsolete the Libuv transport #23480)
  8. "SslProtocols" settable via config (Kestrel Endpoints' "SslProtocols" settable via config (#22663) #22910)
  9. "ClientCertificateMode" settable via config (Load ClientCertificateMode from config #24076)

The following APIs are new, but might not warrant conceptual docs.

  1. custom request header decoder API to Kestrel (Add custom request header decoder API to Kestrel #23233)
  2. Inline scheduler option for Sockets transport (Add inline scheduler option for Sockets transport #24638)
  3. Add SocketTransportOption to enable/disable WaitForData (Add SocketTransportOption to enable/disable WaitForData #19396)

@Pilchie Would it be better to move this to https://github.com/dotnet/AspNetCore.Docs?

@halter73 halter73 added Docs This issue tracks updating documentation area-servers feature-kestrel labels Sep 21, 2020
@halter73 halter73 self-assigned this Sep 21, 2020
@Pilchie
Copy link
Member

Pilchie commented Sep 21, 2020

Tagging @mkArtakMSFT for thoughts on whether this should move to the Docs repo or stay here. Personally I spend a lot more time here.

@BrennanConroy BrennanConroy added this to the Next sprint planning milestone Sep 21, 2020
@ghost
Copy link

ghost commented Sep 21, 2020

Thanks for contacting us.
We're moving this issue to the Next sprint planning milestone for future evaluation / consideration. We will evaluate the request when we are planning the work for the next milestone. To learn more about what to expect next and how this issue will be handled you can read more about our triage process here.

@davidfowl
Copy link
Member

davidfowl commented Sep 27, 2020

@halter73 seems like we didn't fix the KestrelServer constructor breaking change. Is that being documented in here as well?

@halter73
Copy link
Member Author

We should fix it.

@jkotalik jkotalik closed this as completed Oct 9, 2020
@ghost ghost locked as resolved and limited conversation to collaborators Nov 8, 2020
@amcasey amcasey added area-networking Includes servers, yarp, json patch, bedrock, websockets, http client factory, and http abstractions and removed area-runtime labels Jun 2, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area-networking Includes servers, yarp, json patch, bedrock, websockets, http client factory, and http abstractions Docs This issue tracks updating documentation feature-kestrel
Projects
None yet
Development

No branches or pull requests

6 participants