opensearchproject/opensearch

OpenSearch Docker镜像文档

镜像概述和主要用途

OpenSearch是一个可扩展、灵活且可扩展的开源软件套件，用于搜索、分析和可观测性应用，衍生自Elasticsearch 7.10.2和Kibana 7.10.2，采用Apache 2.0许可。该Docker镜像包含OpenSearch搜索引擎守护进程和OpenSearch Dashboards数据管理与可视化用户界面，便于快速部署和使用。

核心功能和特性

• 开源免费：基于Apache 2.0许可，完全开源，无商业许可限制
• 全面功能：集成搜索、分析和可观测性功能，满足多种数据处理需求
• 可扩展性：支持单节点部署用于开发，也可扩展为集群用于生产环境
• 兼容性：衍生自Elasticsearch和Kibana，保持良好的兼容性和迁移便利性

使用场景和适用范围

• 本地开发：快速搭建单节点环境进行应用开发和测试
• 数据分析：利用搜索和分析功能处理日志、指标等数据
• 可观测性：通过可视化界面监控系统运行状态
• 学习研究：作为开源搜索技术的学习和研究平台

详细使用方法和配置说明

拉取镜像

使用以下命令拉取最新版本的OpenSearch镜像：

bash
docker pull docker.xuanyuan.run/opensearchproject/opensearch:latest

所有可用版本可在https://hub.docker.com/r/opensearchproject/opensearch/tags%E6%9F%A5%E7%9C%8B%E3%80%82

注意：OpenSearch镜像在1.x版本和2.x版本（直至2.9.0）使用https://aws.amazon.com/amazon-linux-2/%E4%BD%9C%E4%B8%BA%E5%9F%BA%E7%A1%80%E9%95%9C%E5%83%8F%EF%BC%8C%E8%87%AA2.10.0%E8%B5%B7%E4%BD%BF%E7%94%A8https://aws.amazon.com/linux/amazon-linux-2023/%E3%80%82%E8%8B%A5%E4%BD%BF%E7%94%A8https://www.docker.com/products/docker-desktop/%EF%BC%8C%E5%BB%BA%E8%AE%AE%E9%85%8D%E7%BD%AE%E8%87%B3%E5%B0%914GB%E7%B3%BB%E7%BB%9F%E5%86%85%E5%AD%98%E3%80%82

单节点运行（本地开发）

OpenSearch 2.12之前版本

bash
docker run -it -p 9200:9200 -p 9600:9600 -e "discovery.type=single-node" --name opensearch-node -d docker.xuanyuan.run/opensearchproject/opensearch:latest

OpenSearch 2.12及之后版本

需要为admin用户设置自定义密码：

bash
docker run -it -p 9200:9200 -p 9600:9600 -e OPENSEARCH_INITIAL_ADMIN_PASSWORD=<strong-password> -e "discovery.type=single-node" --name opensearch-node docker.xuanyuan.run/opensearchproject/opensearch:latest

验证部署

通过OpenSearch REST API验证服务是否正常运行。默认使用自签名TLS证书，-k选项用于跳过证书验证。默认用户名均为admin：

• OpenSearch 2.12及之前版本：默认密码为admin
• OpenSearch 2.12及之后版本：密码为部署时通过OPENSEARCH_INITIAL_ADMIN_PASSWORD指定的自定义值

bash
curl -X GET "https://localhost:9200" -ku admin:<password>
curl -X GET "https://localhost:9200/_cat/nodes?v" -ku admin:<password>
curl -X GET "https://localhost:9200/_cat/plugins?v" -ku admin:<password>

容器管理

可通过容器ID或名称停止、启动和重启容器：

bash
# 停止容器
docker stop opensearch-node

# 启动容器
docker start opensearch-node

# 重启容器
docker restart opensearch-node

启动集群

使用https://docs.docker.com/compose/%E6%90%AD%E5%BB%BAOpenSearch%E9%9B%86%E7%BE%A4%E3%80%82%E8%8B%A5%E4%BD%BF%E7%94%A8https://www.docker.com/products/docker-desktop/%EF%BC%8CDocker Compose已预装，可直接使用docker compose命令；否则需手动安装。

安装Docker Compose（若未安装）

若环境已安装Python，可使用pip安装：

bash
pip install docker-compose

定义集群配置

OpenSearch项目提供示例https://github.com/opensearch-project/opensearch-build/tree/main/docker/release/dockercomposefiles%E3%80%82%E5%88%9B%E5%BB%BA%E8%AF%A5%E6%96%87%E4%BB%B6%E5%90%8E%EF%BC%8C%E4%BD%BF%E7%94%A8Docker Compose管理集群。

启动集群

进入docker-compose.yml所在目录，后台启动集群：

bash
docker-compose up -d

停止集群

bash
docker-compose down

若需同时删除关联数据卷：

bash
docker-compose down -v

许可信息

OpenSearch及其包含的插件采用https://www.apache.org/licenses/LICENSE-2.0%E8%AE%B8%E5%8F%AF%E3%80%82

支持与反馈

• 维护者：https://github.com/opensearch-project
• 社区论坛：在https://forum.opensearch.org/%E6%8F%90%E9%97%AE%E5%92%8C%E8%AE%A8%E8%AE%BA
• 问题跟踪：通过https://github.com/opensearch-project/opensearch-build/issues%E6%8A%A5%E5%91%8A%E6%9E%84%E5%BB%BA%E6%88%96Docker%E9%95%9C%E5%83%8F%E9%97%AE%E9%A2%98