Azimutt 部署指南：从 Docker 到 Kubernetes 的完整方案

【免费下载链接】azimutt Explore, document and optimize any database 项目地址: https://gitcode.com/gh_mirrors/az/azimutt

Azimutt 是一款功能强大的数据库探索与文档工具，能够帮助开发人员轻松可视化、分析和优化数据库结构。本指南将详细介绍如何从 Docker 快速部署到 Kubernetes 集群的完整方案，让你在任何环境中都能高效使用 Azimutt 管理数据库。

📋 准备工作：环境与依赖检查

在开始部署前，请确保你的环境满足以下要求：

• Docker 环境：建议 Docker 20.10+ 和 Docker Compose 2.0+
• Kubernetes 集群：1.21+ 版本（如果选择 K8s 部署）
• Git：用于克隆项目代码
• 网络：确保 80/443 端口可访问（或自定义端口）

首先克隆官方仓库：

git clone https://gitcode.com/gh_mirrors/az/azimutt
cd azimutt

🐳 方案一：Docker 快速部署（推荐新手）

Docker 部署是最简单快捷的方式，适合个人使用或小团队测试。

1. 一键启动 Docker 容器

项目根目录提供了 docker-compose.yml 文件，包含完整的服务配置：

docker-compose up -d

2. 验证部署状态

检查容器是否正常运行：

docker-compose ps

你应该能看到 azimutt-backend 和 azimutt-frontend 两个服务状态为 Up。

3. 访问 Azimutt 界面

打开浏览器访问 http://localhost:8080，你将看到 Azimutt 的主界面：

图 1：Azimutt 基础数据库关系图展示界面，清晰呈现表结构与关系

☸️ 方案二：Kubernetes 集群部署（生产环境）

对于企业级生产环境，Kubernetes 提供了更稳定、可扩展的部署方案。项目的 charts/azimutt 目录包含完整的 Helm Chart 配置。

1. 安装 Helm Chart

helm install azimutt ./charts/azimutt

2. 自定义配置（可选）

创建自定义 values 文件覆盖默认配置：

# custom-values.yaml
replicaCount: 2
service:
  type: LoadBalancer
ingress:
  enabled: true
  hosts:
    - host: azimutt.example.com
      paths: ["/"]

应用自定义配置：

helm install azimutt ./charts/azimutt -f custom-values.yaml

3. 验证 Kubernetes 部署

检查 pod 状态：

kubectl get pods

访问复杂数据库示例：

图 2：Azimutt 展示复杂数据库架构，支持多表关联与分组查看

⚙️ 基础配置与使用

连接数据库

1. 登录 Azimutt 后，点击右上角「+ 新建项目」
2. 选择数据库类型（支持 PostgreSQL、MySQL、MongoDB 等）
3. 输入连接信息并测试连接
4. 点击「导入 schema」开始探索数据库

核心功能界面

Azimutt 主界面分为以下几个区域：

• 搜索栏：快速定位表、字段或关系
• 布局选择器：切换不同的视图布局
• 主画布：展示数据库关系图，支持拖拽和缩放
• 属性面板：查看/编辑选中表或字段的详细信息

图 3：Azimutt 电商数据库示例，展示多数据源整合能力

📝 常见问题解决

1. Docker 部署后无法访问

检查端口映射是否正确：

docker-compose logs backend

确保容器内服务正常启动，默认端口为 4000（后端）和 3000（前端）。

2. Kubernetes 部署后 Pod 启动失败

查看 pod 日志：

kubectl logs <pod-name>

常见问题包括：资源不足、配置错误或存储卷挂载问题。

3. 数据库连接失败

确保数据库允许来自 Azimutt 服务的网络访问，检查防火墙规则和数据库用户权限。

🚀 进阶配置（可选）

持久化存储

Docker 部署添加持久卷（修改 docker-compose.yml）：

volumes:
  azimutt-data:
    driver: local

Kubernetes 部署使用 PersistentVolumeClaim：

# custom-values.yaml
persistence:
  enabled: true
  size: 10Gi

环境变量配置

重要环境变量（在 .env 文件或 K8s ConfigMap 中设置）：

• DATABASE_URL：后端数据库连接串
• SECRET_KEY_BASE：安全密钥
• PORT：服务端口

📌 总结

通过本指南，你已经掌握了 Azimutt 从 Docker 快速部署到 Kubernetes 集群部署的完整流程。无论是个人开发还是企业级应用，Azimutt 都能帮助你更高效地探索和管理数据库结构。

如需进一步定制或扩展，可以参考项目的官方文档和源码：

• Helm Chart 配置：charts/azimutt/
• Docker 配置：docker-compose.yml
• 后端源码：backend/
• 前端源码：frontend/

开始使用 Azimutt，让数据库探索变得简单而高效！

【免费下载链接】azimutt Explore, document and optimize any database 项目地址: https://gitcode.com/gh_mirrors/az/azimutt