Home Explore Help
Register Sign In
milvus
/
attu
mirror of https://github.com/zilliztech/attu.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: v2.5.12
Branches Tags
attu
/
README_CN.md

README_CN.md 13 KB
Permalink History Raw

Attu

Attu 是一个全方位的 Milvus 管理工具。

GitHub release (latest by date) License downloads GitHub last commit GitHub stars 中文 Contributors PRs Welcome

目录

<h4>首页视图</h4>
<img src="./.github/images/connect.png" width="100%" alt="attu home view" />


<h4>数据浏览器</h4>
<img src="./.github/images/screenshot.png" width="100%" alt="attu data explorer" />


<h4>集合管理</h4>
<img src="./.github/images/data_explorer.png" width="100%" alt="attu data explorer" />


<h4>创建集合</h4>
<img src="./.github/images/create_collection.png" width="100%" alt="attu create collection dialog" />


<h4>集合树</h4>
<img src="./.github/images/collections.png" width="100%" alt="attu collections" />


<h4>集合概览</h4>
<img src="./.github/images/collection_overview.png" width="100%" alt="attu collection view" />


<h4>数据视图</h4>
<img src="./.github/images/data_preview.png" width="100%" alt="attu data view" />


<h4>向量搜索</h4>
<img src="./.github/images/vector_search.png" width="100%" alt="attu vector search" />


<h4>系统视图</h4>
<img src="./.github/images/system_view.png" width="100%" alt="attu system view" />


<h4>角色图表（浅色）</h4>
<img src="./.github/images/role_chart.png" width="100%" alt="attu role chart" />


<h4>角色图表（深色）</h4>
<img src="./.github/images/role_chart_night.png" width="100%" alt="attu role chart" />


Attu 是一个通过用户友好的图形界面管理和操作 Milvus 的系统，提供以下功能：

  • 数据库、集合和分区管理： 只需点击几下鼠标即可高效地组织和管理您的数据库、集合和分区，帮助用户快速构建和导航 Milvus 设置。
  • 向量的插入、索引和查询： 通过简单的图形界面无缝插入、索引和查询向量，使用户能够高效地处理向量数据。
  • 执行向量搜索： 只需点击几下鼠标即可进行高性能的向量搜索，快速找到相似项，帮助用户迅速进行功能验证。
  • 用户和角色管理： 管理用户和角色，以确保安全和受控的访问权限，使用户能够快速管理权限和安全设置。
  • 查看系统拓扑： 可视化系统架构以实现更好的监督和管理，使用户能够迅速了解和优化他们的系统设置。

系统要求

  • Docker 20.10.0 或更高版本
  • Kubernetes 1.19 或更高版本（如果使用 K8s 部署）
  • 现代网页浏览器（Chrome、Firefox、Safari、Edge）
  • 桌面应用程序要求：
    • Windows 10/11
    • macOS 10.15 或更高版本
    • Linux（Ubuntu 20.04 或更高版本）

快速开始

  1. 启动 Milvus 服务器（如果尚未运行）：

    docker run -d --name milvus_standalone -p 19530:19530 -p 9091:9091 milvusdb/milvus:latest

  2. 启动 Attu：

    docker run -p 8000:3000 -e MILVUS_URL=localhost:19530 zilliz/attu:v2.5

  3. 打开浏览器并访问 http://localhost:8000

安装指南

在开始之前，请确保您已在 Zilliz Cloud 或 您自己的服务器 上安装了 Milvus。

兼容性

Milvus 版本 推荐的 Attu 版本
2.5.x v2.5.10
2.4.x v2.4.12
2.3.x v2.3.5
2.2.x v2.2.8
2.1.x v2.2.2

从 Docker 运行 Attu

以下是运行 Attu 容器的步骤：

docker run -p 8000:3000 -e MILVUS_URL={milvus server IP}:19530 zilliz/attu:v2.5

确保 Attu 容器可以访问 Milvus IP 地址。启动容器后，在您的浏览器中输入 http://{ Attu IP }:8000 以查看 Attu GUI。

运行 Attu Docker 的可选环境变量

参数 示例 必填 描述
MILVUS_URL 192.168.0.1:19530 否 可选，Milvus 服务器 URL
DATABASE your database 否 可选，默认数据库名称
ATTU_LOG_LEVEL info 否 可选，设置 Attu 的日志级别
ROOT_CERT_PATH /path/to/root/cert 否 可选，根证书的路径
PRIVATE_KEY_PATH /path/to/private/key 否 可选，私钥的路径
CERT_CHAIN_PATH /path/to/cert/chain 否 可选，证书链的路径
SERVER_NAME your_server_name 否 可选，您的服务器名称
SERVER_PORT Server listen port 否 可选，默认 3000

请注意，MILVUS_URL 应为 Attu Docker 容器可访问的地址，因此 "127.0.0.1" 或 "localhost" 将无法使用。

Attu SSL 示例

docker run -p 8000:3000 \
-v /your-tls-file-path:/app/tls \
-e ATTU_LOG_LEVEL=info  \
-e ROOT_CERT_PATH=/app/tls/ca.pem \
-e PRIVATE_KEY_PATH=/app/tls/client.key \
-e CERT_CHAIN_PATH=/app/tls/client.pem \
-e SERVER_NAME=your_server_name \
zilliz/attu:v2.5

自定义服务器端口示例

此命令允许您使用主机网络运行 Docker 容器，指定服务器监听的自定义端口

docker run --network host \
-v /your-tls-file-path:/app/tls \
-e ATTU_LOG_LEVEL=info  \
-e SERVER_NAME=your_server_name \
-e SERVER_PORT=8080 \
zilliz/attu:v2.5

在 Kubernetes 中运行 Attu

在开始之前，请确保您已在 K8's 集群 中安装并运行了 Milvus。请注意，Attu 仅支持 Milvus 2.x。

以下是运行 Attu 容器的步骤：

kubectl apply -f https://raw.githubusercontent.com/zilliztech/attu/main/attu-k8s-deploy.yaml

确保 Attu pod 可以访问 Milvus 服务。在提供的示例中，这将直接连接到 my-release-milvus:19530。根据 Milvus 服务名称更改此设置。实现这一目标的更灵活方法是引入 ConfigMap。详见此 [示例]("https://raw.githubusercontent.com/zilliztech/attu/main/examples/attu-k8s-deploy-ConfigMap.yaml")。

在 nginx 代理后运行 Attu

在 nginx 代理后运行 Attu

安装桌面应用程序

如果您更喜欢使用桌面应用程序，可以下载 Attu 的桌面版本。

注意：

  • Mac M 芯片安装应用失败：attu.app 已损坏，无法打开。
  sudo xattr -rd com.apple.quarantine /Applications/attu.app

开发

前提条件

  • Node.js 16.x 或更高版本
  • Yarn 包管理器
  • Docker（用于本地开发）

设置开发环境

  1. 克隆仓库：

    git clone https://github.com/zilliztech/attu.git
cd attu

  2. 安装依赖：

    yarn install

  3. 启动开发服务器：

    yarn start

本地构建 Docker 镜像

  • 开发版：yarn run build:dev
  • 发布版：yarn run build:release

运行测试

yarn test

贡献

我们欢迎社区贡献！在提交拉取请求之前，请阅读我们的贡献指南。

行为准则

请阅读我们的行为准则，以保持我们的社区友好和受人尊敬。

常见问题

  • 无法登录系统 > 确保 Milvus 服务器的 IP 地址可以从 Attu 容器访问。#161
  • 如果遇到在 Mac OS 上安装桌面应用的问题，请参考安装桌面应用程序下的说明。
  • 如何更新 Attu？ > 对于 Docker 用户，只需拉取最新镜像并重启容器。对于桌面用户，从我们的发布页面下载最新版本。
  • 如何备份我的 Attu 配置？ > Attu 配置存储在浏览器的本地存储中。您可以从设置页面导出它们。

使用示例

Milvus Typescript 示例：此仓库提供了一些基于 Next.js 的简单 React 应用程序。

名称 演示 模型
semantic-search-example https://zilliz-semantic-search-example.vercel.app all-MiniLM-L6-v2
semantic-image-search clip-vit-base-patch16
semantic-image-search-client https://zilliz-semantic-image-search-client.vercel.app clip-vit-base-patch16

Milvus 相关链接

以下是一些有助于您入门 Milvus 的资源：

  • Milvus 文档：在这里，您可以找到有关如何使用 Milvus 的详细信息，包括安装说明、教程和 API 文档。
  • Milvus Python SDK：Python SDK 允许您使用 Python 进行 Milvus 交互。它提供了一个简单直观的界面来创建和查询向量。
  • Milvus Java SDK：Java SDK 类似于 Python SDK，但专为 Java 开发人员设计。它也提供了一个简单直观的界面来创建和查询向量。
  • Milvus Go SDK：Go SDK 提供了 Milvus 的 Go API。如果您是 Go 开发人员，这是适合您的 SDK。
  • Milvus Node SDK：Node SDK 提供了 Milvus 的 Node.js API。如果您是 Node.js 开发人员，这是适合您的 SDK。
  • Feder：Feder 是一个 JavaScript 工具，旨在帮助理解嵌入向量。

社区

💬 加入我们充满活力的 Milvus 社区，在那里您可以分享知识、提问并参与有意义的对话。这不仅仅是编码，更是与志同道合的人们交流。点击下面的链接立即加入！

license

许可证

Attu 采用 Apache License 2.0 许可证。详情请参阅 LICENSE 文件。

更新日志

查看我们的 CHANGELOG.md 了解版本之间的变更。