docs: add operations runbook and update test count to 28
This commit is contained in:
1 parent
a151a8bebf
commit
6b567df015
1 file changed
+56
@@ -286,6 +286,62 @@ Actual output columns depend on the current implementation and input dataset.
|
|||||||
- Strengthen checkpoint recovery and API retry behavior.
|
- Strengthen checkpoint recovery and API retry behavior.
|
||||||
- Track ranking changes across releases and review significant shifts.
|
- Track ranking changes across releases and review significant shifts.
|
||||||
- Automate recurring regression reports and release checks.
|
- Automate recurring regression reports and release checks.
|
||||||
|
## Production Deployment & Operations Runbook
|
||||||
|
|
||||||
|
### Dashboard Service (`systemd`)
|
||||||
|
|
||||||
|
The multi-platform Streamlit dashboard runs in the background as a Linux systemd service.
|
||||||
|
|
||||||
|
**Check service status**
|
||||||
|
```bash
|
||||||
|
sudo systemctl status hiffi-dashboard --no-pager
|
||||||
|
```
|
||||||
|
|
||||||
|
**Restart after approved code or dataset updates**
|
||||||
|
```bash
|
||||||
|
sudo systemctl restart hiffi-dashboard
|
||||||
|
```
|
||||||
|
|
||||||
|
**View live application logs**
|
||||||
|
```bash
|
||||||
|
sudo journalctl -u hiffi-dashboard -f
|
||||||
|
```
|
||||||
|
|
||||||
|
**View the latest 100 log entries**
|
||||||
|
```bash
|
||||||
|
sudo journalctl -u hiffi-dashboard -n 100 --no-pager
|
||||||
|
```
|
||||||
|
|
||||||
|
**Enable automatic startup after server reboot**
|
||||||
|
```bash
|
||||||
|
sudo systemctl enable hiffi-dashboard
|
||||||
|
```
|
||||||
|
|
||||||
|
### Server Health Checks
|
||||||
|
|
||||||
|
Check available disk space:
|
||||||
|
```bash
|
||||||
|
df -h
|
||||||
|
```
|
||||||
|
|
||||||
|
Check memory usage:
|
||||||
|
```bash
|
||||||
|
free -h
|
||||||
|
```
|
||||||
|
|
||||||
|
List running application sessions:
|
||||||
|
```bash
|
||||||
|
tmux ls
|
||||||
|
```
|
||||||
|
|
||||||
|
### Operational Notes
|
||||||
|
|
||||||
|
- Confirm the service is active before restarting or stopping it.
|
||||||
|
- Check application logs if the dashboard becomes unavailable.
|
||||||
|
- Verify dashboard access after any restart or deployment.
|
||||||
|
- Back up important files before making production changes.
|
||||||
|
- Do not expose API keys, passwords, or other secrets in the repository.
|
||||||
|
- Confirm the configured service name and deployment paths before running commands.
|
||||||
|
|
||||||
## Summary
|
## Summary
|
||||||
|
|
||||||
|
|||||||
Reference in new issue
Block a user