[
https://issues.apache.org/jira/browse/QPID-8409?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Ansgar Sachs updated QPID-8409:
-------------------------------
Description:
{code:java}
// code placeholder
{code}
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:
{{"virtualhostnodes" : [ {}}
\{{ "id" : "acf93b98-b68f-42ba-bcf5-8a78253f88d6",}}
\{{ "name" : "qpid-node1",}}
\{{ "type" : "BDB_HA",}}
\{{ "context" : { },}}
\{{ "address" : "qpid-node1:5000",}}
\{{ "defaultVirtualHostNode" : true,}}
\{{ "designatedPrimary" : false,}}
\{{ "groupName" : "qpid-group",}}
\{{ "helperAddress" : "qpid-node1:5000",}}
\{{ "permittedNodes" : [ "qpid-node1:5000", "qpid-node2:5000",
"qpid-node3:5000" ],}}
\{{ "priority" : "2",}}
\{{ "quorumOverride" : "0",}}
\{{ "virtualHostInitialConfiguration" : "{}",}}
\{{ }]}}
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
was:
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|[https://qpid.apache.org/releases/qpid-broker-j-7.1.7/book/Java-Broker-High-Availability-Behaviour.html#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:
{{"virtualhostnodes" : [ {}}
\{{ "id" : "acf93b98-b68f-42ba-bcf5-8a78253f88d6",}}
\{{ "name" : "qpid-node1",}}
\{{ "type" : "BDB_HA",}}
\{{ "context" : { },}}
\{{ "address" : "qpid-node1:5000",}}
\{{ "defaultVirtualHostNode" : true,}}
\{{ "designatedPrimary" : false,}}
\{{ "groupName" : "qpid-group",}}
\{{ "helperAddress" : "qpid-node1:5000",}}
\{{ "permittedNodes" : [ "qpid-node1:5000", "qpid-node2:5000",
"qpid-node3:5000" ],}}
\{{ "priority" : "2",}}
\{{ "quorumOverride" : "0",}}
\{{ "virtualHostInitialConfiguration" : "{}",}}
\{{ }]}}
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
> 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, C++ Broker
> Affects Versions: qpid-java-broker-7.1.7
> Reporter: Ansgar Sachs
> Priority: Minor
> Labels: documentation
> Fix For: Future
>
>
> {code:java}
> // code placeholder
> {code}
> 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:
>
>
> {{"virtualhostnodes" : [ {}}
> \{{ "id" : "acf93b98-b68f-42ba-bcf5-8a78253f88d6",}}
> \{{ "name" : "qpid-node1",}}
> \{{ "type" : "BDB_HA",}}
> \{{ "context" : { },}}
> \{{ "address" : "qpid-node1:5000",}}
> \{{ "defaultVirtualHostNode" : true,}}
> \{{ "designatedPrimary" : false,}}
> \{{ "groupName" : "qpid-group",}}
> \{{ "helperAddress" : "qpid-node1:5000",}}
> \{{ "permittedNodes" : [ "qpid-node1:5000", "qpid-node2:5000",
> "qpid-node3:5000" ],}}
> \{{ "priority" : "2",}}
> \{{ "quorumOverride" : "0",}}
> \{{ "virtualHostInitialConfiguration" : "{}",}}
> \{{ }]}}
> 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: [email protected]
For additional commands, e-mail: [email protected]
