[ARTEMIS-1962] "HA: failover-on-server-shutdown" documentation wrong or incomplete

• Type: Bug
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 2.6.2
• Fix Version/s: 2.38.0
• Component/s: Broker
• Assignee: Justin Bertram
• Reporter: Johan Stenberg
• Created: 28/Jun/18 21:36
• Updated: 16/Oct/24 16:02
• Resolved: 23/Sep/24 17:29

Description

The HA documentation at https://activemq.apache.org/artemis/docs/latest/ha.html seems to contain errors regarding the "failover-on-server-shutdown" feature.

1. The text talks about an option named failover-on-server-shutdown but the code uses <failover-on-shutdown>true</failover-on-shutdown>
2. The documentation suggests that the failover-on-server-shutdown option only exists for <shared-store/> but e.g. not for <colocated/>. Looking at the configuration XSD failover-on-server-shutdown is only defined for <bridge> elements and not for <master> elements used by <shared-store/>. So it remains unclear where the failover-on-server-shutdown actually can be used and if for example in case of <colocated/> it can/must also be specified.

Issue Links

• links to: GitHub Pull Request #5250