diff options
| author | Keith Wall <kwall@apache.org> | 2014-10-14 17:41:50 +0000 |
|---|---|---|
| committer | Keith Wall <kwall@apache.org> | 2014-10-14 17:41:50 +0000 |
| commit | dd256e5f6aa598bde97dcc6236d5cb6417add5ba (patch) | |
| tree | d01dd4874c7f2951f561b26fba96426542685e0c | |
| parent | 881d631b1587d86951f0e2aac2138261aa7554d0 (diff) | |
| download | qpid-python-dd256e5f6aa598bde97dcc6236d5cb6417add5ba.tar.gz | |
QPID-6108: [Java Broker Documentation] Address some comments from Andrew Macbean
git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk@1631830 13f79535-47bb-0310-9956-ffa450edef68
9 files changed, 77 insertions, 56 deletions
diff --git a/qpid/doc/book/src/java-broker/Java-Broker-Backup-And-Recovery.xml b/qpid/doc/book/src/java-broker/Java-Broker-Backup-And-Recovery.xml index 670fc04829..09bb2b4fcc 100644 --- a/qpid/doc/book/src/java-broker/Java-Broker-Backup-And-Recovery.xml +++ b/qpid/doc/book/src/java-broker/Java-Broker-Backup-And-Recovery.xml @@ -55,9 +55,14 @@ <example> <title>Performing store backup by using <classname>BDBBackup</classname> class directly</title> - <command> java -cp qpid-bdbstore-&qpidCurrentRelease;.jar - org.apache.qpid.server.store.berkeleydb.BDBBackup -fromdir - ${QPID_WORK}/<nodename>/config -todir path/to/backup/folder</command> + <cmdsynopsis> + <command>java</command> + <arg choice="plain">-cp qpid-bdbstore-&qpidCurrentRelease;.jar</arg> + <arg choice="plain">org.apache.qpid.server.store.berkeleydb.BDBBackup</arg> + <sbr/> + <arg choice="plain">-fromdir <replaceable>${QPID_WORK}/<nodename>/config</replaceable></arg> + <arg choice="plain">-todir <replaceable>path/to/backup/folder</replaceable></arg> + </cmdsynopsis> </example> <para>In the example above BDBBackup utility is called from qpid-bdbstore-&qpidCurrentRelease;.jar to backup the store at @@ -67,12 +72,15 @@ running this script in a similar way.</para> <example> <title>Performing store backup by using <classname>backup.sh</classname> bash script</title> - <command>backup.sh -fromdir ${QPID_WORK}/<nodename>/config -todir - path/to/backup/folder</command> + <cmdsynopsis> + <command>backup.sh</command> + <arg choice="plain">-fromdir <replaceable>${QPID_WORK}/<nodename>/config</replaceable></arg> + <arg choice="plain">-todir <replaceable>path/to/backup/folder</replaceable></arg> + </cmdsynopsis> </example> </section> <section id="Java-Broker-Backup-And-Recovery-Virtualhost-Node-BDB-HA"> - <title>BDB</title> + <title>BDB-HA</title> <para>See <xref linkend="Java-Broker-Backup-And-Recovery-Virtualhost-Node-BDB"/></para> </section> <section id="Java-Broker-Backup-And-Recovery-Virtualhost-Node-Derby"> diff --git a/qpid/doc/book/src/java-broker/Java-Broker-High-Availability.xml b/qpid/doc/book/src/java-broker/Java-Broker-High-Availability.xml index 9dfbbaf764..25c56a8d14 100644 --- a/qpid/doc/book/src/java-broker/Java-Broker-High-Availability.xml +++ b/qpid/doc/book/src/java-broker/Java-Broker-High-Availability.xml @@ -116,8 +116,8 @@ </listitem> <listitem> <para>Select one Broker instance to host the first node instance. This choice is an - arbitrary one. The node is special only whilst creating group. Once creation is complete, - all nodes will be considered equal.</para> + arbitrary one. The node is special only whilst creating group. Once creation is + complete, all nodes will be considered equal.</para> </listitem> <listitem> <para> @@ -198,12 +198,13 @@ contact it and introduce itself into the group. At this stage, the group will have two nodes, with the second node in the replica role.</para> </listitem> - <listitem>Repeat these steps until you have added all the nodes to the - group.</listitem> + <listitem> + <para>Repeat these steps until you have added all the nodes to the group.</para> + </listitem> </orderedlist> <para> <figure> - <title>Adding subsequent nodes to the group</title> + <title>Adding subsequent nodes to the group</title> <mediaobject> <imageobject> <imagedata fileref="images/HA-Create-2.png" format="PNG" scalefit="1"/> @@ -261,8 +262,8 @@ </listitem> </itemizedlist></para> <para>If there were to be a master failure immediately after the transaction was committed, - the transaction would be held by at least quorum minus one replicas. For example, if we - had a group of three, then we would be assured that at least one replica held the + the transaction would be held by at least quorum minus one replicas. For example, if we had + a group of three, then we would be assured that at least one replica held the transaction.</para> <para>In the event of a master failure, if quorum nodes remain, those nodes hold an election. @@ -273,9 +274,9 @@ fewer than quorum nodes and to influence which node gets elected in the event of a tie.</para> - <para>Whenever a group has fewer than quorum nodes present, the virtualhost will be unavailable - and messaging connections will be refused. If quorum disappears at the very moment a - messaging client sends a transaction that transaction will fail.</para> + <para>Whenever a group has fewer than quorum nodes present, the virtualhost will be + unavailable and messaging connections will be refused. If quorum disappears at the very + moment a messaging client sends a transaction that transaction will fail.</para> <para>You will have noticed the difference in the synchronization policies applied the master and the replicas. The replicas send the acknowledgement back before the data is written to @@ -392,9 +393,11 @@ as the remaining node cannot elect itself master. To allow it to become master, apply the designated primary flag to it. It will elect itself master and work can continue, albeit from one node.</para> - <important>It is imperative not to allow designated primary to be set on both nodes at once. - To do so will mean, in the event of a network partition, a <ulink - url="http://en.wikipedia.org/wiki/Split-brain_(computing)">split-brain</ulink> will occur. + <important> + <para>It is imperative not to allow designated primary to be set on both nodes at once. To + do so will mean, in the event of a network partition, a <ulink + url="http://en.wikipedia.org/wiki/Split-brain_(computing)">split-brain</ulink> will + occur.</para> </important> </section> </section> @@ -434,9 +437,9 @@ </listitem> <listitem> <para><emphasis>Delete</emphasis></para> - <para>A virtualhost node can be deleted. Deleting a node permanently removes the node - from the group. The data stored locally is removed but this does not affect the data - held by the remainder of the group.</para> + <para>A virtualhost node can be deleted. Deleting a node permanently removes the node from + the group. The data stored locally is removed but this does not affect the data held by + the remainder of the group.</para> <note> <para>The names of deleted virtualhost node cannot be reused within a group.</para> </note> @@ -485,8 +488,8 @@ </section> <section role="h3" id="Java-Broker-High-Availability-JMXAPI"> <title>Qpid JMX API for HA</title> - <para>The Qpid JMX API for HA is now deprecated. New users are recommended to use the REST - API.</para> + <para>The Qpid JMX API for HA is now deprecated. New users are recommended to use the <link + linkend="Java-Broker-Management-Channel-REST-API">REST API.</link></para> </section> <section id="Java-Broker-High-Availability-DiskSpace"> @@ -541,14 +544,21 @@ provided information. </para> <example> <title>Resetting of replication group with <classname>DbResetRepGroup</classname></title> - <command>java -cp je-&oracleBdbProductVersion;.jar com.sleepycat.je.rep.util.DbResetRepGroup - -h path/to/jelogfiles -groupName newgroupname -nodeName nodename -nodeHostPort - thor:5000</command> + <cmdsynopsis> + <command>java</command> + <arg choice="plain">-cp je-&oracleBdbProductVersion;.jar</arg> + <arg choice="plain">com.sleepycat.je.rep.util.DbResetRepGroup</arg> + <arg choice="plain">-h <replaceable>path/to/jelogfiles</replaceable></arg> + <sbr/> + <arg choice="plain">-groupName <replaceable>newgroupname</replaceable></arg> + <arg choice="plain">-nodeName <replaceable>newnodename</replaceable></arg> + <arg choice="plain">-nodeHostPort <replaceable>newhostname:5000</replaceable></arg> + </cmdsynopsis> </example> <para>The modified log files can then by copied into <literal>${QPID_WORK}/<nodename>/config</literal> directory of a target Broker. Then - start the Broker, and add a BDB HA Virtualhost node specify the same group name, node name - and node address. You will then have a group with a single node, ready to start re-adding + start the Broker, and add a BDB HA Virtualhost node specify the same group name, node name and + node address. You will then have a group with a single node, ready to start re-adding additional nodes as described above. </para> </section> diff --git a/qpid/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Virtualhost-Nodes.xml b/qpid/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Virtualhost-Nodes.xml index 064c44b22f..c1dd903aed 100644 --- a/qpid/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Virtualhost-Nodes.xml +++ b/qpid/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Virtualhost-Nodes.xml @@ -27,7 +27,7 @@ <para>A <emphasis>virtualhost node</emphasis> is backed by storage. This storage is used to record the durable entities that exist beneath the virtualhost node (the virtualhost, queues, exchanges etc).</para> - <para>When HA is in used, it is the virtualhost nodes of many Brokers that come together to form + <para>When HA is in use, it is the virtualhost nodes of many Brokers that come together to form the group. The virtualhost nodes together elect a master. When the high availability feature is in use, the virtualhost node has <link linkend="Java-Broker-Concepts-RemoteReplicationNodes" >remote replications nodes</link>. There is a remote replication node corresponding to each diff --git a/qpid/doc/book/src/java-broker/images/Management-Web-Add-Dialogue.png b/qpid/doc/book/src/java-broker/images/Management-Web-Add-Dialogue.png Binary files differindex a2d6b4c690..b476060daa 100644 --- a/qpid/doc/book/src/java-broker/images/Management-Web-Add-Dialogue.png +++ b/qpid/doc/book/src/java-broker/images/Management-Web-Add-Dialogue.png diff --git a/qpid/doc/book/src/java-broker/images/Management-Web-ContextVar.png b/qpid/doc/book/src/java-broker/images/Management-Web-ContextVar.png Binary files differindex 92626e092e..3c62bc9f6e 100644 --- a/qpid/doc/book/src/java-broker/images/Management-Web-ContextVar.png +++ b/qpid/doc/book/src/java-broker/images/Management-Web-ContextVar.png diff --git a/qpid/doc/book/src/java-broker/management/channels/Java-Broker-Management-Channel-REST-API.xml b/qpid/doc/book/src/java-broker/management/channels/Java-Broker-Management-Channel-REST-API.xml index 94c7039819..76fe0974f9 100644 --- a/qpid/doc/book/src/java-broker/management/channels/Java-Broker-Management-Channel-REST-API.xml +++ b/qpid/doc/book/src/java-broker/management/channels/Java-Broker-Management-Channel-REST-API.xml @@ -23,7 +23,7 @@ <section id="Java-Broker-Management-Channel-REST-API"> <title>REST API</title> <para> This section provides a brief overview of the REST interface, which can be used directly to - monitor and manage the Broker instance.. </para> + monitor and manage the Broker instance.</para> <para>The REST interface support traditional REST model which uses the GET method requests to retrieve the information about broker configured objects, DELETE method requests to delete the @@ -32,7 +32,7 @@ <para>The REST API is versioned with the version number built into the URL. The general form of the URL is <literal>/api/<version></literal>. For convenience the alias <literal>latest</literal> signifies the latest supported version. There are also some - ancillary service prefixed by <literal>/service</literal>.</para> + ancillary services prefixed by <literal>/service</literal>.</para> <para>The table below lists the available REST services with brief description how they can be used.</para> @@ -321,16 +321,17 @@ "asterisks" in GET requests to denote all object of a particular type. Additionally, trailing object type in the URL hierarchy can be omitted. In this case GET request will return all of the object underneath of the current object.</para> - <para>For example, for binding URL - http://localhost:8080/api/latest/binding/<vhost node>/<vhost>/<exchange>/<queue>/<binding> - replacing of <emphasis><exchange></emphasis> with "asterisks" - (http://localhost:8080/api/<ver>/binding/<vhost node>/<vhost>/*/<queue>/<binding>) - will result in the GET response containing the list of bindings for all of the exchanges in the - virtualhost having the given name and given queue. If <emphasis><binding></emphasis> and - <emphasis><queue></emphasis> are omitted in binding REST URL - (http://localhost:8080/api/<ver>/binding/<vhost node>/<vhost>/<exchangename>) the GET - request will result in returning all bindings for all queues for the given exchange in the - virtual host. </para> + <para>For example, for binding URL <literal>http://localhost:8080/api/latest/binding/<vhost + node>/<vhost>/<exchange>/<queue>/<binding></literal> replacing of + <literal><exchange></literal> with "asterisks" + (<literal>http://localhost:8080/api/<ver>/binding/<vhost + node>/<vhost>/*/<queue>/<binding></literal>) will result in the GET + response containing the list of bindings for all of the exchanges in the virtualhost having the + given name and given queue.</para> + <para>If <literal><binding></literal> and <literal><queue></literal> are omitted in + binding REST URL (<literal>http://localhost:8080/api/<ver>/binding/<vhost + node>/<vhost>/<exchangename></literal>) the GET request will result in + returning all bindings for all queues for the given exchange in the virtual host. </para> <example> <title>Examples of queue creation using curl (authenticating as user admin):</title> <programlisting><
