使用 Docker Compose 部署 Nebula Graph

使用 Docker Compose 可以基于准备好的配置文件快速部署 Nebula Graph 服务，仅建议在测试 Nebula Graph 功能时使用该方式。

前提条件

• 主机上安装如下应用程序。

  应用程序	推荐版本	官方安装参考
  Docker	最新版本	Install Docker Engine
  Docker Compose	最新版本	Install Docker Compose
  Git	最新版本	Download Git

• 如果使用非 root 用户部署 Nebula Graph，请授权该用户 Docker 相关的权限。详细信息，请参见 Manage Docker as a non-root user。

• 启动主机上的 Docker 服务。

• 如果已经通过 Docker Compose 在主机上部署了另一个版本的 Nebula Graph，为避免兼容性问题，需要删除目录nebula-docker-compose/data。

部署和连接 Nebula Graph

1. 通过 Git 克隆nebula-docker-compose仓库的3.1.0分支到主机。

   Danger

   master分支包含最新的未测试代码。请不要在生产环境使用此版本。

   $ git clone -b release-3.1 https://github.com/vesoft-inc/nebula-docker-compose.git
   

   Note

   Docker Compose 的x.y版本对齐内核的x.y版本，对于内核z版本，Docker Compose 不会发布对应的z版本，但是会拉取z版本的内核镜像。

2. 切换至目录nebula-docker-compose。

   $ cd nebula-docker-compose/
   

3. 执行如下命令启动 Nebula Graph 服务。

   从 3.0.2 开始，Nebula Graph 在 Docker Hub 上的 Docker 支持 ARM64 架构。用户可以在 ARM macOS 的 Docker Desktop 上或者 ARM Linux Server 上运行容器化的 Nebula Graph。

   Note

   如果长期未内核更新镜像，请先更新 Nebula Graph 镜像和 Nebula Console 镜像。

   [nebula-docker-compose]$ docker-compose up -d
   Creating nebula-docker-compose_metad0_1 ... done
   Creating nebula-docker-compose_metad2_1 ... done
   Creating nebula-docker-compose_metad1_1 ... done
   Creating nebula-docker-compose_graphd2_1   ... done
   Creating nebula-docker-compose_graphd_1    ... done
   Creating nebula-docker-compose_graphd1_1   ... done
   Creating nebula-docker-compose_storaged0_1 ... done
   Creating nebula-docker-compose_storaged2_1 ... done
   Creating nebula-docker-compose_storaged1_1 ... done
   

   Note

   上述服务的更多信息，请参见架构总览。

4. 连接 Nebula Graph。

   Compatibility

   从 3.1 版本开始，Docker-compose 会自动启动 Nebula Console 镜像的容器，并将 Storage 主机增加至集群中（即ADD HOSTS命令）。

   1. 使用docker-compose ps命令查看 Nebula Console 容器名称。

      $ docker-compose ps
                Name                         Command             State                 Ports
      ----------------------------------------------------------------------------------------------
      nebula-docker-compose_console_1     sh -c sleep 3 &&          Up
                                         nebula-co ...
      ......
      

   2. 进入 Nebula Console 容器中。

      $ docker exec -it nebula-docker-compose_console_1 /bin/sh
      / #
      

   3. 通过 Nebula Console 连接 Nebula Graph。

      / # ./usr/local/bin/nebula-console -u <user_name> -p <password> --address=graphd --port=9669
      

      Note

      默认情况下，身份认证功能是关闭的，只能使用已存在的用户名（默认为root）和任意密码登录。如果想使用身份认证，请参见身份认证。

   4. 查看集群状态。

      nebula> SHOW HOSTS;
      +-------------+------+-----------+----------+--------------+----------------------+------------------------+---------+
      | Host        | Port | HTTP port | Status   | Leader count | Leader distribution  | Partition distribution | Version |
      +-------------+------+-----------+----------+--------------+----------------------+------------------------+---------+
      | "storaged0" | 9779 | 19669     | "ONLINE" | 0            | "No valid partition" | "No valid partition"   | "3.1.0" |
      | "storaged1" | 9779 | 19669     | "ONLINE" | 0            | "No valid partition" | "No valid partition"   | "3.1.0" |
      | "storaged2" | 9779 | 19669     | "ONLINE" | 0            | "No valid partition" | "No valid partition"   | "3.1.0" |
      +-------------+------+-----------+----------+--------------+----------------------+------------------------+---------+
      

5. 执行两次exit可以退出容器。

查看 Nebula Graph 服务的状态和端口

执行命令docker-compose ps可以列出 Nebula Graph 服务的状态和端口。

$ docker-compose ps
nebula-docker-compose_console_1     sh -c sleep 3 &&                 Up
                                  nebula-co ...
nebula-docker-compose_graphd1_1     /usr/local/nebula/bin/nebu ...   Up      0.0.0.0:49174->19669/tcp,:::49174->19669/tcp, 0.0.0.0:49171->19670/tcp,:::49171->19670/tcp, 0.0.0.0:49177->9669/tcp,:::49177->9669/tcp
nebula-docker-compose_graphd2_1     /usr/local/nebula/bin/nebu ...   Up      0.0.0.0:49175->19669/tcp,:::49175->19669/tcp, 0.0.0.0:49172->19670/tcp,:::49172->19670/tcp, 0.0.0.0:49178->9669/tcp,:::49178->9669/tcp
nebula-docker-compose_graphd_1      /usr/local/nebula/bin/nebu ...   Up      0.0.0.0:49180->19669/tcp,:::49180->19669/tcp, 0.0.0.0:49179->19670/tcp,:::49179->19670/tcp, 0.0.0.0:9669->9669/tcp,:::9669->9669/tcp
nebula-docker-compose_metad0_1      /usr/local/nebula/bin/nebu ...   Up      0.0.0.0:49157->19559/tcp,:::49157->19559/tcp, 0.0.0.0:49154->19560/tcp,:::49154->19560/tcp, 0.0.0.0:49160->9559/tcp,:::49160->9559/tcp, 9560/tcp
nebula-docker-compose_metad1_1      /usr/local/nebula/bin/nebu ...   Up      0.0.0.0:49156->19559/tcp,:::49156->19559/tcp, 0.0.0.0:49153->19560/tcp,:::49153->19560/tcp, 0.0.0.0:49159->9559/tcp,:::49159->9559/tcp, 9560/tcp
nebula-docker-compose_metad2_1      /usr/local/nebula/bin/nebu ...   Up      0.0.0.0:49158->19559/tcp,:::49158->19559/tcp, 0.0.0.0:49155->19560/tcp,:::49155->19560/tcp, 0.0.0.0:49161->9559/tcp,:::49161->9559/tcp, 9560/tcp
nebula-docker-compose_storaged0_1   /usr/local/nebula/bin/nebu ...   Up      0.0.0.0:49166->19779/tcp,:::49166->19779/tcp, 0.0.0.0:49163->19780/tcp,:::49163->19780/tcp, 9777/tcp, 9778/tcp, 0.0.0.0:49169->9779/tcp,:::49169->9779/tcp, 9780/tcp
nebula-docker-compose_storaged1_1   /usr/local/nebula/bin/nebu ...   Up      0.0.0.0:49165->19779/tcp,:::49165->19779/tcp, 0.0.0.0:49162->19780/tcp,:::49162->19780/tcp, 9777/tcp, 9778/tcp, 0.0.0.0:49168->9779/tcp,:::49168->9779/tcp, 9780/tcp
nebula-docker-compose_storaged2_1   /usr/local/nebula/bin/nebu ...   Up      0.0.0.0:49167->19779/tcp,:::49167->19779/tcp, 0.0.0.0:49164->19780/tcp,:::49164->19780/tcp, 9777/tcp, 9778/tcp, 0.0.0.0:49170->9779/tcp,:::49170->9779/tcp, 9780/tcp

Nebula Graph 默认使用9669端口为客户端提供服务，如果需要修改端口，请修改目录nebula-docker-compose内的文件docker-compose.yaml，然后重启 Nebula Graph 服务。

查看 Nebula Graph 服务的数据和日志

Nebula Graph 的所有数据和日志都持久化存储在nebula-docker-compose/data和nebula-docker-compose/logs目录中。

目录的结构如下：

nebula-docker-compose/
  |-- docker-compose.yaml
  ├── data
  │   ├── meta0
  │   ├── meta1
  │   ├── meta2
  │   ├── storage0
  │   ├── storage1
  │   └── storage2
  └── logs
      ├── graph
      ├── graph1
      ├── graph2
      ├── meta0
      ├── meta1
      ├── meta2
      ├── storage0
      ├── storage1
      └── storage2

停止 Nebula Graph 服务

用户可以执行如下命令停止 Nebula Graph 服务：

$ docker-compose down

如果返回如下信息，表示已经成功停止服务。

Stopping nebula-docker-compose_console_1   ... done
Stopping nebula-docker-compose_graphd1_1   ... done
Stopping nebula-docker-compose_graphd2_1   ... done
Stopping nebula-docker-compose_storaged0_1 ... done
Stopping nebula-docker-compose_storaged1_1 ... done
Stopping nebula-docker-compose_storaged2_1 ... done
Stopping nebula-docker-compose_metad0_1    ... done
Stopping nebula-docker-compose_metad2_1    ... done
Stopping nebula-docker-compose_metad1_1    ... done
Removing nebula-docker-compose_console_1             ... done
Removing nebula-docker-compose_graphd1_1             ... done
Removing nebula-docker-compose_graphd2_1             ... done
Removing nebula-docker-compose_graphd_1              ... done
Removing nebula-docker-compose_storaged0_1           ... done
Removing nebula-docker-compose_storaged1_1           ... done
Removing nebula-docker-compose_storaged2_1           ... done
Removing nebula-docker-compose_metad0_1              ... done
Removing nebula-docker-compose_metad2_1              ... done
Removing nebula-docker-compose_metad1_1              ... done
Removing network nebula-docker-compose_nebula-net

Danger

命令docker-compose down -v的参数-v将会删除所有本地的数据。如果使用的是 nightly 版本，并且有一些兼容性问题，请尝试这个命令。

修改配置

Docker Compose 部署的 Nebula Graph，配置文件位置为nebula-docker-compose/docker-compose.yaml，修改该文件内的配置并重启服务即可使新配置生效。

具体的配置说明请参见配置管理。

常见问题

如何固定 Docker 映射到外部的端口？

在目录nebula-docker-compose内修改文件docker-compose.yaml，将对应服务的ports设置为固定映射，例如：

graphd:
    image: vesoft/nebula-graphd:release-3.1
    ...
    ports:
      - 9669:9669
      - 19669
      - 19670

9669:9669表示内部的 9669 映射到外部的端口也是 9669，下方的19669表示内部的 19669 映射到外部的端口是随机的。

如何升级/更新 Nebula Graph 服务的 Docker 镜像？

1. 在文件nebula-docker-compose/docker-compose.yaml中，找到所有服务的image并修改其值为相应的镜像版本。

2. 在目录nebula-docker-compose内执行命令docker-compose pull，更新 Graph 服务、Storage 服务、Meta 服务和 Nebula Console 的镜像。

3. 执行命令docker-compose up -d启动 Nebula Graph 服务。

4. 通过 Nebula Console 连接 Nebula Graph 后，分别执行命令SHOW HOSTS GRAPH、SHOW HOSTS STORAGE、SHOW HOSTS META查看各服务版本。

执行命令docker-compose pull报错ERROR: toomanyrequests

可能遇到如下错误：

ERROR: toomanyrequests: You have reached your pull rate limit. You may increase the limit by authenticating and upgrading: https://www.docker.com/increase-rate-limit

以上错误表示已达到 Docker Hub 的速率限制。解决方案请参见 Understanding Docker Hub Rate Limiting。

如何更新 Nebula Console？

docker-compose pull会同时更新 Nebula Graph 服务和 Nebula Console。

---

最后更新: June 20, 2023