Author: kwall
Date: Sun Oct 12 15:48:18 2014
New Revision: 1631195
URL: http://svn.apache.org/r1631195
Log:
QPID-6108: [Java Broker Documentation] Rewrite HA documentation to reflect the
new model and the include multi-node support.
* Correct many spelling errors
* Improve web-console documentation around add/edit/delete entities, and the
setting of context variables
* Extract new top level section for backup/recovery
Added:
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Appendix-Miscellaneous.xml
- copied, changed from r1631194,
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Miscellaneous.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Backup-And-Recovery.xml
qpid/trunk/qpid/doc/book/src/java-broker/images/HA-Create-1.png
qpid/trunk/qpid/doc/book/src/java-broker/images/HA-Create-2.png
qpid/trunk/qpid/doc/book/src/java-broker/images/HA-Create-3.png
qpid/trunk/qpid/doc/book/src/java-broker/images/HA-Overview.png
qpid/trunk/qpid/doc/book/src/java-broker/images/Management-Web-Add-Dialogue.png
qpid/trunk/qpid/doc/book/src/java-broker/images/Management-Web-ContextVar.png
qpid/trunk/qpid/doc/book/src/java-broker/images/Management-Web-Edit-Dialogue.png
Removed:
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Miscellaneous.xml
qpid/trunk/qpid/doc/book/src/java-broker/images/HA-2N-Key.png
qpid/trunk/qpid/doc/book/src/java-broker/images/HA-2N-Key.svg
qpid/trunk/qpid/doc/book/src/java-broker/images/HA-2N-MasterFail.png
qpid/trunk/qpid/doc/book/src/java-broker/images/HA-2N-MasterFail.svg
qpid/trunk/qpid/doc/book/src/java-broker/images/HA-2N-NetworkPartition.png
qpid/trunk/qpid/doc/book/src/java-broker/images/HA-2N-NetworkPartition.svg
qpid/trunk/qpid/doc/book/src/java-broker/images/HA-2N-Normal.png
qpid/trunk/qpid/doc/book/src/java-broker/images/HA-2N-Normal.svg
qpid/trunk/qpid/doc/book/src/java-broker/images/HA-2N-ReplicaFail.png
qpid/trunk/qpid/doc/book/src/java-broker/images/HA-2N-ReplicaFail.svg
qpid/trunk/qpid/doc/book/src/java-broker/images/HA-2N-SplitBrain.png
qpid/trunk/qpid/doc/book/src/java-broker/images/HA-2N-SplitBrain.svg
qpid/trunk/qpid/doc/book/src/java-broker/images/HA-perftests-results.png
Modified:
qpid/trunk/qpid/doc/book/src/java-broker/AMQP-Messaging-Broker-Java-Book.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Appendix-Operational-Logging-Messages.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Close-On-No-Route.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-High-Availability.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Initial-Configuration.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Installation.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Management-Channels.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Management-Managing-Entities.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Runtime-Disk-Space-Management-Producer-Flow-Control.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Runtime-Flow-To-Disk.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Runtime-Log-Files.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Security-ACLs.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Security-Authentication-Providers.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Security-Configuration-Encryption.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Security-Group-Providers.xml
qpid/trunk/qpid/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Overview.xml
qpid/trunk/qpid/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Ports.xml
qpid/trunk/qpid/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Queues.xml
qpid/trunk/qpid/doc/book/src/java-broker/management/channels/Java-Broker-Management-Channel-HTTP.xml
qpid/trunk/qpid/doc/book/src/java-broker/management/channels/Java-Broker-Management-Channel-JMX.xml
qpid/trunk/qpid/doc/book/src/java-broker/management/channels/Java-Broker-Management-Channel-REST-API.xml
qpid/trunk/qpid/doc/book/src/java-broker/management/channels/Java-Broker-Management-Channel-Web-Console.xml
qpid/trunk/qpid/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Broker.xml
qpid/trunk/qpid/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Plugins-HTTP.xml
qpid/trunk/qpid/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Plugins-JMX.xml
qpid/trunk/qpid/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Queues.xml
qpid/trunk/qpid/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-RemoteReplicationNodes.xml
qpid/trunk/qpid/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Truststores.xml
qpid/trunk/qpid/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-VirtualHostNodes.xml
qpid/trunk/qpid/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Virtualhosts.xml
Modified:
qpid/trunk/qpid/doc/book/src/java-broker/AMQP-Messaging-Broker-Java-Book.xml
URL:
http://svn.apache.org/viewvc/qpid/trunk/qpid/doc/book/src/java-broker/AMQP-Messaging-Broker-Java-Book.xml?rev=1631195&r1=1631194&r2=1631195&view=diff
==============================================================================
---
qpid/trunk/qpid/doc/book/src/java-broker/AMQP-Messaging-Broker-Java-Book.xml
(original)
+++
qpid/trunk/qpid/doc/book/src/java-broker/AMQP-Messaging-Broker-Java-Book.xml
Sun Oct 12 15:48:18 2014
@@ -33,9 +33,10 @@
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Java-Broker-Security.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Java-Broker-Runtime.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Java-Broker-High-Availability.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Java-Broker-Miscellaneous.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Java-Broker-Backup-And-Recovery.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Java-Broker-Appendix-Environment-Variables.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Java-Broker-Appendix-System-Properties.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Java-Broker-Appendix-Operational-Logging-Messages.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Java-Broker-Appendix-Queue-Alerts.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Java-Broker-Appendix-Miscellaneous.xml"/>
</book>
Copied:
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Appendix-Miscellaneous.xml
(from r1631194,
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Miscellaneous.xml)
URL:
http://svn.apache.org/viewvc/qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Appendix-Miscellaneous.xml?p2=qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Appendix-Miscellaneous.xml&p1=qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Miscellaneous.xml&r1=1631194&r2=1631195&rev=1631195&view=diff
==============================================================================
--- qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Miscellaneous.xml
(original)
+++
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Appendix-Miscellaneous.xml
Sun Oct 12 15:48:18 2014
@@ -24,7 +24,7 @@
-->
-<chapter id="Java-Broker-Miscellaneous">
+<appendix id="Java-Broker-Miscellaneous">
<title>Miscellaneous</title>
<section role="h2" id="Java-Broker-Miscellaneous-JVM-Verification">
@@ -77,7 +77,7 @@ copy <literal>driver</literal>.jar qpid-
<title>Installing Oracle BDB JE</title>
<para> The Oracle BDB JE is not distributed with Apache Qpid owing to
license considerations.. </para>
<para>If you wish to use a BDB Virtualhost Node, BDB Virtualhost, or BDB
HA Virtualhost Node you
- must make the BDB JE's JDBC 4.0 compatible drivers= available on the
Broker's classpath. </para>
+ must make the BDB JE's JAR available on the Broker's classpath. </para>
<para> Download the Oracle BDB JE &oracleBdbProductVersion; release <ulink
url="&oracleJeDownloadUrl;">from the Oracle website.</ulink>
</para>
@@ -100,4 +100,4 @@ copy je-&oracleBdbProductVersion;.jar qp
-</chapter>
+</appendix>
Modified:
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Appendix-Operational-Logging-Messages.xml
URL:
http://svn.apache.org/viewvc/qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Appendix-Operational-Logging-Messages.xml?rev=1631195&r1=1631194&r2=1631195&view=diff
==============================================================================
---
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Appendix-Operational-Logging-Messages.xml
(original)
+++
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Appendix-Operational-Logging-Messages.xml
Sun Oct 12 15:48:18 2014
@@ -28,7 +28,7 @@
<title>Operational Logging</title>
<para>The Broker will, by default, produce structured log messages in
response to key events in
- the lives of objects within the Broker. These consise messages are
designed to allow the user to
+ the lives of objects within the Broker. These concise messages are
designed to allow the user to
understand the actions of the Broker in retrospect. This is valuable for
problem diagnosis and
provides a useful audit trail.</para>
<para>Each log message includes details of the entity causing the action
(e.g. a management user
@@ -1196,7 +1196,7 @@
</row>
<row>
<entry>
- <para>The node is no longer reachanble. This may be as a result of
the node being
+ <para>The node is no longer reachable. This may be as a result of
the node being
stopped or a network partition may be preventing it from being
connected. The node is
still a member of the group.</para>
</entry>
Added:
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Backup-And-Recovery.xml
URL:
http://svn.apache.org/viewvc/qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Backup-And-Recovery.xml?rev=1631195&view=auto
==============================================================================
---
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Backup-And-Recovery.xml
(added)
+++
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Backup-And-Recovery.xml
Sun Oct 12 15:48:18 2014
@@ -0,0 +1,129 @@
+<?xml version="1.0"?>
+<!DOCTYPE entities [
+<!ENTITY % entities SYSTEM "commonEntities.xml">
+%entities;
+]>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+-->
+
+<chapter id="Java-Broker-Backup-And-Recovery">
+ <title>Backup And Recovery</title>
+ <section id="Java-Broker-Backup-And-Recovery-Broker">
+ <title>Broker</title>
+ <para>To perform a complete backup whilst the Broker is shutdown, simply
copy all the files the
+ exist beneath <literal>${QPID_WORK}</literal>, assuming all virtualhost
nodes and virtualhost
+ are in their standard location, this will copy all configuration and
persistent message data. </para>
+ <para>There is currently no safe mechanism to take a complete copy of the
entire Broker whilst
+ it is running.</para>
+ </section>
+ <section id="Java-Broker-Backup-And-Recovery-Virtualhost-Node">
+ <title>Virtualhost Node</title>
+ <para>To perform a complete backup of a Virtualhost node whilst it is
stopped (or Broker down),
+ simply copy all the files the exist beneath
+ <literal>${QPID_WORK}/<nodename>/config</literal>, assuming the
virtualhost node is in
+ the standard location. This will copy all configuration that belongs to
that virtualhost
+ node.</para>
+ <para>The technique for backing up a virtualhost node whilst it is running
depends on its
+ type.</para>
+ <section id="Java-Broker-Backup-And-Recovery-Virtualhost-Node-BDB">
+ <title>BDB</title>
+ <para>Qpid Broker distribution includes the "hot" backup utility
<literal>backup.sh</literal>
+ which can be found at broker bin folder. This utility can perform the
backup when broker is
+ running.</para>
+ <para><literal>backup.sh</literal> script invokes
+
<classname>org.apache.qpid.server.store.berkeleydb.BDBBackup</classname> to do
the
+ job.</para>
+ <para>You can also run this class from command line like in an example
below:</para>
+ <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>
+ </example>
+ <para>In the example above BDBBackup utility is called from
+ qpid-bdbstore-&qpidCurrentRelease;.jar to backup the store at
+ <literal>${QPID_WORK}/<nodename>/config</literal> and copy
store logs into
+ <literal>path/to/backup/folder</literal>.</para>
+ <para>Linux and Unix users can take advantage of
<literal>backup.sh</literal> bash script by
+ 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>
+ </example>
+ </section>
+ <section id="Java-Broker-Backup-And-Recovery-Virtualhost-Node-BDB-HA">
+ <title>BDB</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">
+ <title>Derby</title>
+ <para>Not yet supported</para>
+ </section>
+ <section id="Java-Broker-Backup-And-Recovery-Virtualhost-Node-JDBC">
+ <title>JDBC</title>
+ <para>The responsibility for backup is delegated to the database server
itself. See the
+ documentation accompanying it. Any technique that takes a consistent
snapshot of the
+ database is acceptable.</para>
+ </section>
+ <section id="Java-Broker-Backup-And-Recovery-Virtualhost-Node-JSON">
+ <title>JSON</title>
+ <para>JSON stores its config in a single text file. It can be safely
backed up using standard
+ command line tools.</para>
+ </section>
+ </section>
+ <section id="Java-Broker-Backup-And-Recovery-Virtualhost">
+ <title>Virtualhost</title>
+ <para>To perform a complete backup of a Virtualhost whilst it is stopped
(or Broker down),
+ simply copy all the files the exist beneath
+ <literal>${QPID_WORK}/<name>/messages</literal>, assuming the
virtualhost is in the
+ standard location. This will copy all messages that belongs to that
virtualhost.</para>
+ <para>The technique for backing up a virtualhost whilst it is running
depends on its
+ type.</para>
+ <section id="Java-Broker-Backup-And-Recovery-Virtualhost-BDB">
+ <title>BDB</title>
+ <para>Use the same backup utility described above, but use the path
+ <literal>${QPID_WORK}/<name>/messages</literal> instead.</para>
+ </section>
+ <section id="Java-Broker-Backup-And-Recovery-Virtualhost-Derby">
+ <title>Derby</title>
+ <para>Not yet supported</para>
+ </section>
+ <section id="Java-Broker-Backup-And-Recovery-Virtualhost-JDBC">
+ <title>JDBC</title>
+ <para>The responsibility for backup is delegated to the database server
itself. See the
+ documentation accompanying it. Any technique that takes a consistent
snapshot of the
+ database is acceptable.</para>
+ </section>
+ <section id="Java-Broker-Backup-And-Recovery-Virtualhost-Provided">
+ <title>Provided</title>
+ <para>The contents of the virtualhost will be backed up as part of
virtualhost node that
+ contains it.</para>
+ </section>
+ <section id="Java-Broker-Backup-And-Recovery-Virtualhost-BDBHA">
+ <title>BDB-HA</title>
+ <para>The contents of the virtualhost will be backed up as part of
virtualhost node that
+ contains it.</para>
+ </section>
+ </section>
+
+</chapter>
Modified:
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Close-On-No-Route.xml
URL:
http://svn.apache.org/viewvc/qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Close-On-No-Route.xml?rev=1631195&r1=1631194&r2=1631195&view=diff
==============================================================================
--- qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Close-On-No-Route.xml
(original)
+++ qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Close-On-No-Route.xml
Sun Oct 12 15:48:18 2014
@@ -33,7 +33,7 @@
an <emphasis>AMQNoRouteException</emphasis> through the configured
ExceptionListener on the Connection.
This does not cause channel or connection closure, however it requires
a special exception handling
on client side in order to deal with
<emphasis>AMQNoRouteExceptions</emphasis>.
- This could potentially be a problem when using various messaging
frameworks (e.g Mule)
+ This could potentially be a problem when using various messaging
frameworks (e.g. Mule)
as they usually close the connection on receiving any JMSException.
</para>
<para>
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
