本教程介绍了如何部署简单的 Cloud Search 解决方案,并使用 GitHub 作为要编入索引的数据的代码库。具体而言,本教程包含两个示例应用:
- 使用 Cloud Search Connector SDK 创建的内容连接器,用于为 GitHub 代码库中找到的数据编制索引。编入索引的数据包括问题、拉取请求以及默认分支 (
master
) 的头内容。 - 使用搜索微件提供自定义搜索界面的 Web 应用。
前提条件
本教程需要满足以下前提条件:
- 对已启用 Cloud Search 第三方数据索引功能的 Google Workspace 或 Cloud Identity 网域的管理员访问权限。如果您无法在“管理”控制台中查看设置,请与您的网域管理员联系,或注册 Cloud Search。
- 一个 GitHub 用户账号。
- 熟悉 Java 和 JavaScript。
- Java 8 或更高版本。
- Maven。
- Node.js 8.11 或更高版本。
创建教程项目
首先,您必须创建一个 Google Cloud Platform 项目。该项目构成了创建、启用和使用所有 Google Cloud Platform (GCP) 服务的基础,包括管理 API、启用结算功能、添加和移除协作者以及管理权限。
在页面顶部,点击“Google Cloud 控制台”右侧的
。此时会显示一个列出当前项目的对话框。点击新建项目。此时会显示“新建项目”屏幕。
在 Project Name 字段中,输入项目名称,例如“SearchTutorial”。
(可选)点击修改以修改项目 ID。创建项目后,项目 ID 无法更改,因此请选择满足项目生命周期需求的 ID。
如需浏览项目的位置,请点击浏览。
点击项目所在的位置,然后点击选择。
点击创建。Console 将导航到“信息中心”页面。项目会在几分钟内创建完成。
如需详细了解如何创建和管理项目,请参阅创建和管理项目。
启用 API
您需要启用 Google Cloud Search API 并创建服务账号以获取凭据。
- 在左侧导航栏中,点击 API 和服务。
- 点击 Google Cloud 控制台横幅右侧的 图标并选择新创建的项目,以确保您使用的是新创建的项目。
- 点击启用 API 和服务。系统随即会显示“欢迎使用 API 库”页面。
- 在搜索字段中输入“Cloud Search API”,然后按 return 键。系统会返回一个 API 列表。
- 点击 Cloud Search API。系统随即会显示“Cloud Search API”页面。
- 点击启用。此时会显示“概览”页面。
如需详细了解如何启用和停用 API,请参阅在 Google Cloud 控制台中管理 API
克隆教程代码库
如需克隆示例代码库,请运行以下命令:
git clone https://github.com/googleworkspace/cloud-search-samples.git