hardware_report 0.1.7

Hardware inventory reports for observability and cluster acceptance testing
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123

# Deployment Guide

## Table of Contents

- [Production Deployment](#production-deployment)
- [Automation Integration](#automation-integration)
- [Troubleshooting](#troubleshooting)

## Production Deployment

### Pre-built binary (recommended)

```bash
# Download tarball (x86_64 example; use aarch64 asset names on ARM)
curl -sL https://api.github.com/repos/sfcompute/hardware_report/releases/latest \
  | grep "browser_download_url.*hardware_report-linux-x86_64.*\.tar\.gz" | cut -d '"' -f 4 | wget -qi -
tar xzf hardware_report-linux-x86_64-*.tar.gz

# Install to PATH
sudo install -m 755 hardware_report-linux-x86_64 /usr/local/bin/hardware_report

# Runtime tools (Debian/Ubuntu example)
sudo apt-get install -y numactl ipmitool ethtool pciutils

sudo hardware_report
```

### Multi-server deployment with Ansible

```bash
# After extracting the release tarball locally:
ansible servers -m copy -a "src=hardware_report-linux-x86_64 dest=/usr/local/bin/hardware_report mode=0755"
ansible servers -m apt -a "name=numactl,ipmitool,ethtool,pciutils state=present" --become
ansible servers -m shell -a "sudo /usr/local/bin/hardware_report" --become
```

### Binary deployment (scp)

```bash
curl -sL https://api.github.com/repos/sfcompute/hardware_report/releases/latest \
  | grep "browser_download_url.*hardware_report-linux-x86_64.*\.tar\.gz" | cut -d '"' -f 4 | wget -qi -
tar xzf hardware_report-linux-x86_64-*.tar.gz

scp hardware_report-linux-x86_64 user@target:/tmp/
ssh user@target "sudo install -m 755 /tmp/hardware_report-linux-x86_64 /usr/local/bin/hardware_report"
ssh user@target "sudo apt-get install -y numactl ipmitool ethtool pciutils"
```

## Automation Integration

### Scheduled Execution (systemd timer)

```ini
# /etc/systemd/system/hardware-report.service
[Unit]
Description=Hardware Report Collection

[Service]
Type=oneshot
ExecStart=/usr/bin/hardware_report
WorkingDirectory=/var/lib/hardware-report

# /etc/systemd/system/hardware-report.timer
[Unit]
Description=Run Hardware Report daily

[Timer]
OnCalendar=daily
Persistent=true

[Install]
WantedBy=timers.target
```

```bash
sudo systemctl enable --now hardware-report.timer
```

### Cron

```bash
# Daily at 2 AM
echo "0 2 * * * root /usr/bin/hardware_report" | sudo tee /etc/cron.d/hardware-report
```

## Troubleshooting

### Permission Issues

```bash
# Most hardware detection requires root
sudo hardware_report

# Or add user to required groups
sudo usermod -aG disk,video $USER
```

### Missing Dependencies

```bash
# Check which tools are available
which numactl ipmitool ethtool lspci dmidecode nvidia-smi

# Install missing (Ubuntu/Debian)
sudo apt-get install -y numactl ipmitool ethtool pciutils dmidecode
```

### Incomplete GPU Detection

```bash
# Verify NVIDIA driver is loaded
nvidia-smi

# If not working, install drivers
sudo apt-get install -y nvidia-driver-535  # or appropriate version
```

### Debug Output

```bash
# Enable verbose logging
RUST_LOG=debug sudo hardware_report
```