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

add dockercompose in quick start #2209

Merged
merged 1 commit into from
Aug 4, 2023
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
365 changes: 335 additions & 30 deletions docs-2.0/2.quick-start/1.quick-start-workflow.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs-2.0/20.appendix/6.eco-tool-version.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ NebulaGraph Console is the native CLI client of NebulaGraph. For how to use it,

## NebulaGraph Docker Compose

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

|NebulaGraph version|Docker Compose version|
|:---|:---|
Expand Down
2 changes: 1 addition & 1 deletion docs-2.0/20.appendix/learning-path.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ After completing the NebulaGraph learning path, taking [NebulaGraph Certificatio
| ------------------------------------------------------------ | ------------------------------------------------------------ |
| [Install with a RPM or DEB package](../4.deployment-and-installation/2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md) | - |
| [Install with a TAR package](../4.deployment-and-installation/2.compile-and-install-nebula-graph/4.install-nebula-graph-from-tar.md) | - |
| [Install with Docker](../4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md) | [Install NebulaGraph with Docker and Docker Compose](https://www.youtube.com/watch?v=yM5GDpJedEI) |
| [Install with Docker](../2.quick-start/1.quick-start-workflow.md) | [Install NebulaGraph with Docker and Docker Compose](https://www.youtube.com/watch?v=yM5GDpJedEI) |
| [Install from source](../4.deployment-and-installation/2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md) | [Install NebulaGraph with Source Code](https://www.youtube.com/watch?v=x-I835eEBz0) |


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ curl -G "http://<ip>:<port>/stats?stats=<metric_name_list> [&format=json]"

!!! note

If NebulaGraph is deployed with [Docker Compose](..//4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md), run `docker-compose ps` to check the ports that are mapped from the service ports inside of the container and then query through them.
If NebulaGraph is deployed with [Docker Compose](../2.quick-start/1.quick-start-workflow.md), run `docker-compose ps` to check the ports that are mapped from the service ports inside of the container and then query through them.


### Query a single metric
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This example is done on MacOS. Here is the environment configuration information

- ClickHouse: docker deployment yandex/clickhouse-server tag: latest(2021.07.01)

- NebulaGraph: {{nebula.release}}. [Deploy NebulaGraph with Docker Compose](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md).
- NebulaGraph: {{nebula.release}}. [Deploy NebulaGraph with Docker Compose](../../2.quick-start/1.quick-start-workflow.md).

## Prerequisites

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ This example is done on MacOS. Here is the environment configuration information

- Hadoop: 2.9.2, pseudo-distributed deployment

- NebulaGraph: {{nebula.release}}. [Deploy NebulaGraph with Docker Compose](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md).
- NebulaGraph: {{nebula.release}}. [Deploy NebulaGraph with Docker Compose](../../2.quick-start/1.quick-start-workflow.md).

## Prerequisites

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ This example is done on MacOS. Here is the environment configuration information

- HBase: 2.2.7

- NebulaGraph: {{nebula.release}}. [Deploy NebulaGraph with Docker Compose](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md).
- NebulaGraph: {{nebula.release}}. [Deploy NebulaGraph with Docker Compose](../../2.quick-start/1.quick-start-workflow.md).

## Prerequisites

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ This example is done on MacOS. Here is the environment configuration information

- Hive: 2.3.7, Hive Metastore database is MySQL 8.0.22

- NebulaGraph: {{nebula.release}}. [Deploy NebulaGraph with Docker Compose](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md).
- NebulaGraph: {{nebula.release}}. [Deploy NebulaGraph with Docker Compose](../../2.quick-start/1.quick-start-workflow.md).

## Prerequisites

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ This example is done on MacOS. Here is the environment configuration information

- MySQL: 8.0.23

- NebulaGraph: {{nebula.release}}. [Deploy NebulaGraph with Docker Compose](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md).
- NebulaGraph: {{nebula.release}}. [Deploy NebulaGraph with Docker Compose](../../2.quick-start/1.quick-start-workflow.md).

## Prerequisites

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ This example is done on MacOS. Here is the environment configuration information

- Hadoop: 2.9.2, pseudo-distributed deployment

- NebulaGraph: {{nebula.release}}. [Deploy NebulaGraph with Docker Compose](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md).
- NebulaGraph: {{nebula.release}}. [Deploy NebulaGraph with Docker Compose](../../2.quick-start/1.quick-start-workflow.md).

## Prerequisites

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This example is done on MacOS. Here is the environment configuration information

- Spark: 2.4.7, stand-alone

- NebulaGraph: {{nebula.release}}. [Deploy NebulaGraph with Docker Compose](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md).
- NebulaGraph: {{nebula.release}}. [Deploy NebulaGraph with Docker Compose](../../2.quick-start/1.quick-start-workflow.md).

## Prerequisites

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This example is done on MacOS. Here is the environment configuration information

- MaxCompute: Alibaba Cloud official version

- NebulaGraph: {{nebula.release}}. [Deploy NebulaGraph with Docker Compose](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md).
- NebulaGraph: {{nebula.release}}. [Deploy NebulaGraph with Docker Compose](../../2.quick-start/1.quick-start-workflow.md).

## Prerequisites

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ This example is done on MacOS. Here is the environment configuration information

- MySQL: 8.0.23

- NebulaGraph: {{nebula.release}}. [Deploy NebulaGraph with Docker Compose](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md).
- NebulaGraph: {{nebula.release}}. [Deploy NebulaGraph with Docker Compose](../../2.quick-start/1.quick-start-workflow.md).

## Prerequisites

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ This example is done on MacOS. Here is the environment configuration information

- Neo4j: 3.5.20 Community Edition

- NebulaGraph: {{nebula.release}}. [Deploy NebulaGraph with Docker Compose](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md).
- NebulaGraph: {{nebula.release}}. [Deploy NebulaGraph with Docker Compose](../../2.quick-start/1.quick-start-workflow.md).

## Prerequisites

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ This example is done on MacOS. Here is the environment configuration information

- Spark: 2.4.7, stand-alone

- NebulaGraph: {{nebula.release}}. [Deploy NebulaGraph with Docker Compose](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md).
- NebulaGraph: {{nebula.release}}. [Deploy NebulaGraph with Docker Compose](../../2.quick-start/1.quick-start-workflow.md).

## Prerequisites

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ This example is done on MacOS. Here is the environment configuration information

- Hadoop: 2.9.2, pseudo-distributed deployment

- NebulaGraph: {{nebula.release}}. [Deploy NebulaGraph with Docker Compose](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md).
- NebulaGraph: {{nebula.release}}. [Deploy NebulaGraph with Docker Compose](../../2.quick-start/1.quick-start-workflow.md).

## Prerequisites

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ This example is done on MacOS. Here is the environment configuration information

- Hadoop: 2.9.2, pseudo-distributed deployment

- NebulaGraph: {{nebula.release}}. [Deploy NebulaGraph with Docker Compose](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md).
- NebulaGraph: {{nebula.release}}. [Deploy NebulaGraph with Docker Compose](../../2.quick-start/1.quick-start-workflow.md).

## Prerequisites

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This example is done on MacOS. Here is the environment configuration information

- Spark: 2.4.7, stand-alone

- NebulaGraph: {{nebula.release}}. [Deploy NebulaGraph with Docker Compose](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md).
- NebulaGraph: {{nebula.release}}. [Deploy NebulaGraph with Docker Compose](../../2.quick-start/1.quick-start-workflow.md).

## Prerequisites

Expand Down
14 changes: 7 additions & 7 deletions docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-sst.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,10 +190,10 @@ After Exchange is compiled, copy the conf file `target/classes/application.conf`
# NebulaGraph configuration
nebula: {
address:{
graph:["127.0.0.1:9669"]
graph:["192.8.168.XXX:9669"]
# the address of any of the meta services.
# if your NebulaGraph server is in virtual network like k8s, please config the leader address of meta.
meta:["127.0.0.1:9559"]
meta:["192.8.168.XXX:9559"]
}
user: root
pswd: nebula
Expand All @@ -207,7 +207,7 @@ After Exchange is compiled, copy the conf file `target/classes/application.conf`
# The path for storing the SST file in the HDFS
remote:"/sst"

# The NameNode address of HDFS
# The NameNode address of HDFS, for example, "hdfs://<ip/hostname>:<port>"
hdfs.namenode: "hdfs://*.*.*.*:9000"
}

Expand Down Expand Up @@ -250,7 +250,7 @@ After Exchange is compiled, copy the conf file `target/classes/application.conf`
}

# Specify the path to the CSV file.
# If the file is stored in HDFS, use double quotation marks to enclose the file path, starting with hdfs://. For example, "hdfs://ip:port/xx/xx.csv".
# If the file is stored in HDFS, use double quotation marks to enclose the file path, starting with hdfs://. For example, "hdfs://<ip/hostname>:port/xx/xx.csv".
path: "hdfs://*.*.*.*:9000/dataset/vertex_player.csv"

# If the CSV file does not have a header, use [_c0, _c1, _c2, ..., _cn] to represent its header and indicate the columns as the source of the property values.
Expand Down Expand Up @@ -298,7 +298,7 @@ After Exchange is compiled, copy the conf file `target/classes/application.conf`
}

# Specify the path to the CSV file.
# If the file is stored in HDFS, use double quotation marks to enclose the file path, starting with hdfs://. For example, "hdfs://ip:port/xx/xx.csv".
# If the file is stored in HDFS, use double quotation marks to enclose the file path, starting with hdfs://. For example, "hdfs://<ip/hostname>:port/xx/xx.csv".
path: "hdfs://*.*.*.*:9000/dataset/vertex_team.csv"

# If the CSV file does not have a header, use [_c0, _c1, _c2, ..., _cn] to represent its header and indicate the columns as the source of the property values.
Expand Down Expand Up @@ -352,7 +352,7 @@ After Exchange is compiled, copy the conf file `target/classes/application.conf`
}

# Specify the path to the CSV file.
# If the file is stored in HDFS, use double quotation marks to enclose the file path, starting with hdfs://. For example, "hdfs://ip:port/xx/xx.csv".
# If the file is stored in HDFS, use double quotation marks to enclose the file path, starting with hdfs://. For example, "hdfs://<ip/hostname>:port/xx/xx.csv".
path: "hdfs://*.*.*.*:9000/dataset/edge_follow.csv"

# If the CSV file does not have a header, use [_c0, _c1, _c2, ..., _cn] to represent its header and indicate the columns as the source of the property values.
Expand Down Expand Up @@ -407,7 +407,7 @@ After Exchange is compiled, copy the conf file `target/classes/application.conf`
}

# Specify the path to the CSV file.
# If the file is stored in HDFS, use double quotation marks to enclose the file path, starting with hdfs://. For example, "hdfs://ip:port/xx/xx.csv".
# If the file is stored in HDFS, use double quotation marks to enclose the file path, starting with hdfs://. For example, "hdfs://<ip/hostname>:port/xx/xx.csv".
path: "hdfs://*.*.*.*:9000/dataset/edge_serve.csv"

# If the CSV file does not have a header, use [_c0, _c1, _c2, ..., _cn] to represent its header and indicate the columns as the source of the property values.
Expand Down
2 changes: 1 addition & 1 deletion docs-2.0/nebula-importer/use-importer.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Before using NebulaGraph Importer, make sure:

- NebulaGraph service has been deployed. There are currently three deployment modes:

- [Deploy NebulaGraph with Docker Compose](../4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md)
- [Deploy NebulaGraph with Docker Compose](../2.quick-start/1.quick-start-workflow.md)

- [Install NebulaGraph with RPM or DEB package](../4.deployment-and-installation/2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md)

Expand Down
18 changes: 9 additions & 9 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -266,8 +266,8 @@ extra:
azureLatestRelease: 3.1.0 # The latest doc version that supports Azure Cloud
aliyunLatestRelease: 3.1.0 # The latest doc version that supports Alibaba Cloud
ent:
ent_begin: <!- -> # change to "<!- ->" when releasing core-ent
ent_end: <!- -> # change to "<!- ->" when releasing core-ent
ent_begin: <!-- --> # change to "<!-- -->" when releasing core-ent
ent_end: <!-- --> # change to "<!-- -->" when releasing core-ent

nav:
- About: README.md
Expand Down Expand Up @@ -295,12 +295,13 @@ nav:
- Manage licenses: 9.about-license/4.manage-license.md
#ent
- Quick start:
- Getting started with NebulaGraph: 2.quick-start/1.quick-start-workflow.md
- Step 1 Install NebulaGraph: 2.quick-start/2.install-nebula-graph.md
- Step 2 Manage NebulaGraph Service: 2.quick-start/5.start-stop-service.md
- Step 3 Connect to NebulaGraph: 2.quick-start/3.connect-to-nebula-graph.md
- Step 4 Register the Storage Service: 2.quick-start/3.1add-storage-hosts.md
- Step 5 Use nGQL (CRUD): 2.quick-start/4.nebula-graph-crud.md
- Deploy NebulaGraph using Docker: 2.quick-start/1.quick-start-workflow.md
- Deploy NebulaGraph on-premise:
- Step 1 Install NebulaGraph: 2.quick-start/2.install-nebula-graph.md
- Step 2 Manage NebulaGraph Service: 2.quick-start/5.start-stop-service.md
- Step 3 Connect to NebulaGraph: 2.quick-start/3.connect-to-nebula-graph.md
- Step 4 Register the Storage Service: 2.quick-start/3.1add-storage-hosts.md
- Step 5 Use nGQL (CRUD): 2.quick-start/4.nebula-graph-crud.md
- nGQL cheatsheet: 2.quick-start/6.cheatsheet-for-ngql.md

- nGQL guide:
Expand Down Expand Up @@ -461,7 +462,6 @@ nav:
- Compile and install from source code: 4.deployment-and-installation/2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md
- Install using RPM or DEB package: 4.deployment-and-installation/2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md
- Install using TAR package: 4.deployment-and-installation/2.compile-and-install-nebula-graph/4.install-nebula-graph-from-tar.md
- Deploy using Docker Compose: 4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md
- Deploy a NebulaGraph cluster on multiple servers: 4.deployment-and-installation/2.compile-and-install-nebula-graph/deploy-nebula-graph-cluster.md
# release after operator 1.5.0 published
# - Deploy with ecosystem tools: 4.deployment-and-installation/2.compile-and-install-nebula-graph/6.deploy-nebula-graph-with-peripherals.md
Expand Down