Added: qpid/site/input/releases/qpid-dispatch-0.4/man/qdrouterd.conf.html.in URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-dispatch-0.4/man/qdrouterd.conf.html.in?rev=1673280&view=auto ============================================================================== --- qpid/site/input/releases/qpid-dispatch-0.4/man/qdrouterd.conf.html.in (added) +++ qpid/site/input/releases/qpid-dispatch-0.4/man/qdrouterd.conf.html.in Mon Apr 13 21:05:44 2015 @@ -0,0 +1,343 @@ + + + + + + + + qdrouterd.conf manual page — Qpid Dispatch 0.4 documentation + + + + + + + + + + + + + +
+
+
+
+ +
+

qdrouterd.conf manual page¶

+
+

Synopsis¶

+

qdroutered.conf is the configuration file for the dispatch router.

+
+
+

Description¶

+

The configuration file is made up of sections with this syntax:

+
SECTION-NAME {
+    ATTRIBUTE-NAME: ATTRIBUTE-VALUE
+    ATTRIBUTE-NAME: ATTRIBUTE-VALUE
+    ...
+}
+
+
+

There are two types of sections:

+

Configuration sections correspond to configuration entities. They can be queried and +configured via management tools as well as via the configuration file.

+

Annotation sections define a group of attribute values that can be included in +one or more entity sections.

+

For example you can define an “ssl-profile” annotation section with SSL credentials +that can be included in multiple “listener” entities. Here’s an example, note +how the ‘ssl-profile’ attribute of ‘listener’ sections references the ‘name’ +attribute of ‘ssl-profile’ sections.

+
ssl-profile {
+    name: ssl-profile-one
+    cert-db: ca-certificate-1.pem
+    cert-file: server-certificate-1.pem
+    key-file: server-private-key.pem
+}
+
+listener {
+    ssl-profile: ssl-profile-one
+    addr: 0.0.0.0
+    port: 20102
+    sasl-mechanisms: ANONYMOUS
+}
+
+
+
+
+

Annotation Sections¶

+
+

addrPort¶

+

Attributes for internet address and port.

+

Used by: listener, connector.

+
+
addr (string, default=‘0.0.0.0’)
+
IP address: ipv4 or ipv6 literal or a host name.
+
port (string, default=’amqp’)
+
Port number or symbolic service name.
+
+
+
+

saslMechanisms¶

+

Attribute for a list of SASL mechanisms.

+

Used by: listener, connector.

+
+
saslMechanisms (string, required)
+
Comma separated list of accepted SASL authentication mechanisms.
+
+
+
+

connectionRole¶

+

Attribute for the role of a connection.

+

Used by: listener, connector.

+
+
role (One of [‘normal’, ‘inter-router’, ‘on-demand’], default=’normal’)
+
The role of an established connection. In the normal role, the connection is assumed to be used for AMQP clients that are doing normal message delivery over the connection. In the inter-router role, the connection is assumed to be to another router in the network. Inter-router discovery and routing protocols can only be used over inter-router connections.
+
+
+
+

sslProfile¶

+

Attributes for setting TLS/SSL configuration for connections.

+

Used by: listener, connector.

+
+
certDb (path)
+
The path to the database that contains the public certificates of trusted certificate authorities (CA).
+
certFile (path)
+
The path to the file containing the PEM-formatted public certificate to be used on the local end of any connections using this profile.
+
keyFile (path)
+
The path to the file containing the PEM-formatted private key for the above certificate.
+
passwordFile (path)
+
If the above private key is password protected, this is the path to a file containing the password that unlocks the certificate key.
+
password (string)
+
An alternative to storing the password in a file referenced by passwordFile is to supply the password right here in the configuration file. This option can be used by supplying the password in the ‘password’ option. Don’t use both password and passwordFile in the same profile.
+
+
+
+
+

Configuration Sections¶

+
+

container¶

+

Attributes related to the AMQP container.

+
+
containerName (string)
+
The name of the AMQP container. If not specified, the container name will be set to a value of the container’s choosing. The automatically assigned container name is not guaranteed to be persistent across restarts of the container.
+
workerThreads (integer, default=1)
+
The number of threads that will be created to process message traffic and other application work (timers, non-amqp file descriptors, etc.) .
+
debugDump (path)
+
A file to dump debugging information that can’t be logged normally.
+
+
+
+

router¶

+

Tracks peer routers and computes routes to destinations.

+
+
routerId (string)
+
Router’s unique identity.
+
mode (One of [‘standalone’, ‘interior’, ‘edge’, ‘endpoint’], default=’standalone’)
+
In standalone mode, the router operates as a single component. It does not participate in the routing protocol and therefore will not cooperate with other routers. In interior mode, the router operates in cooperation with other interior routers in an interconnected network. In edge mode, the router operates with an up link into an interior router network. Edge routers are typically used as connection concentrators or as security firewalls for access into the interior network.
+
helloInterval (integer, default=1)
+
Interval in seconds between HELLO messages sent to neighbor routers.
+
helloMaxAge (integer, default=3)
+
Time in seconds after which a neighbor is declared lost if no HELLO is received.
+
raInterval (integer, default=30)
+
Interval in seconds between Router-Advertisements sent to all routers in a stable network.
+
raIntervalFlux (integer, default=4)
+
Interval in seconds between Router-Advertisements sent to all routers during topology fluctuations.
+
remoteLsMaxAge (integer, default=60)
+
Time in seconds after which link state is declared stale if no RA is received.
+
mobileAddrMaxAge (integer, default=60)
+
Deprecated - This value is no longer used in the router.
+
+
+
+

listener¶

+

Listens for incoming connections to the router.

+

Annotations: addrPort, connectionRole, sslProfile, saslMechanisms.

+
+
addr (string, default=‘0.0.0.0’)
+
IP address: ipv4 or ipv6 literal or a host name.
+
port (string, default=’amqp’)
+
Port number or symbolic service name.
+
role (One of [‘normal’, ‘inter-router’, ‘on-demand’], default=’normal’)
+
The role of an established connection. In the normal role, the connection is assumed to be used for AMQP clients that are doing normal message delivery over the connection. In the inter-router role, the connection is assumed to be to another router in the network. Inter-router discovery and routing protocols can only be used over inter-router connections.
+
certDb (path)
+
The path to the database that contains the public certificates of trusted certificate authorities (CA).
+
certFile (path)
+
The path to the file containing the PEM-formatted public certificate to be used on the local end of any connections using this profile.
+
keyFile (path)
+
The path to the file containing the PEM-formatted private key for the above certificate.
+
passwordFile (path)
+
If the above private key is password protected, this is the path to a file containing the password that unlocks the certificate key.
+
password (string)
+
An alternative to storing the password in a file referenced by passwordFile is to supply the password right here in the configuration file. This option can be used by supplying the password in the ‘password’ option. Don’t use both password and passwordFile in the same profile.
+
saslMechanisms (string, required)
+
Comma separated list of accepted SASL authentication mechanisms.
+
requirePeerAuth (boolean, default=True)
+
Only for listeners using SSL. If set to ‘yes’, attached clients will be required to supply a certificate. If the certificate is not traceable to a CA in the ssl profile’s cert-db, authentication fails for the connection.
+
trustedCerts (path)
+
This optional setting can be used to reduce the set of available CAs for client authentication. If used, this setting must provide a path to a PEM file that contains the trusted certificates.
+
allowUnsecured (boolean)
+
For listeners using SSL only. If set to ‘yes’ the listener will allow both SSL-secured clients and non-SSL clients to connect.
+
allowNoSasl (boolean)
+
If set to ‘yes’, this option causes the listener to allow clients to connect even if they skip the SASL authentication protocol.
+
maxFrameSize (integer, default=65536)
+
Defaults to 65536. If specified, it is the maximum frame size in octets that will be used in the connection-open negotiation with a connected peer. The frame size is the largest contiguous set of uninterrupted data that can be sent for a message delivery over the connection. Interleaving of messages on different links is done at frame granularity.
+
+
+
+

connector¶

+

Establishes an outgoing connections from the router.

+

Annotations: addrPort, connectionRole, sslProfile, saslMechanisms.

+
+
addr (string, default=‘0.0.0.0’)
+
IP address: ipv4 or ipv6 literal or a host name.
+
port (string, default=’amqp’)
+
Port number or symbolic service name.
+
role (One of [‘normal’, ‘inter-router’, ‘on-demand’], default=’normal’)
+
The role of an established connection. In the normal role, the connection is assumed to be used for AMQP clients that are doing normal message delivery over the connection. In the inter-router role, the connection is assumed to be to another router in the network. Inter-router discovery and routing protocols can only be used over inter-router connections.
+
certDb (path)
+
The path to the database that contains the public certificates of trusted certificate authorities (CA).
+
certFile (path)
+
The path to the file containing the PEM-formatted public certificate to be used on the local end of any connections using this profile.
+
keyFile (path)
+
The path to the file containing the PEM-formatted private key for the above certificate.
+
passwordFile (path)
+
If the above private key is password protected, this is the path to a file containing the password that unlocks the certificate key.
+
password (string)
+
An alternative to storing the password in a file referenced by passwordFile is to supply the password right here in the configuration file. This option can be used by supplying the password in the ‘password’ option. Don’t use both password and passwordFile in the same profile.
+
saslMechanisms (string, required)
+
Comma separated list of accepted SASL authentication mechanisms.
+
allowRedirect (boolean, default=True)
+
Allow the peer to redirect this connection to another address.
+
maxFrameSize (integer, default=65536)
+
Maximum frame size in octets that will be used in the connection-open negotiation with a connected peer. The frame size is the largest contiguous set of uninterrupted data that can be sent for a message delivery over the connection. Interleaving of messages on different links is done at frame granularity.
+
+
+
+

log¶

+

Configure logging for a particular module. You can use the UPDATE operation to change log settings while the router is running.

+
+
enable (string, default=’default’, required)
+
Levels are: trace, debug, info, notice, warning, error, critical. The enable string is a comma-separated list of levels. A level may have a trailing ‘+’ to enable that level and above. For example ‘trace,debug,warning+’ means enable trace, debug, warning, error and critical. The value ‘none’ means disable logging for the module. The value ‘default’ means use the value from the DEFAULT module.
+
timestamp (boolean)
+
Include timestamp in log messages.
+
source (boolean)
+
Include source file and line number in log messages.
+
output (string)
+
Where to send log messages. Can be ‘stderr’, ‘syslog’ or a file name.
+
+
+
+

fixedAddress¶

+

Establishes semantics for addresses starting with a prefix.

+
+
prefix (string, required)
+
The address prefix (always starting with ‘/’).
+
phase (integer)
+
The phase of a multi-hop address passing through one or more waypoints.
+
fanout (One of [‘multiple’, ‘single’], default=’multiple’)
+
One of ‘multiple’ or ‘single’. Multiple fanout is a non-competing pattern. If there are multiple consumers using the same address, each consumer will receive its own copy of every message sent to the address. Single fanout is a competing pattern where each message is sent to only one consumer.
+
bias (One of [‘closest’, ‘spread’], default=’closest’)
+
Only if fanout is single. One of ‘closest’ or ‘spread’. Closest bias means that messages to an address will always be delivered to the closest (lowest cost) subscribed consumer. Spread bias will distribute the messages across subscribers in an approximately even manner.
+
+
+
+

waypoint¶

+

A remote node that messages for an address pass through.

+
+
address (string, required)
+
The AMQP address of the waypoint.
+
connector (string, required)
+
The name of the on-demand connector used to reach the waypoint’s container.
+
inPhase (integer, default=-1)
+
The phase of the address as it is routed _to_ the waypoint.
+
outPhase (integer, default=-1)
+
The phase of the address as it is routed _from_ the waypoint.
+
+
+
+

linkRoutePattern¶

+

An address pattern to match against link sources and targets to cause the router to link-route the attach across the network to a remote node.

+
+
prefix (string, required)
+
An address prefix to match against target and source addresses. For Dispatch 0.4, this pattern must be of the form ‘<text>.’ and matches any address that contains that prefix. Note that the prefix must end with a period (.) and must not contain any other periods.
+
connector (string)
+
The name of the on-demand connector used to reach the target node’s container. If this value is not provided, it means that the target container is expected to be connected to a different router in the network. This prevents links to a link-routable address from being misinterpreted as message-routing links when there is no route to a valid destination available.
+
+
+
+
+

See also¶

+

qdrouterd(8), qdmanage(8)

+

http://qpid.apache.org/components/dispatch-router

+
+
+ + +
+
+
+
+
+

Table Of Contents

+ + + + +
+
+
+
+ + + + \ No newline at end of file Added: qpid/site/input/releases/qpid-dispatch-0.4/man/qdrouterd.html.in URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-dispatch-0.4/man/qdrouterd.html.in?rev=1673280&view=auto ============================================================================== --- qpid/site/input/releases/qpid-dispatch-0.4/man/qdrouterd.html.in (added) +++ qpid/site/input/releases/qpid-dispatch-0.4/man/qdrouterd.html.in Mon Apr 13 21:05:44 2015 @@ -0,0 +1,118 @@ + + + + + + + + qdrouterd manual page — Qpid Dispatch 0.4 documentation + + + + + + + + + + + + + +
+
+
+
+ +
+

qdrouterd manual page¶

+
+

SYNOPSIS¶

+

qdrouterd [options]

+
+
+

DESCRIPTION¶

+

The Qpid Dispatch router (qdrouterd) is a network daemon that directs +AMQP 1.0 messages between endpoints, such as messaging clients and +servers.

+
+
+

OPTIONS¶

+

-c, –config=PATH (/usr/local/etc/qpid-dispatch/qdrouterd.conf) +: Load configuration from file at PATH

+

-I, –include=PATH (/usr/local/lib/qpid-dispatch/python) +: Location of Dispatch’s Python library

+

-d, –daemon +: Run process as a SysV-style daemon

+

-P, –pidfile +: If daemon, the file for the stored daemon pid

+

-U, –user +: If daemon, the username to run as

+

-h, –help +: Print this help

+
+
+

FILES¶

+
+
/usr/local/etc/qdrouterd.conf
+
Configuration flie.
+
+
+
+

SEE ALSO¶

+

qdrouterd.conf(5), qdstat(8), qdmanage(8)

+

http://qpid.apache.org/components/dispatch-router

+
+
+ + +
+
+
+
+
+

Table Of Contents

+ + + + +
+
+
+
+ + + + \ No newline at end of file Added: qpid/site/input/releases/qpid-dispatch-0.4/man/qdstat.html.in URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-dispatch-0.4/man/qdstat.html.in?rev=1673280&view=auto ============================================================================== --- qpid/site/input/releases/qpid-dispatch-0.4/man/qdstat.html.in (added) +++ qpid/site/input/releases/qpid-dispatch-0.4/man/qdstat.html.in Mon Apr 13 21:05:44 2015 @@ -0,0 +1,134 @@ + + + + + + + + qdstat manual page — Qpid Dispatch 0.4 documentation + + + + + + + + + + + + + +
+
+
+
+ +
+

qdstat manual page¶

+
+

Synopsis¶

+

qdstat [options]

+
+
+

Description¶

+

qdstat shows status information about networks of Dispatch routers. It +can display connections, network nodes and links, and router stats such +as memory use.

+
+
+

Options¶

+

-h, –help +: show this help message and exit

+

–version +: Print version and exit.

+

-g, –general +: Show General Router Stats

+

-c, –connections +: Show Connections

+

-l, –links +: Show Router Links

+

-n, –nodes +: Show Router Nodes

+

-a, –address +: Show Router Addresses

+

-m, –memory +: Show Broker Memory Stats

+
+

Connection Options¶

+

-b URL, –bus=URL +: URL of the messaging bus to connect to (default 0.0.0.0)

+

-r ROUTER-ID, –router=ROUTER-ID +: Router to be queried

+

-t SECS, –timeout=SECS +: Maximum time to wait for connection in seconds (default 5)

+

–ssl-certificate=CERT +: Client SSL certificate (PEM Format)

+

–ssl-key=KEY +: Client SSL private key (PEM Format)

+

–ssl-trustfile=TRUSTED-CA-DB +: Trusted Certificate Authority Database file (PEM Format)

+

–ssl-password=PASSWORD +: Certificate password, will be prompted if not specifed.

+
+
+
+

See also¶

+

qdrouterd(8), qdmanage(8), qdrouterd.conf(5)

+

http://qpid.apache.org/components/dispatch-router

+
+
+ + +
+
+
+
+
+

Table Of Contents

+ + + + +
+
+
+
+ + + + \ No newline at end of file Added: qpid/site/input/releases/qpid-dispatch-0.4/release-notes.md URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-dispatch-0.4/release-notes.md?rev=1673280&view=auto ============================================================================== --- qpid/site/input/releases/qpid-dispatch-0.4/release-notes.md (added) +++ qpid/site/input/releases/qpid-dispatch-0.4/release-notes.md Mon Apr 13 21:05:44 2015 @@ -0,0 +1,53 @@ +;; +;; 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. +;; + +# Qpid Dispatch 0.4 Release Notes + +Dispatch is a lightweight AMQP message router library. More about +[Qpid Dispatch](@site-url@/components/dispatch-router/index.html). + +For more information about this release, including download links and +documentation, see the [release overview](index.html). + + +## New features and improvements + + - [DISPATCH-6](https://issues.apache.org/jira/browse/DISPATCH-6) - Implement link-routing + - [DISPATCH-97](https://issues.apache.org/jira/browse/DISPATCH-97) - Router Engine Redesign + - [DISPATCH-100](https://issues.apache.org/jira/browse/DISPATCH-100) - Accelerate the router-advert interval during topology fluctuations + - [DISPATCH-102](https://issues.apache.org/jira/browse/DISPATCH-102) - Provide qdrouter schema via management interface + - [DISPATCH-108](https://issues.apache.org/jira/browse/DISPATCH-108) - Identify settable, updatable and read-only attributes in management schema. + - [DISPATCH-109](https://issues.apache.org/jira/browse/DISPATCH-109) - Support parsing of the Subject field from the message properties + - [DISPATCH-125](https://issues.apache.org/jira/browse/DISPATCH-125) - Convert documentation to rst, generate book and HTML man pages from sphinx. + - [DISPATCH-128](https://issues.apache.org/jira/browse/DISPATCH-128) - Documentation updates for 0.4 + +## Bugs fixed + + - [DISPATCH-90](https://issues.apache.org/jira/browse/DISPATCH-90) - Routing table is corrupt after a router quickly restarts + - [DISPATCH-96](https://issues.apache.org/jira/browse/DISPATCH-96) - Installing qpid_dispatch_site and qpid_dispatch/management does not work with "make DESTDIR" + - [DISPATCH-106](https://issues.apache.org/jira/browse/DISPATCH-106) - pn link corruption after router restart + - [DISPATCH-107](https://issues.apache.org/jira/browse/DISPATCH-107) - Links are not detached if the remote ends the session prematurely + - [DISPATCH-112](https://issues.apache.org/jira/browse/DISPATCH-112) - Router fails with duplicate link ID errors. + - [DISPATCH-114](https://issues.apache.org/jira/browse/DISPATCH-114) - SSL configuration fails to translate to proper internal names + - [DISPATCH-116](https://issues.apache.org/jira/browse/DISPATCH-116) - Qpid dispatch management tools do not use SSL and SASL correctly. + - [DISPATCH-117](https://issues.apache.org/jira/browse/DISPATCH-117) - SEG Fault when outgoing SSL connections fail + - [DISPATCH-118](https://issues.apache.org/jira/browse/DISPATCH-118) - crash due to race on proton-c/src/error.c error structures. + - [DISPATCH-122](https://issues.apache.org/jira/browse/DISPATCH-122) - Message annotations are not indexed by Symbol types + - [DISPATCH-124](https://issues.apache.org/jira/browse/DISPATCH-124) - Error handling when SSL is not available. + - [DISPATCH-130](https://issues.apache.org/jira/browse/DISPATCH-130) - qdrouterd with --daemon and --user options does not dump core. \ No newline at end of file Modified: qpid/site/scripts/gen-dispatch-release-books URL: http://svn.apache.org/viewvc/qpid/site/scripts/gen-dispatch-release-books?rev=1673280&r1=1673279&r2=1673280&view=diff ============================================================================== --- qpid/site/scripts/gen-dispatch-release-books (original) +++ qpid/site/scripts/gen-dispatch-release-books Mon Apr 13 21:05:44 2015 @@ -20,26 +20,22 @@ from qpid_site.generate import * -def gen_books_and_man(release, source_dir, output_dir): - with working_dir(source_dir): - call("cmake .") - - with working_dir(join(source_dir, "doc")): - call("make") - - src = join(source_dir, "doc", "book") +def copy_html_to_in(from_dir, to_dir): + html = list_dir(from_dir, "*.html") + for h in html: + copy(join(from_dir, h), join(to_dir, h+".in")) - # Copy book HTML fragment so it will get site style. - for f in ["book.html.in", "book.pdf"]: - copy(join(source_dir, "doc", "book", f), join(output_dir, f)) - - # Copy complete HTML man pages, they look odd with site style - for f in ["qdrouterd.8.html", "qdrouterd.conf.5.html", - "qdmanage.8.html", "qdstat.8.html"]: - copy(join(source_dir, "doc", "man", f), output_dir) +def gen_books_and_man(release, source_dir, output_dir): + build_dir = join(source_dir, "build") + make_dirs(build_dir) + with working_dir(build_dir): + call("cmake ..; make doc") + + # Rename html files as html.in so they'll get the qpid website style. + copy_html_to_in(join(build_dir, "doc", "html", "book"), join(output_dir, "book")) + copy_html_to_in(join(build_dir, "doc", "html", "man"), join(output_dir, "man")) ## Now do stuff ## - release, release_dir, checkout_dir = setup_release_script() source_dir = export_release("dispatch", release, checkout_dir) Modified: qpid/site/scripts/gen-dispatch-release-page URL: http://svn.apache.org/viewvc/qpid/site/scripts/gen-dispatch-release-page?rev=1673280&r1=1673279&r2=1673280&view=diff ============================================================================== --- qpid/site/scripts/gen-dispatch-release-page (original) +++ qpid/site/scripts/gen-dispatch-release-page Mon Apr 13 21:05:44 2015 @@ -36,14 +36,13 @@ documentation = \
- [Installing Qpid Dispatch](http://svn.apache.org/repos/asf/qpid/dispatch/trunk/README) -- [Dispatch router book](book.html) ([PDF](book.pdf)) -- [Dispatch library API](api/index.html) +- [Dispatch router book](book/book.html)
-- [qdrouterd](qdrouterd.8.html) - The router daemon -- [qdrouterd.conf](qdrouterd.conf.5.html) - Router daemon configuration -- [qdstat](qdstat.8.html) - Check statistics for a running router -- [qdmanage](qdmanage.8.html) - Check statistics for a running router +- [qdrouterd](man/qdrouterd.html) - Router daemon +- [qdrouterd.conf](man/qdrouterd.conf.html) - Daemon configuration +- [qdstat](man/qdstat.html) - Get router statistics +- [qdmanage](man/qdmanage.html) - Manage the router
--------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org For additional commands, e-mail: commits-help@qpid.apache.org