You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@hugegraph.apache.org by "bitflicker64 (via GitHub)" <gi...@apache.org> on 2026/08/09 19:49:33 UTC

[I] [Feature] Add a Hubble Compose add-on to attach the dashboard to a running cluster [hugegraph]

bitflicker64 opened a new issue, #3147:
URL: https://github.com/apache/hugegraph/issues/3147

   ### Feature Description
   
   The `docker/` directory ships three Compose deployments: the single-node
   file already includes Hubble, but the distributed
   `docker-compose-3pd-3store-3server.yml` does not. Today an operator who
   runs the distributed topology and wants the dashboard has to clone
   `apache/hugegraph-toolchain`, build the Hubble image from source, and
   hand-wire it to the cluster. That is not a realistic path for end users.
   
   Two concrete gaps:
   
   - There is no Hubble service definition that can be attached to the
     distributed Compose deployment.
   - The 3PD+3Store+3Server file does not carry the Server settings Hubble
     needs to work through PD (cluster registration, REST URL, auth token
     secret, admin password), so merely adding a Hubble container is not
     enough.
   
   ### Proposal
   
   Add a small additive Compose file, `docker/docker-compose-hubble.yml`,
   that defines only the Hubble service:
   
   - It joins the running cluster's Docker network (external network name
     supplied via an environment variable with a sane default) and never
     defines or recreates PD, Store, or Server. Attaching or upgrading
     Hubble must not restart the cluster.
   - One shared version variable selects matching cluster and Hubble
     images. Until the next release is published the file uses `latest`
     with an inline note to pin the released version.
   - The published `hugegraph/hubble` image is used as-is; the toolchain
     repository changes only if the image cannot accept some required
     runtime configuration.
   
   Also extend `docker-compose-3pd-3store-3server.yml` with the missing
   Server PD-registration and auth settings (validated already in a live
   3PD+3Store+3Server environment), and document three flows in
   `docker/README.md`:
   
   1. Attach Hubble to an already-running compatible cluster with one
      `docker compose -f docker-compose-hubble.yml up -d` command.
   2. Start a fresh distributed cluster with the dashboard using both
      files together.
   3. Override the Hubble image locally for development without touching
      the cluster.
   
   This follows the pattern used by comparable projects: Elastic documents
   attaching Kibana to a running Elasticsearch container over a shared
   Docker network with matched versions, and TiDB Operator provides a
   standalone `TidbDashboard` resource that binds the dashboard to an
   existing cluster without redeploying it.
   
   Completion criteria:
   
   - Single-node and distributed Compose paths both come up healthy with
     Hubble able to log in and show the cluster topology.
   - Attaching Hubble to an already-running distributed cluster recreates
     no cluster containers.
   - No credentials committed to the repository.
   
   A Kubernetes counterpart (delivering Hubble as an independently
   upgradable attach-style component in the Helm chart) is tracked as a
   TODO in #3132 and can build on the same design.
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@hugegraph.apache.org.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [I] [Feature] Add a Hubble Compose add-on to attach the dashboard to a running cluster [hugegraph]

Posted by "imbajin (via GitHub)" <gi...@apache.org>.
imbajin closed issue #3147: [Feature] Add a Hubble Compose add-on to attach the dashboard to a running cluster
URL: https://github.com/apache/hugegraph/issues/3147


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@hugegraph.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org