asf-tooling commented on issue #816:
URL:
https://github.com/apache/tooling-trusted-releases/issues/816#issuecomment-4410092938
<!-- gofannon-issue-triage-bot v2 -->
**Automated triage** — analyzed at `main@2da7807a`
**Type:** `documentation` • **Classification:** `actionable` •
**Confidence:** `medium`
**Application domain(s):** `shared_infrastructure`, `admin_operations`
### Summary
This issue requests new documentation describing ATR's disk layout and size
requirements, covering svn:dist areas, the main release store, state/log
directories, and /tmp usage. The goal is to support production VM sizing and
monitoring script design. No prior discussion exists. The relevant code that
would inform this documentation (atr/paths.py, atr/storage/__init__.py) was not
provided in the source files I can see, but from the architecture inventory
these files clearly exist and define the storage structure.
### Where new code would go
- `docs/disk-layout.md` — new file
A new markdown file documenting disk layout, size requirements, growth
expectations, log rotation, and /tmp usage patterns. This would live alongside
other project documentation.
### Proposed approach
To properly document the disk layout, someone with access to the production
system (or deep knowledge of atr/paths.py and atr/storage/__init__.py) needs to
enumerate: (1) the svn:dist checkout paths for 'release' and 'dev' areas with
existing SVN size policies, (2) the main ATR release store structure showing
how artifacts are organized and how storage grows per release, (3) the state
directory structure including log files and their rotation policy, and (4)
temporary file usage during archive extraction (atr/tasks/quarantine.py) and
SBOM generation. The documentation should include concrete size estimates and
growth projections that can inform VM disk allocation and monitoring thresholds.
A monitoring script (or at least its design) should also be documented or
scaffolded, checking disk usage against defined thresholds for each area. This
could live in a scripts/ directory given the existing labeler.yml
categorization for that path.
### Open questions
- What are the actual paths defined in atr/paths.py for state, releases, svn
checkouts, and tmp?
- What are the current SVN size enforcement policies referenced in the issue?
- What is the expected release volume (releases per month/year) to estimate
growth?
- What log rotation mechanism is currently in place (logrotate,
application-level, etc.)?
- How large are typical quarantine extractions in /tmp (depends on archive
sizes)?
- Should the monitoring script be a standalone script in scripts/ or
integrated into the application?
### Files examined
- `.asf.yaml`
- `.github/PULL_REQUEST_TEMPLATE.md`
- `.github/dependabot.yml`
- `.github/labeler.yml`
- `.github/linters/.markdown-lint.yml`
- `.github/workflows/allowlistchecker.yml`
- `.github/workflows/analyze.yml`
- `.github/workflows/build.yml`
---
*Draft from a triage agent. A human reviewer should validate before merging
any change. The agent did not run tests or verify diffs apply.*
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
