You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by tr...@apache.org on 2018/10/31 12:43:52 UTC

qpid-dispatch git commit: DISPATCH-1162 - Added 'edge' mode and role to documented lists of modes and roles.

Repository: qpid-dispatch
Updated Branches:
  refs/heads/master 7c344339c -> 283cb2f74


DISPATCH-1162 - Added 'edge' mode and role to documented lists of modes and roles.


Project: http://git-wip-us.apache.org/repos/asf/qpid-dispatch/repo
Commit: http://git-wip-us.apache.org/repos/asf/qpid-dispatch/commit/283cb2f7
Tree: http://git-wip-us.apache.org/repos/asf/qpid-dispatch/tree/283cb2f7
Diff: http://git-wip-us.apache.org/repos/asf/qpid-dispatch/diff/283cb2f7

Branch: refs/heads/master
Commit: 283cb2f7431a3dfe2218b02e894aeef275b392b7
Parents: 7c34433
Author: Ted Ross <tr...@redhat.com>
Authored: Wed Oct 31 08:43:18 2018 -0400
Committer: Ted Ross <tr...@redhat.com>
Committed: Wed Oct 31 08:43:18 2018 -0400

----------------------------------------------------------------------
 .../user-guide/configuration-connections.adoc      |  1 -
 docs/books/user-guide/configuration-reference.adoc |  4 ++--
 .../understand-router-configuration.adoc           | 17 +++++++++++++----
 3 files changed, 15 insertions(+), 7 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/283cb2f7/docs/books/user-guide/configuration-connections.adoc
----------------------------------------------------------------------
diff --git a/docs/books/user-guide/configuration-connections.adoc b/docs/books/user-guide/configuration-connections.adoc
index 02a6235..d424630 100644
--- a/docs/books/user-guide/configuration-connections.adoc
+++ b/docs/books/user-guide/configuration-connections.adoc
@@ -120,5 +120,4 @@ If you have set up SSL/TLS or SASL in your environment, you can configure the ro
 . For each remaining router or broker to which this router should connect, configure an additional `connector` entity.
 
 
-[id='connection-failover']
 include::modules/connection-failover.adoc[leveloffset=+1]

http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/283cb2f7/docs/books/user-guide/configuration-reference.adoc
----------------------------------------------------------------------
diff --git a/docs/books/user-guide/configuration-reference.adoc b/docs/books/user-guide/configuration-reference.adoc
index 9ea6a12..17a5d51 100644
--- a/docs/books/user-guide/configuration-reference.adoc
+++ b/docs/books/user-guide/configuration-reference.adoc
@@ -91,7 +91,7 @@ Describe main information about the router related to identity, internal process
 
 
 * *_id_* (string) : Router’s unique identity. It is required and the router will fail to start without it.
-* *_mode_* (One of [`standalone`, `interior`], 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.
+* *_mode_* (One of [`standalone`, `interior`, `edge`], 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 may create one or more connections (of role 'edge') to interior routers and participate normally in the network.  There is no limit to the number of edge routers that can be deployed in a network.
 * *_helloIntervalSeconds_* (integer, default=`1`) : Interval in seconds between HELLO messages sent to neighbor routers in order to announce its presence (as a keep alive).
 * *_helloMaxAgeSeconds_* (integer, default=`3`) : Time in seconds after which a neighbor router is declared lost if no HELLO is received.
 * *_raIntervalSeconds_* (integer, default=`30`) : Interval in seconds between Router-Advertisements sent to all routers in a stable network.
@@ -110,7 +110,7 @@ Listens for incoming connections to the router.
 * *_host_* (string, default=`127.0.0.1`) : IP address: ipv4 or ipv6 literal or a hostname.
 * *_port_* (string, default=`amqp`) : Port number or symbolic service name.
 * *_protocolFamily_* (One of [`IPv4`, `IPv6`]) : IPv4: Internet Protocol version 4; IPv6: Internet Protocol version 6. If not specified, the protocol family will be automatically determined from the address.
-* *_role_* (One of [`normal`, `inter-router`, `route-container`], 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. The route-container role can be used for router-container connections, for example, a router-broker connection.
+* *_role_* (One of [`normal`, `inter-router`, `route-container`, `edge`], 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 interior router in the network. Inter-router discovery and routing protocols can only be used over inter-router connections. The route-container role can be used for router-container connections, for example, a router-broker connection.  The edge role is used for connections between edge and interior routers.
 * *_cost_* (integer, default=`1`) : For the `inter-route` role only. This value assigns a cost metric to the inter-router connection. The default (and minimum) value is one. Higher values represent higher costs. The cost is used to influence the routing algorithm as it attempts to use the path with the lowest total cost from ingress to egress.
 * *_saslMechanisms_* (string) : Space separated list of accepted SASL authentication mechanisms.
 * *_authenticatePeer_* (boolean) : yes: Require the peer’s identity to be authenticated; no: Do not require any authentication.

http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/283cb2f7/docs/books/user-guide/understand-router-configuration.adoc
----------------------------------------------------------------------
diff --git a/docs/books/user-guide/understand-router-configuration.adoc b/docs/books/user-guide/understand-router-configuration.adoc
index 4e3111b..d742447 100644
--- a/docs/books/user-guide/understand-router-configuration.adoc
+++ b/docs/books/user-guide/understand-router-configuration.adoc
@@ -294,16 +294,25 @@ If you are changing the router's default configuration file, the file is located
 [options="nowrap",subs="+quotes"]
 ----
 router {
-    mode: _STANDALONE/INTERIOR_
+    mode: _STANDALONE/INTERIOR/EDGE_
     id: _ROUTER_ID_
 }
 ----
 
 `mode`:: Specify one of the following modes:
 +
-* `standalone` - Use this mode if the router does not communicate with other routers and is not part of a router network. When operating in this mode, the router only routes messages between directly connected endpoints.
-* `interior` - Use this mode if the router is part of a router network and needs to collaborate with other routers.
-`id`:: The unique identifier for the router. This ID will also be the container name at the AMQP protocol level.
+* `standalone` - Use this mode if the router does not communicate with
+other routers and is not part of a router network. When operating in
+this mode, the router only routes messages between directly connected
+endpoints. 
+* `interior` - Use this mode if the router is part of a router network
+and needs to collaborate with other routers.
+* `edge` - Use this mode if the router is an edge router that will
+connect to a network of interior routers.
+
+`id`:: The unique
+identifier for the router. This ID will also be the container name at
+the AMQP protocol level.
 
 For information about additional attributes, see link:{qdrouterdConfManPageUrl}#_router[router] in the `qdrouterd.conf` man page.
 --


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