From 89448ce420638ab213958fef9dfa1053224ce7be Mon Sep 17 00:00:00 2001 From: akanksha choudhary Date: Tue, 17 Feb 2026 12:17:33 +0530 Subject: [PATCH 1/4] Update doc to add component classification, storage and system requirements --- README.md | 101 +++++++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 85 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 7baf96a..03c32e3 100644 --- a/README.md +++ b/README.md @@ -50,28 +50,31 @@ Prerequisites
  • - Installation instructions + Enterprise deployment architecture & requirements
  • - Update repository list and re-index + Installation instructions
  • - Setting up AI Architect MCP in coding agents + Update repository list and re-index
  • - Configuring AI Architect for Bito AI Code Review Agent + Setting up AI Architect MCP in coding agents
  • - Command reference + Configuring AI Architect for Bito AI Code Review Agent
  • - Troubleshooting guide + Command reference
  • - Upgrading AI Architect + Troubleshooting guide
  • - Support & contact + Upgrading AI Architect +
    • +
  • + Support & contact
    • @@ -205,9 +208,75 @@ For testing and development purposes, you can create a local cluster using KIND
    + + +## 3. Enterprise deployment architecture & requirements + +This section provides infrastructure planning guidance for enterprise deployments of AI Architect. + +--- + +### Component overview + +AI Architect includes the following services, all managed through the standard deployment: + +| Component | Type | Requires Persistent Storage | +|-----------|------|----------------------------| +| **Database (MySQL)** | Stateful | ✅ Yes | +| **Manager** | Stateful | ✅ Yes | +| **Provider** | Stateless | No | +| **Config** | Stateless | No | +| **Tracker** | Stateless | No | + +> **Note:** All persistent storage is automatically configured using Docker volumes or Kubernetes PersistentVolumeClaims during installation. + +--- + +### Persistent storage + +AI Architect automatically creates persistent volumes for: + +| Data Type | What's Stored | Sizing Guide | +|-----------|---------------|--------------| +| **Database** | Configuration, metadata, processing state | 100–500 MB | +| **Index data** | Cloned repositories, search indexes, analysis data | 2–3× total repository size | +| **Backups** | Database and configuration backups | 20–30% of data size | + +**Disk space estimation:** +``` +Total Storage = (Sum of repository sizes × 3) + 5 GB base overhead +``` + +--- + +### System requirements + +| Deployment Size | Repositories | CPU | Memory | Storage | +|-----------------|--------------|-----|--------|---------| +| **Small** | Up to 20 | 4 cores | 8 GB | 10–15 GB | +| **Medium** | 20–100 | 8 cores | 16 GB | 30–60 GB | +| **Large** | 100–500 | 16 cores | 32 GB | 100–300 GB | +| **Enterprise** | 500+ | 32+ cores | 64+ GB | 300 GB+ | + +> **Note:** Storage requirements scale with repository size. Estimates assume average repos of 50–200 MB each. + +--- + +### Deployment checklist + +- [ ] Verify system meets minimum requirements (4 cores, 8 GB RAM, 10 GB+ storage) +- [ ] Ensure persistent storage is available for Docker volumes or Kubernetes PVCs +- [ ] Plan for storage growth based on repository count and size +- [ ] Configure firewall rules to restrict access to trusted IPs (services are exposed on all network interfaces) +- [ ] For production deployments, set up a reverse proxy (e.g., Nginx) with HTTPS + +--- + +
    + -## 3. Installation instructions +## 4. Installation instructions Setting up AI Architect has three main steps: 1. Download and install Bito AI Architect @@ -368,7 +437,7 @@ bitoarch rotate-mcp-token -## 4. Update repository list and re-index +## 5. Update repository list and re-index You can update the repository list and re-index anytime after the initial setup through `.bitoarch-config.yaml` file. @@ -396,7 +465,7 @@ bitoarch index-repos -## 5. Setting up AI Architect MCP in coding agents +## 6. Setting up AI Architect MCP in coding agents Now that AI Architect is installed and your repositories are indexed, the next step is to connect it to your AI coding tools (such as Claude Code, Cursor, Windsurf, GitHub Copilot, etc.) through the Model Context Protocol (MCP). @@ -430,7 +499,7 @@ If you prefer hands-on control over your configuration or encounter issues with -## 6. Configuring AI Architect for Bito AI Code Review Agent +## 7. Configuring AI Architect for Bito AI Code Review Agent Now that you have **AI Architect** set up, you can take your code quality to the next level by integrating it with **[Bito's AI Code Review Agent](https://bito.ai/product/ai-code-review-agent/)**. This powerful combination delivers significantly more accurate and context-aware code reviews by leveraging the deep codebase knowledge graph that AI Architect has built. @@ -461,7 +530,7 @@ This enables the AI Code Review Agent to: -## 7. Command reference +## 8. Command reference Quick reference to CLI commands for managing Bito's AI Architect. @@ -549,7 +618,7 @@ bitoarch --version -## 8. Troubleshooting guide +## 9. Troubleshooting guide ```bash # Check all services @@ -597,7 +666,7 @@ tail -f setup.log --- -## 9. Upgrading AI Architect +## 10. Upgrading AI Architect [](#overview) @@ -686,7 +755,7 @@ To switch between deployment types (Docker to Kubernetes or Kubernetes to Docker -## 10. Support & contact +## 11. Support & contact For comprehensive information and guidance on the AI Architect, including installation and configuration instructions, please refer to our detailed **[documentation available here](https://docs.bito.ai/ai-architect/overview)**. Should you require further assistance or have any inquiries, our support team is readily available to assist you. From 38b72a4da1ef23d1f03c30d4882baa32330db81f Mon Sep 17 00:00:00 2001 From: akanksha choudhary Date: Tue, 17 Feb 2026 12:47:54 +0530 Subject: [PATCH 2/4] Update doc to add component classification, storage and system requirements --- README.md | 43 +++++++++++++++++++++++++------------------ 1 file changed, 25 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 03c32e3..a34bd5f 100644 --- a/README.md +++ b/README.md @@ -218,15 +218,15 @@ This section provides infrastructure planning guidance for enterprise deployment ### Component overview -AI Architect includes the following services, all managed through the standard deployment: +AI Architect includes the following services: -| Component | Type | Requires Persistent Storage | -|-----------|------|----------------------------| -| **Database (MySQL)** | Stateful | ✅ Yes | -| **Manager** | Stateful | ✅ Yes | -| **Provider** | Stateless | No | -| **Config** | Stateless | No | -| **Tracker** | Stateless | No | +| Component | Type | Architectural Role | Application State | Persistent Storage | +|-----------|------|-------------------|-------------------|-------------------| +| **Database (MySQL)** | Stateful | Data Store | All metadata, configs, analytics | ✅ Yes - Database files | +| **Manager** | Stateful | Indexing Engine | Repository clones, search indexes | ✅ Yes - Shared data volume | +| **Config** | Stateless | Configuration API | Workspace configurations | ✅ Yes - Database only | +| **Provider** | Stateless | MCP Server | None (API gateway) | ✅ Yes - Logs, temp files only | +| **Tracker** | Stateless | Analytics | None (forwards to external) | ✅ Yes - Logs only | > **Note:** All persistent storage is automatically configured using Docker volumes or Kubernetes PersistentVolumeClaims during installation. @@ -238,27 +238,34 @@ AI Architect automatically creates persistent volumes for: | Data Type | What's Stored | Sizing Guide | |-----------|---------------|--------------| -| **Database** | Configuration, metadata, processing state | 100–500 MB | -| **Index data** | Cloned repositories, search indexes, analysis data | 2–3× total repository size | -| **Backups** | Database and configuration backups | 20–30% of data size | +| **Database** | Metadata, configs, analytics | ~5 MB per repo (500 MB for 100 repos) | +| **Index data** | Cloned repositories + search indexes | ~1.5 GB per repository | +| **Backups** | Database and configuration backups | 10 GB default | +| **Temp/Logs** | Processing files and service logs | 10 GB default | **Disk space estimation:** ``` -Total Storage = (Sum of repository sizes × 3) + 5 GB base overhead +Storage Required = (Number_of_Repos × 1.5 GB) + 10 GB (MySQL + overhead) + +Examples: +- 10 repos: 25 GB minimum +- 50 repos: 85 GB minimum +- 100 repos: 160 GB minimum ``` +> **Note:** Storage requirements scale with repository size. Estimates assume average repos of 500 MB each. --- ### System requirements +Default resource allocation: 5 CPU cores, 6 GB memory across all services. + | Deployment Size | Repositories | CPU | Memory | Storage | |-----------------|--------------|-----|--------|---------| -| **Small** | Up to 20 | 4 cores | 8 GB | 10–15 GB | -| **Medium** | 20–100 | 8 cores | 16 GB | 30–60 GB | -| **Large** | 100–500 | 16 cores | 32 GB | 100–300 GB | -| **Enterprise** | 500+ | 32+ cores | 64+ GB | 300 GB+ | - -> **Note:** Storage requirements scale with repository size. Estimates assume average repos of 50–200 MB each. +| **Small** | 1–20 | 6 cores | 8 GB | 50 GB | +| **Medium** | 20–50 | 8 cores | 16 GB | 100 GB | +| **Large** | 50–150 | 12 cores | 24 GB | 250 GB | +| **Enterprise** | 150+ | 16+ cores | 32+ GB | 500+ GB | --- From ed8a09fb796e80549ada5e3b0871f57779f21b28 Mon Sep 17 00:00:00 2001 From: akanksha choudhary Date: Tue, 17 Feb 2026 12:51:12 +0530 Subject: [PATCH 3/4] Update doc to add component classification, storage and system requirements --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a34bd5f..41c8465 100644 --- a/README.md +++ b/README.md @@ -271,7 +271,8 @@ Default resource allocation: 5 CPU cores, 6 GB memory across all services. ### Deployment checklist -- [ ] Verify system meets minimum requirements (4 cores, 8 GB RAM, 10 GB+ storage) +- [ ] Verify system meets minimum requirements (6 cores, 8 GB RAM, 50 GB storage for up to 20 repos) +- [ ] Calculate storage: `(Number_of_Repos × 1.5 GB) + 10 GB overhead` - [ ] Ensure persistent storage is available for Docker volumes or Kubernetes PVCs - [ ] Plan for storage growth based on repository count and size - [ ] Configure firewall rules to restrict access to trusted IPs (services are exposed on all network interfaces) From 6a778db19d4a6684c36021c3bbd8f065fa2699ee Mon Sep 17 00:00:00 2001 From: akanksha choudhary Date: Thu, 21 May 2026 15:27:16 +0530 Subject: [PATCH 4/4] Revise ai architect system requirements --- README.md | 34 ++++++++++++---------------------- 1 file changed, 12 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 41c8465..f6b25d9 100644 --- a/README.md +++ b/README.md @@ -239,40 +239,30 @@ AI Architect automatically creates persistent volumes for: | Data Type | What's Stored | Sizing Guide | |-----------|---------------|--------------| | **Database** | Metadata, configs, analytics | ~5 MB per repo (500 MB for 100 repos) | -| **Index data** | Cloned repositories + search indexes | ~1.5 GB per repository | -| **Backups** | Database and configuration backups | 10 GB default | +| **Index data** | Cloned repositories + search indexes + extracted edges/symbols | ~5 GB per repository | +| **Backups** | Database and configuration backups (30-day retention default) | Scales with retention window | | **Temp/Logs** | Processing files and service logs | 10 GB default | -**Disk space estimation:** -``` -Storage Required = (Number_of_Repos × 1.5 GB) + 10 GB (MySQL + overhead) - -Examples: -- 10 repos: 25 GB minimum -- 50 repos: 85 GB minimum -- 100 repos: 160 GB minimum -``` - -> **Note:** Storage requirements scale with repository size. Estimates assume average repos of 500 MB each. --- ### System requirements -Default resource allocation: 5 CPU cores, 6 GB memory across all services. +| Tier | Repositories | vCPU | Memory | Storage | +|------|--------------|------|--------|---------| +| **Minimum** | up to 25 | 12 cores | 24 GB | 500 GB | +| **Ideal** | 25 – 100 | 16 cores | 48 GB | 1.5 TB | +| **Enterprise** | 100+ | 32+ cores | 128+ GB | 2 – 4 TB+ | -| Deployment Size | Repositories | CPU | Memory | Storage | -|-----------------|--------------|-----|--------|---------| -| **Small** | 1–20 | 6 cores | 8 GB | 50 GB | -| **Medium** | 20–50 | 8 cores | 16 GB | 100 GB | -| **Large** | 50–150 | 12 cores | 24 GB | 250 GB | -| **Enterprise** | 150+ | 16+ cores | 32+ GB | 500+ GB | +> **Notes** +> - **Large repositories:** Increase memory and storage by 50% above the tier baseline when any single repository exceeds 5 GB. +> - **Indexing workload:** Indexing generates transient CPU and memory peaks above steady-state usage. The resources listed above include the headroom required to absorb these peaks; do not size below the tier minimums. --- ### Deployment checklist -- [ ] Verify system meets minimum requirements (6 cores, 8 GB RAM, 50 GB storage for up to 20 repos) -- [ ] Calculate storage: `(Number_of_Repos × 1.5 GB) + 10 GB overhead` +- [ ] Verify system meets the tier requirements above (refer to the System requirements table) +- [ ] Provision storage per the tier table; double for monorepo-heavy environments - [ ] Ensure persistent storage is available for Docker volumes or Kubernetes PVCs - [ ] Plan for storage growth based on repository count and size - [ ] Configure firewall rules to restrict access to trusted IPs (services are exposed on all network interfaces)