Skip to content

Update doc to add component classification, storage and system requirements #19

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

Closed
akanksha-choudhary-8 wants to merge 4 commits into from
Closed

Update doc to add component classification, storage and system requirements #19

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
89448ce
Update doc to add component classification, storage and system requir…
akanksha-choudhary-8 Feb 17, 2026
38b72a4
Update doc to add component classification, storage and system requir…
akanksha-choudhary-8 Feb 17, 2026
ed8a09f
Update doc to add component classification, storage and system requir…
akanksha-choudhary-8 Feb 17, 2026
6a778db
Revise ai architect system requirements
akanksha-choudhary-8 May 21, 2026
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
99 changes: 83 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,28 +50,31 @@
<a href="#2-prerequisites">Prerequisites</a>
</li>
<li>
<a href="#3-installation-instructions">Installation instructions</a>
<a href="#3-enterprise-deployment-architecture--requirements">Enterprise deployment architecture & requirements</a>
</li>
<li>
<a href="#4-update-repository-list-and-re-index">Update repository list and re-index</a>
<a href="#4-installation-instructions">Installation instructions</a>
</li>
<li>
<a href="#5-setting-up-ai-architect-mcp-in-coding-agents">Setting up AI Architect MCP in coding agents</a>
<a href="#5-update-repository-list-and-re-index">Update repository list and re-index</a>
</li>
<li>
<a href="#6-configuring-ai-architect-for-bito-ai-code-review-agent">Configuring AI Architect for Bito AI Code Review Agent</a>
<a href="#6-setting-up-ai-architect-mcp-in-coding-agents">Setting up AI Architect MCP in coding agents</a>
</li>
<li>
<a href="#7-command-reference">Command reference</a>
<a href="#7-configuring-ai-architect-for-bito-ai-code-review-agent">Configuring AI Architect for Bito AI Code Review Agent</a>
</li>
<li>
<a href="#8-troubleshooting-guide">Troubleshooting guide</a>
<a href="#8-command-reference">Command reference</a>
</li>
<li>
<a href="#9-upgrading-ai-architect">Upgrading AI Architect</a>
<a href="#9-troubleshooting-guide">Troubleshooting guide</a>
</li>
<li>
<a href="#10-support--contact">Support & contact</a>
<a href="#10-upgrading-ai-architect">Upgrading AI Architect</a>
</li>
<li>
<a href="#11-support--contact">Support & contact</a>
</li>
</ol>
</details>
Expand Down Expand Up @@ -205,9 +208,73 @@ For testing and development purposes, you can create a local cluster using KIND

<br />

<!-- Enterprise Deployment Architecture & Requirements -->

## 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:

| 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.

---

### Persistent storage

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 + 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 |

---

### System requirements

| 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+ |

> **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 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)
- [ ] For production deployments, set up a reverse proxy (e.g., Nginx) with HTTPS

---

<br />

<!-- Installation instructions -->

## 3. Installation instructions
## 4. Installation instructions

Setting up AI Architect has three main steps:
1. Download and install Bito AI Architect
Expand Down Expand Up @@ -368,7 +435,7 @@ bitoarch rotate-mcp-token <new-token>

<!-- Update repository list and re-index -->

## 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.

Expand Down Expand Up @@ -396,7 +463,7 @@ bitoarch index-repos

<!-- Setting up AI Architect MCP in coding agents -->

## 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).

Expand Down Expand Up @@ -430,7 +497,7 @@ If you prefer hands-on control over your configuration or encounter issues with

<!-- Configuring AI Architect for Bito AI Code Review Agent -->

## 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.

Expand Down Expand Up @@ -461,7 +528,7 @@ This enables the AI Code Review Agent to:

<!-- Command reference -->

## 7. Command reference
## 8. Command reference

Quick reference to CLI commands for managing Bito's AI Architect.

Expand Down Expand Up @@ -549,7 +616,7 @@ bitoarch --version

<!-- Troubleshooting guide -->

## 8. Troubleshooting guide
## 9. Troubleshooting guide

```bash
# Check all services
Expand Down Expand Up @@ -597,7 +664,7 @@ tail -f setup.log
---


## 9. Upgrading AI Architect
## 10. Upgrading AI Architect

[](#overview)

Expand Down Expand Up @@ -686,7 +753,7 @@ To switch between deployment types (Docker to Kubernetes or Kubernetes to Docker

<!-- Support & contact -->

## 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.

Expand Down