Developer Tools

开发说明

如何部署3d一览通SDK

概述

本文描述了如何将3D一览通作为第三方系统的子模块进行私有化集成。集成开发人员可以了解3D一览通安装部署时所需的环境，以及安装时的操作流程。

3D一览通分为文件转换服务、文件存储服务、3D模型浏览器三部分，完成本文所述安装后，可将文件转换服务、3D模型浏览器两部分部署于给定物理机上，文件存储服务需要客户自行提供，或使用提供的本地Mock程序提供服务。在安装前，请确保文件存储服务已正常运行。

预先准备

提供的安装文件包括：可执行文件install、可执行文件update，分别用于在线安装、更新。

首次安装

子虔3D一览通私有化版本基于Debian 12.5 版本，使用docker compose 安装部署，在硬件、网络、操作系统、系统组件满足的情况下，3D一览通可通过部署脚本自动安装。

整个部署过程需要有以下几个步骤。

准备硬件。x86_64架构服务器，物理机。
安装系统。Debian 12.5。
1. GLIBC 2.34或以上版本
配置系统
1. 建议直接使用root用户运行脚本。若使用其它用户，需要：
  1. 添加脚本执行用户为sudoer
  2. 为脚本执行用户添加软件安装权限、服务启停权限
2. 启用ssh-server 用于远程登录
  1. 允许ssh登录root用户
  2. 为了方便后续对接排除故障，查看日志等操作，建议为子虔准备ssh访问用户。
3. 配置网络
  1. 配置固定IP地址，多机之间网络互相连通，且在同一子网下。
  2. 支持在线或离线安装，如果需要离线安装，需要联系子虔提供离线安装包。
4. 如果使用离线安装，需要事先在目标服务器上安装docker、docker compose。
复制安装必要文件。将可执行文件install放在目录下，并创建安装目标地址空文件夹target。
1. 如果是离线安装，还需要将相关源文件放在目录下，包括zixelviewer-xxx(其中xxx为版本号)，transform2-base.tar.gz，transform2-update-{tag}.tar.gz，envpkg-tar.gz(环境离线安装当前仅支持yum)
```
# 在线安装目录结构
transform2
|-install
|-target
# 离线安装目录结构
transform2
|-install
|-zixelviewer-xxx
|-transform2-base.tar.gz
|-transform2-update-{tag}.tar.gz
|-envpkg-tar.gz
|-target
```

执行一键部署脚本。

如果是离线安装，需要将zixelviewer-xxx，base压缩包，update压缩包三个文件放入install.sh源文件地址作为参数传入。

cd transform2
# 在线安装，默认使用此方式即可
./install ./target zixelviewer-xxx 
# 如果本地已有相关文件，可以将文件地址作为参数传入，避免反复下载
./install ./target zixelviewer-xxx <base> <update> 
# 完全离线安装
./install ./target zixelviewer-xxx <base> <update> <envpkg>

在线服务注册。
1. 请根据在线/离线实际情况，参考服务注册一节。
注册成功后，会要求输入文件存储服务连接地址，请输入你的Storage Service的[域名/IP]:[端口号]
1. 如果使用附带的StorageMock服务，在同一服务器上运行后，此处输入地址为HOST_IP:8000，其中HOST_IP为docker容器内可以访问到的宿主机ip地址。
等待服务启动完成，稳定运行，完成安装。

# 服务启动完成会有以下提示
[+] Running 12/12
 ✔ Network transform2                Created                                0.1s
 ✔ Container temporal-elasticsearch  Started                                0.1s
 ✔ Container temporal-postgresql     Started                                0.1s
 ✔ Container redis                   Started                                0.1s
 ✔ Container mongo                   Started                                0.1s
 ✔ Container temporal                Started                                0.0s
 ✔ Container temporal-admin-tools    Started                                0.0s
 ✔ Container worker-downloader       Started                                0.0s
 ✔ Container scheduler               Started                                0.0s
 ✔ Container worker-executor         Started                                0.0s
 ✔ Container transform2              Started                                0.0s
 ✔ Container temporal-ui             Started                                0.0s

客户端验证。
1. docker ps -adocker查看容器均处于稳定运行状态时，表示安装已经完成。
2. 通过${您的实际访问域名}:8742/transform2/z3d/可以查看 Demo。
3. 可以通过正常业务调用创建任务，验证文件转换服务及文件存储服务是否正常。