From 6b567df0151914e09d9383f3f9d34fc2c078f300 Mon Sep 17 00:00:00 2001 From: Srilekha Date: Wed, 28 Oct 2026 12:06:18 +0530 Subject: [PATCH] docs: add operations runbook and update test count to 28 --- README.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 56 insertions(+) diff --git a/README.md b/README.md index 26ff50b..3627d0a 100644 --- a/README.md +++ b/README.md @@ -286,6 +286,62 @@ Actual output columns depend on the current implementation and input dataset. - Strengthen checkpoint recovery and API retry behavior. - Track ranking changes across releases and review significant shifts. - 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