Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add NebulaGraph Lite (#2535) #2536

Merged
merged 5 commits into from
May 9, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Deploy NebulaGraph with NebulaGraph Lite

Using [NebulaGraph Lite](https://github.com/nebula-contrib/nebulagraph-lite) can quickly deploy NebulaGraph and start experiencing NebulaGraph in just five minutes. It is ideal for ad-hoc development and learning NebulaGraph.

## Benefits

- Quick installation of NebulaGraph Lite through the Python package management tool.
- NebulaGraph Lite supports the deployment of NebulaGraph with non-root permission.
- NebulaGraph Lite supports the deployment of NebulaGraph in containers or any Jupyter Notebook platform on Linux-based systems.

## Steps

1. Run the following statement to install NebulaGraph Lite.

```bash
pip3 install nebulagraph-lite
```

2. Start NebulaGraph Lite。

- Start from Jupyter Notebook

```bash
from nebulagraph_lite import nebulagraph_let as ng_let
n = ng_let()
n.start()
```

- Start from the command line

```bash
nebulagraph start
```

The following result is returned indicating that the startup and import of the test dataset was successful.

```bash
Info: loading basketballplayer dataset...

_ _ _ _ ____ _
| \ | | ___| |__ _ _| | __ _ / ___|_ __ __ _ _ __ | |__
| \| |/ _ | '_ \| | | | |/ _` | | _| '__/ _` | '_ \| '_ \
| |\ | __| |_) | |_| | | (_| | |_| | | | (_| | |_) | | | |
|_| \_|\___|_.__/ \__,_|_|\__,_|\____|_| \__,_| .__/|_| |_|
|_|
lite version

[ OK ] nebulagraph_lite started successfully!
```

## What's next

- Connect to NebulaGraph with [NebulaGraph Jupyter Extension](https://jupyter-nebulagraph.readthedocs.io/en/latest/).
- Connect to NebulaGraph with [NebulaGraph Console](../connect-to-nebula-graph.md).
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# 使用 NebulaGraph Lite 部署 {{nebula.name}}

使用 NebulaGraph Lite 可以快速安装部署 {{nebula.name}},仅需五分钟即可开始体验 {{nebula.name}} 图数据库,适用于临时开发、学习 {{nebula.name}}。

## 优势

- 通过 Python 包管理工具快速安装 NebulaGraph Lite。
- 支持非 Root 权限部署 {{nebula.name}}。
- 支持在容器或基于 Linux 系统的 Jupyter Notebook 平台上部署 {{nebula.name}}。

## 操作步骤

1. 执行如下命令安装 NebulaGraph Lite。

```bash
pip3 install nebulagraph-lite
```

2. 启动 NebulaGraph Lite。
cooper-lzy marked this conversation as resolved.
Show resolved Hide resolved

- 从 Jupyter Notebook 启动

```bash
from nebulagraph_lite import nebulagraph_let as ng_let
n = ng_let()
n.start()
```

- 从命令行启动

```bash
nebulagraph start
```

返回如下结果表示启动并导入测试数据集成功。

```bash
Info: loading basketballplayer dataset...

_ _ _ _ ____ _
| \ | | ___| |__ _ _| | __ _ / ___|_ __ __ _ _ __ | |__
| \| |/ _ | '_ \| | | | |/ _` | | _| '__/ _` | '_ \| '_ \
| |\ | __| |_) | |_| | | (_| | |_| | | | (_| | |_) | | | |
|_| \_|\___|_.__/ \__,_|_|\__,_|\____|_| \__,_| .__/|_| |_|
|_|
lite version

[ OK ] nebulagraph_lite started successfully!
```

## 下一步

- 使用[NebulaGraph Jupyter Extension](https://jupyter-nebulagraph.readthedocs.io/en/latest/)连接 {{nebula.name}}。
- 使用[NebulaGraph Console](../connect-to-nebula-graph.md)连接 {{nebula.name}}。
2 changes: 2 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -555,6 +555,7 @@ nav:
- Install standalone NebulaGraph: 4.deployment-and-installation/standalone-deployment.md
- Local multi-node installation: 4.deployment-and-installation/2.compile-and-install-nebula-graph/deploy-nebula-graph-cluster.md
- Install using Docker Compose: 4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md
- Install using NebulaGraph Lite: 4.deployment-and-installation/2.compile-and-install-nebula-graph/8.deploy-nebula-graph-with-lite.md
- Install with ecosystem tools: 4.deployment-and-installation/2.compile-and-install-nebula-graph/6.deploy-nebula-graph-with-peripherals.md
- Manage Service: 4.deployment-and-installation/manage-service.md
- Connect to Service: 4.deployment-and-installation/connect-to-nebula-graph.md
Expand Down Expand Up @@ -913,6 +914,7 @@ nav:
- 安装存算合并版服务: 4.deployment-and-installation/standalone-deployment.md
- 本地多机安装: 4.deployment-and-installation/2.compile-and-install-nebula-graph/deploy-nebula-graph-cluster.md
- 使用 Docker Compose 安装: 4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md
- 使用 NebulaGraph Lite 安装: 4.deployment-and-installation/2.compile-and-install-nebula-graph/8.deploy-nebula-graph-with-lite.md
- 使用生态工具安装: 4.deployment-and-installation/2.compile-and-install-nebula-graph/6.deploy-nebula-graph-with-peripherals.md
- 管理服务: 4.deployment-and-installation/manage-service.md
- 连接服务: 4.deployment-and-installation/connect-to-nebula-graph.md
Expand Down