快速安装

OpenSearch 支持多种安装方法：Docker、Debian、Helm、RPM、tarball 和 Windows。本指南使用 Docker 进行快速本地设置。有关其他安装选项，请参阅完整的安装和升级 OpenSearch 指南。

有两种入门方式

一键试用 OpenSearch – 非常适合快速演示。
设置自定义 Docker 集群 – 适合需要更多控制的场景。

先决条件

开始之前，请在您的机器上安装 Docker。

选项 1：一键试用 OpenSearch

使用此方法可在您的本地机器上快速启动 OpenSearch，设置最少。

此配置会禁用安全性，应仅在测试环境中使用。

下载并运行 OpenSearch

docker pull opensearchproject/opensearch:latest && docker run -it -p 9200:9200 -p 9600:9600 -e "discovery.type=single-node" -e "DISABLE_SECURITY_PLUGIN=true" opensearchproject/opensearch:latest

此过程可能需要一些时间。完成后，OpenSearch 将在端口 9200 上运行。要验证 OpenSearch 是否正在运行，请发送以下请求

curl https://:9200

您应该会收到如下响应：

{
  "name" : "a937e018cee5",
  "cluster_name" : "docker-cluster",
  "cluster_uuid" : "GLAjAG6bTeWErFUy_d-CLw",
  "version" : {
    "distribution" : "opensearch",
    "number" : <version>,
    "build_type" : <build-type>,
    "build_hash" : <build-hash>,
    "build_date" : <build-date>,
    "build_snapshot" : false,
    "lucene_version" : <lucene-version>,
    "minimum_wire_compatibility_version" : "7.10.0",
    "minimum_index_compatibility_version" : "7.0.0"
  },
  "tagline" : "The OpenSearch Project: https://opensearch.org.cn/"
}

选项 2：设置自定义 Docker 集群

使用 Docker Compose 运行本地多节点 OpenSearch 和 OpenSearch Dashboards 集群

设置无安全性的集群 – 最适合本地开发。
设置带安全性的集群 – 通过安装默认证书来试用带安全性的 OpenSearch。

设置无安全性的集群（用于本地开发）

此设置使用一个已禁用安全性的开发 Docker Compose 文件。

此配置会禁用安全性，应仅在测试环境中使用。

为您的 OpenSearch 集群创建一个目录（例如，opensearch-cluster）。在此目录中创建一个 docker-compose.yml 文件，并将开发用的 Docker Compose 文件的内容复制到此文件中。
运行以下命令启动集群
```
 docker compose up -d
```

检查容器是否正在运行

 docker compose ps

您应该会看到类似以下内容的输出

 NAME                    COMMAND                  SERVICE                 STATUS              PORTS
 opensearch-dashboards   "./opensearch-dashbo…"   opensearch-dashboards   running             0.0.0.0:5601->5601/tcp
 opensearch-node1        "./opensearch-docker…"   opensearch-node1        running             0.0.0.0:9200->9200/tcp, 9300/tcp, 0.0.0.0:9600->9600/tcp, 9650/tcp
 opensearch-node2        "./opensearch-docker…"   opensearch-node2        running             9200/tcp, 9300/tcp, 9600/tcp, 9650/tcp

要验证 OpenSearch 是否正在运行，请发送以下请求
```
 curl https://:9200
```
您应该会收到与选项 1 中类似的响应。

现在您可以通过打开 https://:5601/ 探索 OpenSearch Dashboards。

设置带安全性的集群（推荐用于大多数用例）

此配置使用演示证书启用安全性，并需要额外的系统设置。

在您的机器上运行 OpenSearch 之前，您应该禁用主机的内存分页和交换性能，以提高性能并增加 OpenSearch 可用的内存映射数量。

禁用内存分页和交换
```
 sudo swapoff -a
```
编辑定义主机最大映射计数的 sysctl 配置文件
```
 sudo vi /etc/sysctl.conf
```
将最大映射计数设置为推荐值 262144
```
 vm.max_map_count=262144
```
重新加载内核参数
```
 sudo sysctl -p
```
有关更多信息，请参阅重要系统设置。
将示例 Compose 文件下载到您的主机。您可以使用 curl 和 wget 等命令行实用程序下载文件，或者您可以使用网络浏览器从 OpenSearch Project 文档网站仓库手动复制 docker-compose.yml。

要使用 cURL，请发送以下请求
```
 curl -O https://raw.githubusercontent.com/opensearch-project/documentation-website/3.1/assets/examples/docker-compose.yml
```
要使用 wget，请发送以下请求
```
 wget https://raw.githubusercontent.com/opensearch-project/documentation-website/3.1/assets/examples/docker-compose.yml
```
在您的终端应用程序中，导航到包含您下载的 docker-compose.yml 文件的目录，设置自定义管理员密码，并运行以下命令以在后台进程中创建并启动集群
```
 docker compose up -d
```

使用以下命令确认容器正在运行

 docker compose ps

您应该会看到类似以下内容的输出

 NAME                    COMMAND                  SERVICE                 STATUS              PORTS
 opensearch-dashboards   "./opensearch-dashbo…"   opensearch-dashboards   running             0.0.0.0:5601->5601/tcp
 opensearch-node1        "./opensearch-docker…"   opensearch-node1        running             0.0.0.0:9200->9200/tcp, 9300/tcp, 0.0.0.0:9600->9600/tcp, 9650/tcp
 opensearch-node2        "./opensearch-docker…"   opensearch-node2        running             9200/tcp, 9300/tcp, 9600/tcp, 9650/tcp

验证 OpenSearch 是否正在运行。您应该使用 -k（也写作 --insecure）来禁用主机名检查，因为默认安全配置使用演示证书。使用 -u 传递默认用户名和密码（admin:<custom-admin-password>）
```
 curl https://:9200 -ku admin:<custom-admin-password>
```
您应该会收到与选项 1 中类似的响应。

现在，您可以通过在运行 OpenSearch 集群的同一主机上的网络浏览器中打开 https://:5601/ 来探索 OpenSearch Dashboards。默认用户名为 admin，默认密码在您的 docker-compose.yml 文件的 OPENSEARCH_INITIAL_ADMIN_PASSWORD=<custom-admin-password> 设置中设置。

常见问题

如果您的容器未能启动或意外退出，请查看这些常见问题和建议的解决方案。

Docker 命令需要提升权限

通过将您的用户添加到 docker 用户组来避免在 Docker 命令前运行 sudo。有关更多信息，请参阅 Docker 的Linux 安装后步骤。

sudo usermod -aG docker $USER

错误消息：“-bash: docker-compose: command not found”

如果您安装了 Docker Desktop，则 Docker Compose 已安装在您的机器上。请尝试使用 docker compose（不带连字符）而不是 docker-compose。请参阅使用 Docker Compose。

错误消息：“docker: ‘compose’ is not a docker command.”

如果您安装了 Docker Engine，则必须单独安装 Docker Compose，并且您将使用命令 docker-compose（带连字符）。请参阅Docker Compose。

错误消息：“max virtual memory areas vm.max_map_count [65530] is too low”

如果您的主机的 vm.max_map_count 过低，OpenSearch 将无法启动。如果您在服务日志中看到以下错误，请查看重要系统设置，并相应地设置 vm.max_map_count。

opensearch-node1         | ERROR: [1] bootstrap checks failed
opensearch-node1         | [1]: max virtual memory areas vm.max_map_count [65530] is too low, increase to at least [262144]
opensearch-node1         | ERROR: OpenSearch did not exit normally - check the logs at /usr/share/opensearch/logs/opensearch-cluster.log

其他安装类型

除了 Docker，您还可以在各种 Linux 发行版和 Windows 上安装 OpenSearch。有关所有可用的安装指南，请参阅安装和升级 OpenSearch。

延伸阅读

您已成功部署了自己的 OpenSearch 集群，包括 OpenSearch Dashboards 并添加了一些示例数据。现在您可以更详细地了解配置和功能。以下是一些建议的入门点

后续步骤

请参阅与 OpenSearch 通信以了解如何向 OpenSearch 发送请求。

先决条件
选项 1：一键试用 OpenSearch
选项 2：设置自定义 Docker 集群
- 设置无安全性的集群（用于本地开发）
- 设置带安全性的集群（推荐用于大多数用例）
常见问题
其他安装类型
延伸阅读
后续步骤

此页面有帮助吗？

✔ 是 ✖ 否

告诉我们原因

剩余 350 字符

有问题？在 OpenSearch 论坛上提问。

想贡献？编辑此页面或创建问题。