gilles/scrutiny
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update docs.

Browse Source
This commit is contained in:
Jason Kulatunga
2022-10-12 20:58:41 -07:00
parent 578a262d90
commit d7b45e5f01
2 changed files with 9 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/SUPPORTED_NAS_OS.md
+2 -1
View File
@@ -11,8 +11,9 @@ in `docs/guides/` or elsewhere) it will be linked here.
- [ ] OMV - [ ] OMV
- [ ] Amahi - [ ] Amahi
- [ ] Running in a LXC container - [ ] Running in a LXC container
- [x] [PFSense](./INSTALL_UNRAID.md) - [x] [PFSense](./INSTALL_PFSENSE.md)
- [x] QNAP - [x] QNAP
- [x] [RockStor](https://rockstor.com/docs/interface/docker-based-rock-ons/scrutiny.html) - [x] [RockStor](https://rockstor.com/docs/interface/docker-based-rock-ons/scrutiny.html)
- [ ] Solaris/OmniOS CE Support - [ ] Solaris/OmniOS CE Support
- [ ] Kubernetes - [ ] Kubernetes
- [x] [Windows](./INSTALL_MANUAL_WINDOWS.md)
docs/TROUBLESHOOTING_DEVICE_COLLECTOR.md
+7 -3
View File
@@ -61,7 +61,8 @@ using a collector config file. See [example.collector.yaml](/example.collector.y
> NOTE: If you use docker, you **must** pass though the RAID virtual disk to the container using `--device` (see below) > NOTE: If you use docker, you **must** pass though the RAID virtual disk to the container using `--device` (see below)
> >
> This device may be in `/dev/*` or `/dev/bus/*`. > This device may be in `/dev/*` or `/dev/bus/*`.
> If you do not see a virtual device file `/dev/bus/*` you may need to use the `--privileged` flag. See [#366 for more info](https://github.com/AnalogJ/scrutiny/issues/366#issuecomment-1253196407)
> >
> If you're unsure, run `smartctl --scan` on your host, and pass all listed devices to the container. > If you're unsure, run `smartctl --scan` on your host, and pass all listed devices to the container.
@@ -92,7 +93,7 @@ devices:
type: type:
- aacraid,0,0,0 - aacraid,0,0,0
- aacraid,0,0,1 - aacraid,0,0,1
# HPE Smart Array example: https://github.com/AnalogJ/scrutiny/issues/213 # HPE Smart Array example: https://github.com/AnalogJ/scrutiny/issues/213
- device: /dev/sda - device: /dev/sda
type: type:
@@ -100,8 +101,11 @@ devices:
- 'cciss,1' - 'cciss,1'
``` ```
>
### NVMe Drives ### NVMe Drives
As mentioned in the [README.md](/README.md), NVMe devices require both `--cap-add SYS_RAWIO` and `--cap-add SYS_ADMIN`
As mentioned in the [README.md](/README.md), NVMe devices require both `--cap-add SYS_RAWIO` and `--cap-add SYS_ADMIN`
to allow smartctl permission to query your NVMe device SMART data [#26](https://github.com/AnalogJ/scrutiny/issues/26) to allow smartctl permission to query your NVMe device SMART data [#26](https://github.com/AnalogJ/scrutiny/issues/26)
When attaching NVMe devices using `--device=/dev/nvme..`, make sure to provide the device controller (`/dev/nvme0`) When attaching NVMe devices using `--device=/dev/nvme..`, make sure to provide the device controller (`/dev/nvme0`)