You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by gm...@apache.org on 2018/03/15 21:00:24 UTC
qpid-dispatch git commit: Update anchorname format and fix broken
links. This closes #264
Repository: qpid-dispatch
Updated Branches:
refs/heads/master 0f05f836f -> f80c40ff4
Update anchorname format and fix broken links. This closes #264
Project: http://git-wip-us.apache.org/repos/asf/qpid-dispatch/repo
Commit: http://git-wip-us.apache.org/repos/asf/qpid-dispatch/commit/f80c40ff
Tree: http://git-wip-us.apache.org/repos/asf/qpid-dispatch/tree/f80c40ff
Diff: http://git-wip-us.apache.org/repos/asf/qpid-dispatch/diff/f80c40ff
Branch: refs/heads/master
Commit: f80c40ff472a486eb0ec62ba56a3c72caa9f0ec8
Parents: 0f05f83
Author: Ben Hardesty <bh...@redhat.com>
Authored: Thu Feb 15 17:30:08 2018 -0500
Committer: Ganesh Murthy <gm...@redhat.com>
Committed: Thu Mar 15 16:59:49 2018 -0400
----------------------------------------------------------------------
doc/book/policy.adoc | 4 +-
doc/new-book/attributes.adoc | 14 ++--
doc/new-book/configuration-connections.adoc | 16 ++---
doc/new-book/configuration-reference.adoc | 18 +++---
doc/new-book/configuration-security.adoc | 68 ++++++++++----------
doc/new-book/cyrus-sasl.adoc | 6 +-
doc/new-book/getting-started.adoc | 14 ++--
doc/new-book/introduction.adoc | 8 +--
doc/new-book/logging.adoc | 12 ++--
doc/new-book/managing-using-qdmanage.adoc | 18 +++---
doc/new-book/monitoring-using-qdstat.adoc | 14 ++--
doc/new-book/reliability.adoc | 2 +-
doc/new-book/routing.adoc | 38 +++++------
.../technical-details-specifications.adoc | 20 +++---
.../understand-router-configuration.adoc | 30 ++++-----
15 files changed, 141 insertions(+), 141 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/f80c40ff/doc/book/policy.adoc
----------------------------------------------------------------------
diff --git a/doc/book/policy.adoc b/doc/book/policy.adoc
index 645334f..d10a841 100644
--- a/doc/book/policy.adoc
+++ b/doc/book/policy.adoc
@@ -17,7 +17,7 @@ specific language governing permissions and limitations
under the License
////
-[[policy]]
+[id='policy']
= Policy
The Policy module is an optional authorization mechanism enforcing
@@ -218,7 +218,7 @@ Policy is disabled when no policy configuation objects are defined.
Any number of connections are allowed and all users have
access to all AMQP resources in the network.
-[[example2]]
+[id='example2']
=== Example 2. All Users Have Simple Connection Limits
This example shows how to keep users from overwhelming the router with
http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/f80c40ff/doc/new-book/attributes.adoc
----------------------------------------------------------------------
diff --git a/doc/new-book/attributes.adoc b/doc/new-book/attributes.adoc
index bfdd03d..3cc7080 100644
--- a/doc/new-book/attributes.adoc
+++ b/doc/new-book/attributes.adoc
@@ -42,7 +42,7 @@ under the License
:FragmentDir: common
:RouterName: Dispatch Router
:RouterSchemaDir: ../../build/doc/book
-:RouterVersion: 0.8
+:RouterVersion: 1.0
// Book names
@@ -50,29 +50,29 @@ under the License
// Doc links
-:BookUrlBase: https://qpid.apache.org/releases/qpid-dispatch-0.8.0
+:BookUrlBase: https://qpid.apache.org/releases/qpid-dispatch-1.0.0
:ManagementEntitiesUrl: {BookUrlBase}/man/managementschema.html
-:ManagementEntitiesLink: link:{ManagementEntitiesUrl}[{RouterName} Management Schema]
+:ManagementEntitiesLink: link:{ManagementEntitiesUrl}[{RouterName} Management Schema^]
:RouterBookUrl: {BookUrlBase}/book/book.html
:RouterBookLink: link:{RouterBookUrl}[{RouterBook}]
:qdmanageManPageUrl: {BookUrlBase}/man/qdmanage.html
-:qdmanageManPageLink: link:{qdmanageManPageUrl}[qdmanage man page]
+:qdmanageManPageLink: link:{qdmanageManPageUrl}[qdmanage man page^]
:qdrouterdManPageUrl: {BookUrlBase}/man/qdrouterd.html
-:qdrouterdManPageLink: link:{qdrouterdManPageUrl}[qdrouterd man page]
+:qdrouterdManPageLink: link:{qdrouterdManPageUrl}[qdrouterd man page^]
:qdrouterdConfManPageUrl: {BookUrlBase}/man/qdrouterd.conf.html
:qdrouterdConfManPageLink: link:{qdrouterdManPageUrl}[qdrouterd.conf man page]
:qdstatManPageUrl: {BookUrlBase}/man/qdstat.html
-:qdstatManPageLink: link:{qdstatManPageUrl}[qdstat man page]
+:qdstatManPageLink: link:{qdstatManPageUrl}[qdstat man page^]
:ClientAmqpPythonUrl: https://qpid.apache.org/proton/
// Other links
:AmqpSpecUrl: http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-overview-v1.0-os.html
-:AmqpSpecLink: link:{AmqpSpecUrl}[AMQP 1.0 specification]
+:AmqpSpecLink: link:{AmqpSpecUrl}[AMQP 1.0 specification^]
http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/f80c40ff/doc/new-book/configuration-connections.adoc
----------------------------------------------------------------------
diff --git a/doc/new-book/configuration-connections.adoc b/doc/new-book/configuration-connections.adoc
index 30e737a..27ec361 100644
--- a/doc/new-book/configuration-connections.adoc
+++ b/doc/new-book/configuration-connections.adoc
@@ -17,12 +17,12 @@ specific language governing permissions and limitations
under the License
////
-[[router_network_connections]]
+[id='router-network-connections']
= Network Connections
Connections define how the router communicates with clients, other routers, and brokers. You can configure _incoming connections_ to define how the router listens for data from clients and other routers, and you can configure _outgoing connections_ to define how the router sends data to other routers and brokers.
-[[adding_incoming_connections]]
+[id='adding-incoming-connections']
== Listening for Incoming Connections
Listening for incoming connections involves setting the host and port on which the router should listen for traffic.
@@ -44,22 +44,22 @@ listener {
`host`:: Either an IP address (IPv4 or IPv6) or hostname on which the router should listen for incoming connections.
`port`:: The port number or symbolic service name on which the router should listen for incoming connections.
-For information about additional attributes, see xref:router_configuration_file_listener[Listener] in the _Configuration Reference_.
+For information about additional attributes, see xref:router-configuration-file-listener[Listener] in the _Configuration Reference_.
--
-. If necessary, xref:securing_incoming_connections[secure the connection].
+. If necessary, xref:securing-incoming-connections[secure the connection].
+
If you have set up SSL/TLS or SASL in your environment, you can configure the router to only accept encrypted or authenticated communication on this connection.
. If you want the router to listen for incoming connections on additional hosts or ports, configure an additional `listener` entity for each host and port.
-[[adding_outgoing_connections]]
+[id='adding-outgoing-connections']
== Adding Outgoing Connections
Configuring outgoing connections involves setting the host and port on which the router connects to other routers and brokers.
// Adding this here for now; in the future it might be better to have separate procedures for creating inter-router and route-container connections.
-When a router connects to a broker, the broker might provide backup connection data that the router can use if the primary connection fails. If the primary connection fails, the router attempts to reconnect by using a combination of the primary and -- if provided -- backup connections in round-robin fashion until the connection is successful. For more information about viewing the backup connection data provided by the broker, see xref:managing_connectors[].
+When a router connects to a broker, the broker might provide backup connection data that the router can use if the primary connection fails. If the primary connection fails, the router attempts to reconnect by using a combination of the primary and -- if provided -- backup connections in round-robin fashion until the connection is successful. For more information about viewing the backup connection data provided by the broker, see xref:managing-connectors[].
.Procedure
@@ -80,10 +80,10 @@ connector {
`host`:: Either an IP address (IPv4 or IPv6) or hostname on which the router should connect.
`port`:: The port number or symbolic service name on which the router should connect.
-For information about additional attributes, see xref:router_configuration_file_connector[Connector] in the _Configuration Reference_.
+For information about additional attributes, see xref:router-configuration-file-connector[Connector] in the _Configuration Reference_.
--
-. If necessary, xref:securing_outgoing_connections[secure the connection].
+. If necessary, xref:securing-outgoing-connections[secure the connection].
+
If you have set up SSL/TLS or SASL in your environment, you can configure the router to only send encrypted or authenticated communication on this connection.
http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/f80c40ff/doc/new-book/configuration-reference.adoc
----------------------------------------------------------------------
diff --git a/doc/new-book/configuration-reference.adoc b/doc/new-book/configuration-reference.adoc
index e89a391..1880d93 100644
--- a/doc/new-book/configuration-reference.adoc
+++ b/doc/new-book/configuration-reference.adoc
@@ -17,7 +17,7 @@ specific language governing permissions and limitations
under the License
////
-[[router_configuration_reference]]
+[id='router-configuration-reference']
// This config reference could stand to be cleaned up. Also, some of the introductory content is no longer necessary since it's covered in the introductory chapter about configuration. We should just link to it instead of repeating it here.
@@ -68,7 +68,7 @@ In the above example, the _sslProfile_ section named _ssl-profile-one_ is used t
=== Configuration Sections
-[[router_configuration_file_sslprofile]]
+[id='router-configuration-file-sslprofile']
==== sslProfile
Attributes for setting SSL/TLS configuration for connections.
@@ -84,7 +84,7 @@ Attributes for setting SSL/TLS configuration for connections.
*Used by* : _listener_, _connector_.
-[[router_configuration_file_router]]
+[id='router-configuration-file-router']
==== router
Describe main information about the router related to identity, internal processes and inter routers communication.
@@ -102,7 +102,7 @@ Describe main information about the router related to identity, internal process
* *_saslConfigPath_* (path) : The absolute path to the SASL configuration file.
* *_saslConfigName_* (string, default=`qdrouterd`) : Name of the SASL configuration. This string + ‘.conf’ is the name of the configuration file.
-[[router_configuration_file_listener]]
+[id='router-configuration-file-listener']
==== listener
Listens for incoming connections to the router.
@@ -125,7 +125,7 @@ Listens for incoming connections to the router.
* *_sslProfile_* (string) : The name of the _sslProfile_ entity to use in order to have SSL/TLS configuration.
* *_http_* (boolean): If set to `yes`, the listener will accept HTTP connections using AMQP over WebSockets.
-[[router_configuration_file_connector]]
+[id='router-configuration-file-connector']
==== connector
Establishes an outgoing connection from the router.
@@ -147,7 +147,7 @@ Establishes an outgoing connection from the router.
* *_saslPassword_* (string) : The password that the connector is using to connect to a peer.
* *_sslProfile_* (string) : The name of the _sslProfile_ entity to use in order to have SSL/TLS configuration.
-[[router_configuration_file_log]]
+[id='router-configuration-file-log']
==== log
Configure logging for a particular module which is part of the router. You can use the UPDATE operation to change log settings while the router is running.
@@ -158,7 +158,7 @@ Configure logging for a particular module which is part of the router. You can u
* *_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.
-[[router_configuration_file_address]]
+[id='router-configuration-file-address']
==== address
Entity type for address configuration. This is used to configure the treatment of message-routed deliveries within a particular address-space. The configuration controls distribution and address phasing.
@@ -169,7 +169,7 @@ Entity type for address configuration. This is used to configure the treatment o
* *_ingressPhase_* (integer) : Advanced - Override the ingress phase for this address.
* *_egressPhase_* (integer) : Advanced - Override the egress phase for this address.
-[[router_configuration_file_linkroute]]
+[id='router-configuration-file-linkroute']
==== linkRoute
Entity type for link-route configuration. This is used to identify remote containers that shall be destinations for routed link-attaches. The link-routing configuration applies to an addressing space defined by a prefix.
@@ -180,7 +180,7 @@ Entity type for link-route configuration. This is used to identify remote contai
* *_distribution_* (One of [`linkBalanced`], default=`linkBalanced`) : Treatment of traffic associated with the address.
* *_direction_* (One of [`in`, `out`], required) : The permitted direction of links. It is defined from a router point of view so ‘in’ means client senders (router ingress) and ‘out’ means client receivers (router egress).
-[[router_configuration_file_autolink]]
+[id='router-configuration-file-autolink']
==== autoLink
Entity type for configuring auto-links. Auto-links are links whose lifecycle is managed by the router. These are typically used to attach to waypoints on remote containers (brokers, and so on.).
http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/f80c40ff/doc/new-book/configuration-security.adoc
----------------------------------------------------------------------
diff --git a/doc/new-book/configuration-security.adoc b/doc/new-book/configuration-security.adoc
index f727700..8909d74 100644
--- a/doc/new-book/configuration-security.adoc
+++ b/doc/new-book/configuration-security.adoc
@@ -17,7 +17,7 @@ specific language governing permissions and limitations
under the License
////
-[[security_config]]
+[id='security-config']
= Security
Securing your router network involves configuring authentication and authorization. You can authenticate and encrypt the router's connections using SSL/TLS or SASL. Additionally, you can authorize access to messaging resources by setting user connection restrictions and defining AMQP resource access control.
@@ -29,8 +29,8 @@ You can configure {RouterName} to communicate with clients, routers, and brokers
* _SSL/TLS_ for certificate-based encryption and mutual authentication
* _SASL_ for authentication and payload encryption
-[[setting_up_ssl_for_encryption_and_authentication]]
-=== Setting Up SSL/TLS for Encryption and Authentication
+[id='setting-up-ssl-for-encryption-and-authentication']
+== Setting Up SSL/TLS for Encryption and Authentication
Before you can secure incoming and outgoing connections using SSL/TLS encryption and authentication, you must first set up the SSL/TLS profile in the router's configuration file.
@@ -116,11 +116,11 @@ For example:
password: routerKeyPassword
----
-For information about additional `sslProfile` attributes, see xref:router_configuration_file_sslprofile[_sslProfile_] in the _Configuration Reference_.
+For information about additional `sslProfile` attributes, see xref:router-configuration-file-sslprofile[_sslProfile_] in the _Configuration Reference_.
--
-[[setting_up_sasl_for_authentication_and_payload_encryption]]
-=== Setting Up SASL for Authentication and Payload Encryption
+[id='setting-up-sasl-for-authentication-and-payload-encryption']
+== Setting Up SASL for Authentication and Payload Encryption
If you plan to use SASL to authenticate connections, you must first add the SASL attributes to the `router` entity in the router's configuration file. These attributes define a set of SASL parameters that can be used by the router's incoming and outgoing connections.
@@ -128,8 +128,8 @@ If you plan to use SASL to authenticate connections, you must first add the SASL
Before you can set up SASL, you must have the following:
-* xref:generating_sasl_database[The SASL database is generated.]
-* xref:configuring_sasl_database[The SASL configuration file is configured.]
+* xref:generating-sasl-database[The SASL database is generated.]
+* xref:configuring-sasl-database[The SASL configuration file is configured.]
* The Cyrus SASL plugin is installed for each SASL mechanism you plan to use.
+
Cyrus SASL uses plugins to support specific SASL mechanisms. Before you can use a particular SASL mechanism, the relevant plugin must be installed. For example, you need the `cyrus-sasl-plain` plugin to use SASL PLAIN authentication.
@@ -172,8 +172,8 @@ saslConfigName: qdrouterd_sasl
----
--
-[[securing_incoming_connections]]
-=== Securing Incoming Connections
+[id='securing-incoming-connections']
+== Securing Incoming Connections
You can secure incoming connections by configuring each connection's `listener` entity for encryption, authentication, or both.
@@ -183,13 +183,13 @@ Before securing incoming connections, the security protocols you plan to use sho
.Choices
-* xref:adding_ssl_encryption_to_incoming_connection[Add SSL/TLS encryption]
-* xref:adding_sasl_authentication_to_incoming_connection[Add SASL authentication]
-* xref:adding_ssl_client_authentication_to_incoming_connection[Add SSL/TLS client authentication]
-* xref:adding_sasl_payload_encryption_to_incoming_connection[Add SASL payload encryption]
+* xref:adding-ssl-encryption-to-incoming-connection[Add SSL/TLS encryption]
+* xref:adding-sasl-authentication-to-incoming-connection[Add SASL authentication]
+* xref:adding-ssl-client-authentication-to-incoming-connection[Add SSL/TLS client authentication]
+* xref:adding-sasl-payload-encryption-to-incoming-connection[Add SASL payload encryption]
-[[adding_ssl_encryption_to_incoming_connection]]
-==== Adding SSL/TLS Encryption to an Incoming Connection
+[id='adding-ssl-encryption-to-incoming-connection']
+=== Adding SSL/TLS Encryption to an Incoming Connection
You can configure an incoming connection to accept encrypted connections only. By adding SSL/TLS encryption, to connect to this router, a remote peer must first start an SSL/TLS handshake with the router and be able to validate the server certificate received by the router during the handshake.
@@ -212,8 +212,8 @@ listener {
`requireSsl`:: Enter `yes` to require all clients connecting to the router on this connection to use encryption.
--
-[[adding_sasl_authentication_to_incoming_connection]]
-==== Adding SASL Authentication to an Incoming Connection
+[id='adding-sasl-authentication-to-incoming-connection']
+=== Adding SASL Authentication to an Incoming Connection
You can configure an incoming connection to authenticate the client using SASL. You can use SASL authentication with or without SSL/TLS encryption.
@@ -238,8 +238,8 @@ listener {
For a full list of supported Cyrus SASL authentication mechanisms, see link:https://www.cyrusimap.org/sasl/sasl/authentication_mechanisms.html[Authentication Mechanisms^].
--
-[[adding_ssl_client_authentication_to_incoming_connection]]
-==== Adding SSL/TLS Client Authentication to an Incoming Connection
+[id='adding-ssl-client-authentication-to-incoming-connection']
+=== Adding SSL/TLS Client Authentication to an Incoming Connection
You can configure an incoming connection to authenticate the client using SSL/TLS.
@@ -265,8 +265,8 @@ listener {
`authenticatePeer`:: Set this attribute to `yes` to require the router to authenticate the identity of a remote peer before it can use this incoming connection.
--
-[[adding_sasl_payload_encryption_to_incoming_connection]]
-==== Adding SASL Payload Encryption to an Incoming Connection
+[id='adding-sasl-payload-encryption-to-incoming-connection']
+=== Adding SASL Payload Encryption to an Incoming Connection
If you do not use SSL/TLS, you can still encrypt the incoming connection by using SASL payload encryption.
@@ -291,8 +291,8 @@ listener {
For a full list of supported Cyrus SASL authentication mechanisms, see link:https://www.cyrusimap.org/sasl/sasl/authentication_mechanisms.html[Authentication Mechanisms^].
--
-[[securing_outgoing_connections]]
-=== Securing Outgoing Connections
+[id='securing-outgoing-connections']
+== Securing Outgoing Connections
You can secure outgoing connections by configuring each connection's `connector` entity for encryption, authentication, or both.
@@ -302,11 +302,11 @@ Before securing outgoing connections, the security protocols you plan to use sho
.Choices
-* xref:adding_ssl_authentication_to_outgoing_connection[Add SSL/TLS authentication]
-* xref:adding_sasl_authentication_to_outgoing_connection[Add SASL authentication]
+* xref:adding-ssl-authentication-to-outgoing-connection[Add SSL/TLS authentication]
+* xref:adding-sasl-authentication-to-outgoing-connection[Add SASL authentication]
-[[adding_ssl_authentication_to_outgoing_connection]]
-==== Adding SSL/TLS Client Authentication to an Outgoing Connection
+[id='adding-ssl-authentication-to-outgoing-connection']
+=== Adding SSL/TLS Client Authentication to an Outgoing Connection
If an outgoing connection connects to an external client configured with mutual authentication, you should ensure that the outgoing connection is configured to provide the external client with a valid security certificate during the SSL/TLS handshake.
@@ -328,8 +328,8 @@ connector {
`sslProfile`:: The name of the SSL/TLS profile you set up.
--
-[[adding_sasl_authentication_to_outgoing_connection]]
-==== Adding SASL Authentication to an Outgoing Connection
+[id='adding-sasl-authentication-to-outgoing-connection']
+=== Adding SASL Authentication to an Outgoing Connection
You can configure an outgoing connection to provide authentication credentials to the external container. You can use SASL authentication with or without SSL/TLS encryption.
@@ -355,8 +355,8 @@ For a full list of supported Cyrus SASL authentication mechanisms, see link:http
`saslPassword`:: If any of the SASL mechanisms uses username/password authentication, then provide the password to connect to the external container.
--
-[[integrating_with_kerberos]]
-=== Integrating with Kerberos
+[id='integrating-with-kerberos']
+== Integrating with Kerberos
By using the `GSSAPI` SASL mechanism, you can configure {RouterName} to authenticate incoming connections using Kerberos.
@@ -370,7 +370,7 @@ This is the service principal that {RouterName} uses.
* The `cyrus-sasl-gssapi` package must be installed on each client and router host machine.
-* xref:setting_up_sasl_for_authentication_and_payload_encryption[SASL must be set up for {RouterName}].
+* xref:setting-up-sasl-for-authentication-and-payload-encryption[SASL must be set up for {RouterName}].
.Procedure
@@ -412,7 +412,7 @@ listener {
----
====
-For more information about these attributes, see xref:adding_sasl_authentication_to_incoming_connection[].
+For more information about these attributes, see xref:adding-sasl-authentication-to-incoming-connection[].
--
== Authorizing Access to Messaging Resources
http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/f80c40ff/doc/new-book/cyrus-sasl.adoc
----------------------------------------------------------------------
diff --git a/doc/new-book/cyrus-sasl.adoc b/doc/new-book/cyrus-sasl.adoc
index 6d510d6..cff8fff 100644
--- a/doc/new-book/cyrus-sasl.adoc
+++ b/doc/new-book/cyrus-sasl.adoc
@@ -17,14 +17,14 @@ specific language governing permissions and limitations
under the License
////
-[[cyrus_sasl]]
+[id='cyrus-sasl']
= Using Cyrus SASL to Provide Authentication
// Just doing some basic editing for now; for future releases, this content will need some more work. Also need to determine if it should be moved from an appendix to the section that deals with setting up SASL.
{RouterName} uses the Cyrus SASL library for SASL authentication. Therefore, if you want to use SASL, you must set up the Cyrus SASL database and configure it.
-[[generating_sasl_database]]
+[id='generating-sasl-database']
== Generating a SASL Database
To generate a SASL database to store credentials, enter the following command:
@@ -51,7 +51,7 @@ user2@domain.com: __PASSWORD__
user1@domain.com: __PASSWORD__
----
-[[configuring_sasl_database]]
+[id='configuring-sasl-database']
== Configuring a SASL Database
To use the SASL database to provide authentication in {RouterName}:
http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/f80c40ff/doc/new-book/getting-started.adoc
----------------------------------------------------------------------
diff --git a/doc/new-book/getting-started.adoc b/doc/new-book/getting-started.adoc
index 6c899d2..021dcba 100644
--- a/doc/new-book/getting-started.adoc
+++ b/doc/new-book/getting-started.adoc
@@ -17,12 +17,12 @@ specific language governing permissions and limitations
under the License
////
-[[getting_started]]
+[id='getting-started']
= Getting Started
Before configuring {RouterName}, you should understand how to start the router, how it is configured by default, and how to use it in a simple peer-to-peer configuration.
-[[starting_the_router]]
+[id='starting-the-router']
== Starting the Router
.Procedure
@@ -32,7 +32,7 @@ include::{FragmentDir}/fragment-starting-router-step.adoc[]
+
[NOTE]
====
-You can specify a different configuration file with which to start the router. For more information, see xref:methods_for_changing_router_configuration[_Changing a Router's Configuration_].
+You can specify a different configuration file with which to start the router. For more information, see xref:methods-for-changing-router-configuration[_Changing a Router's Configuration_].
====
+
The router starts, using the default configuration file stored at `/etc/qpid-dispatch/qdrouterd.conf`.
@@ -93,10 +93,10 @@ This example uses a {ClientAmqpPythonName} client to start a receiver client, an
.Procedure
-. xref:starting_the_receiver_client[Start the receiver client].
-. xref:sending_messages[Send messages].
+. xref:starting-the-receiver-client[Start the receiver client].
+. xref:sending-messages[Send messages].
-[[starting_the_receiver_client]]
+[id='starting-the-receiver-client']
=== Starting the Receiver Client
In this example, the receiver client is started first. This means that the messages will be sent as soon as the sender client is started.
@@ -120,7 +120,7 @@ $ python simple_recv.py -a 127.0.0.1:5672/examples -m 5
This command starts the receiver and listens on the default address (`127.0.0.1:5672/examples`). The receiver is also set to receive a maximum of five messages.
--
-[[sending_messages]]
+[id='sending-messages']
=== Sending Messages
After starting the receiver client, you can send messages from the sender. These messages will travel through the router to the receiver.
http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/f80c40ff/doc/new-book/introduction.adoc
----------------------------------------------------------------------
diff --git a/doc/new-book/introduction.adoc b/doc/new-book/introduction.adoc
index 2f2655b..37eb37c 100644
--- a/doc/new-book/introduction.adoc
+++ b/doc/new-book/introduction.adoc
@@ -17,10 +17,10 @@ specific language governing permissions and limitations
under the License
////
-[[introduction]]
+[id='introduction']
= Introduction
-[[overview]]
+[id='overview']
== Overview
The {RouterName} is an AMQP message router that provides
@@ -91,7 +91,7 @@ Messages not delivered to their final destination will not be
acknowledged to the sender and therefore the sender can re-send such
messages if it is disconnected from the network.
-[[benefits]]
+[id='benefits']
== Benefits
Simplifies connectivity
@@ -113,7 +113,7 @@ not server clustering
* Reliable end-to-end messaging without persistent stores
* Use a message broker only when you need store-and-forward semantics
-[[features]]
+[id='features']
== Features
* Can be deployed stand-alone or in a network of routers
http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/f80c40ff/doc/new-book/logging.adoc
----------------------------------------------------------------------
diff --git a/doc/new-book/logging.adoc b/doc/new-book/logging.adoc
index f28a7a1..465f71c 100644
--- a/doc/new-book/logging.adoc
+++ b/doc/new-book/logging.adoc
@@ -17,14 +17,14 @@ specific language governing permissions and limitations
under the License
////
-[[logging]]
+[id='logging']
= Logging
Logging enables you to diagnose error and performance issues with {RouterName}.
{RouterName} consists of internal modules that provide important information about the router. For each module, you can specify logging levels, the format of the log file, and the location to which the logs should be written.
-[[logging_modules_you_can_configure]]
+[id='logging-modules-you-can-configure']
== Logging Modules
{RouterName} logs are broken into different categories called _logging modules_. Each module provides important information about a particular aspect of {RouterName}.
@@ -254,7 +254,7 @@ Tue Jun 7 15:07:32 2016 POLICY (info) Policy configured maximumConnections: 0,
Tue Jun 7 15:07:32 2016 POLICY (info) Policy fallback defaultApplication is disabled
----
-[[configure_default_logging]]
+[id='configure-default-logging']
== Configuring Logging
You can specify the types of events that should be logged, the format of the log entries, and where those entries should be sent.
@@ -291,7 +291,7 @@ To specify multiple levels, use a comma-separated list. You can also use `+` to
//end::logging-levels[]
`timestamp`:: Set this to `yes` to include the timestamp in all logs.
-For information about additional log attributes, see xref:router_configuration_file_log[Log] in the _Configuration Reference_.
+For information about additional log attributes, see xref:router-configuration-file-log[Log] in the _Configuration Reference_.
--
. Add an additional `log` section for each logging module that should not follow the default logging configuration:
@@ -307,12 +307,12 @@ log {
}
----
-`module`:: The name of the module for which you are configuring logging. For a list of valid modules, see xref:logging_modules_you_can_configure[Logging Modules You Can Configure].
+`module`:: The name of the module for which you are configuring logging. For a list of valid modules, see xref:logging-modules-you-can-configure[].
`enable`:: The logging level. You can specify any of the following levels (from lowest to highest):
+
include::logging.adoc[tags=logging-levels]
-For information about additional log attributes, see xref:router_configuration_file_log[Log] in the _Configuration Reference_.
+For information about additional log attributes, see xref:router-configuration-file-log[Log] in the _Configuration Reference_.
--
== Viewing Log Entries
http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/f80c40ff/doc/new-book/managing-using-qdmanage.adoc
----------------------------------------------------------------------
diff --git a/doc/new-book/managing-using-qdmanage.adoc b/doc/new-book/managing-using-qdmanage.adoc
index 1f3dcf1..ddf8648 100644
--- a/doc/new-book/managing-using-qdmanage.adoc
+++ b/doc/new-book/managing-using-qdmanage.adoc
@@ -17,7 +17,7 @@ specific language governing permissions and limitations
under the License
////
-[[managing_router]]
+[id='managing-router']
= Managing {RouterName} Using `qdmanage`
You can use `qdmanage` to view and modify the configuration of a running router at runtime. Specifically, `qdmanage` enables you to create, read, update, and delete the sections and attributes in the router's configuration file without having to restart the router.
@@ -85,7 +85,7 @@ You can use `qdmanage` to view, create, update, and delete listeners and connect
Listeners define how clients can connect to a router. The following table lists the `qdmanage` commands you can use to perform common operations on listeners.
-For more information about the attributes you can use with these commands, see the xref:router_configuration_file_listener[listener] section in the _Configuration Reference_.
+For more information about the attributes you can use with these commands, see the xref:router-configuration-file-listener[listener] section in the _Configuration Reference_.
//tag::qdmanage-connection-options-note[]
[NOTE]
@@ -183,12 +183,12 @@ qdmanage delete --name=_LISTENER_NAME_
|===
-[[managing_connectors]]
+[id='managing-connectors']
=== Managing Connectors
Connectors define how the router can connect to other endpoints in your messaging network, such as brokers and other routers. The following table lists the `qdmanage` commands you can use to perform common operations on connectors.
-For more information about the attributes you can use with these commands, see the xref:router_configuration_file_connector[connector] section in the _Configuration Reference_.
+For more information about the attributes you can use with these commands, see the xref:router-configuration-file-connector[connector] section in the _Configuration Reference_.
// Note about qdmanage connection options.
include::managing-using-qdmanage.adoc[tags=qdmanage-connection-options-note]
@@ -297,7 +297,7 @@ qdmanage delete --name=_CONNECTOR_NAME_
{RouterName} supports SSL/TLS for certificate-level encryption and mutual authentication. The following table lists the common `qdmanage` commands you can use to secure incoming and outgoing connections for a router in your router network.
-For more information about the attributes you can use with these commands, see the xref:router_configuration_file_sslprofile[sslProfile] and xref:router_configuration_file_listener[listener] sections in the _Configuration Reference_.
+For more information about the attributes you can use with these commands, see the xref:router-configuration-file-sslprofile[sslProfile] and xref:router-configuration-file-listener[listener] sections in the _Configuration Reference_.
// Note about qdmanage connection options.
include::managing-using-qdmanage.adoc[tags=qdmanage-connection-options-note]
@@ -375,7 +375,7 @@ qdmanage delete --name=_SSL_PROFILE_NAME_
{RouterName} supports SASL for authentication and payload encryption. The following table lists the common `qdmanage` commands you can use to secure incoming and outgoing connections for a router in your router network.
-For more information about the attributes you can use with these commands, see the xref:router_configuration_file_router[router] and xref:router_configuration_file_listener[listener] sections in the _Configuration Reference_.
+For more information about the attributes you can use with these commands, see the xref:router-configuration-file-router[router] and xref:router-configuration-file-listener[listener] sections in the _Configuration Reference_.
// Note about qdmanage connection options.
include::managing-using-qdmanage.adoc[tags=qdmanage-connection-options-note]
@@ -457,7 +457,7 @@ qdmanage update --type=router --saslConfigPath --saslConfigName
Message routing involves configuring addresses to define how {RouterName} should distribute messages. The following table lists the common `qdmanage` commands you can use to configure addresses for a router in your router network.
-For more information about the attributes you can use with these commands, see the xref:router_configuration_file_address[address] and xref:router_configuration_file_autolink[autoLink] sections in the _Configuration Reference_.
+For more information about the attributes you can use with these commands, see the xref:router-configuration-file-address[address] and xref:router-configuration-file-autolink[autoLink] sections in the _Configuration Reference_.
// Note about qdmanage connection options.
include::managing-using-qdmanage.adoc[tags=qdmanage-connection-options-note]
@@ -574,7 +574,7 @@ qdmanage delete --name=_AUTOLINK_NAME_
A link route is a chain of links between a sender and receiver that provides a private messaging path. The following table lists the common `qdmanage` commands you can use to view, create, update, and delete link routes.
-For more information about the attributes you can use with these commands, see the xref:router_configuration_file_linkroute[linkRoute] section in the _Configuration Reference_.
+For more information about the attributes you can use with these commands, see the xref:router-configuration-file-linkroute[linkRoute] section in the _Configuration Reference_.
// Note about qdmanage connection options.
include::managing-using-qdmanage.adoc[tags=qdmanage-connection-options-note]
@@ -632,7 +632,7 @@ qdmanage delete --name=_OUTGOING_LINK_ROUTE_NAME_
{RouterName} logs are broken into different categories called logging modules. Each module provides important information about a particular aspect of a router. The following table lists the common `qdmanage` commands you can use to view and change the configuration of a logging module.
-For more information about the attributes you can use with these commands, see the xref:router_configuration_file_log[log] section in the _Configuration Reference_.
+For more information about the attributes you can use with these commands, see the xref:router-configuration-file-log[log] section in the _Configuration Reference_.
// Note about qdmanage connection options.
include::managing-using-qdmanage.adoc[tags=qdmanage-connection-options-note]
http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/f80c40ff/doc/new-book/monitoring-using-qdstat.adoc
----------------------------------------------------------------------
diff --git a/doc/new-book/monitoring-using-qdstat.adoc b/doc/new-book/monitoring-using-qdstat.adoc
index 2f31327..c0b1c64 100644
--- a/doc/new-book/monitoring-using-qdstat.adoc
+++ b/doc/new-book/monitoring-using-qdstat.adoc
@@ -17,7 +17,7 @@ specific language governing permissions and limitations
under the License
////
-[[monitoring_using_qdstat]]
+[id='monitoring-using-qdstat']
= Monitoring {RouterName} Using `qdstat`
You can use `qdstat` to view the status of routers on your router network. For example, you can view information about the attached links and configured addresses, available connections, and nodes in the router network.
@@ -95,7 +95,7 @@ You can view:
$ qdstat -c [__CONNECTION_OPTIONS__]
----
-For more information about the fields displayed by this command, see link:https://qpid.apache.org/releases/qpid-dispatch-0.8.0/man/qdstat.html#_qdstat_c[the qdstat -c output columns].
+For more information about the fields displayed by this command, see link:{qdstatManPageUrl}#_qdstat_c[the qdstat -c output columns^].
In this example, two clients are connected to `Router.A`. `Router.A` is connected to `Router.B` and a broker.
@@ -144,7 +144,7 @@ You can view a list of AMQP links attached to the router from clients (sender/re
$ qdstat -l [__CONNECTION_OPTIONS__]
----
-For more information about the fields displayed by this command, see link:https://qpid.apache.org/releases/qpid-dispatch-0.8.0/man/qdstat.html#_qdstat_l[the qdstat -l output columns].
+For more information about the fields displayed by this command, see link:{qdstatManPageUrl}#_qdstat_l[the qdstat -l output columns^].
In this example, `Router.A` is connected to both `Router.B` and a broker. A link route is configured for the `my_queue` queue and waypoint (with autolinks), and for the `my_queue_wp` queue on the broker. In addition, there is a receiver connected to `my_address` (message routing based), another to `my_queue`, and the a third one to `my_queue_wp`.
@@ -193,7 +193,7 @@ To see the topology of the router network, you can view known routers on the net
$ qdstat -n [__CONNECTION_OPTIONS__]
----
-For more information about the fields displayed by this command, see link:https://qpid.apache.org/releases/qpid-dispatch-0.8.0/man/qdstat.html#_qdstat_n[the qdstat -n output columns].
+For more information about the fields displayed by this command, see link:{qdstatManPageUrl}#_qdstat_n[the qdstat -n output columns^].
In this example, `Router.A` is connected to `Router.B`, which is connected to `Router.C`. Viewing the router topology on `Router.A` shows the following:
@@ -258,7 +258,7 @@ You can view message-routed and link-routed addresses known to a router.
$ qdstat -a [__CONNECTION_OPTIONS__]
----
-For more information about the fields displayed by this command, see link:https://qpid.apache.org/releases/qpid-dispatch-0.8.0/man/qdstat.html#_qdstat_a[the qdstat -a output columns].
+For more information about the fields displayed by this command, see link:{qdstatManPageUrl}#_qdstat_a[the qdstat -a output columns^].
In this example, `Router.A` is connected to both `Router.B` and a broker. The broker has two queues:
@@ -313,7 +313,7 @@ You can view a list of the autolinks that are associated with waypoint addresses
$ qdstat --autolinks [__CONNECTION_OPTIONS__]
----
-For more information about the fields displayed by this command, see link:https://qpid.apache.org/releases/qpid-dispatch-0.8.0/man/qdstat.html#_qdstat_autolinks[the qdstat --autolinks output columns].
+For more information about the fields displayed by this command, see link:{qdstatManPageUrl}#_qdstat_autolinks[the qdstat --autolinks output columns^].
In this example, a router is connected to a broker. The broker has a queue called `my_queue_wp`, to which the router is configured with a waypoint and autolinks. Viewing the autolinks displays the following:
@@ -344,7 +344,7 @@ You can view the status of each incoming and outgoing link route.
$ qdstat --linkroutes [__CONNECTION_OPTIONS__]
----
-For more information about the fields displayed by this command, see link:https://qpid.apache.org/releases/qpid-dispatch-0.8.0/man/qdstat.html#_qdstat_linkroutes[the qdstat --linkroutes output columns].
+For more information about the fields displayed by this command, see link:{qdstatManPageUrl}#_qdstat_linkroutes[the qdstat --linkroutes output columns^].
In this example, a router is connected to a broker. The router is configured with a link route to the `my_queue` queue on the broker. Viewing the link routes displays the following:
http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/f80c40ff/doc/new-book/reliability.adoc
----------------------------------------------------------------------
diff --git a/doc/new-book/reliability.adoc b/doc/new-book/reliability.adoc
index 61ffa7b..442cc18 100644
--- a/doc/new-book/reliability.adoc
+++ b/doc/new-book/reliability.adoc
@@ -17,7 +17,7 @@ specific language governing permissions and limitations
under the License
////
-[[reliability]]
+[id='reliability']
= Reliability
////
http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/f80c40ff/doc/new-book/routing.adoc
----------------------------------------------------------------------
diff --git a/doc/new-book/routing.adoc b/doc/new-book/routing.adoc
index 243df10..a7f5fc1 100644
--- a/doc/new-book/routing.adoc
+++ b/doc/new-book/routing.adoc
@@ -17,7 +17,7 @@ specific language governing permissions and limitations
under the License
////
-[[routing]]
+[id='routing']
= Routing
Routing is the process by which messages are delivered to their destinations. To accomplish this, {RouterName} provides two routing mechanisms: _message routing_ and _link routing_.
@@ -132,7 +132,7 @@ When a router receives a message, it uses the message's address to determine whe
// Need to add something here about the difference between discovered vs. configured mobile addresses so that it's clear that with message routing, the router can either be proactive or reactive in the way it routes messages.
-[[routing_patterns_overview]]
+[id='routing-patterns-overview']
=== Routing Patterns
Each address has one of the following routing patterns, which define the path that a message with the address can take across the messaging network:
@@ -192,7 +192,7 @@ This means that the message did not reach its destination.
This means that the message might or might not have reached its destination. The delivery is considered to be "in-doubt" and should be re-sent if "at least once" delivery is required.
* The link, session, or connection to {RouterName} was dropped, and all deliveries are "in-doubt".
-[[routing_messages_between_clients]]
+[id='routing-messages-between-clients']
=== Routing Messages Between Clients
You can route messages between clients without using a broker. In a brokerless scenario (sometimes called _direct-routed messaging_), {RouterName} routes messages between clients directly.
@@ -246,16 +246,16 @@ You can convert a `prefix` value to a `pattern` by appending `/\#` to it. For ex
* `closest` - Messages sent to the address are sent on the shortest path to reach the destination. It means that if there are multiple receivers for the same address, only the closest one will receive the message.
* `multicast` - Messages are sent to all receivers that are attached to the address in a _publish/subscribe_ model.
+
-For more information about message distribution patterns, see xref:routing_patterns_overview[Routing Patterns].
+For more information about message distribution patterns, see xref:routing-patterns-overview[Routing Patterns].
-For information about additional attributes, see xref:router_configuration_file_address[Address] in the _Configuration Reference_.
+For information about additional attributes, see xref:router-configuration-file-address[Address] in the _Configuration Reference_.
--
. Add the same `address` section to any other routers that need to use the address.
+
The `address` that you added to this router configuration file only controls how this router distributes messages sent to the address. If you have additional routers in your router network that should distribute messages for this address, then you must add the same `address` section to each of their configuration files.
-[[routing_messages_through_broker]]
+[id='routing-messages-through-broker']
=== Routing Messages Through a Broker Queue
You can route messages to and from a broker queue to provide clients with access to the queue through a router. In this scenario, clients connect to a router to send and receive messages, and the router routes the messages to or from the broker queue.
@@ -276,23 +276,23 @@ In this diagram, a sharded queue (my_queue) is distributed across two brokers. T
.Procedure
-. xref:configure_waypoint_address[Add a waypoint address].
+. xref:configure-waypoint-address[Add a waypoint address].
+
This address identifies the queue to which you want to route messages.
-. xref:connect_router_to_broker[Add autolinks to connect the router to the broker].
+. xref:connect-router-to-broker[Add autolinks to connect the router to the broker].
+
Autolinks connect the router to the broker queue identified by the waypoint address.
-. xref:connect_router_to_broker[If the queue is sharded, add autolinks for each additional broker that hosts a shard].
+. xref:connect-router-to-broker[If the queue is sharded, add autolinks for each additional broker that hosts a shard].
-[[configure_waypoint_address]]
+[id='configure-waypoint-address']
==== Configuring Waypoint Addresses
A waypoint address identifies a queue on a broker to which you want to route messages. You need to configure the waypoint address on each router that needs to use the address. For example, if a client is connected to _Router A_ to send messages to the broker queue, and another client is connected to _Router B_ to receive those messages, then you would need to configure the waypoint address on both _Router A_ and _Router B_.
.Prerequisites
-An incoming connection (`listener`) to which the clients can connect should be configured. This connection defines how the producers and consumers connect to the router to send and receive messages. For more information, see xref:adding_incoming_connections[Adding Incoming Connections].
+An incoming connection (`listener`) to which the clients can connect should be configured. This connection defines how the producers and consumers connect to the router to send and receive messages. For more information, see xref:adding-incoming-connections[Adding Incoming Connections].
// Does the broker queue have to exist before you create the waypoint address? If it doesn't exist, will you get an error?
@@ -318,7 +318,7 @@ include::routing.adoc[tags=pattern-matching]
`waypoint`:: Set this attribute to `yes` so that the router handles messages sent to this address as a waypoint.
--
-[[connect_router_to_broker]]
+[id='connect-router-to-broker']
==== Connecting a Router to the Broker
After you add waypoint addresses to identify the broker queue, you must connect a router to the broker using autolinks.
@@ -346,7 +346,7 @@ connector {
`port`:: The port number or symbolic service name on which the router should connect to the broker.
`role`:: Specify `route-container` to indicate that this connection is for an external container (broker).
-For information about additional attributes, see xref:router_configuration_file_connector[Connector] in the _Configuration Reference_.
+For information about additional attributes, see xref:router-configuration-file-connector[Connector] in the _Configuration Reference_.
--
. If you want to send messages to the broker queue, create an outgoing autolink to the broker queue:
@@ -367,7 +367,7 @@ autoLink {
`connection` | `containerID`:: How the router should connect to the broker. You can specify either an outgoing connection (`connection`) or the container ID of the broker (`containerID`).
`direction`:: Set this attribute to `out` to specify that this autolink can send messages from the router to the broker.
-For information about additional attributes, see xref:router_configuration_file_autolink[autoLink] in the _Configuration Reference_.
+For information about additional attributes, see xref:router-configuration-file-autolink[autoLink] in the _Configuration Reference_.
--
. If you want to receive messages from the broker queue, create an incoming autolink from the broker queue:
@@ -388,7 +388,7 @@ autoLink {
`connection` | `containerID`:: How the router should connect to the broker. You can specify either an outgoing connection (`connection`) or the container ID of the broker (`containerID`).
`direction`:: Set this attribute to `in` to specify that this autolink can receive messages from the broker to the router.
-For information about additional attributes, see xref:router_configuration_file_autolink[autoLink] in the _Configuration Reference_.
+For information about additional attributes, see xref:router-configuration-file-autolink[autoLink] in the _Configuration Reference_.
--
=== Example: Routing Messages Through Broker Queues
@@ -544,7 +544,7 @@ Unlike message routing, with link routing, the sender and receiver handle flow c
// What additional information do we need to provide about AMQP link flow control options? Since this is handled on the client side for link routing, should we provide a simple example with a client program that implements link flow control?
-[[creating_link_route]]
+[id='creating-link-route']
=== Creating a Link Route
Link routes establish a link between a sender and a receiver that travels through a router. You can configure inward and outward link routes to enable the router to receive link-attaches from clients and to send them to a particular destination.
@@ -572,7 +572,7 @@ connector {
`port`:: The port number or symbolic service name on which the router should connect to the broker.
`role`:: Specify `route-container` to indicate that this connection is for an external container (broker).
-For information about additional attributes, see xref:router_configuration_file_connector[Connector] in the _Configuration Reference_.
+For information about additional attributes, see xref:router-configuration-file-connector[Connector] in the _Configuration Reference_.
--
. If you want clients to send messages on this link route, create an incoming link route:
@@ -600,7 +600,7 @@ If multiple brokers are connected to the router through this connection, request
`direction`:: Set this attribute to `in` to specify that clients can send messages into the router network on this link route.
-For information about additional attributes, see xref:router_configuration_file_linkroute[linkRoute] in the _Configuration Reference_.
+For information about additional attributes, see xref:router-configuration-file-linkroute[linkRoute] in the _Configuration Reference_.
--
. If you want clients to receive messages on this link route, create an outgoing link route:
@@ -627,7 +627,7 @@ include::routing.adoc[tags=pattern-matching]
If multiple brokers are connected to the router through this connection, requests for addresses matching the link route's prefix or pattern are balanced across the brokers. Alternatively, if you want to specify a particular broker, use `containerID` and add the broker's container ID.
`direction`:: Set this attribute to `out` to specify that this link route is for receivers.
-For information about additional attributes, see xref:router_configuration_file_linkroute[linkRoute] in the _Configuration Reference_.
+For information about additional attributes, see xref:router-configuration-file-linkroute[linkRoute] in the _Configuration Reference_.
--
=== Example: Using a Link Route to Provide Client Isolation
http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/f80c40ff/doc/new-book/technical-details-specifications.adoc
----------------------------------------------------------------------
diff --git a/doc/new-book/technical-details-specifications.adoc b/doc/new-book/technical-details-specifications.adoc
index 2f1cc59..4a57d32 100644
--- a/doc/new-book/technical-details-specifications.adoc
+++ b/doc/new-book/technical-details-specifications.adoc
@@ -17,10 +17,10 @@ specific language governing permissions and limitations
under the License
////
-[[technical_details_specifications]]
+[id='technical-details-specifications']
= Technical Details and Specifications
-[[client_compatibility]]
+[id='client-compatibility']
== Client Compatibility
{RouterName} should, in theory, work with any client that is
@@ -39,14 +39,14 @@ connection option.
|Proton Messenger |Messenger works with {RouterName}.
|=======================================================================
-[[amqp_mapping]]
+[id='amqp-mapping']
== AMQP Mapping
{RouterName} is an AMQP router and as such, it provides extensions,
code-points, and semantics for routing over AMQP. This page documents the
details of {RouterName}'s use of AMQP.
-[[message_annotations]]
+[id='message-annotations']
=== Message Annotations
The following Message Annotation fields are defined by {RouterName}:
@@ -75,7 +75,7 @@ for routing the message.
flowing between routers.
|=======================================================================
-[[sourcetarget_capabilities]]
+[id='sourcetarget-capabilities']
=== Source/Target Capabilities
The following Capability values are used in Sources and Targets.
@@ -93,7 +93,7 @@ link used for user messages being message-routed across an inter-router
connection.
|=======================================================================
-[[dynamic_node_properties]]
+[id='dynamic-node-properties']
=== Dynamic-Node-Properties
The following dynamic-node-properties are used by {RouterName} in Sources.
@@ -108,13 +108,13 @@ address to route the dynamic link attach to the proper destination
container.
|=======================================================================
-[[addresses_and_address_formats]]
+[id='addresses-and-address-formats']
=== Addresses and Address Formats
The following AMQP addresses and address patterns are used within
{RouterName}.
-[[address_patterns]]
+[id='address-patterns']
==== Address Patterns
[width="100%",cols="38%,62%",options="header",]
@@ -143,7 +143,7 @@ to determine which router nodes are valid destinations for mobile
addresses.
|=======================================================================
-[[supported_addresses]]
+[id='supported-addresses']
==== Supported Addresses
[width="100%",cols="36%,64%",options="header",]
@@ -172,7 +172,7 @@ indicated router. This address form is used by a router to communicate
with a specific router that may or may not be a neighbor.
|=======================================================================
-[[implementation_of_the_amqp_management_specification]]
+[id='implementation-of-the-amqp-management-specification']
=== Implementation of the AMQP Management Specification
{RouterName} is manageable remotely via AMQP. It is compliant with the
http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/f80c40ff/doc/new-book/understand-router-configuration.adoc
----------------------------------------------------------------------
diff --git a/doc/new-book/understand-router-configuration.adoc b/doc/new-book/understand-router-configuration.adoc
index 011bff8..3191a97 100644
--- a/doc/new-book/understand-router-configuration.adoc
+++ b/doc/new-book/understand-router-configuration.adoc
@@ -17,7 +17,7 @@ specific language governing permissions and limitations
under the License
////
-[[router_configuration]]
+[id='router-configuration']
= Configuration
Before starting {RouterName}, you should understand where the router's configuration file is stored, how the file is structured, and the methods you can use to modify it.
@@ -51,16 +51,16 @@ sectionName {
}
----
-[[methods_for_changing_router_configuration]]
+[id='methods-for-changing-router-configuration']
== Changing a Router's Configuration
You can use different methods for changing a router's configuration based on whether the router is currently running, and whether you want the change to take effect immediately.
.Choices
-* xref:making_permanent_change_to_router_configuration[Make a permanent change to the router's configuration].
-* xref:changing_configuration_for_running_router[Change the configuration for a running router.]
+* xref:making-permanent-change-to-router-configuration[Make a permanent change to the router's configuration].
+* xref:changing-configuration-for-running-router[Change the configuration for a running router.]
-[[making_permanent_change_to_router_configuration]]
+[id='making-permanent-change-to-router-configuration']
=== Making a Permanent Change to the Router's Configuration
You can make a permanent change to the router's configuration by editing the router's configuration file directly. You must restart the router for the changes to take effect, but the changes will be saved even if the router is stopped.
@@ -81,7 +81,7 @@ If you created a new configuration file, you must specify the path using the `--
# qdrouterd -d --conf /etc/qpid-dispatch/new-configuration-file.conf
----
-[[changing_configuration_for_running_router]]
+[id='changing-configuration-for-running-router']
=== Changing the Configuration for a Running Router
If the router is running, you can change its configuration on the fly. The changes you make take effect immediately, but are lost if the router is stopped.
@@ -90,7 +90,7 @@ If the router is running, you can change its configuration on the fly. The chang
* Use `qdmanage` to change the configuration.
+
-For more information about using `qdmanage`, see xref:managing_router[Managing {RouterName} Using _qdmanage_].
+For more information about using `qdmanage`, see xref:managing-router[Managing {RouterName} Using _qdmanage_].
== Default Configuration Settings
@@ -178,29 +178,29 @@ router {
* `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.
-For information about additional attributes, see xref:router_configuration_file_router[Router] in the _Configuration Reference_.
+For information about additional attributes, see xref:router-configuration-file-router[Router] in the _Configuration Reference_.
--
. If necessary for your environment, secure the router.
+
--
-* xref:setting_up_ssl_for_encryption_and_authentication[Set up SSL/TLS for encryption, authentication, or both]
-* xref:setting_up_sasl_for_authentication_and_payload_encryption[Set up SASL for authentication and payload encryption]
+* xref:setting-up-ssl-for-encryption-and-authentication[Set up SSL/TLS for encryption, authentication, or both]
+* xref:setting-up-sasl-for-authentication-and-payload-encryption[Set up SASL for authentication and payload encryption]
--
. Connect the router to other routers, clients, and brokers.
+
--
-* xref:adding_incoming_connections[Add incoming connections]
-* xref:adding_outgoing_connections[Add outgoing connections]
+* xref:adding-incoming-connections[Add incoming connections]
+* xref:adding-outgoing-connections[Add outgoing connections]
--
. Set up routing for your environment:
+
--
-* xref:routing_messages_between_clients[Configure the router to route messages between clients directly]
-* xref:routing_messages_through_broker[Configure the router to route messages through a broker queue]
-* xref:creating_link_route[Create a link route to define a private messaging path between endpoints]
+* xref:routing-messages-between-clients[Configure the router to route messages between clients directly]
+* xref:routing-messages-through-broker[Configure the router to route messages through a broker queue]
+* xref:creating-link-route[Create a link route to define a private messaging path between endpoints]
--
. xref:logging[Set up logging].
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org