Skip to content

docs: document deployment sizing parameters - #28

Open
d4rshnn wants to merge 1 commit into
aboutcode-org:mainfrom
d4rshnn:docs-26-deployment-sizing
Open

d4rshnn wants to merge 1 commit into
aboutcode-org:mainfrom
d4rshnn:docs-26-deployment-sizing

Conversation

@d4rshnn

@d4rshnn d4rshnn commented Nov 8, 2026

Copy link
Copy Markdown

Issues

Closes #26

Changes

Adds deployment sizing documentation for HealthyCode, covering the infrastructure considerations involved in processing approximately 10,000 packages.

  • Documents the deployment architecture and individual component requirements.
  • Explains CPU, memory, persistent storage and temporary storage considerations.
  • Documents GrimoireLab, PurlDB, ScanCode.io and OpenSearch.
  • Explains repository deduplication, worker concurrency and workload variability.
  • Documents timeout, date-range and AMD64 considerations.
  • Adds a reproducible benchmarking methodology for collecting actual resource measurements.

The documentation distinguishes existing configuration values from estimates and requirements that still need benchmarking.

Validation

  • Checked Markdown formatting and relative links.
  • Verified the README reference to the new sizing document.
  • make doc8 could not run because Make is unavailable in the local Windows environment.

AI Assistance

GitHub Copilot assisted with repository investigation and documentation drafting. ChatGPT assisted with issue analysis and implementation guidance. The contributor reviewed the resulting changes.

Signed-off-by: Darshan Mahale <darshanmahaleofficial@gmail.com>

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

healthycode: Document HealthyCode Deployment sizing parameters (Compute/Memory/Storage)

1 participant