Skip to content

Commit

Permalink
merge helm in studio doc (#2333)
Browse files Browse the repository at this point in the history
  • Loading branch information
cooper-lzy committed Nov 21, 2022
1 parent 221137c commit 99732ad
Show file tree
Hide file tree
Showing 4 changed files with 60 additions and 66 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,7 @@ NebulaGraph Studio(简称 Studio)是一款可以通过 Web 访问的开源

## 发行版本

可以使用以下方式安装部署 Studio:

- 用户可以使用 Docker 服务、RPM 服务、tar 包和 DEB 包安装部署 Studio,并连接到 NebulaGraph 数据库。详细信息参考 [部署 Studio](../deploy-connect/st-ug-deploy.md)
- 使用 Helm 安装部署:在 Kubernetes 集群里使用 Helm 安装并部署 Studio,并连接到 NebulaGraph 数据库。详细信息参考[使用 Helm 部署 NebulaGraph Studio](../deploy-connect/st-ug-deploy-by-helm.md)
用户可以使用 RPM 包、DEB 包、tar 包和 Docker 服务安装部署 Studio,在 Kubernetes 集群里还支持使用 Helm 安装部署 Studio。详细信息参考 [部署 Studio](../deploy-connect/st-ug-deploy.md)

<!--
- 云服务版本:用户可以在 NebulaGraph Cloud Service 上创建 NebulaGraph 数据库实例,并一键直连云服务版 Studio。详细信息参考 [NebulaGraph Cloud Service 用户手册](https://cloud-docs.nebula-graph.com.cn/cn/posts/manage-instances/dbaas-ug-connect-nebulastudio/ "点击前往 NebulaGraph Cloud Service 用户手册")。
Expand Down
61 changes: 0 additions & 61 deletions docs-2.0/nebula-studio/deploy-connect/st-ug-deploy-by-helm.md

This file was deleted.

59 changes: 59 additions & 0 deletions docs-2.0/nebula-studio/deploy-connect/st-ug-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,7 @@ $ kill $(lsof -t -i :7001) # stop nebula-graph-studio
```

## Docker 部署 Studio

### 前提条件

在部署 Docker 版 Studio 之前,用户需要确认以下信息:
Expand Down Expand Up @@ -272,6 +273,64 @@ $ kill $(lsof -t -i :7001) # stop nebula-graph-studio

![NebulaGraph Studio 登录界面](https://docs-cdn.nebula-graph.com.cn/figures/st-ug-000-cn.png "NebulaGraph Studio 登录界面")

## Helm 部署 Studio

本小节介绍如何在 Kubernetes 中使用 Helm 部署并启动 Studio。

### 前提条件

安装 Studio 前,用户需要安装以下软件并确保安装版本的正确性:

| 软件 | 版本要求 |
| ------------------------------------------------------------ | --------- |
| [Kubernetes](https://kubernetes.io) | \>= 1.14 |
| [Helm](https://helm.sh) | \>= 3.2.0 |

### 操作步骤

1. 克隆 Studio 的源代码到主机。

```bash
$ git clone https://github.com/vesoft-inc/nebula-studio.git
```

2. 进入`nebula-studio`目录。

```bash
$ cd nebula-studio
```

3. 更新并安装 NebulaGraph Studio chart,命名为`my-studio`

```bash
$ helm upgrade --install my-studio --set service.type=NodePort --set service.port={30070} deployment/helm
```

NebulaGraph Studio chart 配置参数说明如下。

| 参数 | 默认值 | 描述 |
|:---|:---|:---|
| replicaCount | 0 | Deployment 的副本数。 |
| image.nebulaStudio.name | vesoft/nebula-graph-studio | nebula-graph-studio 镜像的仓库地址。 |
| image.nebulaStudio.version | v3.2.0 | nebula-graph-studio 的版本。 |
| service.type | ClusterIP | 服务类型,必须为`NodePort``ClusterIP``LoadBalancer`其中之一。 |
| service.port | 7001 | nebula-graph-studio 中 web 服务的端口。 |
| service.nodePort | 32701 | Kubernetes 集群外部访问 nebula-studio 的代理端口。 |
| resources.nebulaStudio | {} | nebula-studio 的资源限制/请求。 |
| persistent.storageClassName | "" | storageClass 名称,如果不指定就使用默认值。 |
| persistent.size | 5Gi | 存储盘大小。 |

4. 启动成功后,在浏览器地址栏输入`http://<node_address>:30070`
如果在浏览器窗口中能看到以下登录界面,表示已经成功部署并启动 Studio。

![NebulaGraph Studio 登录界面](https://docs-cdn.nebula-graph.com.cn/figures/st-ug-000-cn.png "NebulaGraph Studio 登录界面")

### 卸载

```bash
$ helm uninstall my-studio
```

## 后续操作

进入 Studio 登录界面后,用户需要连接 NebulaGraph。详细信息,参考[连接数据库](st-ug-connect.md)
1 change: 0 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -553,7 +553,6 @@ nav:
- 使用限制: nebula-studio/about-studio/st-ug-limitations.md
- 安装与登录:
- 部署 Studio: nebula-studio/deploy-connect/st-ug-deploy.md
- 使用 Helm 部署 Studio: nebula-studio/deploy-connect/st-ug-deploy-by-helm.md
- 连接数据库: nebula-studio/deploy-connect/st-ug-connect.md
- 快速开始:
- 规划 Schema: nebula-studio/quick-start/st-ug-plan-schema.md
Expand Down

0 comments on commit 99732ad

Please sign in to comment.