diff --git a/docs-2.0/2.quick-start/1.quick-start-workflow.md b/docs-2.0/2.quick-start/1.quick-start-workflow.md index e8f358fcb3f..ed9482a02a9 100644 --- a/docs-2.0/2.quick-start/1.quick-start-workflow.md +++ b/docs-2.0/2.quick-start/1.quick-start-workflow.md @@ -1,56 +1,361 @@ -# Getting started with NebulaGraph +# Quickly deploy NebulaGraph using Docker -This topic describes how to use NebulaGraph with Docker Desktop and on-premises deployment workflow to quickly get started with NebulaGraph. +You can quickly get started with NebulaGraph by deploying NebulaGraph with Docker Desktop or Docker Compose. -## Using NebulaGraph with Docker Desktop -NebulaGraph is available as a [Docker Extension](https://hub.docker.com/extensions/weygu/nebulagraph-dd-ext) that you can easily install and run on your Docker Desktop. You can quickly deploy NebulaGraph using Docker Desktop with just one click. +=== "Using Docker Desktop" -1. Install Docker Desktop + NebulaGraph is available as a [Docker Extension](https://hub.docker.com/extensions/weygu/nebulagraph-dd-ext) that you can easily install and run on your Docker Desktop. You can quickly deploy NebulaGraph using Docker Desktop with just one click. - - [Install Docker Desktop on Mac](https://docs.docker.com/docker-for-mac/install/) - - [Install Docker Desktop on Windows](https://docs.docker.com/docker-for-windows/install/) + 1. Install Docker Desktop - !!! caution - To install Docker Desktop, you need to install [WSL 2](https://docs.docker.com/desktop/install/windows-install/#system-requirements) first. + - [Install Docker Desktop on Mac](https://docs.docker.com/docker-for-mac/install/) + - [Install Docker Desktop on Windows](https://docs.docker.com/docker-for-windows/install/) -2. In the left sidebar of Docker Desktop, click **Extensions** or **Add Extensions**. -3. On the Extensions Marketplace, search for NebulaGraph and click **Install**. + !!! caution + To install Docker Desktop, you need to install [WSL 2](https://docs.docker.com/desktop/install/windows-install/#system-requirements) first. - ![docker](https://docs-cdn.nebula-graph.com.cn/figures/docker.png) + 2. In the left sidebar of Docker Desktop, click **Extensions** or **Add Extensions**. + 3. On the Extensions Marketplace, search for NebulaGraph and click **Install**. - Click **Update** to update NebulaGraph to the latest version when a new version is available. + ![docker](https://docs-cdn.nebula-graph.com.cn/figures/docker.png) - ![docker-update](https://docs-cdn.nebula-graph.com.cn/figures/docker-update.png) + Click **Update** to update NebulaGraph to the latest version when a new version is available. -4. Click **Open** to navigate to the NebulaGraph extension page. + ![docker-update](https://docs-cdn.nebula-graph.com.cn/figures/docker-update.png) -5. At the top of the page, click **Studio in Browser** to use NebulaGraph. + 4. Click **Open** to navigate to the NebulaGraph extension page. -For more information about how to use NebulaGraph with Docker Desktop, see the following video: + 5. At the top of the page, click **Studio in Browser** to use NebulaGraph. - + For more information about how to use NebulaGraph with Docker Desktop, see the following video: -## Deploying NebulaGraph on-premises workflow + -The following workflow describes how to use NebulaGraph on-premises, including deploying NebulaGraph, connecting to NebulaGraph, and running basic CRUD. -1. [Deploy NebulaGraph](2.install-nebula-graph.md) +=== "Using Docker Compose" - Users can use the RPM or DEB file to quickly deploy NebulaGraph. For other deployment methods and the corresponding preparations, see the **Deployment and installation** chapter. + Using Docker Compose can quickly deploy NebulaGraph services based on the prepared configuration file. It is only recommended to use this method when testing the functions of NebulaGraph. -2. [Start NebulaGraph](5.start-stop-service.md) + ## Prerequisites - Users need to start NebulaGraph after deployment. + * You have installed the following applications on your host. -3. [Connect to NebulaGraph](3.connect-to-nebula-graph.md) + | Application | Recommended version | Official installation reference | + | -------------- | ------------------- | ------------------------------------------------------------------ | + | Docker | Latest | [Install Docker Engine](https://docs.docker.com/engine/install/) | + | Docker Compose | Latest | [Install Docker Compose](https://docs.docker.com/compose/install/) | + | Git | Latest | [Download Git](https://git-scm.com/download/) | - Then users can use clients to connect to NebulaGraph. NebulaGraph supports a variety of clients. This topic will describe how to use NebulaGraph Console to connect to NebulaGraph. + * If you are deploying NebulaGraph as a non-root user, grant the user with Docker-related privileges. For detailed instructions, see [Manage Docker as a non-root user](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user). -4. [Register the Storage Service](3.1add-storage-hosts.md) + * You have started the Docker service on your host. + + * If you have already deployed another version of NebulaGraph with Docker Compose on your host, to avoid compatibility issues, you need to delete the `nebula-docker-compose/data` directory. + + * For NebulaGraph Enterprise, you must have the [license key](../9.about-license/1.license-overview.md#licensing-process) loaded in [LM](../9.about-license/2.license-management-suite/3.license-manager.md). + + + ## Deploy NebulaGraph + + + 1. Clone the `{{dockercompose.release}}` branch of the `nebula-docker-compose` repository to your host with Git. + + !!! danger + + The `master` branch contains the untested code for the latest NebulaGraph development release. **DO NOT** use this release in a production environment. + + ```bash + $ git clone -b {{dockercompose.branch}} https://github.com/vesoft-inc/nebula-docker-compose.git + ``` + + !!! Note + + The `x.y` version of Docker Compose aligns to the `x.y` version of NebulaGraph. For the NebulaGraph `z` version, Docker Compose does not publish the corresponding `z` version, but pulls the `z` version of the NebulaGraph image. + + !!! note + For installation of the NebulaGraph enterprise version, [contact us](https://www.nebula-graph.io/contact). + + 2. Go to the `nebula-docker-compose` directory. + + ```bash + $ cd nebula-docker-compose/ + ``` + + {{ ent.ent_begin }} + + 3. Configure License Manager address. + + !!! enterpriseonly + + Skip this step if you are using the community version. + + 1. Edit the `docker-compose.yml` file. + + ```bash + $ cd nebula-docker-compose/ + $ vim docker-compose.yml + ``` + + 2. Add the `license_manager_url` field under all `services.metad{number}.command` and set its value to the access address of LM. + + ```yaml + ... + services: + metad0: + command: + - --license_manager_url=: // is the address of the LM service, and is the port of the LM service, which is 9119 by default. + metad1: + command: + - --license_manager_url=: + ... + ``` + + 3. Save and exit. + + + {{ ent.ent_end }} + + + 4. Run the following command to start all the NebulaGraph services. + + + !!! Note + + - Update the [NebulaGraph images](#how_to_upgrade_or_update_the_docker_images_of_nebulagraph_services) and [NebulaGraph Console images](#how_to_update_the_nebulagraph_console_client) first if they are out of date. + - The return result after executing the command varies depending on the installation directory. + + ```bash + [nebula-docker-compose]$ docker-compose up -d + Creating nebuladockercompose_metad0_1 ... done + Creating nebuladockercompose_metad2_1 ... done + Creating nebuladockercompose_metad1_1 ... done + Creating nebuladockercompose_graphd2_1 ... done + Creating nebuladockercompose_graphd_1 ... done + Creating nebuladockercompose_graphd1_1 ... done + Creating nebuladockercompose_storaged0_1 ... done + Creating nebuladockercompose_storaged2_1 ... done + Creating nebuladockercompose_storaged1_1 ... done + ``` + + !!! compatibility + + Starting from NebulaGraph version 3.1.0, nebula-docker-compose automatically starts a NebulaGraph Console docker container and adds the storage host to the cluster (i.e. `ADD HOSTS` command). + + !!! note + + For more information of the preceding services, see [NebulaGraph architecture](../1.introduction/3.nebula-graph-architecture/1.architecture-overview.md). + + ## Connect to NebulaGraph + + There are two ways to connect to NebulaGraph: + + - Connected with Nebula Console outside the container. Because the external mapping port for the Graph service is also fixed as `9669` in the container's configuration file, you can connect directly through the default port. For details, see [Connect to NebulaGraph](../2.quick-start/3.connect-to-nebula-graph.md). + + - Log into the container installed NebulaGraph Console, then connect to the Graph service. This section describes this approach. + + 1. Run the following command to view the name of NebulaGraph Console docker container. + + ```bash + $ docker-compose ps + Name Command State Ports + -------------------------------------------------------------------------------------------- + nebuladockercompose_console_1 sh -c sleep 3 && Up + nebula-co ... + ...... + ``` + + 2. Run the following command to enter the NebulaGraph Console docker container. + + ```bash + docker exec -it nebuladockercompose_console_1 /bin/sh + / # + ``` + + 3. Connect to NebulaGraph with NebulaGraph Console. + + ```bash + / # ./usr/local/bin/nebula-console -u -p --address=graphd --port=9669 + ``` + + !!! Note + + By default, the authentication is off, you can only log in with an existing username (the default is `root`) and any password. To turn it on, see [Enable authentication](../7.data-security/1.authentication/1.authentication.md). + + 4. Run the following commands to view the cluster state. + + ```bash + nebula> SHOW HOSTS; + +-------------+------+----------+--------------+----------------------+------------------------+---------+ + | Host | Port | Status | Leader count | Leader distribution | Partition distribution | Version | + +-------------+------+----------+--------------+----------------------+------------------------+---------+ + | "storaged0" | 9779 | "ONLINE" | 0 | "No valid partition" | "No valid partition" | "{{nebula.release}}" | + | "storaged1" | 9779 | "ONLINE" | 0 | "No valid partition" | "No valid partition" | "{{nebula.release}}" | + | "storaged2" | 9779 | "ONLINE" | 0 | "No valid partition" | "No valid partition" | "{{nebula.release}}" | + +-------------+------+----------+--------------+----------------------+------------------------+---------+ + ``` + + Run `exit` twice to switch back to your terminal (shell). + + ## Check the NebulaGraph service status and ports + + Run `docker-compose ps` to list all the services of NebulaGraph and their status and ports. + + !!! note + + NebulaGraph provides services to the clients through port `9669` by default. To use other ports, modify the `docker-compose.yaml` file in the `nebula-docker-compose` directory and restart the NebulaGraph services. + + ```bash + $ docker-compose ps + nebuladockercompose_console_1 sh -c sleep 3 && Up + nebula-co ... + nebuladockercompose_graphd1_1 /usr/local/nebula/bin/nebu ... Up 0.0.0.0:49174->19669/tcp,:::49174->19669/tcp, 0.0.0.0:49171->19670/tcp,:::49171->19670/tcp, 0.0.0.0:49177->9669/tcp,:::49177->9669/tcp + nebuladockercompose_graphd2_1 /usr/local/nebula/bin/nebu ... Up 0.0.0.0:49175->19669/tcp,:::49175->19669/tcp, 0.0.0.0:49172->19670/tcp,:::49172->19670/tcp, 0.0.0.0:49178->9669/tcp,:::49178->9669/tcp + nebuladockercompose_graphd_1 /usr/local/nebula/bin/nebu ... Up 0.0.0.0:49180->19669/tcp,:::49180->19669/tcp, 0.0.0.0:49179->19670/tcp,:::49179->19670/tcp, 0.0.0.0:9669->9669/tcp,:::9669->9669/tcp + nebuladockercompose_metad0_1 /usr/local/nebula/bin/nebu ... Up 0.0.0.0:49157->19559/tcp,:::49157->19559/tcp, 0.0.0.0:49154->19560/tcp,:::49154->19560/tcp, 0.0.0.0:49160->9559/tcp,:::49160->9559/tcp, 9560/tcp + nebuladockercompose_metad1_1 /usr/local/nebula/bin/nebu ... Up 0.0.0.0:49156->19559/tcp,:::49156->19559/tcp, 0.0.0.0:49153->19560/tcp,:::49153->19560/tcp, 0.0.0.0:49159->9559/tcp,:::49159->9559/tcp, 9560/tcp + nebuladockercompose_metad2_1 /usr/local/nebula/bin/nebu ... Up 0.0.0.0:49158->19559/tcp,:::49158->19559/tcp, 0.0.0.0:49155->19560/tcp,:::49155->19560/tcp, 0.0.0.0:49161->9559/tcp,:::49161->9559/tcp, 9560/tcp + nebuladockercompose_storaged0_1 /usr/local/nebula/bin/nebu ... Up 0.0.0.0:49166->19779/tcp,:::49166->19779/tcp, 0.0.0.0:49163->19780/tcp,:::49163->19780/tcp, 9777/tcp, 9778/tcp, 0.0.0.0:49169->9779/tcp,:::49169->9779/tcp, 9780/tcp + nebuladockercompose_storaged1_1 /usr/local/nebula/bin/nebu ... Up 0.0.0.0:49165->19779/tcp,:::49165->19779/tcp, 0.0.0.0:49162->19780/tcp,:::49162->19780/tcp, 9777/tcp, 9778/tcp, 0.0.0.0:49168->9779/tcp,:::49168->9779/tcp, 9780/tcp + nebuladockercompose_storaged2_1 /usr/local/nebula/bin/nebu ... Up 0.0.0.0:49167->19779/tcp,:::49167->19779/tcp, 0.0.0.0:49164->19780/tcp,:::49164->19780/tcp, 9777/tcp, 9778/tcp, 0.0.0.0:49170->9779/tcp,:::49170->9779/tcp, 9780/tcp + ``` + + If the service is abnormal, you can first confirm the abnormal container name (such as `nebuladockercompose_graphd2_1`). + + Then you can execute `docker ps` to view the corresponding `CONTAINER ID` (such as `2a6c56c405f5`). + + ```bash + [nebula-docker-compose]$ docker ps + CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES + 2a6c56c405f5 vesoft/nebula-graphd:nightly "/usr/local/nebula/b…" 36 minutes ago Up 36 minutes (healthy) 0.0.0.0:49230->9669/tcp, 0.0.0.0:49229->19669/tcp, 0.0.0.0:49228->19670/tcp nebuladockercompose_graphd2_1 + 7042e0a8e83d vesoft/nebula-storaged:nightly "./bin/nebula-storag…" 36 minutes ago Up 36 minutes (healthy) 9777-9778/tcp, 9780/tcp, 0.0.0.0:49227->9779/tcp, 0.0.0.0:49226->19779/tcp, 0.0.0.0:49225->19780/tcp nebuladockercompose_storaged2_1 + 18e3ea63ad65 vesoft/nebula-storaged:nightly "./bin/nebula-storag…" 36 minutes ago Up 36 minutes (healthy) 9777-9778/tcp, 9780/tcp, 0.0.0.0:49219->9779/tcp, 0.0.0.0:49218->19779/tcp, 0.0.0.0:49217->19780/tcp nebuladockercompose_storaged0_1 + 4dcabfe8677a vesoft/nebula-graphd:nightly "/usr/local/nebula/b…" 36 minutes ago Up 36 minutes (healthy) 0.0.0.0:49224->9669/tcp, 0.0.0.0:49223->19669/tcp, 0.0.0.0:49222->19670/tcp nebuladockercompose_graphd1_1 + a74054c6ae25 vesoft/nebula-graphd:nightly "/usr/local/nebula/b…" 36 minutes ago Up 36 minutes (healthy) 0.0.0.0:9669->9669/tcp, 0.0.0.0:49221->19669/tcp, 0.0.0.0:49220->19670/tcp nebuladockercompose_graphd_1 + 880025a3858c vesoft/nebula-storaged:nightly "./bin/nebula-storag…" 36 minutes ago Up 36 minutes (healthy) 9777-9778/tcp, 9780/tcp, 0.0.0.0:49216->9779/tcp, 0.0.0.0:49215->19779/tcp, 0.0.0.0:49214->19780/tcp nebuladockercompose_storaged1_1 + 45736a32a23a vesoft/nebula-metad:nightly "./bin/nebula-metad …" 36 minutes ago Up 36 minutes (healthy) 9560/tcp, 0.0.0.0:49213->9559/tcp, 0.0.0.0:49212->19559/tcp, 0.0.0.0:49211->19560/tcp nebuladockercompose_metad0_1 + 3b2c90eb073e vesoft/nebula-metad:nightly "./bin/nebula-metad …" 36 minutes ago Up 36 minutes (healthy) 9560/tcp, 0.0.0.0:49207->9559/tcp, 0.0.0.0:49206->19559/tcp, 0.0.0.0:49205->19560/tcp nebuladockercompose_metad2_1 + 7bb31b7a5b3f vesoft/nebula-metad:nightly "./bin/nebula-metad …" 36 minutes ago Up 36 minutes (healthy) 9560/tcp, 0.0.0.0:49210->9559/tcp, 0.0.0.0:49209->19559/tcp, 0.0.0.0:49208->19560/tcp nebuladockercompose_metad1_1 + ``` + + Use the `CONTAINER ID` to log in the container and troubleshoot. + + ```bash + nebula-docker-compose]$ docker exec -it 2a6c56c405f5 bash + [root@2a6c56c405f5 nebula]# + ``` + + ## Check the service data and logs + + All the data and logs of NebulaGraph are stored persistently in the `nebula-docker-compose/data` and `nebula-docker-compose/logs` directories. + + The structure of the directories is as follows: + + ```text + nebula-docker-compose/ + |-- docker-compose.yaml + ├── data + │   ├── meta0 + │   ├── meta1 + │   ├── meta2 + │   ├── storage0 + │   ├── storage1 + │   └── storage2 + └── logs + ├── graph + ├── graph1 + ├── graph2 + ├── meta0 + ├── meta1 + ├── meta2 + ├── storage0 + ├── storage1 + └── storage2 + ``` + + ## Stop the NebulaGraph services + + You can run the following command to stop the NebulaGraph services: + + ```bash + $ docker-compose down + ``` + + The following information indicates you have successfully stopped the NebulaGraph services: + + ```bash + Stopping nebuladockercompose_console_1 ... done + Stopping nebuladockercompose_graphd1_1 ... done + Stopping nebuladockercompose_graphd_1 ... done + Stopping nebuladockercompose_graphd2_1 ... done + Stopping nebuladockercompose_storaged1_1 ... done + Stopping nebuladockercompose_storaged0_1 ... done + Stopping nebuladockercompose_storaged2_1 ... done + Stopping nebuladockercompose_metad2_1 ... done + Stopping nebuladockercompose_metad0_1 ... done + Stopping nebuladockercompose_metad1_1 ... done + Removing nebuladockercompose_console_1 ... done + Removing nebuladockercompose_graphd1_1 ... done + Removing nebuladockercompose_graphd_1 ... done + Removing nebuladockercompose_graphd2_1 ... done + Removing nebuladockercompose_storaged1_1 ... done + Removing nebuladockercompose_storaged0_1 ... done + Removing nebuladockercompose_storaged2_1 ... done + Removing nebuladockercompose_metad2_1 ... done + Removing nebuladockercompose_metad0_1 ... done + Removing nebuladockercompose_metad1_1 ... done + Removing network nebuladockercompose_nebula-net + ``` + + !!! danger + + The parameter `-v` in the command `docker-compose down -v` will **delete** all your local NebulaGraph storage data. Try this command if you are using the nightly release and having some compatibility issues. + + ## Modify configurations + + The configuration file of NebulaGraph deployed by Docker Compose is `nebula-docker-compose/docker-compose.yaml`. To make the new configuration take effect, modify the configuration in this file and restart the service. + + For more instructions, see [Configurations](../5.configurations-and-logs/1.configurations/1.configurations.md). + + ## FAQ + + ### How to fix the docker mapping to external ports? + + To set the `ports` of corresponding services as fixed mapping, modify the `docker-compose.yaml` in the `nebula-docker-compose` directory. For example: + + ```bash + graphd: + image: vesoft/nebula-graphd:{{nebula.branch}} + ... + ports: + - 9669:9669 + - 19669 + - 19670 + ``` + + `9669:9669` indicates the internal port 9669 is uniformly mapped to external ports, while `19669` indicates the internal port 19669 is randomly mapped to external ports. + + ### How to upgrade or update the docker images of NebulaGraph services + + 5. In the `nebula-docker-compose/docker-compose.yaml` file, change all the `image` values to the required image version. + + 6. In the `nebula-docker-compose` directory, run `docker-compose pull` to update the images of the Graph Service, Storage Service, Meta Service, and NebulaGraph Console. + + 7. Run `docker-compose up -d` to start the NebulaGraph services again. + + 8. After connecting to NebulaGraph with NebulaGraph Console, run `SHOW HOSTS GRAPH`, `SHOW HOSTS STORAGE`, or `SHOW HOSTS META` to check the version of the responding service respectively. + + ### `ERROR: toomanyrequests` when `docker-compose pull` + + You may meet the following error. + + `ERROR: toomanyrequests: You have reached your pull rate limit. You may increase the limit by authenticating and upgrading: https://www.docker.com/increase-rate-limit`. + + You have met the rate limit of Docker Hub. Learn more on [Understanding Docker Hub Rate Limiting](https://www.docker.com/increase-rate-limit). + + ### How to update the NebulaGraph Console client + + The command `docker-compose pull` updates both the NebulaGraph services and the NebulaGraph Console. - When connecting to NebulaGraph for the first time, users must register the Storage Service before querying data. -5. [CRUD in NebulaGraph](4.nebula-graph-crud.md) - Users can use nGQL (NebulaGraph Query Language) to run CRUD after connecting to NebulaGraph. diff --git a/docs-2.0/20.appendix/6.eco-tool-version.md b/docs-2.0/20.appendix/6.eco-tool-version.md index e07686ffb9b..a887e7ea41d 100644 --- a/docs-2.0/20.appendix/6.eco-tool-version.md +++ b/docs-2.0/20.appendix/6.eco-tool-version.md @@ -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| |:---|:---| diff --git a/docs-2.0/20.appendix/learning-path.md b/docs-2.0/20.appendix/learning-path.md index 0e098b0fb8a..869d6d9698b 100644 --- a/docs-2.0/20.appendix/learning-path.md +++ b/docs-2.0/20.appendix/learning-path.md @@ -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) | diff --git a/docs-2.0/6.monitor-and-metrics/1.query-performance-metrics.md b/docs-2.0/6.monitor-and-metrics/1.query-performance-metrics.md index 211f1bcf134..4ba6f0b5c18 100644 --- a/docs-2.0/6.monitor-and-metrics/1.query-performance-metrics.md +++ b/docs-2.0/6.monitor-and-metrics/1.query-performance-metrics.md @@ -30,7 +30,7 @@ curl -G "http://:/stats?stats= [&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 diff --git a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-clickhouse.md b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-clickhouse.md index 47a77a28e2b..8474265621d 100644 --- a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-clickhouse.md +++ b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-clickhouse.md @@ -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 diff --git a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-csv.md b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-csv.md index 8309c75f735..d45dc35c5a4 100644 --- a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-csv.md +++ b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-csv.md @@ -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 diff --git a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-hbase.md b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-hbase.md index 283ea119b66..7f0639a2485 100644 --- a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-hbase.md +++ b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-hbase.md @@ -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 diff --git a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-hive.md b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-hive.md index ad4f52a5dcf..b5688e4731b 100644 --- a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-hive.md +++ b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-hive.md @@ -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 diff --git a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-jdbc.md b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-jdbc.md index 48e218ad9e5..7d164a88b67 100644 --- a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-jdbc.md +++ b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-jdbc.md @@ -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 diff --git a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-json.md b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-json.md index c12d7e0f51a..ed511ef024c 100644 --- a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-json.md +++ b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-json.md @@ -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 diff --git a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-kafka.md b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-kafka.md index c5e20c5e954..66bafcc3bb3 100644 --- a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-kafka.md +++ b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-kafka.md @@ -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 diff --git a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-maxcompute.md b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-maxcompute.md index 8ed7240e1aa..e46a337a861 100644 --- a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-maxcompute.md +++ b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-maxcompute.md @@ -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 diff --git a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-mysql.md b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-mysql.md index bc627c66c09..8603f1bae54 100644 --- a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-mysql.md +++ b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-mysql.md @@ -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 diff --git a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-neo4j.md b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-neo4j.md index fa9cc5915d2..da2f3724fcb 100644 --- a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-neo4j.md +++ b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-neo4j.md @@ -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 diff --git a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-oracle.md b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-oracle.md index 7472d6d2a13..366416f6905 100644 --- a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-oracle.md +++ b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-oracle.md @@ -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 diff --git a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-orc.md b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-orc.md index 707d7c403e2..191030c067a 100644 --- a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-orc.md +++ b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-orc.md @@ -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 diff --git a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-parquet.md b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-parquet.md index dacbf5fe03a..fd3b73609b3 100644 --- a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-parquet.md +++ b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-parquet.md @@ -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 diff --git a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-pulsar.md b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-pulsar.md index 2699747fda3..ad30b86a7f2 100644 --- a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-pulsar.md +++ b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-pulsar.md @@ -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 diff --git a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-sst.md b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-sst.md index 61f8e979e6e..a7c130c8600 100644 --- a/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-sst.md +++ b/docs-2.0/nebula-exchange/use-exchange/ex-ug-import-from-sst.md @@ -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 @@ -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://:" hdfs.namenode: "hdfs://*.*.*.*:9000" } @@ -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://: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. @@ -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://: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. @@ -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://: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. @@ -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://: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. diff --git a/docs-2.0/nebula-importer/use-importer.md b/docs-2.0/nebula-importer/use-importer.md index dd78b0958ef..429dc531ebf 100644 --- a/docs-2.0/nebula-importer/use-importer.md +++ b/docs-2.0/nebula-importer/use-importer.md @@ -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) diff --git a/mkdocs.yml b/mkdocs.yml index 453f042242c..e447e5aa42f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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 @@ -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: @@ -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