NebulaGraph Lite

Try NebulaGraph with pip install, on Linux/ WSL2 or even Google Colab!

How to use

Install NebulaGraph Lite

pip3 install nebulagraph-lite

Start NebulaGraph Lite from Jupyter Notebook

from nebulagraph_lite import nebulagraph_let as ng_let

n = ng_let()

n.start()

Voilà! It'ts up and running already now!

What's next

Play with nebula3-python or ipython-ngql and walk through the Documentation!

pip3 install ipython-ngql
%load_ext ngql

And we could access it like:

%ngql --address 127.0.0.1 --port 9669 --user root --password nebula

And query like:

%ngql SHOW HOSTS;

Other non-lite or less-lite options

Intrested in other play or production options?

Production

• Binary Packages, if running on bare OS.
• K8s Operator, on K8s.
• NebulaGrpah Cloud, the managed NebulaGraph service.

Play and Dev

• Docker Compose, if you are comfortable on single server
• nebula-up, one-liner test env installer on single server, support studio, dashboard, nebulagraph algorithm, exchange etc, all-in-one.
• Docker Extension, one-click on Docker Desktop(macOS, windows) on desktop machines, in GUI flavor.
• Nebula-Operator-KinD, Nebula K8s Operator with K8s-in-Docker, one-liner test env with docker+k8s+nebulagrpah-operator, try NebulaGraph on K8s with ease on your single server.

Acknowledgements

• udocker, https://github.com/indigo-dc/udocker
• docker-in-colab, https://github.com/drengskapur/docker-in-colab
• NebulaGraph Docker, https://github.com/vesoft-inc/nebula-docker-compose

FAQ

Why not docker?

With udocker, the opinionated subset docker running in user space, we could run docker images without root privilege, docker daemon.

Thus we support running inside docker container, WSL2, Google Colab.

Can NebulaGraph-Lite run inside a container?

Yes! Say we are in a container that runs Ubuntu, we could run:

docker run -it --rm ubuntu:latest bash
# inside the container
apt update && apt install python3-pip curl -y
pip3 install nebulagraph-lite
python3

In python3:

from nebulagraph_lite import nebulagraph_let as ng_let
n = ng_let(in_container=True)
n.start()

Does it support Windows?

Yes, it supports Windows with WSL2 or other Linux VMs with a Hypervisor.

How to clean up?

• Step 1, from nebulagraph-lite, remove the udocker container and clean up the base path.

n.stop()
n.clean_up()

• Step 2, pip uninstall nebulagraph-lite and dependencies.

pip3 uninstall nebulagraph-lite udocker

• Step 3, remove the udocker files.

rm -rf ~/.udocker

• Step 4, kill the left processes, in case of any.

ss -plunt | grep "9559\|9669\|9779"
# if any, kill them with killall or other tools

killall -9 nebula-graphd
killall -9 nebula-storaged
killall -9 nebula-metad