跳转至

部署 StudioGraph

本文介绍如何在本地通过 Docker、RPM、DEB 和 tar 包部署 Studio。

Note

用户也可以在 Graph 在线试用部分功能。

RPM 部署 StudioGraph

前提条件Graph

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

  • NebulaGraph 服务已经部署并启动。详细信息，参考 Graph。
  • 使用的 Linux 发行版为 CentOS ，安装有 lsof。

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

    端口号 说明
    7001 Studio 提供 web 服务使用。

安装Graph

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

    安装包 检验和 Nebula 版本
    Graph Graph 3.0.1

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

    例如，安装 Studio 3.2.3 版本需要运行以下命令，默认安装路径为/usr/local/nebula-graph-studio：

    $ sudo rpm -i nebula-graph-studio-3.2.3.x86_64.rpm
    也可以使用以下命令安装到指定路径： 
    $ sudo rpm -i nebula-graph-studio-3.2.3.x86_64.rpm --prefix=<path>

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

    Created symlink from /etc/systemd/system/multi-user.target.wants/nebula-graph-studio.service to /usr/lib/systemd/system/nebula-graph-studio.service.

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

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

    NebulaGraph Studio 登录界面

卸载Graph

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

$ sudo rpm -e nebula-graph-studio-3.2.3.x86_64

异常处理Graph

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

  • 手动启动服务 
    $ bash /usr/local/nebula-graph-studio/scripts/start.sh
  • 手动停止服务 
    $ bash /usr/local/nebula-graph-studio/scripts/stop.sh

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

$ lsof -i:7001

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

//修改 studio 服务启动端口
$ vi config/example-config.yaml

//修改
web:
#  task_id_path:
#  upload_dir:
#  tasks_dir:
#  sqlitedb_file_path:
#  ip:
  port: 7001 // 修改这个端口号，改成任意一个当前可用的即可

//重启服务
$ systemctl restart nebula-graph-studio.service

tar 包部署 StudioGraph

前提条件Graph

在部署 tar 包安装的 Studio 之前，用户需要确认以下信息：

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

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

    端口号 说明
    7001 Studio 提供的 web 服务

安装部署Graph

  1. 根据需要下载 tar 包，建议选择最新版本。

    安装包 Studio 版本
    Graph 3.2.3

  2. 使用 tar -xvf 解压 tar 包。

    tar -xvf nebula-graph-studio-3.2.3.x86_64.tar.gz

  3. 部署 nebula-graph-studio 并启动。

    $ cd nebula-graph-studio
$ ./server

    Caution

    Studio 3.2.3 版本不需要依赖于 nebula-importer 和 nebula-http-gateway，故安装部署方式与 Studio v3.1.0 不同。

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

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

    NebulaGraph Studio 登录界面

停止服务Graph

用户可以采用 kill pid 的方式来关停服务： 

$ kill $(lsof -t -i :7001) # stop nebula-graph-studio

DEB 部署 StudioGraph

前提条件Graph

在通过 DEB 部署安装 Studio 之前，用户需要确认以下信息：

  • NebulaGraph 服务已经部署并启动。详细信息，参考 Graph。
  • 使用的 Linux 发行版为 Ubuntu。

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

    端口号 说明
    7001 Studio 提供的 web 服务
  • 确保系统中存在/usr/lib/systemd/system目录。如没有该目录，需手动创建。

安装Graph

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

    安装包 检验和 Nebula 版本
    Graph Graph 3.0.1

  2. 使用sudo dpkg -i <deb>命令安装 DEB 包。

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

    $ sudo dpkg -i nebula-graph-studio-3.2.3.x86_64.deb

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

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

    NebulaGraph Studio 登录界面

卸载Graph

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

$ sudo dpkg -r nebula-graph-studio

Docker 部署 StudioGraph

前提条件Graph

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

  • NebulaGraph 服务已经部署并启动。详细信息，参考 Graph。
  • 在即将运行 Docker 版 Studio 的机器上安装并启动 Docker Compose。详细信息参考 Graph。

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

    端口号 说明
    7001 Studio 提供的 web 服务

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

    {
"registry-mirrors": [
  "https://registry.docker-cn.com",
  "http://hub-mirror.c.163.com",
  "https://docker.mirrors.ustc.edu.cn"
  ]
}

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

操作步骤Graph

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

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

    安装包 NebulaGraph 版本
    Graph 3.0.1

  2. 创建nebula-graph-studio-v3.2.3目录，并将安装包解压至目录中。

    mkdir nebula-graph-studio-v3.2.3 && tar -zxvf nebula-graph-studio-v3.2.3.tar.gz -C nebula-graph-studio-v3.2.3

  3. 解压后进入 nebula-graph-studio-v3.2.3 目录。

    cd nebula-graph-studio-v3.2.3

  4. 拉取 Studio 的 Docker 镜像。

    docker-compose pull

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

    docker-compose up -d

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

    Creating docker_web_1      ... done

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

    Note

    在运行 Docker 版 Studio 的机器上，用户可以运行 ifconfig 或者 ipconfig 获取本机 IP 地址。如果使用这台机器访问 Studio，可以在浏览器地址栏里输入 http://localhost:7001。

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

    NebulaGraph Studio 登录界面

后续操作Graph

进入 Studio 登录界面后，用户需要连接 NebulaGraph。详细信息，参考Graph。

最后更新: July 20, 2022