streamnative / bookkeeper-achieved

Apache Bookkeeper
https://bookkeeper.apache.org
Apache License 2.0
3 stars 2 forks source link

ISSUE-2588: Clarify getAllBookies javadoc #323

Open sijie opened 3 years ago

sijie commented 3 years ago

Original Issue: apache/bookkeeper#2588


It looks like the javadoc for getWritableBookies was copied to getAllBookies. I'm sure that getAllBookies includes all bookies, not just writable ones. However, I would like to clarify what "all bookies" actually includes. Does it include bookies that have shutdown and be unavailable but are not yet decommissioned? In other words, what triggers a bookie to be removed from the list of all bookies? Is it on shutdown or on decommission?

Here's the javadoc:

https://github.com/apache/bookkeeper/blob/67a02db73d62188fc8a143bd9a37038ae770e90a/bookkeeper-server/src/main/java/org/apache/bookkeeper/discover/RegistrationClient.java#L51-L63

I'm happy to submit a PR to update the javadoc, if someone can clarify the intended meaning for me. Thanks!