imbajin commented on code in PR #324: URL: https://github.com/apache/incubator-hugegraph-doc/pull/324#discussion_r1457051625
########## content/cn/docs/config/config-authentication.md: ########## @@ -73,13 +73,15 @@ gremlin.graph=org.apache.hugegraph.auth.HugeFactoryAuthProxy 在鉴权配置完成后，需在首次执行 `init-store.sh` 时命令行中输入 `admin` 密码 (非 docker 部署模式下) -如果基于 docker 镜像部署或者已经初始化 HugeGraph 并需要转换为鉴权模式，需要删除相关图数据并重新启动 HugeGraph，若图已有业务数据，暂时**无法直接转换**鉴权模式 (对于该功能的改进将在下个版本发布，修改方式可参考 [PR 2411](https://github.com/apache/incubator-hugegraph/pull/2411))。 +如果基于 docker 镜像部署或者已经初始化 HugeGraph 并需要转换为鉴权模式，需要删除相关图数据并重新启动 HugeGraph, 若图已有业务数据，暂时**无法直接转换**鉴权模式 (hugegraph 版本 <= 1.2.0) +> 对于该功能的改进已经在最新版本发布，修改方式可参考 [PR 2411](https://github.com/apache/incubator-hugegraph/pull/2411), 此时无需删除原本存储的数据。 Review Comment: ```suggestion > 对于该功能的改进已经在最新版本发布(Docker latest 可用)，可参考 [PR 2411](https://github.com/apache/incubator-hugegraph/pull/2411), 此时可无缝切换。 ``` ########## content/cn/docs/quickstart/hugegraph-hubble.md: ########## @@ -36,11 +36,45 @@ HugeGraph 是一款面向分析型，支持批量操作的图数据库系统， 有三种方式可以部署`hugegraph-hubble` +- 使用 docker (便于**测试**) - 下载 toolchain 二进制包 - 源码编译 -- 使用 docker (便于**测试**) -#### 2.1 下载 toolchain 二进制包 +#### 2.1 使用 Docker (便于**测试**) + +> **特别注意**: docker 模式下，若 hubble 和 server 在同一宿主机，hubble 页面中设置 graph 的 `hostname` **不能设置**为 `localhost/127.0.0.1`，因这会指向 hubble **容器内部**而非宿主机，导致无法连接到 server. +> +> 若 hubble 和 server 在同一 docker 网络下，**推荐**直接使用`container_name` (如下例的 `graph`) 作为主机名。或者也可以使用 **宿主机 IP** 作为主机名，此时端口号为宿主机给 server 配置的端口 + +我们可以使用 `docker run -itd --name=hubble -p 8088:8088 hugegraph/hubble` 快速启动 [hubble](https://hub.docker.com/r/hugegraph/hubble). + +或者使用 docker-compose 启动 hubble，另外如果 hubble 和 graph 在同一个 docker 网络下，可以使用 graph 的 contain_name 进行访问，而不需要宿主机的 ip + +使用`docker-compose up -d`，`docker-compose.yml`如下： + +```yaml +version: '3' +services: + server: + image: hugegraph/hugegraph + container_name: graph + ports: + - 8080:8080 + + hubble: + image: hugegraph/hubble + container_name: hubble + ports: + - 8088:8088 +``` + +> 注意： +> +> 1. hugegraph-hubble 的 docker 镜像是一个便捷版本，用于快速启动 hubble，并不是**官方发布物料包方式**。你可以从 [ASF Release Distribution Policy](https://infra.apache.org/release-distribution.html#dockerhub) 中得到更多细节。 +> +> 2. 推荐使用 `release tag`(如 `1.2.0`) 以获取稳定版。使用 `latest` tag 可以使用开发中的最新功能。 Review Comment: ```suggestion > 2. **生产环境**推荐使用 `release tag`(如 `1.2.0`) 稳定版。使用 `latest` tag 默认对应 master 最新代码。 ``` ########## content/cn/docs/quickstart/hugegraph-loader.md: ########## @@ -103,7 +66,45 @@ services: > > 1. hugegraph-loader 的 docker 镜像是一个便捷版本，用于快速启动 loader，并不是**官方发布物料包方式**。你可以从 > [ASF Release Distribution > Policy](https://infra.apache.org/release-distribution.html#dockerhub) > 中得到更多细节。 > -> 2. 推荐使用 `release tag`(如 `1.0.0`) 以获取稳定版。使用 `latest` tag 可以使用开发中的最新功能。 +> 2. 推荐使用 `release tag`(如 `1.2.0`) 以获取稳定版。使用 `latest` tag 可以使用开发中的最新功能。 + +#### 2.2 下载已编译的压缩包 + +下载最新版本的 HugeGraph-Toolchain Release 包，里面包含了 loader + tool + hubble 全套工具，如果你已经下载，可跳过重复步骤 + +```bash +wget https://downloads.apache.org/incubator/hugegraph/{version}//apache-hugegraph-toolchain-incubating-{version}.tar.gz +tar zxf *hugegraph*.tar.gz +``` + +#### 2.3 克隆源码编译安装 + +克隆最新版本的 HugeGraph-Loader 源码包： + +```bash +# 1. get from github +git clone https://github.com/apache/hugegraph-toolchain.git + +# 2. get from direct (e.g. here is 1.0.0, please choose the latest version) Review Comment: ```suggestion # 2. get from direct url (please choose the **latest release** version) ``` ########## content/cn/docs/quickstart/hugegraph-hubble.md: ########## @@ -36,11 +36,45 @@ HugeGraph 是一款面向分析型，支持批量操作的图数据库系统， 有三种方式可以部署`hugegraph-hubble` +- 使用 docker (便于**测试**) - 下载 toolchain 二进制包 - 源码编译 -- 使用 docker (便于**测试**) -#### 2.1 下载 toolchain 二进制包 +#### 2.1 使用 Docker (便于**测试**) + +> **特别注意**: docker 模式下，若 hubble 和 server 在同一宿主机，hubble 页面中设置 graph 的 `hostname` **不能设置**为 `localhost/127.0.0.1`，因这会指向 hubble **容器内部**而非宿主机，导致无法连接到 server. +> +> 若 hubble 和 server 在同一 docker 网络下，**推荐**直接使用`container_name` (如下例的 `graph`) 作为主机名。或者也可以使用 **宿主机 IP** 作为主机名，此时端口号为宿主机给 server 配置的端口 + +我们可以使用 `docker run -itd --name=hubble -p 8088:8088 hugegraph/hubble` 快速启动 [hubble](https://hub.docker.com/r/hugegraph/hubble). + +或者使用 docker-compose 启动 hubble，另外如果 hubble 和 graph 在同一个 docker 网络下，可以使用 graph 的 contain_name 进行访问，而不需要宿主机的 ip + +使用`docker-compose up -d`，`docker-compose.yml`如下： + +```yaml +version: '3' +services: + server: + image: hugegraph/hugegraph + container_name: graph Review Comment: ```suggestion container_name: server ``` server 是不是好一点? 不过要注意统一修改 ########## content/cn/docs/quickstart/hugegraph-loader.md: ########## @@ -103,7 +66,45 @@ services: > > 1. hugegraph-loader 的 docker 镜像是一个便捷版本，用于快速启动 loader，并不是**官方发布物料包方式**。你可以从 > [ASF Release Distribution > Policy](https://infra.apache.org/release-distribution.html#dockerhub) > 中得到更多细节。 > -> 2. 推荐使用 `release tag`(如 `1.0.0`) 以获取稳定版。使用 `latest` tag 可以使用开发中的最新功能。 +> 2. 推荐使用 `release tag`(如 `1.2.0`) 以获取稳定版。使用 `latest` tag 可以使用开发中的最新功能。 + +#### 2.2 下载已编译的压缩包 + +下载最新版本的 HugeGraph-Toolchain Release 包，里面包含了 loader + tool + hubble 全套工具，如果你已经下载，可跳过重复步骤 + +```bash +wget https://downloads.apache.org/incubator/hugegraph/{version}//apache-hugegraph-toolchain-incubating-{version}.tar.gz +tar zxf *hugegraph*.tar.gz +``` + +#### 2.3 克隆源码编译安装 + +克隆最新版本的 HugeGraph-Loader 源码包： + +```bash +# 1. get from github +git clone https://github.com/apache/hugegraph-toolchain.git + +# 2. get from direct (e.g. here is 1.0.0, please choose the latest version) +wget https://downloads.apache.org/incubator/hugegraph/{version}/apache-hugegraph-toolchain-incubating-{version}-src.tar.gz +``` + +由于 Oracle ojdbc license 的限制，需要手动安装 ojdbc 到本地 maven 仓库。 +访问[Oracle jdbc 下载](https://www.oracle.com/database/technologies/appdev/jdbc-drivers-archive.html) 页面。选择 Oracle Database 12c Release 2 (12.2.0.1) drivers，如下图所示。 + +打开链接后，选择“ojdbc8.jar” + +把 ojdbc8 安装到本地 maven 仓库，进入`ojdbc8.jar`所在目录，执行以下命令。 +``` +mvn install:install-file -Dfile=./ojdbc8.jar -DgroupId=com.oracle -DartifactId=ojdbc8 -Dversion=12.2.0.1 -Dpackaging=jar +``` Review Comment: 考虑折叠 ojdbc 的内容, 用户已经很少了 (后续不影响编译的话可以进一步压缩) ########## content/cn/docs/quickstart/hugegraph-hubble.md: ########## @@ -36,11 +36,45 @@ HugeGraph 是一款面向分析型，支持批量操作的图数据库系统， 有三种方式可以部署`hugegraph-hubble` +- 使用 docker (便于**测试**) - 下载 toolchain 二进制包 - 源码编译 -- 使用 docker (便于**测试**) -#### 2.1 下载 toolchain 二进制包 +#### 2.1 使用 Docker (便于**测试**) + +> **特别注意**: docker 模式下，若 hubble 和 server 在同一宿主机，hubble 页面中设置 graph 的 `hostname` **不能设置**为 `localhost/127.0.0.1`，因这会指向 hubble **容器内部**而非宿主机，导致无法连接到 server. +> +> 若 hubble 和 server 在同一 docker 网络下，**推荐**直接使用`container_name` (如下例的 `graph`) 作为主机名。或者也可以使用 **宿主机 IP** 作为主机名，此时端口号为宿主机给 server 配置的端口 + +我们可以使用 `docker run -itd --name=hubble -p 8088:8088 hugegraph/hubble` 快速启动 [hubble](https://hub.docker.com/r/hugegraph/hubble). + +或者使用 docker-compose 启动 hubble，另外如果 hubble 和 graph 在同一个 docker 网络下，可以使用 graph 的 contain_name 进行访问，而不需要宿主机的 ip + +使用`docker-compose up -d`，`docker-compose.yml`如下： + +```yaml +version: '3' +services: + server: + image: hugegraph/hugegraph + container_name: graph + ports: + - 8080:8080 + + hubble: + image: hugegraph/hubble + container_name: hubble + ports: + - 8088:8088 +``` + +> 注意： +> +> 1. hugegraph-hubble 的 docker 镜像是一个便捷版本，用于快速启动 hubble，并不是**官方发布物料包方式**。你可以从 [ASF Release Distribution Policy](https://infra.apache.org/release-distribution.html#dockerhub) 中得到更多细节。 Review Comment: ```suggestion > 1. `hugegraph-hubble` 的 docker 镜像是一个便捷发布版本，用于快速测试试用 hubble，并非**ASF官方发布物料包的方式**。你可以从 [ASF Release Distribution Policy](https://infra.apache.org/release-distribution.html#dockerhub) 中得到更多细节。 ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
