Skip to content

Commit eec3871

Browse files
imbajinCopilotVGalaxies
authored
chore: update the status of distributed modules (#2916)
* chore: update the status of distributed modules Eliminated mentions of BETA status from AGENTS.md, README.md, and configuration files for HugeGraph PD and Store. This clarifies the current development status and streamlines documentation for production use. * docs: update README with requirements and architecture info Added sections for Requirements and Architecture, specifying Java and Maven versions and deployment options. Updated Docker command to use version 1.7.0. Included build from source instructions with Maven command. * Apply suggestions from code review Co-authored-by: Copilot <[email protected]> * Update run-api-test.sh --------- Co-authored-by: Copilot <[email protected]> Co-authored-by: VGalaxies <[email protected]>
1 parent d28526e commit eec3871

File tree

7 files changed

+27
-50
lines changed

7 files changed

+27
-50
lines changed

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ mvn test -pl hugegraph-server/hugegraph-test -am -P core-test,memory -Dtest=Your
225225

226226
### Working with Distributed Components
227227

228-
The distributed architecture (PD + Store) is in BETA. For distributed development:
228+
For distributed development:
229229
1. Build struct module first: `mvn install -pl hugegraph-struct -am -DskipTests`
230230
2. Build PD: `mvn clean package -pl hugegraph-pd -am -DskipTests`
231231
3. Build Store: `mvn clean package -pl hugegraph-store -am -DskipTests`

README.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,20 @@ achieved through the powerful [Gremlin](https://tinkerpop.apache.org/gremlin.htm
3030
- Integration with `Flink/Spark/HDFS`, and friendly to connect other big data platforms
3131
- Complete graph ecosystem (including both in/out-memory `Graph Computing` + `Graph Visualization & Tools` + `Graph Learning & AI`, see [here](#3-build-from-source))
3232

33+
## Architecture
34+
35+
HugeGraph supports both **standalone** and **distributed** deployments:
36+
37+
| Module | Description |
38+
|----------------------------------------|-----------------------------------------------------------------------------------------------------------|
39+
| [hugegraph-server](hugegraph-server) | Core graph engine with REST API, Gremlin/Cypher support, and pluggable backends (RocksDB default) |
40+
| [hugegraph-pd](hugegraph-pd) | Placement Driver for distributed mode - handles meta storage, partition management and cluster scheduling |
41+
| [hugegraph-store](hugegraph-store) | Distributed storage with Raft consensus for high availability and horizontal scaling |
42+
| [hugegraph-commons](hugegraph-commons) | Shared utilities, RPC framework and common components |
43+
44+
- **Standalone**: HugeGraph Server + RocksDB (for all-in-one deployment)
45+
- **Distributed**: HugeGraph Server + PD + Store (Raft + RocksDB by default)
46+
3347
## Quick Start
3448

3549
### 1. Docker (For Test)
@@ -39,7 +53,7 @@ Use Docker to quickly start a HugeGraph server with `RocksDB` (in the background
3953
```
4054
# (Optional)
4155
# - add "-e PRELOAD=true" to auto-load a sample graph
42-
docker run -itd --name=graph -e PASSWORD=xxx -p 8080:8080 hugegraph/hugegraph:1.5.0
56+
docker run -itd --name=graph -e PASSWORD=xxx -p 8080:8080 hugegraph/hugegraph:1.7.0
4357
```
4458

4559
Please visit [doc page](https://hugegraph.apache.org/docs/quickstart/hugegraph-server/#3-deploy) or
@@ -54,7 +68,7 @@ the [README](hugegraph-server/hugegraph-dist/docker/README.md) for more details.
5468
Visit [Download Page](https://hugegraph.apache.org/docs/download/download/) and refer the [doc](https://hugegraph.apache.org/docs/quickstart/hugegraph-server/#32-download-the-binary-tar-tarball)
5569
to download the latest release package and start the server.
5670

57-
**Note:** if you want to use it in the production environment or expose it to the public network, must enable the [AuthSystem](https://hugegraph.apache.org/docs/config/config-authentication/) to ensure safe.
71+
**Note:** if you want to use it in the production environment or expose it to the public network, you must enable the [AuthSystem](https://hugegraph.apache.org/docs/config/config-authentication/) to ensure safety.
5872

5973
### 3. Build From Source
6074

@@ -64,7 +78,9 @@ steps to build the source code and start the server.
6478
The project [doc page](https://hugegraph.apache.org/docs/) contains more information on HugeGraph
6579
and provides detailed documentation for users. (Structure / Usage / API / Configs...)
6680

67-
And here are links of other **HugeGraph** component/repositories:
81+
## Ecosystem
82+
83+
Other **HugeGraph** components/repositories:
6884

6985
1. [hugegraph-toolchain](https://github.com/apache/hugegraph-toolchain) (graph tools **[loader](https://github.com/apache/hugegraph-toolchain/tree/master/hugegraph-loader)/[dashboard](https://github.com/apache/hugegraph-toolchain/tree/master/hugegraph-hubble)/[tool](https://github.com/apache/hugegraph-toolchain/tree/master/hugegraph-tools)/[client](https://github.com/apache/hugegraph-toolchain/tree/master/hugegraph-client)**)
7086
2. [hugegraph-computer](https://github.com/apache/hugegraph-computer) (integrated **graph computing** system)

hugegraph-pd/AGENTS.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@ HugeGraph PD (Placement Driver) is a meta server for distributed HugeGraph deplo
1010
- Store node monitoring and scheduling
1111
- Metadata coordination using Raft consensus
1212

13-
**Status**: BETA (since HugeGraph 1.5.0)
14-
1513
**Technology Stack**:
1614
- Java 11+ (required)
1715
- Apache Maven 3.5+

hugegraph-server/hugegraph-dist/src/assembly/static/conf/rest-server.properties

Lines changed: 2 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -18,39 +18,12 @@ arthas.ip=127.0.0.1
1818
arthas.disabled_commands=jad
1919

2020
# authentication configs
21-
# choose 'org.apache.hugegraph.auth.StandardAuthenticator' or
22-
# 'org.apache.hugegraph.auth.ConfigAuthenticator'
23-
#auth.authenticator=
21+
#auth.authenticator=org.apache.hugegraph.auth.StandardAuthenticator
2422
# for admin password, By default, it is pa and takes effect upon the first startup
2523
#auth.admin_pa=pa
26-
27-
# for StandardAuthenticator mode
2824
#auth.graph_store=hugegraph
29-
# auth client config
30-
#auth.remote_url=127.0.0.1:8899,127.0.0.1:8898,127.0.0.1:8897
31-
32-
# for ConfigAuthenticator mode
33-
#auth.admin_token=
34-
#auth.user_tokens=[]
35-
36-
# TODO: Deprecated & removed later (useless from version 1.5.0)
37-
# rpc server configs for multi graph-servers or raft-servers
38-
#rpc.server_host=127.0.0.1
39-
#rpc.server_port=8091
40-
#rpc.server_timeout=30
41-
42-
# rpc client configs (like enable to keep cache consistency)
43-
#rpc.remote_url=127.0.0.1:8091,127.0.0.1:8092,127.0.0.1:8093
44-
#rpc.client_connect_timeout=20
45-
#rpc.client_reconnect_period=10
46-
#rpc.client_read_timeout=40
47-
#rpc.client_retries=3
48-
#rpc.client_load_balancer=consistentHash
49-
50-
# raft group initial peers
51-
#raft.group_peers=127.0.0.1:8091,127.0.0.1:8092,127.0.0.1:8093
5225

53-
# lightweight load balancing (beta)
26+
# lightweight load balancing (TODO: legacy mode, remove soon)
5427
server.id=server-1
5528
server.role=master
5629
# use pd

hugegraph-server/hugegraph-dist/src/assembly/travis/run-api-test.sh

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,10 @@ if [[ ! -e "$SERVER_DIR/ikanalyzer-2012_u6.jar" ]]; then
3939
fi
4040

4141
# config rest-server
42-
sed -i 's/#auth.authenticator=/auth.authenticator=org.apache.hugegraph.auth.StandardAuthenticator/' $REST_SERVER_CONF
43-
sed -i 's/#auth.admin_token=/auth.admin_token=pa/' $REST_SERVER_CONF
42+
sed -i '/^#*auth\.authenticator=/d' $REST_SERVER_CONF
43+
sed -i '/^#*auth\.admin_token=/d' $REST_SERVER_CONF
44+
echo "auth.authenticator=org.apache.hugegraph.auth.StandardAuthenticator" >> $REST_SERVER_CONF
45+
echo "auth.admin_token=pa" >> $REST_SERVER_CONF
4446

4547
# config hugegraph.properties
4648
sed -i 's/gremlin.graph=.*/gremlin.graph=org.apache.hugegraph.auth.HugeFactoryAuthProxy/' $CONF

hugegraph-store/AGENTS.md

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@ This file provides guidance to an AI coding tool when working with code in this
66

77
HugeGraph Store is a distributed storage backend for Apache HugeGraph, using RocksDB as the underlying storage engine with Raft consensus protocol for distributed coordination. It is designed for production-scale deployments requiring high availability and horizontal scalability.
88

9-
**Status**: BETA (active development since version 1.5.0)
10-
119
**Technology Stack**:
1210
- Java 11+
1311
- RocksDB: Embedded key-value storage engine
@@ -302,14 +300,6 @@ Store integrates with other HugeGraph components:
302300

303301
## Special Notes
304302

305-
### BETA Status
306-
307-
HugeGraph Store is in BETA:
308-
- Active development and API may change
309-
- Production use requires thorough testing
310-
- Monitor GitHub issues for known problems
311-
- Recommended for new deployments; RocksDB backend available as stable alternative
312-
313303
### Performance Tuning
314304

315305
Key performance factors:

hugegraph-store/README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -475,6 +475,4 @@ HugeGraph Store is licensed under the [Apache License 2.0](https://www.apache.or
475475

476476
---
477477

478-
**Status**: BETA (from v1.5.0+)
479-
480-
HugeGraph Store is under active development. While suitable for production use, APIs and configurations may evolve. Please report issues via GitHub or the mailing list.
478+
HugeGraph Store is under active development. Please report issues via GitHub or the mailing list.

0 commit comments

Comments
 (0)