Skip to content

Commit

Permalink
Update upgrade-nebula-ent-from-3.x-3.4.md (#2021)
Browse files Browse the repository at this point in the history
update-upgrade-doc-for-3.4.0
  • Loading branch information
abby-cyber authored Mar 22, 2023
1 parent 560eb93 commit 85fbbbd
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 17 deletions.
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
# Upgrade NebulaGraph Enterprise Edition from version 3.x to 3.4.0
# Upgrade NebulaGraph Enterprise Edition from version 3.x to {{nebula.release}}

This topic takes the enterprise edition of NebulaGraph v3.1.0 as an example and describes how to upgrade to v3.4.0.
This topic takes the enterprise edition of NebulaGraph v3.1.0 as an example and describes how to upgrade to v{{nebula.release}}.

## Notes

- This upgrade is only applicable for upgrading the enterprise edition of NebulaGraph v3.x to v3.4.0. <!--Because in the Enterprise Edition of NebulaGraph 3.4, one partition corresponds to one RocksDB instance, which is different from one graph space corresponding to one RocksDB instance in versions before 3.4.--> If your version is below 3.0.0, please upgrade to enterprise edition 3.1.0 before upgrading to v3.4.0. For details, see [Upgrade NebulaGraph Enterprise Edition 2.x to 3.1.0](https://docs.nebula-graph.io/3.1.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest/).
- This upgrade is only applicable for upgrading the enterprise edition of NebulaGraph v3.x (x < 4) to v{{nebula.release}}. <!--Because in the Enterprise Edition of NebulaGraph 3.4, one partition corresponds to one RocksDB instance, which is different from one graph space corresponding to one RocksDB instance in versions before 3.4.-->
!!! note

If your version is below 3.0.0, please upgrade to enterprise edition 3.1.0 before upgrading to v{{nebula.release}}. For details, see [Upgrade NebulaGraph Enterprise Edition 2.x to 3.1.0](https://docs.nebula-graph.io/3.1.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest/).

- The IP address of the machine performing the upgrade operation must be the same as the original machine.

Expand All @@ -18,21 +21,21 @@ This topic takes the enterprise edition of NebulaGraph v3.1.0 as an example and

## Steps

1. [Contact us](https://www.nebula-graph.io/contact) to obtain the installation package of the enterprise edition of NebulaGraph v3.4.0 and install it.
1. [Contact us](https://www.nebula-graph.io/contact) to obtain the installation package of the enterprise edition of NebulaGraph v{{nebula.release}} and install it.

!!! note

The upgrade steps are the same for different installation packages. This article uses the RPM package and the installation directory `/usr/local/nebulagraph-ent-3.4` as an example. See [Install with RPM packages](../2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md) for specific operations.

!!! caution

Please ensure that the number of storage paths set for the `--data_path` parameter in the Meta and Storage service configuration files of the 3.4.0 cluster is the same as that for the `--data_path` parameter in the configuration files of the 3.x cluster. Otherwise, the upgraded cluster will not start.
Please ensure that the number of storage paths set for the `--data_path` parameter in the Meta and Storage service configuration files of the {{nebula.release}} cluster is the same as that for the `--data_path` parameter in the configuration files of the 3.x cluster. Otherwise, the upgraded cluster will not start.

2. Stop the enterprise edition of v3.x services. For details see [Manage NebulaGraph services](../../2.quick-start/3.quick-start-on-premise/5.start-stop-service.md).

Run the `nebula.service status all` command to confirm that all services have been stopped after running the command.

3. In the installation directory of the Enterprise Edition NebulaGraph v3.4.0, run the following commands to upgrade the Storage and Meta services.
3. In the installation directory of the Enterprise Edition NebulaGraph v{{nebula.release}}, run the following commands to upgrade the Storage and Meta services.

- Upgrade the Storage service:

Expand Down Expand Up @@ -83,11 +86,11 @@ This topic takes the enterprise edition of NebulaGraph v3.1.0 as an example and

If there are multiple source meta data directories, specify each source meta data directory and target meta data directory and run the corresponding command.

After the upgrade, a `data` directory will be generated in the v3.4.0 installation directory, containing the upgraded data files.
After the upgrade, a `data` directory will be generated in the v{{nebula.release}} installation directory, containing the upgraded data files.

4. Upload the license file to the `share/resources` directory under the v3.4.0 installation directory.
4. Upload the license file to the `share/resources` directory under the v{{nebula.release}} installation directory.

5. Start and connect to the NebulaGraph v3.4.0 enterprise edition service and verify that the data is correct. The following commands can be used as reference:
5. Start and connect to the NebulaGraph v{{nebula.release}} enterprise edition service and verify that the data is correct. The following commands can be used as reference:

```
nebula> SHOW HOSTS;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Upgrade NebulaGraph from version 2.x to {{nebula.release}}
# Upgrade NebulaGraph to {{nebula.release}}

This topic describes how to upgrade NebulaGraph from version 2.x to {{nebula.release}}, taking upgrading from version 2.6.1 to {{nebula.release}} as an example.
This topic describes how to upgrade NebulaGraph from version 2.x and 3.x to {{nebula.release}}, taking upgrading from version 2.6.1 to {{nebula.release}} as an example.

## Applicable source versions

This topic applies to upgrading NebulaGraph from 2.5.0 and later 2.x versions to {{nebula.release}}. It does not apply to historical versions earlier than 2.5.0, including the 1.x versions.
This topic applies to upgrading NebulaGraph from 2.5.0 and later 2.x, and 3.x versions to {{nebula.release}}. It does not apply to historical versions earlier than 2.5.0, including the 1.x versions.

To upgrade NebulaGraph from historical versions to {{nebula.release}}:

Expand Down Expand Up @@ -73,7 +73,7 @@ To upgrade NebulaGraph from historical versions to {{nebula.release}}:

## Preparations before the upgrade

- Download the TAR file of NebulaGraph {{nebula.release}} according to your operating system and system architecture. You need the binary files during the upgrade. Find the TAR file on [the download page](https://nebula-graph.io/download/).
- Download the package of NebulaGraph {{nebula.release}} according to your operating system and system architecture. You need the binary files during the upgrade. Find the package on [the download page](https://nebula-graph.io/download/).

!!! note
You can also get the new binaries from the source code or the RPM/DEB package.
Expand Down Expand Up @@ -106,7 +106,11 @@ To upgrade NebulaGraph from historical versions to {{nebula.release}}:

If the services are not fully stopped in 20 minutes, stop upgrading and ask for help on [the forum](https://github.com/vesoft-inc/nebula/discussions) or [Github](https://github.com/vesoft-inc/nebula/issues).

2. In the target path where you unpacked the TAR file, use the binaries in the `bin` directory to replace the old binaries in the `bin` directory in the NebulaGraph installation path.
!!! caution

Starting from version 3.0.0, it is possible to insert vertices without tags. If you need to keep vertices without tags, add `--graph_use_vertex_key=true` in the configuration file (`nebula-graphd.conf`) of all Graph services within the cluster; and add `--use_vertex_key=true` in the configuration file (`nebula-storaged.conf`) of all Storage services."

2. In the target path where you unpacked the package, use the binaries in the `bin` directory to replace the old binaries in the `bin` directory in the NebulaGraph installation path.

!!! note
Update the binary of the corresponding service on each NebulaGraph server.
Expand Down
6 changes: 3 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -462,10 +462,10 @@ nav:
- Manage Storage host: 4.deployment-and-installation/manage-storage-host.md
# - Manage zone: 4.deployment-and-installation/5.zone.md
- Upgrade:
- Upgrade NebulaGraph from v2.x to v3.4 (Community Edition): 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest.md
- Upgrade NebulaGraph from v3.x to v3.4 (Community Edition): 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-300-to-latest.md
- Upgrade NebulaGraph to the latest version (Community Edition): 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest.md
# - Upgrade NebulaGraph from v3.x to v3.4 (Community Edition): 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-300-to-latest.md
#ent
- Upgrade NebulaGraph from v3.x to v3.4 (Enterprise Edition): 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-ent-from-3.x-3.4.md
- Upgrade NebulaGraph to the latest version (Enterprise Edition): 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-ent-from-3.x-3.4.md
- Uninstall NebulaGraph: 4.deployment-and-installation/4.uninstall-nebula-graph.md

- Configurations and logs:
Expand Down

0 comments on commit 85fbbbd

Please sign in to comment.