Update nvme/metadata: add how to use in a docker (#17909)
* Update nvme/metadata: add how to use in a docker * improve wording * yamllint please --------- Co-authored-by: ilyam8 <ilya@netdata.cloud>
Alex Efros committed
Jun 16, 2024 at 18:39 UTC
8af7043c5a005fc6ef24fd4a67ad190c0f67219e
1 file changed
+22
src/go/collectors/go.d.plugin/modules/nvme/metadata.yaml
+22
@@ -45,6 +45,28 @@ modules:
45
- title: Install nvme-cli
46
description: |
47
See [Distro Support](https://github.com/linux-nvme/nvme-cli#distro-support). Install `nvme-cli` using your distribution's package manager.
48
+ - title: "For Netdata running in a Docker container: grant NVMe device access"
49
+ description: |
50
+ Your NVMe devices need to be accessible within the Docker container for Netdata to monitor them.
51
+
52
+ Include the following option in your `docker run` command or add the device mapping in your `docker-compose.yml` file:
53
+
54
+ - `docker run`
55
+
56
+ ```bash
57
+ --device '/dev/nvme0n1:/dev/nvme0n1'
58
+ ```
59
+
60
+ - `docker-compose.yml`
61
+
62
+ ```yaml
63
+ services:
64
+ netdata:
65
+ devices:
66
+ - "/dev/nvme0n1:/dev/nvme0n1"
67
+ ```
68
+
69
+ **Note**: Replace `/dev/nvme0n1` with your actual NVMe device name.
70
configuration:
71
file:
72
name: go.d/nvme.conf