[
https://issues.apache.org/jira/browse/DISPATCH-1338?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16850667#comment-16850667
]
ASF GitHub Bot commented on DISPATCH-1338:
------------------------------------------
PaulRMellor commented on pull request #512: DISPATCH-1338: Restructure Dispatch
Router book for edge router
URL: https://github.com/apache/qpid-dispatch/pull/512#discussion_r288445253
##########
File path: docs/books/user-guide/modules/connecting-routers.adoc
##########
@@ -0,0 +1,89 @@
+////
+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
+////
+
+// Module is included in the following assemblies:
+//
+// configuring-network-connections.adoc
+
+[id='connecting-routers-{context}']
+= Connecting routers
+
+To connect a router to another router in the router network, you configure a
`connector` on one router to create the outbound connection, and a `listener`
on the other router to accept the connection.
+
+Because connections are bidirectional, there should only be one connection
between any pair of routers. Once the connection is established, message
traffic flows in both directions.
+
+This procedure describes how to connect a router to another router in the
router network.
+
+.Procedure
+
+. Determine the direction of the connection.
++
+--
+Decide which router should be the "connector", and which should be the
"listener". The direction of the connection establishment is sometimes
arbitrary, but consider the following factors:
+
+IP network boundaries and firewalls::
+Generally, inter-router connections should always be established from more
private to more public. For example, to connect a router in a private IP
network to another router in a public location (such as a public cloud
provider), the router in the private network must be the "connector" and the
router in the public location must be the "listener". This is because the
public location cannot reach the private location by TCP/IP without the use of
VPNs or other firewall features designed to allow public-to-private access.
+
+Network topology::
+The topology of the router network may affect the direction in which
connections should be established between the routers. For example, a
star-topology that has a series of routers connected to one or two central
"hub" routers should have "listeners" on the hub and "connectors" on the
spokes. That way, new spoke routers may be added without changing the
configuration of the hub.
+--
+
+. On the router that should create the connection, open the
`{RouterConfigFile}` configuration file and add a `connector`.
Review comment:
```suggestion
. On the router chosen to create the connection, open the
`{RouterConfigFile}` configuration file and add a `connector`.
```
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
> Improvements to edge router documentation
> -----------------------------------------
>
> Key: DISPATCH-1338
> URL: https://issues.apache.org/jira/browse/DISPATCH-1338
> Project: Qpid Dispatch
> Issue Type: Improvement
> Components: Documentation
> Reporter: Ben Hardesty
> Priority: Major
>
> Restructure the doc for edge router.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
