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

Eco tools #840

Merged
merged 6 commits into from
Oct 27, 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
8 changes: 4 additions & 4 deletions docs-2.0/20.appendix/6.eco-tool-version.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,10 +144,10 @@ Docker Compose can quickly deploy Nebula Graph clusters. For how to use it, plea

|Nebula Graph version| Language (commit id) |
|:---| :--- |
| {{ nebula.release }}| [C++](https://github.com/vesoft-inc/nebula-cpp)(00e2625) |
| {{ nebula.release }}| [Go](https://github.com/vesoft-inc/nebula-go/tree/{{go.branch}})(02eb246) |
| {{ nebula.release }}| [Python](https://github.com/vesoft-inc/nebula-python)(6e467a9) |
| {{ nebula.release }}| [Java Client](https://github.com/vesoft-inc/nebula-java/tree/{{java.branch}})(8e171e4) |
| {{ nebula.release }}| [C++](https://github.com/vesoft-inc/nebula-cpp/tree/{{cpp.branch}})(00e2625 |
| {{ nebula.release }}| [Go](https://github.com/vesoft-inc/nebula-go/tree/{{go.branch}})02eb246 |
| {{ nebula.release }}| [Python](https://github.com/vesoft-inc/nebula-python/tree/{{python.branch}})(6e467a9 |
| {{ nebula.release }}| [Java](https://github.com/vesoft-inc/nebula-java/tree/{{java.branch}})8e171e4 |

## Not Released

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Using Docker Compose can quickly deploy Nebula Graph services based on the prepa
1. Run the following command to start a new docker container with the Nebula Console image, and connect the container to the network where Nebula Graph is deployed (nebula-docker-compose_nebula-net).

```bash
$ docker run --rm -ti --network nebula-docker-compose_nebula-net --entrypoint=/bin/sh vesoft/nebula-console:v2.5.0
$ docker run --rm -ti --network nebula-docker-compose_nebula-net --entrypoint=/bin/sh vesoft/nebula-console:{{console.branch}}
```

!!! Note
Expand Down Expand Up @@ -217,7 +217,7 @@ To set the `ports` of corresponding services as fixed mapping, modify the `docke

```bash
graphd:
image: vesoft/nebula-graphd:v2.5.0
image: vesoft/nebula-graphd:{{nebula.branch}}
...
ports:
- 9669:9669
Expand All @@ -244,7 +244,7 @@ You have met the rate limit of Docker Hub. Learn more on [Understanding Docker H
To update the Nebula Console client, run the following command.

```bash
docker pull vesoft/nebula-console:v2.5.0
docker pull vesoft/nebula-console:{{console.branch}}
```

### How to upgrade Nebula Graph services
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ To upgrade Nebula Graph v2.0.x to v{{nebula.release}}, you only need to use the

## Upgrade steps by deploying Docker Compose

1. Modify the file `docker-compose.yaml` in the directory `nebula-docker-compose`, and modify all versions after `image` to `{{nebula.release}}`.
1. Modify the file `docker-compose.yaml` in the directory `nebula-docker-compose`, and modify all versions after `image` to `{{nebula.branch}}`.

2. Execute the command `docker-compose pull` in the directory `nebula-docker-compose` to update the images of all services.

Expand Down
8 changes: 4 additions & 4 deletions docs-2.0/nebula-operator/4.connect-to-nebula-graph-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ When a Nebula Graph cluster is created, Nebula Operator automatically creates a
2. Run the following command to connect to the Nebula Graph database using the IP of the `<cluster-name>-graphd-svc` Service above:

```bash
kubectl run -ti --image vesoft/nebula-console:v2.5.0 --restart=Never -- <nebula-console> -addr <10.98.213.34> -port 9669 -u <root> -p <vesoft>
kubectl run -ti --image vesoft/nebula-console:{{console.branch}} --restart=Never -- <nebula-console> -addr <10.98.213.34> -port 9669 -u <root> -p <vesoft>
```

- `--image`: The image for the tool Nebula Console used to connect to Nebula Graph databases.
Expand All @@ -46,7 +46,7 @@ When a Nebula Graph cluster is created, Nebula Operator automatically creates a
You can also connect to Nebula Graph databases with **Fully Qualified Domain Name (FQDN)**. The domain format is `<cluster-name>-graphd.<cluster-namespace>.svc.<CLUSTER_DOMAIN>`:

```bash
kubectl run -ti --image vesoft/nebula-console:v2.5.0 --restart=Never -- <nebula-console> -addr <cluster_name>-graphd-svc.default.svc.cluster.local -port 9669 -u root -p vesoft
kubectl run -ti --image vesoft/nebula-console:{{console.branch}} --restart=Never -- <nebula-console> -addr <cluster_name>-graphd-svc.default.svc.cluster.local -port 9669 -u root -p vesoft
```

The default value of `CLUSTER_DOMAIN` is `cluster.local`.
Expand Down Expand Up @@ -121,13 +121,13 @@ Steps:
4. Connect to Nebula Graph databases with your node IP and the node port above.

```bash
kubectl run -ti --image vesoft/nebula-console:v2.5.0 --restart=Never -- <nebula-console> -addr <node_ip> -port <node_port> -u root -p vesoft
kubectl run -ti --image vesoft/nebula-console:{{console.branch}}--restart=Never -- <nebula-console> -addr <node_ip> -port <node_port> -u root -p vesoft
```

Example:

```bash
[root@k8s4 ~]# kubectl run -ti --image vesoft/nebula-console:v2.5.0 --restart=Never -- nebula-console2 -addr 192.168.8.24 -port 32236 -u root -p vesoft
[root@k8s4 ~]# kubectl run -ti --image vesoft/nebula-console:{{console.branch}} --restart=Never -- nebula-console2 -addr 192.168.8.24 -port 32236 -u root -p vesoft
If you don't see a command prompt, try pressing enter.

(root@nebula) [(none)]>
Expand Down
Binary file added docs-2.0/reuse/assets-1.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 removed docs-2.0/reuse/assets.png
Binary file not shown.
Binary file modified docs-2.0/reuse/console-1.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 removed docs-2.0/reuse/console.png
Binary file not shown.
6 changes: 3 additions & 3 deletions docs-2.0/reuse/source_connect-to-nebula-graph.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ If you don't have a Nebula Graph database yet, we recommend that you try the clo

We recommend that you select the **latest** release.

![Select a Nebula Graph version and click **Assets**](https://docs-cdn.nebula-graph.com.cn/docs-2.0/2.quick-start/nebula-console-releases-1.png "Click Assets to show the available Nebula Graph binary files")
![Select a Nebula Graph version and click **Assets**](../reuse/console-1.png "Click Assets to show the available Nebula Graph binary files")

2. In the **Assets** area, find the correct binary file for the machine where you want to run Nebula Console and download the file to the machine.

![Click to download the package according to your hardware architecture](https://docs-cdn.nebula-graph.com.cn/docs-2.0/2.quick-start/nebula-console-releases-2-1.png "Click the package name to download it")
![Click to download the package according to your hardware architecture](../reuse/assets-1.png "Click the package name to download it")

3. (Optional) Rename the binary file to `nebula-console` for convenience.

Expand Down Expand Up @@ -76,7 +76,7 @@ If you don't have a Nebula Graph database yet, we recommend that you try the clo
| `-e/-eval` | Sets a string-type nGQL statement. The nGQL statement is executed once the connection succeeds. The connection stops after the result is returned. |
| `-f/-file` | Sets the path of an nGQL file. The nGQL statements in the file are executed once the connection succeeds. You'll get the return messages and the connection stops then. |

You can find more details in the [Nebula Console Repository](https://github.com/vesoft-inc/nebula-console/tree/v2.0.0-ga).
You can find more details in the [Nebula Console Repository](https://github.com/vesoft-inc/nebula-console/tree/{{console.branch}}).

## Nebula Console commands

Expand Down
23 changes: 12 additions & 11 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,8 @@ extra:
release: 2.5.1
branch: v2.5
importer:
release: 2.5.0
branch: release-v2.0.0-ga
release: 2.6.0
branch: v2.6.0
algorithm:
release: 2.5.1
branch: v2.5
Expand All @@ -78,30 +78,31 @@ extra:
release: 2.5.0
branch: v2.5
dockercompose:
release: 2.5.0
branch: v2.5.0
release: 2.6.0
branch: v2.6.0
common:
release: 2.5.1
dashboard:
release: 1.0.1
base100: 1.0.0
branch: v1.0.1
console:
release: 2.5.0
release: 2.6.0
branch: v2.6.0
br:
release: 0.5.0
cpp:
release: 2.5.0
branch: v2.5.0
java:
release: 2.5.0
branch: v2.5.0
release: 2.6.0
branch: v2.6.0
python:
release: 2.5.0
branch: v2.5.0
release: 2.6.0
branch: v2.6.0
go:
release: 2.5.0
branch: release-v2.5.0
release: 2.6.0
branch: v2.6.0
bench:
release: 1.0.0
branch: master
Expand Down