aroundabout commented on code in PR #281: URL: https://github.com/apache/incubator-hugegraph-doc/pull/281#discussion_r1320971085
########## content/en/docs/quickstart/hugegraph-hubble.md: ########## @@ -32,7 +32,116 @@ By inputting the graph traversal language Gremlin, high-performance general anal For Gremlin tasks that need to traverse the whole graph, index creation and reconstruction and other time-consuming asynchronous tasks, the platform provides corresponding task management functions to achieve unified management and result viewing of asynchronous tasks. -### 2 Platform Workflow +### 2 Deploy + +There are three ways to deplot `hugegraph-hubble` +- Download the Toolchain binary package +- Source code compilation +- Use Docker + +#### 2.1 Download the Toolchain binary package + +`hubble` is in the `toolchain` project. First, download the binary tar tarball + +```bash +wget https://downloads.apache.org/incubator/hugegraph/1.0.0/apache-hugegraph-toolchain-incubating-{version}.tar.gz +tar -xvf apache-hugegraph-toolchain-incubating-{version}.tar.gz +cd apache-hugegraph-toolchain-incubating-{version}.tar.gz/apache-hugegraph-hubble-incubating-{version} +``` + +Run `hubble` + +```bash +bin/start-hubble.sh +``` + +Then, we can see: + +```shell +starting HugeGraphHubble ..............timed out with http status 502 +2023-08-30 20:38:34 [main] [INFO ] o.a.h.HugeGraphHubble [] - Starting HugeGraphHubble v1.0.0 on cpu05 with PID xxx (~/apache-hugegraph-toolchain-incubating-1.0.0/apache-hugegraph-hubble-incubating-1.0.0/lib/hubble-be-1.0.0.jar started by $USER in ~/apache-hugegraph-toolchain-incubating-1.0.0/apache-hugegraph-hubble-incubating-1.0.0) +... +2023-08-30 20:38:38 [main] [INFO ] c.z.h.HikariDataSource [] - hugegraph-hubble-HikariCP - Start completed. +2023-08-30 20:38:41 [main] [INFO ] o.a.c.h.Http11NioProtocol [] - Starting ProtocolHandler ["http-nio-0.0.0.0-8088"] +2023-08-30 20:38:41 [main] [INFO ] o.a.h.HugeGraphHubble [] - Started HugeGraphHubble in 7.379 seconds (JVM running for 8.499) +``` + +Then use a web browser to access `ip:8088` and you can see the `Hubble` page. You can stop the service using bin/stop-hubble.sh. + +#### 2.2 Source code compilation + +User should install `nodejs==16.x` and `yarn` firstly. + +```bash +apt install curl build-essential +curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash +source ~/.bashrc +nvm install 16 +``` + +check the version is 16.x or not + +```bash +node -v +``` + +install `yarn` by the command below: + +```bash +npm install -g yarn +``` + +Download the toolchain source code. + +```shell +git clone https://github.com/apache/hugegraph-toolchain.git +``` + +Compile `hubble` Review Comment: ```suggestion Compile `hubble`. It depends on the loader and client, so you need to build these dependencies in advance during the compilation process (you can skip this step later). ``` ########## content/en/docs/quickstart/hugegraph-hubble.md: ########## @@ -32,7 +32,116 @@ By inputting the graph traversal language Gremlin, high-performance general anal For Gremlin tasks that need to traverse the whole graph, index creation and reconstruction and other time-consuming asynchronous tasks, the platform provides corresponding task management functions to achieve unified management and result viewing of asynchronous tasks. -### 2 Platform Workflow +### 2 Deploy + +There are three ways to deplot `hugegraph-hubble` +- Download the Toolchain binary package +- Source code compilation +- Use Docker + +#### 2.1 Download the Toolchain binary package + +`hubble` is in the `toolchain` project. First, download the binary tar tarball + +```bash +wget https://downloads.apache.org/incubator/hugegraph/1.0.0/apache-hugegraph-toolchain-incubating-{version}.tar.gz +tar -xvf apache-hugegraph-toolchain-incubating-{version}.tar.gz +cd apache-hugegraph-toolchain-incubating-{version}.tar.gz/apache-hugegraph-hubble-incubating-{version} +``` + +Run `hubble` + +```bash +bin/start-hubble.sh +``` + +Then, we can see: + +```shell +starting HugeGraphHubble ..............timed out with http status 502 +2023-08-30 20:38:34 [main] [INFO ] o.a.h.HugeGraphHubble [] - Starting HugeGraphHubble v1.0.0 on cpu05 with PID xxx (~/apache-hugegraph-toolchain-incubating-1.0.0/apache-hugegraph-hubble-incubating-1.0.0/lib/hubble-be-1.0.0.jar started by $USER in ~/apache-hugegraph-toolchain-incubating-1.0.0/apache-hugegraph-hubble-incubating-1.0.0) +... +2023-08-30 20:38:38 [main] [INFO ] c.z.h.HikariDataSource [] - hugegraph-hubble-HikariCP - Start completed. +2023-08-30 20:38:41 [main] [INFO ] o.a.c.h.Http11NioProtocol [] - Starting ProtocolHandler ["http-nio-0.0.0.0-8088"] +2023-08-30 20:38:41 [main] [INFO ] o.a.h.HugeGraphHubble [] - Started HugeGraphHubble in 7.379 seconds (JVM running for 8.499) +``` + +Then use a web browser to access `ip:8088` and you can see the `Hubble` page. You can stop the service using bin/stop-hubble.sh. + +#### 2.2 Source code compilation + +User should install `nodejs==16.x` and `yarn` firstly. + +```bash +apt install curl build-essential +curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash +source ~/.bashrc +nvm install 16 +``` + +check the version is 16.x or not Review Comment: ```suggestion Then, verify that the installed Node.js version is 16.x (please note that higher Node versions may cause conflicts). ``` ########## content/en/docs/quickstart/hugegraph-hubble.md: ########## @@ -32,7 +32,116 @@ By inputting the graph traversal language Gremlin, high-performance general anal For Gremlin tasks that need to traverse the whole graph, index creation and reconstruction and other time-consuming asynchronous tasks, the platform provides corresponding task management functions to achieve unified management and result viewing of asynchronous tasks. -### 2 Platform Workflow +### 2 Deploy + +There are three ways to deplot `hugegraph-hubble` +- Download the Toolchain binary package +- Source code compilation +- Use Docker + +#### 2.1 Download the Toolchain binary package + +`hubble` is in the `toolchain` project. First, download the binary tar tarball + +```bash +wget https://downloads.apache.org/incubator/hugegraph/1.0.0/apache-hugegraph-toolchain-incubating-{version}.tar.gz +tar -xvf apache-hugegraph-toolchain-incubating-{version}.tar.gz +cd apache-hugegraph-toolchain-incubating-{version}.tar.gz/apache-hugegraph-hubble-incubating-{version} +``` + +Run `hubble` + +```bash +bin/start-hubble.sh +``` + +Then, we can see: + +```shell +starting HugeGraphHubble ..............timed out with http status 502 +2023-08-30 20:38:34 [main] [INFO ] o.a.h.HugeGraphHubble [] - Starting HugeGraphHubble v1.0.0 on cpu05 with PID xxx (~/apache-hugegraph-toolchain-incubating-1.0.0/apache-hugegraph-hubble-incubating-1.0.0/lib/hubble-be-1.0.0.jar started by $USER in ~/apache-hugegraph-toolchain-incubating-1.0.0/apache-hugegraph-hubble-incubating-1.0.0) +... +2023-08-30 20:38:38 [main] [INFO ] c.z.h.HikariDataSource [] - hugegraph-hubble-HikariCP - Start completed. +2023-08-30 20:38:41 [main] [INFO ] o.a.c.h.Http11NioProtocol [] - Starting ProtocolHandler ["http-nio-0.0.0.0-8088"] +2023-08-30 20:38:41 [main] [INFO ] o.a.h.HugeGraphHubble [] - Started HugeGraphHubble in 7.379 seconds (JVM running for 8.499) +``` + +Then use a web browser to access `ip:8088` and you can see the `Hubble` page. You can stop the service using bin/stop-hubble.sh. + +#### 2.2 Source code compilation + +User should install `nodejs==16.x` and `yarn` firstly. Review Comment: ```suggestion **Note**: Compiling Hubble requires the user's local environment to have Node.js V16.x and yarn installed. ``` -- 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]
