diff options
| author | Alex Efros <powerman@powerman.name> | 2024-06-16 18:39:53 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-06-16 18:39:53 +0300 |
| commit | 8af7043c5a005fc6ef24fd4a67ad190c0f67219e (patch) | |
| tree | 18fe87f5af3ce0ef0148c183f7a8dad9375ba4a7 /src | |
| parent | 264c607f7a37d6022dd4d4ef5ab1b2903ac68f1b (diff) | |
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>
Diffstat (limited to 'src')
| -rw-r--r-- | src/go/collectors/go.d.plugin/modules/nvme/metadata.yaml | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/src/go/collectors/go.d.plugin/modules/nvme/metadata.yaml b/src/go/collectors/go.d.plugin/modules/nvme/metadata.yaml index d787dbc22f..98f35af655 100644 --- a/src/go/collectors/go.d.plugin/modules/nvme/metadata.yaml +++ b/src/go/collectors/go.d.plugin/modules/nvme/metadata.yaml @@ -45,6 +45,28 @@ modules: - title: Install nvme-cli description: | See [Distro Support](https://github.com/linux-nvme/nvme-cli#distro-support). Install `nvme-cli` using your distribution's package manager. + - title: "For Netdata running in a Docker container: grant NVMe device access" + description: | + Your NVMe devices need to be accessible within the Docker container for Netdata to monitor them. + + Include the following option in your `docker run` command or add the device mapping in your `docker-compose.yml` file: + + - `docker run` + + ```bash + --device '/dev/nvme0n1:/dev/nvme0n1' + ``` + + - `docker-compose.yml` + + ```yaml + services: + netdata: + devices: + - "/dev/nvme0n1:/dev/nvme0n1" + ``` + + **Note**: Replace `/dev/nvme0n1` with your actual NVMe device name. configuration: file: name: go.d/nvme.conf |