Skip to content

chore: add readme for agent local db to be persistent #232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ambermingxin merged 1 commit into from
Jul 20, 2026
Merged

chore: add readme for agent local db to be persistent #232

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,20 @@ Built on top of [leptonai/gpud](https://github.com/leptonai/gpud)
- Non-intrusive: Read-only operations, no system modifications
- Production-ready: 24/7 datacenter operation

## Persistent Local State

The agent stores its node identity, enrollment metadata, and retained metrics and
events in `/var/lib/fleetint/fleetint.state` by default. The
`/var/lib/fleetint` directory must use persistent local storage that survives
agent and host restarts, reboots, upgrades, and reinstalls.
Comment on lines +26 to +29

@coderabbitai coderabbitai Bot Jul 20, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🗄️ Data Integrity & Integration | 🟠 Major | ⚡ Quick win

Document the non-root default state path.

internal/config/default.go:120-175 falls back to $HOME/.fleetint/fleetint.state when the agent is not running as root or /var/lib is unavailable. As written, operators may persist the wrong directory and lose identity/credentials across restarts or redeployments.

Proposed wording 
-The agent stores its node identity, enrollment metadata, and retained metrics and
-events in `/var/lib/fleetint/fleetint.state` by default.
+When running as root with `/var/lib` available, the agent stores its node
+identity, enrollment metadata, and retained metrics and events in
+`/var/lib/fleetint/fleetint.state`. Otherwise, the default is
+`$HOME/.fleetint/fleetint.state`. Persist the path selected for the deployment.

Also applies to: 34-35

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` around lines 26 - 29, Update the README state-storage
documentation to describe the non-root fallback path
`$HOME/.fleetint/fleetint.state` when the agent cannot use `/var/lib`. State
that this directory, like `/var/lib/fleetint`, must use persistent local storage
across restarts, reboots, upgrades, and reinstalls.


Deleting or replacing this directory removes the persisted node identity and
enrollment credentials. The agent may then generate a new node identity and
create a separate record for the same physical node in Fleet Intelligence. When
using custom images, installers, or container deployments, preserve or mount
this directory from persistent host storage and restrict access because it
contains enrollment credentials.

## Supported Platforms

| OS Family | Supported Versions | Architecture | GPU |
Expand Down
Loading