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

merge update studio #871

Merged
merged 1 commit into from
Nov 2, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
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
2 changes: 1 addition & 1 deletion docs-2.0/nebula-studio/about-studio/st-ug-check-updates.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ Studio is in development. Users can view the latest releases features through [C

To view the Changelog, on the upper-right corner of the page, click the version and then **New version**.

![On the upper right corner of the page, click version and then New Version](./../figs/st-ug-054-1.png)
![On the upper right corner of the page, click Version and then New Version](./../figs/st-ug-054.png)
1 change: 1 addition & 0 deletions docs-2.0/nebula-studio/about-studio/st-ug-limitations.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ This topic introduces the limitations of Studio.
| 1.x | 1.x|
| 2.0 & 2.0.1 | 2.x |
| 2.5.0 | 3.0.0 |
| 2.6.0 | 3.1.0 |


## Architecture
Expand Down
16 changes: 15 additions & 1 deletion docs-2.0/nebula-studio/about-studio/st-ug-release-note.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,20 @@
# Change Log

## v3.1.0 (2021.10.29)
- Feature Enhancements:
- Compatible with Nebula Graph v2.6.0.
- Added the use of Helm to deploy and start Studio in the Kubernetes cluster.
- Explorer:
- Added the function of modifying the vertex icon.
- Fix:
- Schema:
- Fix the problem that some operations of the tag/edge/property named after keywords will report errors.
- Fix the problem of incomplete data types by adding date/time/datetime/int32/int16/int8.

- Compatibility:
- Remove Studio's dependency on nebula-importer and use http-gateway to be compatible with related functions.

## v3.0.0 (2021.08.13)
- Feature Enhancements:
- Compatible with Nebula Graph v2.5.0.
- Supported adding `COMMENT` in Space, Tag, Edge Type, Index while configuration Schema.
- Supported adding `COMMENT` in Space, Tag, Edge Type, Index while configuration Schema.
66 changes: 66 additions & 0 deletions docs-2.0/nebula-studio/deploy-connect/st-ug-deploy-by-helm.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
# Deploy Studio with Helm

This topic 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=30070 deployment/helm
```

4. When Studio is started, use `http://address-of-node: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](../figs/st-ug-025.png "Studio is started")


## Uninstall

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

## Next to do

On the **Config Server** page, connect Docker-based Studio to Nebula Graph. For more information, see [Connect to Nebula Graph](st-ug-connect.md).

## Configuration

| Parameter | Default value | Description |
|-----------|-------------|---------|
| replicaCount | 0 | The number of replicas for Deployment. |
| image.httpGateway.name | vesoft/nebula-http-gateway | The image name of nebula-http-gateway. |
| image.nebulaStudio.name | vesoft/nebula-graph-studio | The image name of nebula-graph-studio. |
| image.nginx.name | nginx | The image name of nginx. |
| image.httpGateway.version | v2.1.1 | The image version of nebula-http-gateway. |
| image.nebulaStudio.version | v3.1.0 | The image version of nebula-graph-studio. |
| image.nginx.version | alpine | The image version of nginx. |
| 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. |
| resources.httpGateway | {} | The resource limits/requests for nebula-http-gateway. |
| resources.nebulaStudio | {} | The resource limits/requests for nebula-studio. |
| resources.nginx | {} | The resource limits/requests for nginx. |
| persistent.storageClassName | "" | The name of storageClass. The default value will be used if not specified. |
| persistent.size | 5Gi | The persistent volume size. |
37 changes: 13 additions & 24 deletions docs-2.0/nebula-studio/deploy-connect/st-ug-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This topic describes how to deploy Studio locally by Docker, RPM, and tar packag

### Prerequisites

Before you deploy Docker-based Studio, you must confirm that:
Before you deploy RPM-based Studio, you must confirm that:

- The Nebula Graph services are deployed and started. For more information, see [Nebula Graph Database Manual](../../2.quick-start/1.quick-start-workflow.md).

Expand All @@ -35,7 +35,6 @@ Before you deploy Docker-based Studio, you must confirm that:
| ---- | ---- |
| 7001 | Web service provided by Studio. |
| 8080 | HTTP service provided by Nebula HTTP Gateway. |
| 5699 | Data import service provided by Nebula Importer. |

### Install

Expand All @@ -58,8 +57,6 @@ Before you deploy Docker-based Studio, you must confirm that:
```bash
egg started on http://0.0.0.0:7001
nohup: Add the output to "nohup.out"
--- START OF NEBULA IMPORTER ---
[INFO] httpserver.go:80: Starting http server on 5699
```

3. When Docker-based Studio is started, use `http://ip address:7001` to get access to Studio.
Expand All @@ -86,12 +83,12 @@ If the automatic start fails during the installation process or you want to manu

- Start the service manually
```bash
bash /usr/local/nebula-graph-studio/scripts/start.sh
bash /usr/local/nebula-graph-studio/scripts/rpm/start.sh
```

- Stop the service manually
```bash
bash /usr/local/nebula-graph-studio/scripts/stop.sh
bash /usr/local/nebula-graph-studio/scripts/rpm/stop.sh
```

If you encounter an error `bind EADDRINUSE 0.0.0.0:7001` when starting the service, you can use the following command to check port 7001 usage.
Expand Down Expand Up @@ -123,7 +120,7 @@ If the port is occupied and the process on that port cannot be terminated, you c

### Prerequisites

Before you deploy Docker-based Studio , you must do a check of these:
Before you deploy tar-based Studio , you must do a check of these:

- The Nebula Graph services are deployed and started. For more information, see [Nebula Graph Database Manual](../../2.quick-start/1.quick-start-workflow.md).

Expand All @@ -145,7 +142,6 @@ Before you deploy Docker-based Studio , you must do a check of these:
| ---- | ---- |
| 7001 | Web service provided by Studio |
| 8080 | Nebula-http-gateway, Client's HTTP service |
| 5699 | Nebula importer, provide data import service |

### Install

Expand All @@ -165,30 +161,27 @@ Before you deploy Docker-based Studio , you must do a check of these:

!!! Note

The root directory `nebula-graph-studio` has three installation packages: nebula-graph-studio, nebula-importer and nebula-http-gateway. You need to deploy and start the services separately on the same machine to complete the deployment of Studio.
The root directory `nebula-graph-studio` has two installation packages: nebula-graph-studio and nebula-importer. You need to deploy and start the services separately on the same machine to complete the deployment of Studio.

1. Deploy and start nebula-importer.

```bash
$ cd nebula-importer
$ ./nebula-importer --port 5699 --callback "http://0.0.0.0:7001/api/import/finish" &
```

2. Deploy and start nebula-http-gateway.
1. Deploy and start nebula-http-gateway.

```bash
$ cd nebula-http-gateway
$ nohup ./nebula-httpd &
```

3. Deploy and start nebula-graph-studio.
2. Deploy and start nebula-graph-studio.

```bash
$ cd nebula-graph-studio
$ npm run start
```

4. When tar-based Studio is started, use `http://ip address:7001` to get access to Studio.
!!! caution

Studio {{nebula.release}} version is not dependent on nebula-importer, so the installation and deployment procedure is different from Studio v3.0.0.

3. When tar-based Studio is started, use `http://ip address:7001` to get access to Studio.

!!! note

Expand All @@ -202,7 +195,6 @@ Before you deploy Docker-based Studio , you must do a check of these:

You can use `kill pid` to stop the service:
```bash
$ kill $(lsof -t -i :5699) # stop nebula-importer
$ kill $(lsof -t -i :8080) # stop nebula-http-gateway
$ cd nebula-graph-studio
$ npm run stop # stop nebula-graph-studio
Expand All @@ -212,7 +204,7 @@ $ npm run stop # stop nebula-graph-studio

### Prerequisites

Before you deploy Studio, you must do a check of these:
Before you deploy Docker-based Studio, you must do a check of these:

- The Nebula Graph services are deployed and started. For more information, see [Nebula Graph Database Manual](../../2.quick-start/1.quick-start-workflow.md).

Expand All @@ -224,8 +216,6 @@ Before you deploy Studio, you must do a check of these:
| ---- | ---- |
| 7001 | Web service provided by Studio |
| 8080 | Nebula-http-gateway, Client's HTTP service |
| 5699 | Nebula importer file import tool, provide data import service |


### Procedure

Expand Down Expand Up @@ -263,7 +253,6 @@ To deploy and start Docker-based Studio, run the following commands. Here we use
If these lines are returned, Docker-based Studio v3.x is deployed and started.

```bash
Creating docker_importer_1 ... done
Creating docker_client_1 ... done
Creating docker_web_1 ... done
Creating docker_nginx_1 ... done
Expand Down
Binary file modified docs-2.0/nebula-studio/figs/st-ug-046.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs-2.0/nebula-studio/figs/st-ug-054.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ To query the paths or subgraph on the **Console** page and then view them on the
Here is an nGQL statement example.

```ngql
// Run FIND ALL PATH
nebula> FIND ALL PATH FROM "player114" to "player100" OVER follow;
```

Expand All @@ -49,9 +48,9 @@ To query the paths or subgraph on the **Console** page and then view them on the

- **Insert After Clear**: Click this button to clear the existing data from the board and then add the data to the board.

When the data is inserted, you can view the visualized representation of the paths.
When the data is inserted, you can view the visualized representation of the paths. Operations such as expanding vertices, moving the canvas, modifying the color and icon of the vertices, and displaying the properties of the vertices and edges on the page are supported.

![The paths are represented on the Explore board](../figs/st-ug-046-1.png "Visualize paths")
![The paths are represented on the Explore board](../figs/st-ug-046.png "Visualize paths")

## Next to do

Expand Down
83 changes: 42 additions & 41 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -347,37 +347,38 @@ nav:
- Nebula Python: 14.client/5.nebula-python-client.md
- Nebula Go: 14.client/6.nebula-go-client.md

# - Nebula Graph Studio:
# - Change Log: nebula-studio/about-studio/st-ug-release-note.md
# - About Nebula Graph Studio:
# - What is Nebula Graph Studio: nebula-studio/about-studio/st-ug-what-is-graph-studio.md
# - Explanations of terms: nebula-studio/about-studio/st-ug-terms.md
# - Limitations: nebula-studio/about-studio/st-ug-limitations.md
# - Check updates: nebula-studio/about-studio/st-ug-check-updates.md
# - Shortcuts: nebula-studio/about-studio/st-ug-shortcuts.md
# - Deploy and connect:
# - Deploy Studio: nebula-studio/deploy-connect/st-ug-deploy.md
# - Connect to Nebula Graph: nebula-studio/deploy-connect/st-ug-connect.md
# - Clear connection: nebula-studio/deploy-connect/st-ug-reset-connection.md
# - Quick start:
# - Design a schema: nebula-studio/quick-start/st-ug-plan-schema.md
# - Create a schema: nebula-studio/quick-start/st-ug-create-schema.md
# - Import data: nebula-studio/quick-start/st-ug-import-data.md
# - Query graph data: nebula-studio/quick-start/st-ug-explore.md
# - Operation guide:
# - Use Schema:
# - Operate graph spaces: nebula-studio/manage-schema/st-ug-crud-space.md
# - Operate Tags: nebula-studio/manage-schema/st-ug-crud-tag.md
# - Operate Edge types: nebula-studio/manage-schema/st-ug-crud-edge-type.md
# - Operate Indexes: nebula-studio/manage-schema/st-ug-crud-index.md
# - Use Console:
# - Console: nebula-studio/use-console/st-ug-console.md
# - Open in Explore: nebula-studio/use-console/st-ug-open-in-explore.md
# - View subgraphs: nebula-studio/use-console/st-ug-visualize-subgraph.md
# - Troubleshooting:
# - Connecting to the database error: nebula-studio/troubleshooting/st-ug-config-server-errors.md
# - Cannot access to Studio: nebula-studio/troubleshooting/st-ug-connection-errors.md
# - FAQ: nebula-studio/troubleshooting/st-ug-faq.md
- Nebula Graph Studio:
- Change Log: nebula-studio/about-studio/st-ug-release-note.md
- About Nebula Graph Studio:
- What is Nebula Graph Studio: nebula-studio/about-studio/st-ug-what-is-graph-studio.md
- Explanations of terms: nebula-studio/about-studio/st-ug-terms.md
- Limitations: nebula-studio/about-studio/st-ug-limitations.md
- Check updates: nebula-studio/about-studio/st-ug-check-updates.md
- Shortcuts: nebula-studio/about-studio/st-ug-shortcuts.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 Nebula Graph: nebula-studio/deploy-connect/st-ug-connect.md
- Clear connection: nebula-studio/deploy-connect/st-ug-reset-connection.md
- Quick start:
- Design a schema: nebula-studio/quick-start/st-ug-plan-schema.md
- Create a schema: nebula-studio/quick-start/st-ug-create-schema.md
- Import data: nebula-studio/quick-start/st-ug-import-data.md
- Query graph data: nebula-studio/quick-start/st-ug-explore.md
- Operation guide:
- Use Schema:
- Operate graph spaces: nebula-studio/manage-schema/st-ug-crud-space.md
- Operate Tags: nebula-studio/manage-schema/st-ug-crud-tag.md
- Operate Edge types: nebula-studio/manage-schema/st-ug-crud-edge-type.md
- Operate Indexes: nebula-studio/manage-schema/st-ug-crud-index.md
- Use Console:
- Console: nebula-studio/use-console/st-ug-console.md
- Open in Explore: nebula-studio/use-console/st-ug-open-in-explore.md
- View subgraphs: nebula-studio/use-console/st-ug-visualize-subgraph.md
- Troubleshooting:
- Connecting to the database error: nebula-studio/troubleshooting/st-ug-config-server-errors.md
- Cannot access to Studio: nebula-studio/troubleshooting/st-ug-connection-errors.md
- FAQ: nebula-studio/troubleshooting/st-ug-faq.md

# - Nebula Dashboard:
# - What is Nebula Dashboard: nebula-dashboard/1.what-is-dashboard.md
Expand Down Expand Up @@ -429,16 +430,16 @@ nav:
- Import data from SST files: nebula-exchange/use-exchange/ex-ug-import-from-sst.md
- Exchange FAQ: nebula-exchange/ex-ug-FAQ.md

- Nebula Operator:
- What is Nebula Operator: nebula-operator/1.introduction-to-nebula-operator.md
- Overview of using Nebula Operator: nebula-operator/6.get-started-with-operator.md
- Deploy Nebula Operator: nebula-operator/2.deploy-nebula-operator.md
- Deploy clusters:
- Deploy clusters with Kubectl: nebula-operator/3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md
- Deploy clusters with Helm: nebula-operator/3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md
- Connect to Nebula Graph databases: nebula-operator/4.connect-to-nebula-graph-service.md
- Self-healing: nebula-operator/5.operator-failover.md
- FAQ: nebula-operator/7.operator-faq.md
# - Nebula Operator:
# - What is Nebula Operator: nebula-operator/1.introduction-to-nebula-operator.md
# - Overview of using Nebula Operator: nebula-operator/6.get-started-with-operator.md
# - Deploy Nebula Operator: nebula-operator/2.deploy-nebula-operator.md
# - Deploy clusters:
# - Deploy clusters with Kubectl: nebula-operator/3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md
# - Deploy clusters with Helm: nebula-operator/3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md
# - Connect to Nebula Graph databases: nebula-operator/4.connect-to-nebula-graph-service.md
# - Self-healing: nebula-operator/5.operator-failover.md
# - FAQ: nebula-operator/7.operator-faq.md

- Nebula Algorithm: nebula-algorithm.md

Expand Down