Skip to content

Commit 0515853

Browse files
kalyazinShadowCurse
authored andcommitted
doc(prod-host-setup): mention serial device rate limiter
Advertise the rate limiter as a recommended measure for serial device in prod host setup. Signed-off-by: Nikita Kalyazin <kalyazin@amazon.com>
1 parent 999430f commit 0515853

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

docs/prod-host-setup.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -27,17 +27,17 @@ recommended.
2727

2828
Firecracker implements the 8250 serial device, which is visible from the guest
2929
side and is tied to the Firecracker/non-daemonized jailer process stdout.
30-
Without proper handling, because the guest has access to the serial device, this
31-
can lead to unbound memory or storage usage on the host side. Firecracker does
32-
not offer users the option to limit serial data transfer, nor does it impose any
33-
restrictions on stdout handling. Users are responsible for handling the memory
34-
and storage usage of the Firecracker process stdout. We suggest using any
35-
upper-bounded forms of storage, such as fixed-size or ring buffers, using
36-
programs like `journald` or `logrotate`, or redirecting to `/dev/null` or a
37-
named pipe. Furthermore, we do not recommend that users enable the serial device
38-
in production. To disable it in the guest kernel, use the `8250.nr_uarts=0` boot
39-
argument when configuring the boot source. Please be aware that the device can
40-
be reactivated from within the guest even if it was disabled at boot.
30+
Without proper handling, because the guest has access to the serial device. This
31+
can lead to unbound memory or storage usage on the host side. Users are
32+
responsible for handling the memory and storage usage of the Firecracker process
33+
stdout. We recommend using the rate limiter for the serial data transfer that
34+
Firecracker offers or any upper-bounded forms of storage, such as fixed-size or
35+
ring buffers, using programs like `journald` or `logrotate`, or redirecting to
36+
`/dev/null` or a named pipe. Furthermore, we do not recommend that users enable
37+
the serial device in production. To disable it in the guest kernel, use the
38+
`8250.nr_uarts=0` boot argument when configuring the boot source. Please be
39+
aware that the device can be reactivated from within the guest even if it was
40+
disabled at boot.
4141

4242
If Firecracker's `stdout` buffer is non-blocking and full (assuming it has a
4343
bounded size), any subsequent writes will fail, resulting in data loss, until

0 commit comments

Comments
 (0)