Skip to content
Developer Edition runs on one host and does not require a product license file. Need multi-host deployment or performance testing at scale? Explore Enterprise Edition

Deploy NebulaGraph Exchange

Download the NebulaGraph Exchange package and deploy its Spark environment. Run the commands below on the Linux machine that will run NebulaGraph Exchange.

Prerequisites

  • An x86-64 or ARM64 Linux machine.
  • Java 8 installed, with the java and tar commands available, as required by Spark 2.4.7.

Check the Java version:

java -version

Continue once the version is 1.8.x.

Download the package

Current version: 5.3.0. Download the package, or run:

curl -fL -o nebula-graph-exchange-5.3.0.tgz \
  "https://dev-docs.nebula-graph.io/downloads/exchange/5.3.0/nebula-graph-exchange-5.3.0.tgz"

The package includes dependencies for both x86-64 and ARM64. To check file integrity, download its SHA-256 checksum file and follow Verify a package.

Steps

  1. Extract the package in the download directory:

    tar -xzf nebula-graph-exchange-5.3.0.tgz

    The extracted directory contains these files:

    nebula-graph-exchange/
├── deploy.sh  # The script for deploying NebulaGraph Exchange and required dependencies
├── start.sh  # The script for starting NebulaGraph Exchange
├── stop.sh  # The script for stopping NebulaGraph Exchange
├── import.sh  # The script for importing data
├── export.sh  # The script for exporting data
├── monitor.sh  # The script for monitoring the import or export process
├── nebula-exchange-5.3.0.jar # The NebulaGraph Exchange JAR package
├── cli-5.3.0.jar # The JAR package of the CLI tool
├── scala-2.12.11.tgz  # The Scala package
├── spark-2.4.7-bin-hadoop2.7.tar.gz  # The Spark package
├── jdk-8u431-linux-x64.tar.gz # The JDK package for x64 architecture
├── jdk-8u431-linux-aarch64.tar.gz # The JDK package for ARM architecture
├── README.md  # The README file
└── template/  # The configuration templates for different data sources

  2. Enter the extracted directory and deploy Spark with cli-5.3.0.jar. Replace the example IP 192.168.8.113 with the IP address of the Linux machine:

    cd nebula-graph-exchange
java -jar cli-5.3.0.jar -deploy -i 5 -c 2 -ip 192.168.8.113 -port 1077 -webPort 1088

    The following table lists the command-line options:

    Option Alias Description Required Default value
    -deploy - Whether to deploy the Spark server. No N/A
    -instance -i The number of worker instances on each machine. No 5
    -cores -c The number of cores for each worker instance. No 60
    -ip - The local IP of the Spark server. If not specified, the IP is automatically obtained. No N/A
    -port - The port of the Spark server. No 1077
    -webPort - The port of the web UI for the Spark server. No 1088
    -h - Whether to print help information. No N/A

    The following message is displayed if the setup is successful:

    Setup completed successfully!

More information