> ## Documentation Index
> Fetch the complete documentation index at: https://docs.shannon.run/llms.txt
> Use this file to discover all available pages before exploring further.

# 部署

> 将 Shannon 部署到生产环境

## 生产环境部署指南

自信地将 Shannon 部署到您的基础设施。本节涵盖部署模式、云平台集成和运维最佳实践。

> [!WARNING]
>
> Shannon 目前正在积极开发中。生产环境部署指南正在最后确定。对于生产环境使用,我们建议:
>
> * 在预发布环境中进行充分测试
> * 密切监控所有服务

## 部署选项

> [card] [Docker Compose](https://docs.shannon.run/cn/deployment/docker-compose.md)
>
> 生产就绪的 Docker Compose 配置
>
> **状态**: 🚧 第三阶段

> [card] [Kubernetes](https://docs.shannon.run/cn/deployment/kubernetes.md)
>
> Kubernetes 清单文件和 Helm Charts
>
> **状态**: 🚧 第三阶段

> [card] [AWS](https://docs.shannon.run/cn/deployment/aws.md)
>
> 部署到 Amazon Web Services (ECS, RDS, ElastiCache)
>
> **状态**: 🚧 第三阶段

> [card] [Azure](https://docs.shannon.run/cn/deployment/azure.md)
>
> 部署到 Microsoft Azure (AKS, PostgreSQL, Redis)
>
> **状态**: 🚧 第三阶段

## 运维

> [card] [监控](https://docs.shannon.run/cn/deployment/monitoring.md)
>
> Prometheus 指标、Grafana 仪表板和告警
>
> **状态**: 🚧 第三阶段

> [card] [性能调优](https://docs.shannon.run/cn/deployment/performance-tuning.md)
>
> 优化吞吐量、延迟和资源使用
>
> **状态**: 🚧 第三阶段

> [card] [安全](https://docs.shannon.run/cn/deployment/security.md)
>
> 生产环境安全加固和最佳实践
>
> **状态**: 🚧 第三阶段

## 快速开始: 本地开发

对于开发和测试,使用 Docker Compose:

```bash theme={null}
# 克隆仓库
git clone https://github.com/Kocoro-lab/Shannon.git
cd Shannon

# 设置配置
make setup
echo "OPENAI_API_KEY=sk-your-key-here" >> .env

# 下载 Python WASI 解释器
./scripts/setup_python_wasi.sh

# 启动所有服务
make dev
```

详细的设置说明请参见[安装指南](https://docs.shannon.run/cn/quickstart/installation.md)。

## 架构概览

Shannon 由多个需要部署的服务组成:

![部署架构](https://mintcdn.com/ptmind-3aa3d4e1/2Bzddmlzr-QTR0Yc/cn/deployment/assets/deployment-architecture.svg?fit=max\&auto=format\&n=2Bzddmlzr-QTR0Yc\&q=85\&s=afa4672519dbf9daa38dfec47792fc84)

### 核心服务

| 服务 | 用途 | 扩展方式 |
| - | - | - |
| **Gateway** | REST API, 身份认证 | 水平扩展 (无状态) |
| **Orchestrator** | 任务协调, gRPC | 水平扩展 (通过 Temporal 有状态) |
| **Agent Core** | Agent 执行, Rust 运行时 | 水平扩展 |
| **LLM Service** | LLM 提供商网关 | 水平扩展 |
| **Desktop App** | 实时监控 UI（原生客户端） | 客户端侧；后端独立扩展 |

### 数据存储

| 存储 | 用途 | 扩展方式 |
| - | - | - |
| **PostgreSQL** | 任务元数据、事件、会话 | 垂直扩展 + 只读副本 |
| **Redis** | 缓存、发布/订阅、会话 | 集群模式 |
| **Qdrant** | 向量嵌入、语义记忆 | 水平扩展 |
| **Temporal** | 工作流状态、持久化执行 | 集群模式 |

## 生产环境检查清单

在部署到生产环境之前:

### 安全性

* [ ] 启用身份认证 (`GATEWAY_SKIP_AUTH=0`)
* [ ] 为所有服务配置 TLS/SSL
* [ ] 定期轮换 API 密钥
* [ ] 设置 OPA 策略进行访问控制
* [ ] 启用审计日志
* [ ] 配置网络策略/防火墙

### 可靠性

* [ ] 设置健康检查和就绪探针
* [ ] 配置自动扩展策略
* [ ] 实现熔断器
* [ ] 设置资源限制 (CPU、内存)
* [ ] 配置备份和灾难恢复
* [ ] 测试故障转移场景

### 可观测性

* [ ] 部署 Prometheus 和 Grafana
* [ ] 配置告警规则
* [ ] 设置日志聚合 (ELK/Loki)
* [ ] 启用分布式追踪 (OpenTelemetry)
* [ ] 为常见问题创建运维手册

### 性能

* [ ] 调优 Temporal worker 并发
* [ ] 优化数据库连接
* [ ] 配置 Redis 缓存
* [ ] 设置适当的资源限制
* [ ] 生产环境启动前进行负载测试

## 资源需求

### 最低配置 (开发环境)

* **CPU**: 4 核
* **RAM**: 8GB
* **存储**: 20GB SSD

### 推荐配置 (生产环境 - 小型)

* **CPU**: 总共 16 核 (分布在各服务中)
* **RAM**: 总共 32GB
* **存储**: 100GB SSD
* **网络**: 1Gbps

### 推荐配置 (生产环境 - 大型)

* **CPU**: 64+ 核
* **RAM**: 128GB+
* **存储**: 500GB+ SSD
* **网络**: 10Gbps
* **负载均衡器**: 必需
* **多可用区**: 推荐

## 下一步

> [card] [快速开始](https://docs.shannon.run/cn/quickstart/installation.md)
>
> 首先在本地安装 Shannon

> [card] [配置](https://docs.shannon.run/cn/quickstart/configuration.md)
>
> 了解环境变量

> [card] [架构](https://docs.shannon.run/cn/architecture/overview.md)
>
> 学习系统架构

> [card] [监控](https://docs.shannon.run/cn/quickstart/concepts/monitoring.md)
>
> 设置监控

## 获取帮助

* **GitHub**: 提交部署问题或疑问
* **文档**: 查看[故障排除](https://docs.shannon.run/cn/quickstart/troubleshooting.md)了解常见问题


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.