From 6f2f84936b70503b8b8effa271e2a5ecaa11dce3 Mon Sep 17 00:00:00 2001
From: Ilya Mashchenko <ilya@netdata.cloud>
Date: Tue, 6 Dec 2022 17:33:08 +0200
Subject: [PATCH] docs: add a note to set container nofile ulimit for Fedora
users (#14092)
Fixes https://github.com/netdata/netdata/issues/14062
---
packaging/docker/README.md | 27 +++++++++++++++++++++++++++
1 file changed, 27 insertions(+)
diff --git a/packaging/docker/README.md b/packaging/docker/README.md
index d00262a1b0..11f3a6a12c 100644
--- a/packaging/docker/README.md
+++ b/packaging/docker/README.md
@@ -37,6 +37,33 @@ and unfortunately not something we can realistically work around.
## Create a new Netdata Agent container
+<details>
+<summary>Prerequisite steps for Fedora users</summary>
+
+There is a known issue with [Docker Engine on Fedora](https://docs.docker.com/engine/install/fedora/) where a task
+running in a container hangs and consumes 100% of the CPU core. The issue is not Netdata specific. When setting
+the `nofile` ulimit, the task performs normally.
+
+To fix the issue, add the following to the `/etc/docker/daemon.json` file and restart `docker.service`:
+
+```json
+{
+ "default-ulimits": {
+ "nofile": {
+ "Hard": 4096,
+ "Name": "nofile",
+ "Soft": 4096
+ }
+ }
+}
+```
+
+An alternative solution is to set ulimit `nofile` when creating a Netdata container
+with [docker run](https://docs.docker.com/engine/reference/commandline/run/#set-ulimits-in-container---ulimit)
+or [docker-compose](https://docs.docker.com/compose/compose-file/compose-file-v3/#ulimits).
+
+</details>
+
You can create a new Agent container using either `docker run` or Docker Compose. After using either method, you can
visit the Agent dashboard `http://NODE:19999`.