akka/akka-http

Document how to keep running an akka-http server in production

Open

#1,460 opened on Oct 9, 2017

View on GitHub
 (12 comments) (6 reactions) (0 assignees)Scala (1,311 stars) (598 forks)batch import
1 - triagedhelp wantedt:docs

Description

There was a feedback in Twitter.

https://twitter.com/brianclapper/status/917148072718798848

those past techniques aren’t working w/ this version of Akka HTTP. Documentation for non-toy cases would be awesome. ;-)

https://twitter.com/jlprat/status/917149279399108608

Agree, readLine is just for toy cases. iirc, HttpApp listens to SIGTERM as well as readLine. Thanks for the feedback about docs! 😊

Doc samples use readline to wait, which is not recommended in production.

Contributor guide

Tech stack
scala
Domain
backenddocumentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
ScalaAkka HTTPproduction deployment
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Examine the current documentation files for Akka HTTP server deployment, specifically the sections that use readLine. Review the source code for the HttpApp trait to understand its built in signal handling. Look at the comments in the issue for additional context. Propose a new documentation section that details production ready patterns, including graceful shutdown and how to run the server without blocking.