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 2019/09/04 19:53:21 UTC
[qpid-dispatch] branch master updated: DISPATCH-1396 - Add starting
router procedure. This closes #548
This is an automated email from the ASF dual-hosted git repository.
gmurthy pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/qpid-dispatch.git
The following commit(s) were added to refs/heads/master by this push:
new 03a1734 DISPATCH-1396 - Add starting router procedure. This closes #548
03a1734 is described below
commit 03a1734a532f76f02383c9482a8ed7dfc0947862
Author: Ben Hardesty <bh...@redhat.com>
AuthorDate: Mon Aug 12 16:39:56 2019 -0400
DISPATCH-1396 - Add starting router procedure. This closes #548
---
... => fragment-start-router-service-command.adoc} | 8 +--
....adoc => fragment-systemd-limitnofile-fmi.adoc} | 11 +---
.../user-guide/assemblies/getting-started.adoc | 2 +-
docs/books/user-guide/book.adoc | 1 +
...ecting-using-mutual-ssl-tls-authentication.adoc | 2 +-
...r.adoc => starting-router-getting-started.adoc} | 23 +++++----
.../books/user-guide/modules/starting-routers.adoc | 60 ++++++++++++++++++++++
7 files changed, 78 insertions(+), 29 deletions(-)
diff --git a/docs/books/_common/fragment-starting-router-step.adoc b/docs/books/_common/fragment-start-router-service-command.adoc
similarity index 83%
copy from docs/books/_common/fragment-starting-router-step.adoc
copy to docs/books/_common/fragment-start-router-service-command.adoc
index 22142ac..ca15a99 100644
--- a/docs/books/_common/fragment-starting-router-step.adoc
+++ b/docs/books/_common/fragment-start-router-service-command.adoc
@@ -17,13 +17,7 @@ specific language governing permissions and limitations
under the License
////
-. To start the router, use the *`qdrouterd`* command.
-+
---
-This example uses the default configuration to start the router as a daemon:
-
[source,bash,options="nowrap"]
----
-$ qdrouterd -d
+$ systemctl start qdrouterd.service
----
---
\ No newline at end of file
diff --git a/docs/books/_common/fragment-starting-router-step.adoc b/docs/books/_common/fragment-systemd-limitnofile-fmi.adoc
similarity index 79%
rename from docs/books/_common/fragment-starting-router-step.adoc
rename to docs/books/_common/fragment-systemd-limitnofile-fmi.adoc
index 22142ac..3062644 100644
--- a/docs/books/_common/fragment-starting-router-step.adoc
+++ b/docs/books/_common/fragment-systemd-limitnofile-fmi.adoc
@@ -17,13 +17,4 @@ specific language governing permissions and limitations
under the License
////
-. To start the router, use the *`qdrouterd`* command.
-+
---
-This example uses the default configuration to start the router as a daemon:
-
-[source,bash,options="nowrap"]
-----
-$ qdrouterd -d
-----
---
\ No newline at end of file
+For more information, see the `systemd.exec(5)` man page.
diff --git a/docs/books/user-guide/assemblies/getting-started.adoc b/docs/books/user-guide/assemblies/getting-started.adoc
index 019c05f..c1e325a 100644
--- a/docs/books/user-guide/assemblies/getting-started.adoc
+++ b/docs/books/user-guide/assemblies/getting-started.adoc
@@ -33,7 +33,7 @@ include::modules/installing-router.adoc[leveloffset=+1]
include::modules/viewing-default-router-configuration-file.adoc[leveloffset=+1]
// Starting the router
-include::modules/starting-router.adoc[leveloffset=+1]
+include::modules/starting-router-getting-started.adoc[leveloffset=+1]
// Sending some test messages
include::modules/sending-test-messages.adoc[leveloffset=+1]
diff --git a/docs/books/user-guide/book.adoc b/docs/books/user-guide/book.adoc
index bb22571..d291db5 100644
--- a/docs/books/user-guide/book.adoc
+++ b/docs/books/user-guide/book.adoc
@@ -40,6 +40,7 @@ include::routing.adoc[leveloffset=+1]
[id="monitoring-managing-router-network"]
== Monitoring and managing the router network
+include::modules/starting-routers.adoc[leveloffset=+2]
include::logging.adoc[leveloffset=+2]
include::using-console.adoc[leveloffset=+2]
include::monitoring-using-qdstat.adoc[leveloffset=+2]
diff --git a/docs/books/user-guide/modules/connecting-using-mutual-ssl-tls-authentication.adoc b/docs/books/user-guide/modules/connecting-using-mutual-ssl-tls-authentication.adoc
index 6bc9e05..6d2b698 100644
--- a/docs/books/user-guide/modules/connecting-using-mutual-ssl-tls-authentication.adoc
+++ b/docs/books/user-guide/modules/connecting-using-mutual-ssl-tls-authentication.adoc
@@ -33,7 +33,7 @@ You can connect to an external AMQP container (such as a broker) using mutual SS
* A security certificate must be generated for the router and be signed by the CA.
.Procedure
-
+{FragmentDir}
include::{FragmentDir}/fragment-router-open-config-file-step.adoc[]
. If the router does not contain an `sslProfile` that defines the private keys and certificates to connect to the external AMQP container, then add one.
diff --git a/docs/books/user-guide/modules/starting-router.adoc b/docs/books/user-guide/modules/starting-router-getting-started.adoc
similarity index 92%
rename from docs/books/user-guide/modules/starting-router.adoc
rename to docs/books/user-guide/modules/starting-router-getting-started.adoc
index c101a37..4b9b919 100644
--- a/docs/books/user-guide/modules/starting-router.adoc
+++ b/docs/books/user-guide/modules/starting-router-getting-started.adoc
@@ -21,30 +21,32 @@ under the License
//
// getting-started.adoc
-[id='starting-router-{context}']
+[id='starting-router-getting-started-{context}']
= Starting the router
After installing {RouterName}, you start the router by using the `qdrouterd` command.
.Procedure
-// Step 1 for starting the router.
-include::{FragmentDir}/fragment-starting-router-step.adoc[]
-+
-The router starts, using the default configuration file stored at `/etc/qpid-dispatch/qdrouterd.conf`.
-
-. View the log to verify the router status:
+. Start the router:
+
+--
[source,bash,options="nowrap"]
----
-$ qdstat --log
+$ qdrouterd
----
+
+The router starts, using the default configuration file stored at `/etc/qpid-dispatch/qdrouterd.conf`.
+--
+
+. Review the `qdrouterd` command output to verify the router status.
+
+--
This example shows that the router was correctly installed, is running, and is ready to route traffic between clients:
-+
+
[options="nowrap"]
----
-$ qdstat --log
+$ qdrouterd
Fri May 20 09:38:03 2017 SERVER (info) Container Name: Router.A
Fri May 20 09:38:03 2017 ROUTER (info) Router started in Standalone mode
Fri May 20 09:38:03 2017 ROUTER (info) Router Core thread running. 0/Router.A
@@ -59,6 +61,7 @@ Fri May 20 09:38:03 2017 POLICY (info) Policy configured maximumConnections: 0,
Fri May 20 09:38:03 2017 POLICY (info) Policy fallback defaultApplication is disabled
Fri May 20 09:38:03 2017 SERVER (info) Operational, 4 Threads Running
----
+--
.Additional resources
diff --git a/docs/books/user-guide/modules/starting-routers.adoc b/docs/books/user-guide/modules/starting-routers.adoc
new file mode 100644
index 0000000..2a6edff
--- /dev/null
+++ b/docs/books/user-guide/modules/starting-routers.adoc
@@ -0,0 +1,60 @@
+////
+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
+////
+
+[id='starting-router-{context}']
+= Starting a router
+
+You use the `qdrouterd` command to start a router. You can start a router in the foreground, the background, or as a service.
+
+.Procedure
+
+* Do one of the following:
++
+--
+[cols="30,70"]
+|===
+| To... | Enter this command...
+
+| Start the router in the foreground
+a|
+[source,bash,options="nowrap"]
+----
+$ qdrouterd
+----
+
+| Start the router in the background as a daemon
+a|
+[source,bash,options="nowrap"]
+----
+$ qdrouterd -d
+----
+
+| Start the router as a service
+a|
+include::{FragmentDir}/fragment-start-router-service-command.adoc[]
+
+[NOTE]
+====
+If you start the router as a service, the `systemd` `LimitNOFILE` limit affects the number of connections that can be open for the router. If you reach the limit, the router is not able to accept any more connections, and an error message is logged indicating "Too many open files". To avoid reaching this limit, increase the `LimitNOFILE` value for the `systemd` process.
+
+include::{FragmentDir}/fragment-systemd-limitnofile-fmi.adoc[]
+====
+
+|===
+--
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org