OpenSearch 安装与使用教程

OpenSearch 安装与使用教程

OpenSearch🔎 Open source distributed and RESTful search engine.项目地址:https://gitcode.com/gh_mirrors/op/OpenSearch

1. 项目目录结构及介绍

OpenSearch 的源代码仓库包含了多个模块，下面是主要目录结构及其作用：

.
├── buildSrc         # 构建相关的辅助脚本和配置
├── gradle           # 使用的Gradle构建系统的配置
├── licenses         # 开源许可证文件
├── NOTICE.txt       # 项目通知文件
├── README.md        # 项目README
├── src              # 主要的源代码目录
│   ├── main          # 主程序代码
│   │   ├── assembly   # 组件打包相关代码
│   │   ├── java       # Java源码
│   │   └── resources  # 资源文件
│   └── test          # 测试代码
└── submodules       # 子模块，可能包括其他依赖项目
    └── ...

在这个结构中，src/main/java 是存放核心业务逻辑的Java源代码，而 src/main/resources 包含了配置文件和其他非编译资源。

2. 项目的启动文件介绍

OpenSearch 使用 Gradle 作为构建工具，因此可以通过执行 Gradle 命令来启动服务。默认的启动脚本位于根目录的 build.gradle 文件，这个文件定义了构建过程和任务。

要启动OpenSearch实例，首先确保你已经安装了Gradle和Java SDK。然后，在终端中切换到项目根目录并运行以下命令：

./gradlew assemble 
./gradlew run

第一条命令assemble用于编译和打包项目，第二条命令run会启动OpenSearch服务器。请注意，实际操作可能会因为环境变量或特定的构建配置有所不同。

3. 项目的配置文件介绍

OpenSearch 的主要配置文件是 src/main/resources/config/opensearch.yml。这个文件包含了设置服务器端口、数据存储路径、网络选项、日志级别等关键参数。以下是配置文件中一些常见的配置项示例：

# 集群名称
cluster.name: "opensearch-cluster"

# 数据节点名称
node.name: "node-1"

# 数据存储路径
path.data: /usr/local/var/data/opensearch/

# HTTP端口
http.port: 9200

# 内部通信端口
transport.tcp.port: 9300

# 是否开启多租户（索引模板）
action.auto_create_index: true

# 索引分片数量
index.number_of_shards: 1

# 每个分片副本的数量
index.number_of_replicas: 1

# 设置日志级别
logging.level: info

你可以根据你的需求修改这些配置项，但务必小心，不正确的配置可能导致服务无法正常启动或运行。在更改配置后，重新运行上述启动命令以应用新的配置。

以上就是对OpenSearch项目的基本介绍和启动步骤，希望对你理解和部署OpenSearch有所帮助。更多详细的配置和使用方法可以参考官方文档和社区资源。

OpenSearch🔎 Open source distributed and RESTful search engine.项目地址:https://gitcode.com/gh_mirrors/op/OpenSearch