OpenSearch Dashboards 项目教程
1. 项目的目录结构及介绍
OpenSearch Dashboards 项目的目录结构如下:
OpenSearch-Dashboards/
├── README.md
├── CODE_OF_CONDUCT.md
├── LICENSE.txt
├── package.json
├── tsconfig.json
├── src/
│ ├── core/
│ ├── plugins/
│ └── server/
├── config/
│ └── opensearch_dashboards.yml
├── data/
├── test/
└── node_modules/
目录结构介绍
- README.md: 项目介绍和使用说明。
- CODE_OF_CONDUCT.md: 项目行为准则。
- LICENSE.txt: 项目许可证。
- package.json: 项目依赖和脚本配置。
- tsconfig.json: TypeScript 配置文件。
- src/: 源代码目录,包含核心功能、插件和服务器代码。
- core/: 核心功能代码。
- plugins/: 插件代码。
- server/: 服务器代码。
- config/: 配置文件目录。
- opensearch_dashboards.yml: 主配置文件。
- data/: 数据存储目录。
- test/: 测试代码目录。
- node_modules/: 项目依赖模块。
2. 项目的启动文件介绍
OpenSearch Dashboards 的启动文件主要包括 package.json
中的脚本配置和 src/core/server/index.ts
。
package.json
在 package.json
文件中,主要的启动脚本如下:
{
"scripts": {
"start": "node scripts/start.js",
"build": "node scripts/build.js",
"test": "node scripts/test.js"
}
}
- start: 启动开发服务器。
- build: 构建生产版本。
- test: 运行测试。
src/core/server/index.ts
src/core/server/index.ts
是服务器的入口文件,负责初始化和启动服务器。
3. 项目的配置文件介绍
OpenSearch Dashboards 的主要配置文件是 config/opensearch_dashboards.yml
。
config/opensearch_dashboards.yml
该配置文件包含了许多配置项,用于控制 OpenSearch Dashboards 的行为,例如:
server.host: "0.0.0.0"
server.port: 5601
opensearch.hosts: ["http://localhost:9200"]
opensearch.ssl.verificationMode: none
opensearch.username: "admin"
opensearch.password: "admin"
- server.host: 服务器监听的地址。
- server.port: 服务器监听的端口。
- opensearch.hosts: OpenSearch 集群的地址。
- opensearch.ssl.verificationMode: SSL 验证模式。
- opensearch.username: OpenSearch 用户名。
- opensearch.password: OpenSearch 密码。
这些配置项可以根据实际需求进行调整。