Skip to content

Commit

Permalink
fix tag
Browse files Browse the repository at this point in the history
  • Loading branch information
whitewum committed Apr 26, 2022
1 parent 7e18a37 commit faf64f8
Show file tree
Hide file tree
Showing 7 changed files with 53 additions and 51 deletions.
53 changes: 23 additions & 30 deletions docs-2.0/20.appendix/6.eco-tool-version.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,127 +32,127 @@ Nebula Graph Studio (Studio for short) is a graph database visualization tool th

|Nebula Graph version|Studio version|
|:---|:---|
| {{ nebula.release }} | {{studio.release}}|
| {{ nebula.tag }} | {{studio.tag}}|

## Nebula Dashboard Community Edition

Nebula Dashboard Community Edition (Dashboard for short) is a visualization tool for monitoring the status of machines and services in the Nebula Graph cluster. For details, see [What is Nebula Dashboard](../nebula-dashboard/1.what-is-dashboard.md).

|Nebula Graph version|Dashboard Community version|
|:---|:---|
| {{ nebula.release }} | {{dashboard.release}}|
| {{ nebula.tag }} | {{dashboard.tag}}|

## Nebula Dashboard Enterprise Edition

Nebula Dashboard Enterprise Edition (Dashboard for short) is a visualization tool that monitors and manages the status of machines and services in Nebula Graph cluster. For details, see [What is Nebula Dashboard](../nebula-dashboard-ent/1.what-is-dashboard-ent.md).

|Nebula Graph version|Dashboard Enterprise version|
|:---|:---|
| {{ nebula.release }} | {{dashboard_ent.release}}|
| {{ nebula.tag }} | {{dashboard_ent.tag}}|

## Nebula Explorer

Nebula Explorer (Explorer for short) is a graph exploration visualization tool that can be accessed through the Web. It is used with the Nebula Graph core to visualize interaction with graph data. Users can quickly become map experts, even without experience in map data manipulation. For details, see [What is Nebula Explorer](../nebula-explorer/about-explorer/ex-ug-what-is-explorer.md).

|Nebula Graph version|Explorer Enterprise version|
|:---|:---|
| {{ nebula.release }} | {{explorer.release}}|
| {{ nebula.tag }} | {{explorer.tag}}|

## Nebula Stats Exporter

[Nebula-stats-exporter](https://github.com/vesoft-inc/nebula-stats-exporter) exports monitor metrics to Promethus.

|Nebula Graph version|Stats Exporter version|
|:---|:---|
| {{ nebula.release }} | {{exporter.release}}|
| {{ nebula.tag }} | {{exporter.tag}}|

## Nebula Exchange

Nebula Exchange (Exchange for short) is an Apache Spark&trade application for batch migration of data in a cluster to Nebula Graph in a distributed environment. It can support the migration of batch data and streaming data in a variety of different formats. For details, see [What is Nebula Exchange](../nebula-exchange/about-exchange/ex-ug-what-is-exchange.md).

|Nebula Graph version|Exchange Community version|Exchange Enterprise version|
|:---|:---|:--|
| {{ nebula.release }} | {{exchange.release}} | {{exchange_ent.release}} |
| {{ nebula.tag }} | {{exchange.tag}} | {{exchange_ent.tag}} |

## Nebula Operator

Nebula Operator (Operator for short) is a tool to automate the deployment, operation, and maintenance of Nebula Graph clusters on Kubernetes. Building upon the excellent scalability mechanism of Kubernetes, Nebula Graph introduced its operation and maintenance knowledge into the Kubernetes system, which makes Nebula Graph a real cloud-native graph database. For more information, see [What is Nebula Operator](../nebula-operator/1.introduction-to-nebula-operator.md).

|Nebula Graph version|Operator version|
|:---|:---|
| {{ nebula.release }} | {{operator.release}}|
| {{ nebula.tag }} | {{operator.tag}}|

## Nebula Importer

Nebula Importer (Importer for short) is a CSV file import tool for Nebula Graph. The Importer can read the local CSV file, and then import the data into the Nebula Graph database. For details, see [What is Nebula Importer](../nebula-importer/use-importer.md).

|Nebula Graph version|Importer version|
|:---|:---|
| {{ nebula.release }} | {{importer.release}}|
| {{ nebula.tag }} | {{importer.tag}}|

## Nebula Spark Connector

Nebula Spark Connector is a Spark connector that provides the ability to read and write Nebula Graph data in the Spark standard format. Nebula Spark Connector consists of two parts, Reader and Writer. For details, see [What is Nebula Spark Connector](../nebula-spark-connector.md).

|Nebula Graph version|Spark Connector version|
|:---|:---|
| {{ nebula.release }} | {{sparkconnector.release}}|
| {{ nebula.tag }} | {{sparkconnector.tag}}|

## Nebula Flink Connector

Nebula Flink Connector is a connector that helps Flink users quickly access Nebula Graph. It supports reading data from the Nebula Graph database or writing data read from other external data sources to the Nebula Graph database. For details, see [What is Nebula Flink Connector](../nebula-flink-connector.md).

|Nebula Graph version|Flink Connector version|
|:---|:---|
| {{ nebula.release }} | {{flinkconnector.release}}|
| {{ nebula.tag }} | {{flinkconnector.tag}}|

## Nebula Algorithm

Nebula Algorithm (Algorithm for short) is a Spark application based on [GraphX](https://spark.apache.org/graphx/), which uses a complete algorithm tool to analyze data in the Nebula Graph database by submitting a Spark task To perform graph computing, use the algorithm under the lib repository through programming to perform graph computing for DataFrame. For details, see [What is Nebula Algorithm](../nebula-algorithm.md).

|Nebula Graph version|Algorithm version|
|:---|:---|
| {{ nebula.release }} | {{algorithm.release}}|
| {{ nebula.tag }} | {{algorithm.tag}}|

## Nebula Analytics

Nebula Analytics is an application that integrates the open-source Plato Graph Computing Framework, with which Nebula Analytics performs graph computations on Nebula Graph database data. For details, see [What is Nebula Analytics](../nebula-analytics.md).

|Nebula Graph version|Analytics version|
|:---|:---|
| {{ nebula.release }} | {{plato.release}}|
| {{ nebula.tag }} | {{plato.tag}}|

## Nebula Console

Nebula Console is the native CLI client of Nebula Graph. For how to use it, see [Nebula Console](../nebula-console.md).

|Nebula Graph version|Console version|
|:---|:---|
| {{ nebula.release }} | {{console.release}}|
| {{ nebula.tag }} | {{console.tag}}|

## Nebula Docker Compose

Docker Compose can quickly deploy Nebula Graph clusters. For how to use it, please refer to [Docker Compose Deployment Nebula Graph](../4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md ).

|Nebula Graph version|Docker Compose version|
|:---|:---|
| {{ nebula.release }} | {{dockercompose.release}}|
| {{ nebula.tag }} | {{dockercompose.tag}}|

## Backup & Restore

[Backup&Restore](https://github.com/vesoft-inc/nebula-br) (BR for short) is a command line interface (CLI) tool that can help back up the graph space data of Nebula Graph, or restore it through a backup file data.
[Backup&Restore](https://github.com/vesoft-inc/nebula-br/tags/{{br.tag}}) (BR for short) is a command line interface (CLI) tool that can help back up the graph space data of Nebula Graph, or restore it through a backup file data.

|Nebula Graph version|BR version|
|:---|:---|
| {{ nebula.release }} | {{br.release}}|
| {{ nebula.tag }} | {{br.tag}}|

## Nebula Bench

[Nebula Bench](https://github.com/vesoft-inc/nebula-bench) is used to test the baseline performance data of Nebula Graph. It uses the standard data set of LDBC.
[Nebula Bench](https://github.com/vesoft-inc/nebula-bench/releases/tag/{{bench.tag}}) is used to test the baseline performance data of Nebula Graph. It uses the standard data set of LDBC.

|Nebula Graph version|Bench version|
|:---|:---|
| {{ nebula.release }} | {{bench.release}}|
| {{ nebula.tag }} | {{bench.tag}} |

## API, SDK

Expand All @@ -166,18 +166,11 @@ Docker Compose can quickly deploy Nebula Graph clusters. For how to use it, plea
| {{ nebula.release }}| [Go](https://github.com/vesoft-inc/nebula-go/tree/{{go.branch}}) |
| {{ nebula.release }}| [Python](https://github.com/vesoft-inc/nebula-python/tree/{{python.branch}}) |
| {{ nebula.release }}| [Java](https://github.com/vesoft-inc/nebula-java/tree/{{java.branch}}) |
| {{ nebula.release }}| [HTTP](https://github.com/vesoft-inc/nebula-http-gateway) |
| {{ nebula.release }}| [HTTP](https://github.com/vesoft-inc/nebula-http-gateway/tree/{{gateway.branch}}) |

## Not Released

- API

- [Rust Client](https://github.com/vesoft-inc/nebula-rust)

- [Node.js Client](https://github.com/vesoft-inc/nebula-node)

- [Object Graph Mapping Library (OGM, or ORM)] Java, Python (TODO: in design)

- Test

- [Chaos Test](https://github.com/vesoft-inc/nebula-chaos)
- [Rust Client](https://github.com/vesoft-inc/nebula-rust)
- [Node.js Client](https://github.com/vesoft-inc/nebula-node)
- Object Graph Mapping Library (OGM, or ORM)
- 测试
6 changes: 1 addition & 5 deletions docs-2.0/20.appendix/history.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,8 @@

7. 2021.8: Nebula Graph v2.5.0 was released.

![image](https://docs-cdn.nebula-graph.com.cn/books/images/2.5.0.png)

8. 2021.10: Nebula Graph v2.6.0 was released.

For more information about release notes, see [Releases](https://github.com/vesoft-inc/nebula/releases).

9. 2022.2: Nebula Graph v3.0.0 was released.

For more information about release notes, see [Releases](https://github.com/vesoft-inc/nebula/releases).
10. 2022.4: Nebula Graph v3.1.0 was released.
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,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:{{console.branch}}
$ docker run --rm -ti --network nebula-docker-compose_nebula-net --entrypoint=/bin/sh vesoft/nebula-console:{{console.tag}}
```

!!! Note
Expand Down Expand Up @@ -258,7 +258,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:{{console.branch}}
docker pull vesoft/nebula-console:{{console.tag}}
```

## Related documents
Expand Down
2 changes: 1 addition & 1 deletion docs-2.0/nebula-dashboard/1.what-is-dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,4 @@ The version correspondence between Nebula Graph and Dashboard Community Edition

## Release note

[Release](https://github.com/vesoft-inc/nebula-dashboard/releases/tag/{{dashboard.branch}})
[Release](https://github.com/vesoft-inc/nebula-dashboard/releases/tag/{{dashboard.tag}})
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,4 @@ The Nebula Operator scaling feature is only available for the Enterprise Edition

## Release note

[Release](https://github.com/vesoft-inc/nebula-operator/releases/tag/v{{operator.release}})
[Release](https://github.com/vesoft-inc/nebula-operator/releases/tag/v{{operator.tag}})
14 changes: 7 additions & 7 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,13 +25,13 @@ 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:{{console.branch}} --restart=Never -- <nebula_console_name> -addr <cluster_ip> -port <service_port> -u <username> -p <password>
kubectl run -ti --image vesoft/nebula-console:{{console.tag}} --restart=Never -- <nebula_console_name> -addr <cluster_ip> -port <service_port> -u <username> -p <password>
```

For example:

```bash
kubectl run -ti --image vesoft/nebula-console:{{console.branch}} --restart=Never -- nebula-console -addr 10.98.213.34 -port 9669 -u root -p vesoft
kubectl run -ti --image vesoft/nebula-console:{{console.tag}} --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.
- `<nebula-console>`: The custom Pod name.
Expand All @@ -51,7 +51,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:{{console.branch}} --restart=Never -- <nebula_console_name> -addr <cluster_name>-graphd-svc.default.svc.cluster.local -port <service_port> -u <username> -p <password>
kubectl run -ti --image vesoft/nebula-console:{{console.tag}} --restart=Never -- <nebula_console_name> -addr <cluster_name>-graphd-svc.default.svc.cluster.local -port <service_port> -u <username> -p <password>
```
The default value of `CLUSTER_DOMAIN` is `cluster.local`.
Expand Down Expand Up @@ -126,13 +126,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:{{console.branch}} --restart=Never -- <nebula_console_name> -addr <node_ip> -port <node_port> -u <username> -p <password>
kubectl run -ti --image vesoft/nebula-console:{{console.tag}} --restart=Never -- <nebula_console_name> -addr <node_ip> -port <node_port> -u <username> -p <password>
```
For example:
```bash
kubectl run -ti --image vesoft/nebula-console:{{console.branch}} --restart=Never -- nebula-console2 -addr 192.168.8.24 -port 32236 -u root -p vesoft
kubectl run -ti --image vesoft/nebula-console:{{console.tag}} --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 Expand Up @@ -212,13 +212,13 @@ Steps are as follows.
4. Use the IP address and the port configured in the preceding steps. You can connect to Nebula Graph with Nebula Console.

```bash
kubectl run -ti --image vesoft/nebula-console:{{console.branch}} --restart=Never -- <nebula_console_name> -addr <host_ip> -port <external_port> -u <username> -p <password>
kubectl run -ti --image vesoft/nebula-console:{{console.tag}} --restart=Never -- <nebula_console_name> -addr <host_ip> -port <external_port> -u <username> -p <password>
```

Output:

```bash
kubectl run -ti --image vesoft/nebula-console:{{console.branch}} --restart=Never -- nebula-console -addr 192.168.8.160 -port 9769 -u root -p vesoft
kubectl run -ti --image vesoft/nebula-console:{{console.tag}} --restart=Never -- nebula-console -addr 192.168.8.160 -port 9769 -u root -p vesoft
```

- `--image`: The image for the tool Nebula Console used to connect to Nebula Graph databases.
Expand Down
23 changes: 18 additions & 5 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,28 +42,31 @@ extra:
provider: google
property: UA-60523578-15
# branch represents code names (git clone). release represents version number used in texts.
version:
method: mike
social:
- icon: 'fontawesome/brands/github'
link: 'https://github.com/vesoft-inc/nebula-docs'
nebula:
release: 3.1.0
nightly: nightly
master: master
base20: 2.0
base200: 2.0.0
branch: release-3.1
version:
method: mike
social:
- icon: 'fontawesome/brands/github'
link: 'https://github.com/vesoft-inc/nebula-docs'
studio:
base111b: 1.1.1-beta
base220: 2.2.1
base300: 3.0.0
release: 3.3.0
explorer:
release: 3.0.0
branch: reelase-3.0
tag: v3.0.0
exchange_ent:
release: 3.0.0
branch: v3.0.0
tag: v3.0.0
exchange:
release: 3.0.0
branch: v3.0.0
Expand All @@ -75,9 +78,11 @@ extra:
algorithm:
release: 3.0.0
branch: v3.0.0
tag: v3.0.0
plato:
release: 3.1.0
branch: release-3.1
tag: v3.1.0
sparkconnector:
release: 3.0.0
branch: v3.0.0
Expand All @@ -89,17 +94,24 @@ extra:
dockercompose:
release: 3.1.0
branch: release-3.1
tag: v3.1.0
dashboard:
release: 3.0.0
tag: v3.0.0
base100: 1.0.0
branch: release-3.0
dashboard_ent:
release: 3.0.0
tag: v3.0.0
branch: release-3.0
console:
release: 3.0.0
branch: v3.0.0
tag: v3.0.0
br:
release: 0.6.0
branch: master
tag: v0.6.0
cpp:
release: 3.0.0
branch: v3.0.0
Expand All @@ -125,6 +137,7 @@ extra:
exporter:
release: 3.1.0
branch: release-3.1
tag: v3.1.0

nav:
- About: README.md
Expand Down

0 comments on commit faf64f8

Please sign in to comment.