Skip to content

Commit

Permalink
merge helm in studio doc (#1765)
Browse files Browse the repository at this point in the history
  • Loading branch information
cooper-lzy authored Nov 21, 2022
1 parent 93fc266 commit 3518169
Show file tree
Hide file tree
Showing 4 changed files with 60 additions and 68 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,7 @@ NebulaGraph Studio (Studio in short) is a browser-based visualization tool to ma

## Released versions

You can deploy Studio using the following methods:

- You can deploy Studio with Docker, RPM-based, Tar-based or DEB-based and connect it to NebulaGraph. For more information, see [Deploy Studio](../deploy-connect/st-ug-deploy.md).
- Helm-based. You can deploy Studio with Helm in the Kubernetes cluster and connect it to NebulaGraph. For more information, see [Helm-based Studio](../deploy-connect/st-ug-deploy-by-helm.md).
In addition to deploying Studio with RPM-based, DEB-based, or Tar-based package, or with Docker. You can also deploy Studio with Helm in the Kubernetes cluster. For more information, see [Deploy Studio](../deploy-connect/st-ug-deploy.md).

<!--
- Cloud Service: You can create NebulaGraph database instances in NebulaGraph Cloud Service and connect Cloud Service Studio with one click. For more information, see [NebulaGraph Cloud Service Manual](https://cloud-docs.nebula-graph.com.cn/cn/posts/manage-instances/dbaas-ug-connect-nebulastudio/ "Click to go to NebulaGraph Cloud Service Manual").
Expand Down
63 changes: 0 additions & 63 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 @@ -265,6 +265,65 @@ To deploy and start Docker-based Studio, run the following commands. Here we use

![The Config Server page shows that Docker-based Studio is started successfully](https://docs-cdn.nebula-graph.com.cn/figures/st-ug-000-en.png "Docker-based Studio is started")

## Helm-based Studio

This section describes how to deploy Studio with Helm.

### Prerequisites

Before installing Studio, you need to install the following software and ensure the correct version of the software:

| Software | Requirement |
| ------------------------------------------------------------ | --------- |
| [Kubernetes](https://kubernetes.io) | \>= 1.14 |
| [Helm](https://helm.sh) | \>= 3.2.0 |

### Install

1. Use Git to clone the source code of Studio to the host.

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

2. Make the `nebula-studio` directory the current working directory.

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

3. Assume using release name:`my-studio`, installed Studio in Helm Chart.

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

The configuration parameters of the Helm Chart are described below.

| Parameter | Default value | Description |
|-----------|-------------|---------|
| replicaCount | 0 | The number of replicas for Deployment. |
| image.nebulaStudio.name | vesoft/nebula-graph-studio | The image name of nebula-graph-studio. |
| image.nebulaStudio.version | v3.2.0 | The image version of nebula-graph-studio. |
| service.type | ClusterIP | The service type, which should be one of `NodePort`, `ClusterIP`, and `LoadBalancer`. |
| service.port | 7001 | The expose port for nebula-graph-studio's web. |
| service.nodePort | 32701 | The proxy port for accessing nebula-studio outside kubernetes cluster. |
| resources.nebulaStudio | {} | The resource limits/requests for nebula-studio. |
| persistent.storageClassName | "" | The name of storageClass. The default value will be used if not specified. |
| persistent.size | 5Gi | The persistent volume size. |
4. When Studio is started, use `http://<node_address>:30070/` to get access to Studio.
If you can see the **Config Server** page on the browser, Studio is started successfully.
![The Config Server page shows that Studio is started successfully](https://docs-cdn.nebula-graph.com.cn/figures/st-ug-000-en.png "Studio is started")
### Uninstall
```bash
$ helm uninstall my-studio
```
## Next to do
On the **Config Server** page, connect Docker-based Studio to NebulaGraph. For more information, see [Connect to 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 @@ -538,7 +538,6 @@ nav:
- Limitations: nebula-studio/about-studio/st-ug-limitations.md
- Deploy and connect:
- Deploy Studio: nebula-studio/deploy-connect/st-ug-deploy.md
- Deploy Studio with Helm: nebula-studio/deploy-connect/st-ug-deploy-by-helm.md
- Connect to NebulaGraph: nebula-studio/deploy-connect/st-ug-connect.md
- Quick start:
- Design a schema: nebula-studio/quick-start/st-ug-plan-schema.md
Expand Down

0 comments on commit 3518169

Please sign in to comment.