部署 Studio

Nebula Graph Studio（ 以下简称 Studio ）支持云端或本地部署。云服务版 Studio 只能在 Nebula Graph Cloud Service 上使用。当您在 Nebula Graph Cloud Service 上创建 Nebula Graph 实例时即自动完成云服务版本 Studio 的部署，一键直连即可使用，不需要自己部署。详细信息参考《Nebula Graph Cloud Service 用户手册》。本文介绍如何在本地通过 Docker 和 RPM 部署 Studio。

Docker 部署 Studio

前提条件

在部署 Docker 版 Studio 之前，您需要确认以下信息：

  • Nebula Graph 服务已经部署并启动。详细信息，参考Nebula Graph安装部署。

  • 在即将运行 Docker 版 Studio 的机器上安装并启动 Docker Compose。详细信息参考 Docker Compose 文档。

  • 确保在安装开始前，以下端口处于未被使用状态。

    端口号说明
    7001Studio提供的web服务
    8080Nebula-http-gateway，Client的HTTP服务
    5699Nebula importer文件导入工具，数据导入服务

  • （可选）在中国大陆从 Docker Hub 拉取 Docker 镜像的速度可能比较慢，您可以使用 registry-mirrors 参数配置加速镜像。例如，如果您要使用 Docker 中国区官方镜像、网易镜像和中国科技大学的镜像，则按以下格式配置 registry-mirrors 参数：

    1. {
    2. "registry-mirrors": [
    3.   "https://registry.docker-cn.com",
    4.   "http://hub-mirror.c.163.com",
    5.   "https://docker.mirrors.ustc.edu.cn"
    6.   ]
    7. }

    配置文件的路径和方法因您的操作系统和/或 Docker Desktop 版本而异。详细信息参考 Docker Daemon 配置文档。

操作步骤

在命令行工具中按以下步骤依次运行命令，部署并启动 Docker 版 Studio，这里我们用 Nebula Graph 版本为 2.x 的进行演示：

  1. 下载 Studio 的部署配置文件。

    安装包Nebula Graph版本
    nebula-graph-studio-v1.tar.gz1.x
    nebula-graph-studio-v2.tar.gz2.x

  2. 解压后进入 nebula-graph-studio-v2 目录。

    1. cd nebula-graph-studio-v2

  3. 拉取 Studio 的 Docker 镜像。

    1. docker-compose pull

  4. 构建并启动 Studio 服务。其中，-d 表示在后台运行服务容器。

    1. docker-compose up -d

    当屏幕返回以下信息时，表示 Docker 版 Studio 已经成功启动。

    1. Creating docker_importer_1 ... done
    2. Creating docker_client_1   ... done
    3. Creating docker_web_1      ... done
    4. Creating docker_nginx_1    ... done

  5. 启动成功后，在浏览器地址栏输入 http://ip address:7001。

    如果您在浏览器窗口中能看到以下登录界面，表示您已经成功部署并启动 Studio。

    Nebula Graph Studio 登录界面

RPM 部署Studio

前提条件

在部署 RPM 版 Studio 之前，您需要确认以下信息：

  • Nebula Graph 服务已经部署并启动。详细信息，参考Nebula Graph 安装部署。

    • 您的使用的 Linux 发行版为 CentOS ，安装有 losf 和版本为 v10.16.0 + 以上的 Node.js。

  • 确保在安装开始前，以下端口处于未被使用状态。

    端口号说明
    7001Studio提供的web服务
    8080Nebula-http-gateway，Client的HTTP服务
    5699Nebula importer文件导入工具，数据导入服务

安装

  1. 根据需要选择并下载RPM包，建议您选择最新版本。常用下载链接如下：

    安装包检验和Nebula版本
    nebula-graph-studio-2.2.1-1.x86_64.rpmnebula-graph-studio-2.2.1-1.x86_64.rpm.sha2562.0.1
    nebula-graph-studio-2.2.0-1.x86_64.rpmnebula-graph-studio-2.2.0-1.x86_64.rpm.sha2562.0.1
    nebula-graph-studio-2.1.9-1.x86_64.rpm-2.0 GA
    nebula-graph-studio-1.2.7-2.x86_64.rpmnebula-graph-studio-1.2.7-2.x86_64.rpm.sha2561.x

  2. 使用sudo rpm -i <rpm>命令安装RPM包。

    例如，安装Studio 2.2.0 版本需要运行以下命令：

    1. $ sudo rpm -i nebula-graph-studio-2.2.0-1.x86_64.rpm

卸载

您可以使用以下的命令卸载 Studio。

  1. $ sudo rpm -e nebula-graph-studio-2.2.0-1.x86_64

异常处理

如果您在安装过程中自动启动失败或是您需要手动启动或停止服务，请使用以下命令

  • 手动启动服务

    1. $ bash /usr/local/nebula-graph-studio/scripts/start.sh

  • 手动停止服务

    1. $ bash /usr/local/nebula-graph-studio/scripts/stop.sh

如果启动服务时遇到报错报错 ERROR: bind EADDRINUSE 0.0.0.0:7001，您可以通过以下命令查看端口7001是否被占用。

  1. $ lsof -i:7001

如果端口被占用，且无法结束该端口上进程，您可以通过以下命令修改Studio服务启动端口，并重新启动服务。

  1. //修改studio服务启动端口
  2.  $ vi config/config.default.js
  4.  //修改
  5.  ...
  6.      config.cluster = {
  7.          listen: {
  8.              port: 7001, // 修改这个端口号，改成任意一个当前可用的即可
  9.              hostname: '0.0.0.0',
  10.          },
  11.      };
  12.  ...
  14.  //重新启动npm
  15.  $ npm run start

后续操作

进入 Studio 登录界面后，您需要连接 Nebula Graph。详细信息，参考连接数据库。