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.

Sign up for GitHub

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

Jump to bottom

update-studio #1078

Merged
merged 2 commits into from
Feb 9, 2022
Merged

update-studio #1078

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cb1c06a
update-studio
foesa-yang Feb 9, 2022
6468f9e
Update mkdocs.yml
foesa-yang Feb 9, 2022
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
View file
Open in desktop
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.png)
![On the upper right corner of the page, click Version and then New Version](./../figs/st-ug-054.png)
13 changes: 7 additions & 6 deletions docs-2.0/nebula-studio/about-studio/st-ug-limitations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ This topic introduces the limitations of Studio.
| 1.x | 1.x|
| 2.0 & 2.0.1 | 2.x |
| 2.5.0 & 2.5.1 | 3.0.0 |
| 2.6.0 | 3.1.0 |
| 2.6.1 | 3.1.0 |
| 2.6.0 & 2.6.1 & 2.6.2 | 3.1.0 |
| 3.0.0 | 3.2.0 |

## Architecture

For now, Docker-based and RPM-based Studio v3.x supports x86_64 architecture only.
For now, Studio v3.x supports x86_64 architecture only.

## Upload data

Expand All @@ -36,14 +36,15 @@ Only CSV files without headers can be uploaded, but no limitations are applied t

## Data backup

For now, you can export the queried results in the CSV format on the **Console** page and export data in the CSV format on the **Explore** page. No other backup methods are available.
For now, you can export the queried results in the CSV format on the **Console** page and export data in the CSV format and png format on the **Explore** page. No other backup methods are available.

## nGQL statements

On the **Console** page of Docker-based and RPM-based Studio v3.x, all the nGQL syntaxes except these are supported:

- `USE <space_name>`: You cannot run such a statement on the **Console** page to choose a graph space. As an alternative, you can click a graph space name in the drop-down list of **Current Graph Space**.
- You cannot use line breaks (\\). As an alternative, you can use the Enter key to split a line.

<!--
For Studio on Cloud, besides the preceding syntax, you cannot run these account and role management statements on the Console page:

Expand All @@ -54,9 +55,9 @@ For Studio on Cloud, besides the preceding syntax, you cannot run these account
- `GRANT ROLE`
- `REVOKE ROLE`

For more information about the preceding statements, see[Nebula Graph Database Manual](https://docs.nebula-graph.io/2.0.1/7.data-security/1.authentication/2.management-user/)
For more information about the preceding statements, see[User management](../../7.data-security/1.authentication/2.management-user.md)
-->

## Browser

We recommend that you use Chrome to get access to Studio.
We recommend that you use the latest version of Chrome to get access to Studio.
27 changes: 8 additions & 19 deletions docs-2.0/nebula-studio/about-studio/st-ug-release-note.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,25 +1,14 @@
# Change Log

## v3.1.0 (2021.10.29)
## v3.2.0 (TODO)

- Feature enhancements:
- Compatible with Nebula Graph v2.6.0.
- Added the use of Helm to deploy and start Studio in the Kubernetes cluster.
- Added GEO.
- 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.
- Compatible with Nebula Graph v3.0.0.
- Added the use of DEB to deploy and start Studio.
- Import:
- Added password confirmation when importing to enhance security.
- Console:
- Added save parameter for parameterized query.

- 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.
- Remove Studio's dependency on Node.js.
1 change: 1 addition & 0 deletions docs-2.0/nebula-studio/about-studio/st-ug-what-is-graph-studio.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ You can deploy Studio using the following methods:
- Docker-based. You can deploy Studio with Docker and connect it to Nebula Graph. For more information, see [Docker-based Studio](../deploy-connect/st-ug-deploy.md).
- RPM-based. You can deploy Studio with RPM and connect it to Nebula Graph. For more information, see [RPM-based Studio](../deploy-connect/st-ug-deploy.md).
- Tar-based. You can deploy Studio with tar and connect it to Nebula Graph. For more information, see [tar-based Studio](../deploy-connect/st-ug-deploy.md).
- DEB-based. You can deploy Studio with DEB and connect it to Nebula Graph. For more information, see [DEB-based Studio](../deploy-connect/st-ug-deploy.md).
- Helm-based. You can deploy Studio with Helm in the Kubernetes cluster and connect it to Nebula Graph. For more information, see [Helm-based Studio](../deploy-connect/st-ug-deploy-by-helm.md).

<!--
Expand Down
10 changes: 5 additions & 5 deletions docs-2.0/nebula-studio/deploy-connect/st-ug-connect.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,13 @@ To connect Studio to Nebula Graph, follow these steps:

- **Username** and **Password**: Fill in the log in account according to the authentication settings of Nebula Graph.

- If authentication is not enabled, you can use `root` and any password as the username and its password.
- If authentication is not enabled, you can use `root` and any password as the username and its password.

- If authentication is enabled and no account information has been created, you can only log in as GOD role and use `root` and `nebula` as the username and its password.
- If authentication is enabled and no account information has been created, you can only log in as GOD role and use `root` and `nebula` as the username and its password.

- If authentication is enabled and different users are created and assigned roles, users in different roles log in with their accounts and passwords.

![The Config Server page shows the fields to be configured for connection](../figs/st-ug-050-1.png "Config Server")
- If authentication is enabled and different users are created and assigned roles, users in different roles log in with their accounts and passwords.
![The Config Server page shows the fields to be configured for connection](../figs/st-ug-050-1.png "Config Server")

2. After the configuration, click the **Connect** button.

Expand Down
9 changes: 2 additions & 7 deletions docs-2.0/nebula-studio/deploy-connect/st-ug-deploy-by-helm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,16 +51,11 @@ On the **Config Server** page, connect Docker-based Studio to Nebula Graph. For
| 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. |
| 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. |
| resources.httpGateway | {} | The resource limits/requests for nebula-http-gateway. |
| service.nodePort | 32701 | The proxy port for accessing nebula-studio outside kubernetes cluster. |
| 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. |
148 changes: 74 additions & 74 deletions docs-2.0/nebula-studio/deploy-connect/st-ug-deploy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Studio on Cloud can be used on Nebula Graph Cloud Service. When you create a Nebula Graph instance on Nebula Graph Cloud Service, Studio on Cloud is deployed automatically. For more information, see [Nebula Graph Cloud Service User Guide](https://cloud-docs.nebula-graph.com.cn/en/posts/manage-instances/dbaas-ug-connect-nebulastudio/). For Docker-based and PRM-based Studio, you must deploy it. This article introduces how to deploy Docker-based and RPM-based Studio.
-->

This topic describes how to deploy Studio locally by Docker, RPM, and tar package.
This topic describes how to deploy Studio locally by Docker, RPM, tar and DEB package.

!!! Note

Expand All @@ -17,64 +17,48 @@ 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).

- If your Linux distribution is CentOS, install `lsof` and [Node.js](https://nodejs.org/en/) of versions above v10.16.0+.

!!! note

`node` and `npm` should be installed in `/usr/bin/` directory. Avoid the situation that the node command cannot be found during RPM installation.
For example, the default directory of nodejs12 is in `/opt/rh/rh-nodejs12`, you can use following commands to build soft link:

```bash
$ sudo ln -s /opt/rh/rh-nodejs12/root/usr/bin/node /usr/bin/node
$ sudo ln -s /opt/rh/rh-nodejs12/root/usr/bin/npm /usr/bin/npm
```
- The Linux distribution is CentOS, install `lsof`.

- Before the installation starts, the following ports are not occupied.

| Port | Description |
| ---- | ---- |
| 7001 | Web service provided by Studio. |
| 8080 | HTTP service provided by Nebula HTTP Gateway. |

### Install

1. Select and download the RPM package according to your needs. It is recommended to select the latest version. Common links are as follows:

| Installation package | Checksum | Nebula version |
| ----- | ----- | ----- |
| [nebula-graph-studio-{{studio.release}}-1.x86_64.rpm](https://oss-cdn.nebula-graph.io/nebula-graph-studio/{{studio.release}}/nebula-graph-studio-{{studio.release}}-1.x86_64.rpm) | [nebula-graph-studio-{{studio.release}}-1.x86_64.rpm.sha256](https://oss-cdn.nebula-graph.io/nebula-graph-studio/{{studio.release}}/nebula-graph-studio-{{studio.release}}-1.x86_64.rpm.sha256) | v{{nebula.release}} |
| [nebula-graph-studio-{{studio.release}}.x86_64.rpm](https://oss-cdn.nebula-graph.io/nebula-graph-studio/{{studio.release}}/nebula-graph-studio-{{studio.release}}.x86_64.rpm) | [nebula-graph-studio-{{studio.release}}.x86_64.rpm.sha256](https://oss-cdn.nebula-graph.io/nebula-graph-studio/{{studio.release}}/nebula-graph-studio-{{studio.release}}.x86_64.rpm.sha256) | {{nebula.release}} |


2. Use `sudo rpm -i <rpm>` to install RPM package.

For example, install Studio {{studio.release}}, use the following command:
```bash
sudo rpm -i nebula-graph-studio-{{studio.release}}-1.x86_64.rpm
sudo rpm -i nebula-graph-studio-{{studio.release}}.x86_64.rpm
```

When the screen returns the following message, it means that the PRM-based Studio has been successfully started.

```bash
egg started on http://0.0.0.0:7001
nohup: Add the output to "nohup.out"
Created symlink from /etc/systemd/system/multi-user.target.wants/nebula-graph-studio.service to /usr/lib/systemd/system/nebula-graph-studio.service.
```

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

!!! note
If you can see the **Config Server** page on the browser, Studio is started successfully.

Run `ifconfig` or `ipconfig` to get the IP address of the machine where Docker-based Studio is running. On the machine running Docker-based Studio, you can use `http://localhost:7001` to get access to Studio.

If you can see the **Config Server** page on the browser, Docker-based Studio is started successfully.

![The Config Server page shows that Docker-based Studio is started successfully](../figs/st-ug-025.png "Docker-based Studio is started")
![The Config Server page shows that Studio is started successfully](../figs/st-ug-025.png)

### Uninstall

Users can uninstall Studio using the following command:
You can uninstall Studio using the following command:

```bash
sudo rpm -e nebula-graph-studio-{{studio.release}}-1.x86_64
sudo rpm -e nebula-graph-studio-{{studio.release}}.x86_64
```

### Exception handling
Expand All @@ -92,6 +76,7 @@ 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.

```bash
lsof -i:7001
```
Expand Down Expand Up @@ -120,84 +105,99 @@ If the port is occupied and the process on that port cannot be terminated, you c

### Prerequisites

Before you deploy tar-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).

- The Linux distribution is CentOS, installed `lsof` and [Node.js](https://nodejs.org/en/) of version above v10.16.0+.

!!! note

`node` and `npm` should be installed in `/usr/bin/` directory. Avoid the situation that the node command cannot be found during RPM installation.
For example, the default directory of nodejs12 is in `/opt/rh/rh-nodejs12`, you can use following commands to build soft link:

```bash
$ sudo ln -s /opt/rh/rh-nodejs12/root/usr/bin/node /usr/bin/node
$ sudo ln -s /opt/rh/rh-nodejs12/root/usr/bin/npm /usr/bin/npm
```

- Before the installation starts, the following ports are not occupied.

| Port | Description |
| ---- | ---- |
| 7001 | Web service provided by Studio |
| 8080 | Nebula-http-gateway, Client's HTTP service |

### Install
### Install and deploy

1. Select and download the tar package according to your needs. It is recommended to select the latest version. Common links are as follows:

| Installation package | Studio version |
| --- | --- |
| [nebula-graph-studio-{{studio.release}}-1.x86_64.tar.gz](https://oss-cdn.nebula-graph.io/nebula-graph-studio/{{studio.release}}/nebula-graph-studio-{{studio.release}}-1.x86_64.tar.gz) | {{studio.release}} |
| [nebula-graph-studio-{{studio.release}}.x86_64.tar.gz](https://oss-cdn.nebula-graph.io/nebula-graph-studio/{{studio.release}}/nebula-graph-studio-{{studio.release}}.x86_64.tar.gz) | {{studio.release}} |

2. Use `tar -xvf` to decompress the tar package.

```bash
tar -xvf nebula-graph-studio-{{studio.release}}-1.x86_64.tar.gz
tar -xvf nebula-graph-studio-{{studio.release}}.x86_64.tar.gz
```

### Procedure

!!! Note

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-http-gateway.
3. Deploy and start nebula-graph-studio.

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

2. Deploy and start nebula-graph-studio.

```bash
$ cd nebula-graph-studio
$ npm run start
$ ./server
```

!!! 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
Studio {{nebula.release}} version is not dependent on nebula-importer and nebula-http-gateway, so the installation and deployment procedure is different from Studio v3.1.0.

Run `ifconfig` or `ipconfig` to get the IP address of the machine where Docker-based Studio is running. On the machine running Docker-based Studio, you can use `http://localhost:7001` to get access to Studio.
4. When Studio is started, use `http://ip address:7001` to get access to Studio.

If you can see the **Config Server** page on the browser, Docker-based Studio is started successfully.
If you can see the **Config Server** page on the browser, Studio is started successfully.

![The Config Server page shows that Docker-based Studio is started successfully](../figs/st-ug-025.png "Docker-based Studio is started")
![The Config Server page shows that Studio is started successfully](../figs/st-ug-025.png)

### Stop Service

You can use `kill pid` to stop the service:
```bash
$ kill $(lsof -t -i :8080) # stop nebula-http-gateway
$ cd nebula-graph-studio
$ npm run stop # stop nebula-graph-studio
$ kill $(lsof -t -i :7001) #stop nebula-graph-studio
```

## DEB-based Studio

### Prerequisites

Before you deploy DEB-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).

- The Linux distribution is Ubuntu.

- Before the installation starts, the following ports are not occupied.

| Port | Description |
| ---- | ---- |
| 7001 | Web service provided by Studio |

### Install

1. Select and download the DEB package according to your needs. It is recommended to select the latest version. Common links are as follows:

| Installation package | Checksum | Nebula version|
| ----- | ----- | ----- |
| [nebula-graph-studio-{{studio.release}}.x86_64.deb](https://oss-cdn.nebula-graph.io/nebula-graph-studio/{{studio.release}}/nebula-graph-studio-{{studio.release}}.x86_64.deb) | [nebula-graph-studio-{{studio.release}}.x86_64.deb.sha256](https://oss-cdn.nebula-graph.io/nebula-graph-studio/{{studio.release}}/nebula-graph-studio-{{studio.release}}.x86_64.deb.sha256) | {{ nebula.release }} |

2. Use `sudo dpkg -i <deb>` to install DEB package.

For example, install Studio {{studio.release}}, use the following command:

```bash
$ sudo dpkg -i nebula-graph-studio-{{ studio.release }}.x86_64.deb
```

3. When Studio is started, use `http://ip address:7001` 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)

### Uninstall

You can uninstall Studio using the following command:

```bash
$ sudo dpkg -r nebula-graph-studio-{{ studio.release }}.x86_64

```

## Docker-based Studio
Expand Down Expand Up @@ -225,17 +225,17 @@ To deploy and start Docker-based Studio, run the following commands. Here we use

| Installation package | Nebula Graph version |
| ----- | ----- |
| [nebula-graph-studio-v3.tar.gz](https://oss-cdn.nebula-graph.io/nebula-graph-studio/nebula-graph-studio-v3.tar.gz) | v{{nebula.release}} |
| [nebula-graph-studio-v{{studio.release}}.tar.gz](https://oss-cdn.nebula-graph.io/nebula-graph-studio/nebula-graph-studio-v{{studio.release}}.tar.gz) | {{nebula.release}} |

2. Create the `nebula-graph-studio-v3` directory and decompress the installation package to the directory.
2. Create the `nebula-graph-studio-v{{studio.release}}` directory and decompress the installation package to the directory.

```bash
mkdir nebula-graph-studio-v3 && tar -zxvf nebula-graph-studio-v3.gz -C nebula-graph-studio-v3
mkdir nebula-graph-studio-v{{studio.release}} -zxvf nebula-graph-studio-v{{studio.release}}.gz -C nebula-graph-studio-v{{studio.release}}
```

3. Change to the `nebula-graph-studio-v3` directory.
3. Change to the `nebula-graph-studio-v{{studio.release}}` directory.
```bash
cd nebula-graph-studio-v3
cd nebula-graph-studio-v{{studio.release}}
```

4. Pull the Docker image of Studio.
Expand Down
Binary file removed docs-2.0/nebula-studio/figs/st-ug-006.png
View file
Open in desktop
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-031-1.png
View file
Open in desktop
Binary file not shown.
Binary file modified docs-2.0/nebula-studio/figs/st-ug-031.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-032.png
View file
Open in desktop
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-033.png
View file
Open in desktop
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-034.png
View file
Open in desktop
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-036-1.png
View file
Open in desktop
Binary file not shown.
Binary file modified docs-2.0/nebula-studio/figs/st-ug-036.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-038.png
View file
Open in desktop
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-044.png
View file
Open in desktop
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-045.png
View file
Open in desktop
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-046.png
View file
Open in desktop
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-047.png
View file
Open in desktop
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-048.png
View file
Open in desktop
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-050.png
View file
Open in desktop
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-052.png
View file
Open in desktop
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-054-1.png
View file
Open in desktop
Binary file not shown.
Binary file modified docs-2.0/nebula-studio/figs/st-ug-054.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading