[jira] [Commented] (QPID-8409) [Broker-J]Misleading Documentation of "Node Priority" for the initial configuration

["ASF subversion and git services (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/QPID-8409?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17048700#comment-17048700 ] 

ASF subversion and git services commented on QPID-8409:
-------------------------------------------------------

Commit 7c58e56cda2d5ce62a4a829a3bbd10ff6154faab in qpid-broker-j's branch refs/heads/master from Alex Rudyy
[ https://gitbox.apache.org/repos/asf?p=qpid-broker-j.git;h=7c58e56 ]

QPID-8409:[Broker-J][Docs] Improve documentation for BDB HA priority and add an example of BDB HA initial configuration


> [Broker-J]Misleading Documentation of "Node Priority" for the initial configuration
> -----------------------------------------------------------------------------------
>
>                 Key: QPID-8409
>                 URL: https://issues.apache.org/jira/browse/QPID-8409
>             Project: Qpid
>          Issue Type: Improvement
>          Components: Broker-J
>    Affects Versions: qpid-java-broker-7.1.7
>            Reporter: Ansgar Sachs
>            Priority: Minor
>              Labels: documentation
>             Fix For: qpid-java-broker-8.0.0
>
>
> h3. User Story
> {quote}As a developer, I want to easily create a HA cluster by just reading the documentation.{quote}
> h3. State of Play
> In order to configure a Qpid Cluster, you got the following hints:
> 1) Create it in the web UI - it requires a lot of clicking and is (in my opinion) not the way as devOps guy would want to setup a cluster 
> 2) Use the initial configuration
> Besides all the missing information of what can be actually configured in this initial configuration, 
>  the following property is completely miscommunicated: *Node Priority*.
> The following [page|#Java-Broker-High-Availability-Behaviour-NodePriority]] states, that this configuration property can be represented by the values "_Highest_", "_High", "__Normal", "__Never"._
> And yes, this configuration can be set in the web UI - however, it is rather hidden. And of course, these values don't work inside the initial configuration. 
> So let's take a look into the actual API documentation, which is unfortunately only available, when you have already a running broker available ([http://localhost:8080/apidocs/latest/virtualhostnode|http://localhost:8082/apidocs/latest/virtualhostnode]):
> h3. BDB_HA Specific Attributes
> ||Attribute Name||Type||Properties||
> |priority|number|read/write|
>  
> This API doc states that the priority is of type number - and again: setting a number as priority is not working.
> However, the actual configuration (that works) looks as follows:
>  
> {code:java}
> {
>   ...
>   virtualhostnodes: [{
>      ...,
>      priority: "2"
>      ...
>   }]
>   ...
> }{code}
> As you can see, it is a *stringified* number ("2") whereas a pure number isn't working (2).
> h3. Steps to achieve victory
> (x) Add a subchapter in the initial configuration that states *how to configure a HA cluster* by just using the initial config file.
> (x) Add a complete documenation of any configuration property
>  
>  
>  



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@qpid.apache.org
For additional commands, e-mail: dev-help@qpid.apache.org