You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@skywalking.apache.org by "hanahmily (via GitHub)" <gi...@apache.org> on 2026/09/14 09:19:19 UTC

[I] [Docs] Align BanyanDB cluster/discovery docs, drop etcd leftovers, and publish docs from a docs branch [skywalking]

hanahmily opened a new issue, #14081:
URL: https://github.com/apache/skywalking/issues/14081

   ## Background
   
   Follow-up from https://github.com/apache/skywalking/discussions/14077#discussioncomment-18431254: community hit contradictory port examples between the cluster install guide and the file-based discovery guide, and asked which gRPC port liaison should use.
   
   Default `--grpc-port` for both `banyand data` and `banyand liaison` is **17912**. `18912` is only a common override when data and liaison share the same host/IP. Etcd-based discovery has been removed; docs still mention it in places.
   
   ## Tasks
   
   ### 1. Fix cluster / file-discovery port examples
   
   - Align [installation/cluster](https://skywalking.apache.org/docs/skywalking-banyandb/latest/installation/cluster/) and [operation/node-discovery](https://skywalking.apache.org/docs/skywalking-banyandb/latest/operation/node-discovery/) so `nodes.yaml` / liaison examples are consistent.
   - State clearly: default gRPC port is `17912` for data and liaison; when co-located on one IP, use different ports (e.g. data `17912`, liaison `18912`) and list the same ports in `nodes.yaml`.
   
   ### 2. Remove redundant etcd references from documentation
   
   - Purge leftover etcd discovery / configuration / upgrade wording from BanyanDB docs (e.g. `docs/operation/node-discovery.md`, `docs/operation/upgrade.md`, and other hits under `docs/`).
   - Keep only current discovery modes: `none`, `dns`, `file`.
   
   ### 3. Docs branch for continuous doc updates without a release
   
   - Create and maintain a dedicated docs branch in https://github.com/apache/skywalking-banyandb (e.g. `docs` / `asf-site` workflow as appropriate) so documentation can be updated and published without waiting for an official BanyanDB release.
   - Document how doc PRs should target that branch and how they reach skywalking.apache.org.
   
   ## Acceptance
   
   - [ ] Port guidance is consistent across cluster + node-discovery docs
   - [ ] No obsolete etcd discovery instructions remain in the published docs
   - [ ] Docs branch exists and is the agreed path for mid-release doc fixes


-- 
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: notifications-unsubscribe@skywalking.apache.org.apache.org

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

Re: [I] [Docs] Align BanyanDB cluster/discovery docs, drop etcd leftovers, and publish docs from a docs branch [skywalking]

Posted by "hanahmily (via GitHub)" <gi...@apache.org>.
hanahmily closed issue #14081: [Docs] Align BanyanDB cluster/discovery docs, drop etcd leftovers, and publish docs from a docs branch
URL: https://github.com/apache/skywalking/issues/14081


-- 
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: notifications-unsubscribe@skywalking.apache.org

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

Re: [I] [Docs] Align BanyanDB cluster/discovery docs, drop etcd leftovers, and publish docs from a docs branch [skywalking]

Posted by "hanahmily (via GitHub)" <gi...@apache.org>.
hanahmily commented on issue #14081:
URL: https://github.com/apache/skywalking/issues/14081#issuecomment-5664663441

   > Hi [@hanahmily](https://github.com/hanahmily) . I would like to work on this. Can I get this assigned ?
   
   Assigned. You can contribute the first 2 steps. The last one need a specific permission you do not have. I will handle it.


-- 
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: notifications-unsubscribe@skywalking.apache.org

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

Re: [I] [Docs] Align BanyanDB cluster/discovery docs, drop etcd leftovers, and publish docs from a docs branch [skywalking]

Posted by "HesandaLiyanage (via GitHub)" <gi...@apache.org>.
HesandaLiyanage commented on issue #14081:
URL: https://github.com/apache/skywalking/issues/14081#issuecomment-5664311772

   Hi @hanahmily . I would like to work on this. Can I get this assigned ?


-- 
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: notifications-unsubscribe@skywalking.apache.org

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