IndexTank Service 技术文档

1. 安装指南

1.1 环境准备

在安装 IndexTank Service 之前，请确保您的系统满足以下依赖要求：

• Django 1.2.x（推荐使用 1.2.7 版本，不兼容 1.3.x）
• Python 2.6.6
• Java(TM) SE Runtime Environment（推荐使用 build 1.6.0_24-b07）
• nginx
• uWSGI
• MySQL
• daemontools
• Thrift 库（已提供 0.5.0 版本的生成源代码）

1.2 数据库配置

首先，您需要创建数据库架构。使用以下命令：

python manage.py syncdb

该命令将根据 Django 的模型定义自动创建所需的数据库表。

1.3 创建账户

在数据库配置完成后，您需要创建一个账户。可以通过 Storefront 应用中的用户注册表单来完成此操作。

1.4 启动索引实例

在账户创建完成后，您需要启动一个索引实例（IndexTank Engine）。确保 IndexTank Engine 已正确安装并配置。

1.5 启动 API

最后，启动 API 服务。您可以使用以下命令：

python manage.py runserver

2. 项目的使用说明

2.1 API 使用

API 是 IndexTank Service 的核心组件，它提供了 REST JSON API，允许用户管理账户、索引数据以及执行搜索操作。API 通过 Thrift 与特定的索引实例进行交互。

2.2 Backoffice 使用

Backoffice 是一个 Django 应用，允许管理员进行手动管理操作。您可以通过 Backoffice 管理用户账户、索引实例以及其他系统资源。

2.3 Storefront 使用

Storefront 是 IndexTank Service 的 Web 界面，包含用户注册表单。用户可以通过 Storefront 创建账户并管理其索引实例。

2.4 Nebu 使用

Nebu 是索引、部署和工作节点的管理器。一个工作节点（服务器实例）可以包含一个或多个部署（索引实例）。Nebu 负责管理这些实例的生命周期。

3. 项目 API 使用文档

3.1 索引管理

通过 API，您可以创建、删除和管理索引实例。以下是一些常用的 API 操作：

• 创建索引：POST /api/v1/indexes
• 删除索引：DELETE /api/v1/indexes/{index_id}
• 获取索引信息：GET /api/v1/indexes/{index_id}

3.2 数据索引

您可以通过 API 将数据索引到指定的索引实例中。以下是一些常用的 API 操作：

• 添加文档：POST /api/v1/indexes/{index_id}/documents
• 删除文档：DELETE /api/v1/indexes/{index_id}/documents/{document_id}
• 更新文档：PUT /api/v1/indexes/{index_id}/documents/{document_id}

3.3 搜索操作

通过 API，您可以执行搜索操作。以下是一些常用的 API 操作：

• 执行搜索：GET /api/v1/indexes/{index_id}/search?q={query}
• 高级搜索：GET /api/v1/indexes/{index_id}/search?q={query}&filters={filters}

4. 项目安装方式

4.1 从源代码安装

1. 克隆 IndexTank Service 的源代码仓库：

   git clone https://github.com/linkedin/indextank-service.git
   

2. 进入项目目录：

   cd indextank-service
   

3. 安装依赖项：

   pip install -r requirements.txt
   

4. 配置数据库并启动服务，具体步骤请参考第 1 节“安装指南”。

4.2 使用 Docker 安装

如果您希望使用 Docker 来简化安装过程，可以参考以下步骤：

1. 构建 Docker 镜像：

   docker build -t indextank-service .
   

2. 运行 Docker 容器：

   docker run -d -p 8000:8000 indextank-service
   

3. 访问 http://localhost:8000 来使用 IndexTank Service。

通过以上步骤，您应该能够成功安装并使用 IndexTank Service。如果您在安装或使用过程中遇到任何问题，请参考项目的官方文档或联系技术支持。