docs(store): update guidance for store module (#2894)

Author: JisoLya

hugegraph-store/README.md

@@ -104,19 +104,12 @@ From the project root:
 mvn install -pl hugegraph-struct -am -DskipTests
 
 # Build Store and all dependencies
-mvn clean package -pl hugegraph-store -am -DskipTests
-```
-
-Or build from the `hugegraph-store` directory:
-
-```bash
-cd hugegraph-store
-mvn clean install -DskipTests
+mvn clean package -pl hugegraph-store/hugegraph-store-dist -am -DskipTests
 ```
 
 The assembled distribution will be available at:
 ```
-hugegraph-store/hg-store-dist/target/apache-hugegraph-store-incubating-<version>.tar.gz
+hugegraph-store/apache-hugegraph-store-incubating-1.7.0/lib/hg-store-node-1.7.0.jar```
 ```
 
 ### Configuration
@@ -220,8 +213,8 @@ For detailed configuration options, RocksDB tuning, and deployment topologies, s
 Start the Store server:
 
 ```bash
-tar -xzf apache-hugegraph-store-incubating-<version>.tar.gz
-cd apache-hugegraph-store-incubating-<version>
+# Replace {version} with your hugegraph version
+cd apache-hugegraph-store-incubating-{version}
 
 # Start Store node
 bin/start-hugegraph-store.sh
@@ -258,13 +251,13 @@ ps aux | grep hugegraph-store
 grpcurl -plaintext localhost:8500 list
 
 # Check REST API health
-curl http://localhost:8520/actuator/health
+curl http://localhost:8520/v1/health
 
 # Check logs
 tail -f logs/hugegraph-store.log
 
 # Verify registration with PD (from PD node)
-curl http://localhost:8620/pd/v1/stores
+curl http://localhost:8620/v1/stores
 ```
 
 For production deployment, see [Deployment Guide](docs/deployment-guide.md) and [Best Practices](docs/best-practices.md).
@@ -307,14 +300,12 @@ bin/start-hugegraph.sh
 
 ```bash
 # Check backend via REST API
-curl http://localhost:8080/graphs/<graph-name>/backend
-
+curl --location --request GET 'http://localhost:8080/metrics/backend' \
+--header 'Authorization: Bearer <YOUR_ACCESS_TOKEN>'
 # Response should show:
 # {"backend": "hstore", "nodes": [...]}
 ```
 
-For detailed integration steps, client API usage, and migration from other backends, see [Integration Guide](docs/integration-guide.md).
-
 ---
 
 ## Testing

hugegraph-store/docs/best-practices.md

@@ -345,13 +345,12 @@ grpc:
 bin/enable-auth.sh
 
 # Configure users and roles via REST API
-curl -X POST http://localhost:8080/graphs/hugegraph/auth/users \
-  -H "Content-Type: application/json" \
-  -d '{
-    "user_name": "admin",
-    "user_password": "password123",
-    "user_role": "admin"
-  }'
+curl -X POST "http://localhost:8080/graphspaces/{graph_spcace_name}/graphs/{graph}/auth/users" \
+     -H "Content-Type: application/json" \
+     -d '{
+         "user_name": "admin",
+         "user_password": "password123"
+     }'
 ```
 
 ### Data Encryption

hugegraph-store/docs/deployment-guide.md

@@ -471,17 +471,34 @@ curl http://localhost:8620/actuator/health
 
 ```bash
 # Check cluster members
-curl http://192.168.1.10:8620/pd/v1/members
+curl http://192.168.1.10:8620/v1/members
 
 # Expected output:
-# {
-#   "members": [
-#     {"id": "1", "name": "pd-1", "address": "192.168.1.10:8686"},
-#     {"id": "2", "name": "pd-2", "address": "192.168.1.11:8686"},
-#     {"id": "3", "name": "pd-3", "address": "192.168.1.12:8686"}
-#   ],
-#   "leader": "1"
-# }
+{
+  "message":"OK",
+  "data":{
+    "pdLeader":null,
+    "pdList":[{
+      "raftUrl":"127.0.0.1:8610",
+      "grpcUrl":"",
+      "restUrl":"",
+      "state":"Offline",
+      "dataPath":"",
+      "role":"Leader",
+      "replicateState":"",
+      "serviceName":"-PD",
+      "serviceVersion":"1.7.0",
+      "startTimeStamp":1761818483830
+      }],
+    "stateCountMap":{
+      "Offline":1
+      },
+      "numOfService":1,
+      "state":"Cluster_OK",
+      "numOfNormalService":0
+      },
+    "status":0
+}
 ```
 
 ---
@@ -560,23 +577,45 @@ bin/start-hugegraph-store.sh
 tail -f logs/hugegraph-store.log
 
 # Verify Store is running
-curl http://localhost:8520/actuator/health
+curl http://localhost:8520/v1/health
 ```
 
 **Verify Store registration with PD**:
 
 ```bash
 # Query PD for registered stores
-curl http://192.168.1.10:8620/pd/v1/stores
+curl http://192.168.1.10:8620/v1/stores
 
 # Expected output:
-# {
-#   "stores": [
-#     {"id": "1", "address": "192.168.1.20:8500", "state": "Online"},
-#     {"id": "2", "address": "192.168.1.21:8500", "state": "Online"},
-#     {"id": "3", "address": "192.168.1.22:8500", "state": "Online"}
-#   ]
-# }
+{
+  "message":"OK",
+  "data":{
+    "stores":[{
+      "storeId":"1783423547167821026",
+      "address":"192.168.1.10:8500",
+      "raftAddress":"192.168.1.10:8510",
+      "version":"","state":"Up",
+      "deployPath":"/Users/user/incubator-hugegraph/hugegraph-store/hg-store-node/target/classes/",
+      "dataPath":"./storage",
+      "startTimeStamp":1761818547335,
+      "registedTimeStamp":1761818547335,
+      "lastHeartBeat":1761818727631,
+      "capacity":245107195904,
+      "available":118497292288,
+      "partitionCount":0,
+      "graphSize":0,
+      "keyCount":0,
+      "leaderCount":0,
+      "serviceName":"192.168.1.10:8500-store",
+      "serviceVersion":"",
+      "serviceCreatedTimeStamp":1761818547000,
+      "partitions":[]}],
+      "stateCountMap":{"Up":1},
+      "numOfService":1,
+      "numOfNormalService":1
+      },
+      "status":0
+}
 ```
 
 ---
@@ -904,47 +943,45 @@ kubectl port-forward svc/hugegraph-store 8500:8500 -n hugegraph
 
 ```bash
 # PD health
-curl http://192.168.1.10:8620/actuator/health
+curl http://192.168.1.10:8620/v1/health
 
 # Store health
-curl http://192.168.1.20:8520/actuator/health
-
-# Server health
-curl http://192.168.1.30:8080/actuator/health
+curl http://192.168.1.20:8520/v1/health
 ```
 
 ### Cluster Status
 
 ```bash
 # PD cluster members
-curl http://192.168.1.10:8620/pd/v1/members
+curl http://192.168.1.10:8620/v1/members
 
 # Registered stores
-curl http://192.168.1.10:8620/pd/v1/stores
+curl http://192.168.1.10:8620/v1/stores
 
 # Partitions
-curl http://192.168.1.10:8620/pd/v1/partitions
+curl http://192.168.1.10:8620/v1/partitions
 
 # Graph list
-curl http://192.168.1.30:8080/graphs
+curl http://192.168.1.10:8620/v1/graphs
 ```
 
 ### Basic Operations Test
 
 ```bash
 # Create vertex via Server
-curl -X POST http://192.168.1.30:8080/graphs/hugegraph/graph/vertices \
-  -H "Content-Type: application/json" \
-  -d '{
-    "label": "person",
-    "properties": {
-      "name": "Alice",
-      "age": 30
-    }
-  }'
-
-# Query vertex
-curl http://192.168.1.30:8080/graphs/hugegraph/graph/vertices
+curl -X POST "http://192.168.1.30:8080/graphspaces/{graphspace_name}/graphs/{graph_name}/graph/vertices" \
+     -H "Content-Type: application/json" \
+     -d '{
+         "label": "person",
+         "properties": {
+             "name": "marko",
+             "age": 29
+         }
+     }'
+
+# Query vertex (using -u if auth is enabled)
+curl -u admin:admin \
+     -X GET "http://localhost:8080/graphspaces/{graphspace_name}/graphs/graphspace_name}/graph/vertices/{graph_id}
 ```
 
 ### Performance Baseline Test

hugegraph-store/docs/development-guide.md

@@ -220,6 +220,8 @@ cd hugegraph-store/hg-store-dist/target/apache-hugegraph-store-incubating-1.7.0
 bin/start-hugegraph-store.sh
 ```
 
+If you want to run store module in debug mode
+Directly run HgStoreNodeService in your IDE (ensure PD is on).
 ---
 
 ## Build and Test
@@ -823,7 +825,7 @@ cd install-dist/scripts/dependency
 - Slack: (link in project README)
 
 **Related Projects**:
-- Apache JRaft: https://github.com/sofastack/sofa-jraft
+- SOFA-JRaft: https://github.com/sofastack/sofa-jraft
 - RocksDB: https://rocksdb.org/
 - gRPC: https://grpc.io/docs/languages/java/
 

hugegraph-store/docs/distributed-architecture.md

@@ -200,11 +200,11 @@ HugeGraph Store follows a layered architecture with clear separation of responsi
 
 ## Raft Consensus Mechanism
 
-HugeGraph Store uses **Apache JRaft** (Ant Financial's Raft implementation) to achieve strong consistency and high availability.
+HugeGraph Store uses **Sofa-JRaft** (Ant Financial's Raft implementation) to achieve strong consistency and high availability.
 
 ### Raft per Partition Design
 
-Unlike some distributed systems that use a single Raft group for the entire cluster, HugeGraph Store uses **one Raft group per partition**:
+Unlike some distributed systems that use a single Raft group for the entire cluster, HugeGraph Store uses MultiRaft:
 
 ```
 Store Cluster (3 nodes: S1, S2, S3)