mirror of
https://github.com/bunny-lab-io/Borealis.git
synced 2025-12-15 18:55:48 -07:00
ENGINE: Added File Headers and Guidance in AGENTS.md
This commit is contained in:
17
AGENTS.md
17
AGENTS.md
@@ -5,6 +5,21 @@
|
||||
The `script_engines.py` helper exposes a PowerShell runner for potential server-side orchestration, but no current Flask route invokes it; agent-side script execution lives under the roles in `Data/Agent`.
|
||||
- Agents run inside the packaged Python venv (`Data/Agent` mirrored to `Agent/`). `agent.py` handles the primary connection and hot-loads roles from `Data/Agent/Roles` at agent startup.
|
||||
|
||||
## Engine File Headers (Codex Agent Guidance)
|
||||
- Any new Python modules created under `Data/Engine` or its staging counterpart `Engine/Data/Engine` must begin with the standardized commentary header that documents file purpose and API coverage.
|
||||
- Mirror the exact formatting shown below, updating the file path, description, and endpoint list to match the new module. If the file does not expose API routes, set the section to `API Endpoints (if applicable): None`.
|
||||
```text
|
||||
# ======================================================
|
||||
# Data\Engine\services\API\devices\management.py
|
||||
# Description: Device inventory, list view, site management, and repository hash endpoints for the Engine API transition layer.
|
||||
#
|
||||
# API Endpoints (if applicable):
|
||||
# - POST /api/agent/details (Device Authenticated) - Ingests hardware and inventory payloads from enrolled agents.
|
||||
# ======================================================
|
||||
```
|
||||
- Always adjust the first line after `# Description:` and each endpoint bullet so operators can quickly understand why the file exists and how to authenticate to any routes.
|
||||
- When modifying an existing module that is missing this header, add it as part of the change before proceeding with further edits.
|
||||
|
||||
## Logging Policy (Centralized, Rotated)
|
||||
- **Log Locations**
|
||||
- Agent: `<ProjectRoot>/Logs/Agent/<service>.log`
|
||||
@@ -118,4 +133,4 @@ Important: The Ansible integration is not production‑ready. Do not rely on it
|
||||
- Database‑fed credential management (per device/site/global), stored securely and surfaced to playbook runs.
|
||||
- First‑class selection of connection types (local | PSRP | WinRM) from the UI and scheduler, with per‑run credential binding.
|
||||
- Reliable live output and cancel semantics; hardened recap ingestion and history.
|
||||
- Verified packaging of required Ansible components and Windows collections inside the agent venv.
|
||||
- Verified packaging of required Ansible components and Windows collections inside the agent venv.
|
||||
|
||||
Reference in New Issue
Block a user