This is an automated email from the ASF dual-hosted git repository. imbajin pushed a commit to branch toplingdb in repository https://gitbox.apache.org/repos/asf/hugegraph.git
commit 76cb94f30bfe3929cd0401f154b35673b10d4472 Author: dark <[email protected]> AuthorDate: Mon Aug 31 21:25:06 2026 +0800 docs(toplingdb): clarify container support matrix Document native Linux and macOS container targets. Explain linux/amd64 platform selection for Docker engines. Exclude native macOS execution from Topling acceptance scope. Keep standard and Topling topology guidance unchanged. --- docker/README.md | 11 +++++++---- docs/toplingdb/toplingdb-development.md | 5 +++++ docs/toplingdb/toplingdb-quickstart.md | 15 ++++++++++----- 3 files changed, 22 insertions(+), 9 deletions(-) diff --git a/docker/README.md b/docker/README.md index acd385e12..ee2e029cc 100644 --- a/docker/README.md +++ b/docker/README.md @@ -22,10 +22,13 @@ topologies use the matching `hugegraph/pd`, `hugegraph/store`, and `${HUBBLE_IMAGE:-hugegraph/hubble:latest}`. ToplingDB is selected by injecting the documented image, provider, data-root, -marker, volume, and pull-policy variables in the Developers section. It is -Linux x86_64-only: standalone selects Topling for the Server, while HStore -selects it only for PD and Store. The HStore Server remains the standard image -and never loads a local ToplingDB runtime. +marker, volume, and pull-policy variables in the Developers section. Its +published images target Linux x86_64 (`linux/amd64`); on macOS, use Docker +Desktop or OrbStack container mode and set `--platform linux/amd64` when the +engine does not select it automatically. Native macOS execution, including +Intel, is outside this ToplingDB matrix. Standalone selects Topling for the +Server, while HStore selects it only for PD and Store. The HStore Server +remains the standard image and never loads a local ToplingDB runtime. ### Create the authentication environment diff --git a/docs/toplingdb/toplingdb-development.md b/docs/toplingdb/toplingdb-development.md index 28cdccc6c..ab90c64aa 100644 --- a/docs/toplingdb/toplingdb-development.md +++ b/docs/toplingdb/toplingdb-development.md @@ -3,6 +3,11 @@ This guide describes the Topling integration maintained in this repository. Read the [quickstart](toplingdb-quickstart.md) first if you only need to run it. +The runtime support target is native Linux x86_64 and Linux containers on +macOS (Docker Desktop or OrbStack). Native macOS execution, including Intel, +is deliberately outside the ToplingDB matrix; do not treat that CI job as a +Topling image or container failure. + ## Runtime Contract HugeGraph keeps the RocksDB Java API. Topling Easy Migrate supplies the native diff --git a/docs/toplingdb/toplingdb-quickstart.md b/docs/toplingdb/toplingdb-quickstart.md index 640987901..680218f26 100644 --- a/docs/toplingdb/toplingdb-quickstart.md +++ b/docs/toplingdb/toplingdb-quickstart.md @@ -1,7 +1,10 @@ # ToplingDB Quickstart -This guide covers a source-built ToplingDB distribution on Linux x86_64. Use a -standard HugeGraph distribution when you want standard RocksDB. +This guide covers a source-built ToplingDB distribution on Linux x86_64. On +macOS, run the published Linux image through Docker Desktop or OrbStack +container mode. Native macOS execution (including Intel) is outside this +ToplingDB support matrix. Use a standard HugeGraph distribution when you want +standard RocksDB. ## Choose the Correct Component @@ -22,9 +25,11 @@ Set standalone data with `rocksdb.data_path` in ## Prerequisites -Topling images and distributions currently support Linux x86_64 only. The -native packages required by the bundled library are installed in the images. -The preparation script reports any unresolved dependency and stops. +Topling distributions and images currently target Linux x86_64. The published +images use the `linux/amd64` platform, so macOS container mode may need +`--platform linux/amd64`; the native packages required by the bundled library +are installed in the images. The preparation script reports any unresolved +dependency and stops. ## Docker Images
