You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficcontrol.apache.org by ne...@apache.org on 2017/04/03 18:22:22 UTC
[1/4] incubator-trafficcontrol git commit: More minor changes in
traffic server admin doc
Repository: incubator-trafficcontrol
Updated Branches:
refs/heads/master 566577c54 -> b98c7b29b
More minor changes in traffic server admin doc
Project: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/commit/abb08fb1
Tree: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/tree/abb08fb1
Diff: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/diff/abb08fb1
Branch: refs/heads/master
Commit: abb08fb12b2465966cee684a8d3d1fb6fc5292c4
Parents: 5e499e6
Author: Oren Shemesh <or...@qwilt.com>
Authored: Tue Jan 31 10:28:20 2017 +0200
Committer: Dave Neuman <ne...@apache.org>
Committed: Mon Apr 3 12:22:34 2017 -0600
----------------------------------------------------------------------
docs/source/admin/traffic_server.rst | 97 ++++++++++++++++---------------
1 file changed, 49 insertions(+), 48 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/blob/abb08fb1/docs/source/admin/traffic_server.rst
----------------------------------------------------------------------
diff --git a/docs/source/admin/traffic_server.rst b/docs/source/admin/traffic_server.rst
index 41a5b9e..bedd430 100644
--- a/docs/source/admin/traffic_server.rst
+++ b/docs/source/admin/traffic_server.rst
@@ -19,45 +19,42 @@ Traffic Server Administration
Installing Traffic Server
=========================
-#. Get the Traffic Server RPM and the astats RPM.
+#. Get the Traffic Server RPM and the astats RPM.
- Sample command: ::
+ Sample command: ::
- wget http://traffic-control-cdn.net/downloads/1.7.0/RELEASE-1.7.0/trafficserver-5.3.2-759.ee14bbe.el6.x86_64.rpm
- wget http://traffic-control-cdn.net/downloads/1.6.1/RELEASE-1.6.1/astats_over_http-1.2-8.el6.x86_64.rpm
+ wget http://traffic-control-cdn.net/downloads/1.7.0/RELEASE-1.7.0/trafficserver-5.3.2-759.ee14bbe.el6.x86_64.rpm
+ wget http://traffic-control-cdn.net/downloads/1.6.1/RELEASE-1.6.1/astats_over_http-1.2-8.el6.x86_64.rpm
- (astats was not released as part of 1.7, so in this examples 1.6.1 was used)
-#. Install Traffic Server and astats: ::
+ (astats was not released as part of 1.7, so in this examples 1.6.1 was used)
+#. Install Traffic Server and astats: ::
- sudo yum -y install trafficserver-*.rpm astats_over_http*.rpm
+ sudo yum -y install trafficserver-*.rpm astats_over_http*.rpm
-#. Add the server using the Traffic Ops web interface:
+#. Add the server using the Traffic Ops web interface:
- #. Select **Servers**.
- #. Scroll to the bottom of the page and click **Add Server**.
- #. Complete the *Required Info:* section:
- * Set 'Interface Name' to the name of the interface from which traffic server delivers content.
- * Set 'Type' to 'MID' or 'EDGE'.
+ #. Select **Servers**.
+ #. Scroll to the bottom of the page and click **Add Server**.
+ #. Complete the "Required Info:" section:
+ * Set 'Interface Name' to the name of the interface from which traffic server delivers content.
+ * Set 'Type' to 'MID' or 'EDGE'.
- #. Click **Submit**.
- #. Click **Save**.
- #. Click **Online Server**.
+ #. Click **Submit**.
+ #. Click **Save**.
+ #. Click **Online Server**.
+ #. Verify that the server status is now listed as **Reported**
-#. Install the ORT script and run it in 'badass' mode to create the initial configuration, see :ref:`reference-traffic-ops-ort`
+#. Install the ORT script and run it in 'badass' mode to create the initial configuration, see :ref:`reference-traffic-ops-ort`
-#. Start the service: ``sudo service trafficserver start``
+#. Start the service: ``sudo service trafficserver start``
-#. Configure traffic server to start automatically: ``sudo chkconfig trafficserver on``
+#. Configure traffic server to start automatically: ``sudo chkconfig trafficserver on``
-#. Verify that the installation is good:
+#. Verify that the installation is good:
- #. Make sure that the service is running: ``sudo service trafficserver status``
+ #. Make sure that the service is running: ``sudo service trafficserver status``
- #. Assuming a traffic monitor is already installed, login to the traffic monitor, and run the command from it: ::
-
- curl <traffic-server-name>/_astats
-
- Make sure you get a json full of values, and not an error.
+ #. Assuming a traffic monitor is already installed, browse to it, and verify that the traffic server appears in the "Cahce States" table, in white.
.. _reference-traffic-ops-ort:
@@ -92,36 +89,40 @@ The traffic_ops_ort.pl should be installed on all caches (by puppet or other non
Installing the ORT script
--------------------------
-#. The ORT script is not a part of the traffic server distribution. You need to get and install in manually. In this sample session, we get it from github: ::
+#. The ORT script is not a part of the traffic server distribution. In this sample session, we get it manually from github: ::
+
+ sudo mkdir /opt/ort
+ sudo wget -P /opt/ort https://raw.githubusercontent.com/apache/incubator-trafficcontrol/1.7.x/traffic_ops/bin/traffic_ops_ort.pl
+ sudo chmod +x /opt/ort/traffic_ops_ort.pl
+
+#. Install modules required by ORT: ``sudo yum -y install perl-JSON perl-Crypt-SSLeay``
- sudo mkdir /opt/ort
- sudo wget -P /opt/ort https://raw.githubusercontent.com/apache/incubator-trafficcontrol/1.7.x/traffic_ops/bin/traffic_ops_ort.pl
- sudo chmod +x /opt/ort/traffic_ops_ort.pl
+#. For initial configuration or when major changes (like a Profile change) need to be made, run the script in "badass mode". All required rpm packages
+ will be installed, all Traffic Server config files will be fetched and installed, and (if needed) the Traffic Server application will be restarted.
-#. Install modules required by ORT: ``sudo yum -y install perl-JSON perl-Crypt-SSLeay``
+ Example run below: ::
-#. For initial configuration or when major changes (like a Profile change) need to be made, run the script in "badass mode". All required rpm packages
- will be installed, all Traffic Server config files will be fetched and installed, and (if needed) the Traffic Server application will be restarted.
-
- Example run below: ::
+ $ sudo /opt/ort/traffic_ops_ort.pl --dispersion=0 badass warn https://ops.$tcDomain admin:admin123
- $ sudo /opt/ort/traffic_ops_ort.pl --dispersion=0 badass warn https://ops.$tcDomain admin:admin123
+ .. Note:: First run gives a lot of state errors that are expected. The "badass" mode fixes these issue s. Run it a second time, this should be cleaner.
+ Also, note that many ERROR messages emitted by ORT are actually information messages. Do not panic.
- .. Note:: First run gives a lot of state errors that are expected. The "badass" mode fixes these issues. Run it a second time, this should be cleaner.
- .. Note:: Many ERROR messages emitted by ORT are actually information messages. Do not panic.
+#. Create a cron entry for running ort in 'syncds' mode every 15 minutes.
+ This makes traffic control check periodically if 'Queue Updates' was run on Traffic Ops, and it so, get the updated configuration.
-#. Create a cron entry for running ort in 'syncds' mode every 15 minutes.
- This makes traffic control check periodically if 'Queue Updates' was run on Traffic Ops, and it so, get the updated configuration.
+ Run ``sudo crontab -e`` and add the following line ::
- Run ``sudo crontab -e`` and add the following line ::
+ */15 * * * * /opt/ort/traffic_ops_ort.pl syncds warn https://traffops.kabletown.net admin:password > /tmp/ort/syncds.log 2>&1
- */15 * * * * /opt/ort/traffic_ops_ort.pl syncds warn https://traffops.kabletown.net admin:password > /tmp/ort/syncds.log 2>&1
+ .. Note:: By default, running ort on an edge traffic server waits for it's parent (mid) servers to download their configuration before
+ it downloads it's own configuration. Because of this, scheduling ort for running every 15 minutes (with 5 minutes default dispersion) means
+ that it might take up to ~35 minutes for a "Queue Updates" operation to affect all traffic servers.
- .. Note:: In 'syncds' mode, the ort script updates only configurations that might be changed as part of normal operations, such as:
+ .. Note:: In 'syncds' mode, the ort script updates only configurations that might be changed as part of normal operations, such as:
- * Delivery Services
- * SSL certificates
- * Traffic Monitor IP addresses
- * Logging configuration
- * More stuff <To be completed>
+ * Delivery Services
+ * SSL certificates
+ * Traffic Monitor IP addresses
+ * Logging configuration
+ * More stuff <To be completed>
[4/4] incubator-trafficcontrol git commit: This closes #241
Posted by ne...@apache.org.
This closes #241
Project: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/commit/b98c7b29
Tree: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/tree/b98c7b29
Diff: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/diff/b98c7b29
Branch: refs/heads/master
Commit: b98c7b29b20d6aec8d62d75ca889b5e33cd0be1e
Parents: abb08fb
Author: Dave Neuman <ne...@apache.org>
Authored: Mon Apr 3 12:22:44 2017 -0600
Committer: Dave Neuman <ne...@apache.org>
Committed: Mon Apr 3 12:22:44 2017 -0600
----------------------------------------------------------------------
----------------------------------------------------------------------
[2/4] incubator-trafficcontrol git commit: Minor improvements to
Traffic Server administrator manual Changed order of servers in sample
installation procedure: Traffic monitor before Traffic Servers
Posted by ne...@apache.org.
Minor improvements to Traffic Server administrator manual
Changed order of servers in sample installation procedure: Traffic monitor before Traffic Servers
Project: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/commit/5e499e61
Tree: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/tree/5e499e61
Diff: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/diff/5e499e61
Branch: refs/heads/master
Commit: 5e499e613174e71a89d41cd630581fd60bd7c39e
Parents: 278c01a
Author: Oren Shemesh <or...@qwilt.com>
Authored: Mon Jan 30 17:12:24 2017 +0200
Committer: Dave Neuman <ne...@apache.org>
Committed: Mon Apr 3 12:22:34 2017 -0600
----------------------------------------------------------------------
docs/source/admin/index.rst | 16 +++---
docs/source/admin/traffic_monitor.rst | 9 ++-
docs/source/admin/traffic_server.rst | 88 ++++++++++++++++++++++++------
3 files changed, 86 insertions(+), 27 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/blob/5e499e61/docs/source/admin/index.rst
----------------------------------------------------------------------
diff --git a/docs/source/admin/index.rst b/docs/source/admin/index.rst
index e92f5e2..1bb8555 100644
--- a/docs/source/admin/index.rst
+++ b/docs/source/admin/index.rst
@@ -20,14 +20,14 @@ Traffic Control is distributed in source form for the developer, but also as a b
When installing a complete CDN from scratch, a sample recommended order is:
-1. Traffic Ops
-2. Traffic Vault (Riak)
-3. Apache Traffic Server Mid-Tier Caches
-4. Apache Traffic Server Edge Caches
-5. Traffic Monitor
-6. Traffic Router
-7. Traffic Stats
-8. Traffic Portal
+#. Traffic Ops
+#. Traffic Vault (Riak)
+#. Traffic Monitor
+#. Apache Traffic Server Mid-Tier Caches
+#. Apache Traffic Server Edge Caches
+#. Traffic Router
+#. Traffic Stats
+#. Traffic Portal
Once everything is installed, you will need to configure the servers to talk to each other. You will also need Origin server(s), which the Mid-Tier Cache(s) get content from. An Origin server is simply an HTTP(S) server which serves the content you wish to cache on the CDN.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/blob/5e499e61/docs/source/admin/traffic_monitor.rst
----------------------------------------------------------------------
diff --git a/docs/source/admin/traffic_monitor.rst b/docs/source/admin/traffic_monitor.rst
index 4b3d205..10354cd 100644
--- a/docs/source/admin/traffic_monitor.rst
+++ b/docs/source/admin/traffic_monitor.rst
@@ -30,7 +30,7 @@ The following are requirements to ensure an accurate set up:
* perl-JSON
* perl-WWW-Curl
-#. Enter the Traffic Monitor server into Traffic Ops. Set the 'Type' field to 'RASCAL'.
+#. Add the Traffic Monitor server into Traffic Ops using 'Servers' -> 'Add Server'. Set the 'Type' field to 'RASCAL'.
#. Make sure the FQDN of the Traffic Monitor is resolvable in DNS.
@@ -133,7 +133,7 @@ The following are requirements to ensure an accurate set up:
with the address of the traffic monitor being installed, so that the traffic servers will allow this Traffic Monitor
to access the astats plugin.
For details see :ref:`rl-param-prof` in the *Configuring Traffic Ops* section.
-
+
#. Start Tomcat: ``sudo service tomcat start`` ::
Using CATALINA_BASE: /opt/tomcat
@@ -146,7 +146,10 @@ The following are requirements to ensure an accurate set up:
#. Configure tomcat to start automatically: ``sudo chkconfig tomcat on``
-#. Verify Traffic Monitor is running by pointing your browser to port 80 on the Traffic Monitor host.
+#. Verify Traffic Monitor is running by pointing your browser to port 80 on the Traffic Monitor host:
+
+ * The 'Cache States' tab should display all Mid and Edge caches configured in Traffic Ops.
+ * The 'DeliveryService States' tab should display all delivery services configured in Traffic Ops.
#. In Traffic Ops servers table, click 'Edit' for this server, then click 'Online'.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/blob/5e499e61/docs/source/admin/traffic_server.rst
----------------------------------------------------------------------
diff --git a/docs/source/admin/traffic_server.rst b/docs/source/admin/traffic_server.rst
index 1b99ce0..41a5b9e 100644
--- a/docs/source/admin/traffic_server.rst
+++ b/docs/source/admin/traffic_server.rst
@@ -18,26 +18,56 @@ Traffic Server Administration
*****************************
Installing Traffic Server
=========================
-1. Select **Servers** in the Traffic Ops web interface.
-2. Scroll to the bottom of the page and click **Add Server**.
-3. Complete the *Required Info*: section.
-4. Click **Submit**.
-5. Click **Save**.
-.. 6. Click **Online Server**.
-.. 7. From the Set status of this machine to ONLINE? screen, click **OK**.
+#. Get the Traffic Server RPM and the astats RPM.
+
+ Sample command: ::
+
+ wget http://traffic-control-cdn.net/downloads/1.7.0/RELEASE-1.7.0/trafficserver-5.3.2-759.ee14bbe.el6.x86_64.rpm
+ wget http://traffic-control-cdn.net/downloads/1.6.1/RELEASE-1.6.1/astats_over_http-1.2-8.el6.x86_64.rpm
+
+ (astats was not released as part of 1.7, so in this examples 1.6.1 was used)
+#. Install Traffic Server and astats: ::
+
+ sudo yum -y install trafficserver-*.rpm astats_over_http*.rpm
+
+#. Add the server using the Traffic Ops web interface:
+
+ #. Select **Servers**.
+ #. Scroll to the bottom of the page and click **Add Server**.
+ #. Complete the *Required Info:* section:
+ * Set 'Interface Name' to the name of the interface from which traffic server delivers content.
+ * Set 'Type' to 'MID' or 'EDGE'.
+
+ #. Click **Submit**.
+ #. Click **Save**.
+ #. Click **Online Server**.
+
+#. Install the ORT script and run it in 'badass' mode to create the initial configuration, see :ref:`reference-traffic-ops-ort`
+
+#. Start the service: ``sudo service trafficserver start``
+
+#. Configure traffic server to start automatically: ``sudo chkconfig trafficserver on``
+
+#. Verify that the installation is good:
+
+ #. Make sure that the service is running: ``sudo service trafficserver status``
+
+ #. Assuming a traffic monitor is already installed, login to the traffic monitor, and run the command from it: ::
+
+ curl <traffic-server-name>/_astats
+
+ Make sure you get a json full of values, and not an error.
+
.. _reference-traffic-ops-ort:
Configuring Traffic Server
==========================
All of the Traffic Server application configuration files are generated by Traffic Ops and installed by way of the traffic_ops_ort.pl script.
+The traffic_ops_ort.pl should be installed on all caches (by puppet or other non Traffic Ops means), usually in /opt/ort. It is used to do the initial install of the config files when the cache is being deployed, and to keep the config files up to date when the cache is already in service. The usage message of the script is shown below: ::
-
-**traffic_ops_ort.pl**
- The traffic_ops_ort.pl should be installed on all caches (by puppet or other non Traffic Ops means), usually in /opt/ort. It is used to do initial install of the config files when the cache is being deployed, and to keep the config files up to date when the cache is already in service. The usage message of the script is shown below: ::
-
- $ sudo ./traffic_ops_ort.pl syncds warn https://to.cdn.kabletown.net
+ $ sudo /opt/ort/traffic_ops_ort.pl
Thu May 26 15:52:11 UTC 2016
====-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-====
Usage: ./traffic_ops_ort.pl <Mode> <Log_Level> <Traffic_Ops_URL> <Traffic_Ops_Login> [optional flags]
@@ -59,13 +89,39 @@ All of the Traffic Server application configuration files are generated by Traff
====-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-====
$
+Installing the ORT script
+--------------------------
+
+#. The ORT script is not a part of the traffic server distribution. You need to get and install in manually. In this sample session, we get it from github: ::
- For initial configuration or when major changes (like a Profile change) need to be made, run the script in "badass mode". All required rpm packages will be installed, all Traffic Server config files will be fetched and installed, and (if needed) the Traffic Server application will be restarted. Example run below: ::
+ sudo mkdir /opt/ort
+ sudo wget -P /opt/ort https://raw.githubusercontent.com/apache/incubator-trafficcontrol/1.7.x/traffic_ops/bin/traffic_ops_ort.pl
+ sudo chmod +x /opt/ort/traffic_ops_ort.pl
- run here
+#. Install modules required by ORT: ``sudo yum -y install perl-JSON perl-Crypt-SSLeay``
- For "every day changes" such as adding deliveryservices or changing records.config parameters caches should run the script in "syncds" mode out of cron. Example crontab entry: ::
+#. For initial configuration or when major changes (like a Profile change) need to be made, run the script in "badass mode". All required rpm packages
+ will be installed, all Traffic Server config files will be fetched and installed, and (if needed) the Traffic Server application will be restarted.
+
+ Example run below: ::
+
+ $ sudo /opt/ort/traffic_ops_ort.pl --dispersion=0 badass warn https://ops.$tcDomain admin:admin123
+
+ .. Note:: First run gives a lot of state errors that are expected. The "badass" mode fixes these issues. Run it a second time, this should be cleaner.
+ .. Note:: Many ERROR messages emitted by ORT are actually information messages. Do not panic.
+
+#. Create a cron entry for running ort in 'syncds' mode every 15 minutes.
+ This makes traffic control check periodically if 'Queue Updates' was run on Traffic Ops, and it so, get the updated configuration.
+
+ Run ``sudo crontab -e`` and add the following line ::
*/15 * * * * /opt/ort/traffic_ops_ort.pl syncds warn https://traffops.kabletown.net admin:password > /tmp/ort/syncds.log 2>&1
- .. Note:: <disclaimer on what is "hot changeable" here>
+ .. Note:: In 'syncds' mode, the ort script updates only configurations that might be changed as part of normal operations, such as:
+
+ * Delivery Services
+ * SSL certificates
+ * Traffic Monitor IP addresses
+ * Logging configuration
+ * More stuff <To be completed>
+
[3/4] incubator-trafficcontrol git commit: minor improvements to
Traffic Monitor administrator manual
Posted by ne...@apache.org.
minor improvements to Traffic Monitor administrator manual
Project: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/commit/278c01a5
Tree: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/tree/278c01a5
Diff: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/diff/278c01a5
Branch: refs/heads/master
Commit: 278c01a51f7eac328b4d6c0e5ea083a24722acb5
Parents: 566577c
Author: Oren Shemesh <or...@qwilt.com>
Authored: Mon Jan 30 09:23:13 2017 +0200
Committer: Dave Neuman <ne...@apache.org>
Committed: Mon Apr 3 12:22:34 2017 -0600
----------------------------------------------------------------------
docs/source/admin/traffic_monitor.rst | 205 ++++++++++++++++-------------
docs/source/index.rst | 4 +-
2 files changed, 118 insertions(+), 91 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/blob/278c01a5/docs/source/admin/traffic_monitor.rst
----------------------------------------------------------------------
diff --git a/docs/source/admin/traffic_monitor.rst b/docs/source/admin/traffic_monitor.rst
index 3a06e78..4b3d205 100644
--- a/docs/source/admin/traffic_monitor.rst
+++ b/docs/source/admin/traffic_monitor.rst
@@ -30,94 +30,111 @@ The following are requirements to ensure an accurate set up:
* perl-JSON
* perl-WWW-Curl
-1. Enter the Traffic Monitor server into Traffic Ops
-2. Make sure the FQDN of the Traffic Monitor is resolvable in DNS.
-3. Install Traffic Monitor and Perl mods: ``sudo yum -y install traffic_monitor perl-JSON perl-WWW-Curl``
-4. Take the config from Traffic Ops - run : ``sudo /opt/traffic_monitor/bin/traffic_monitor_config.pl``
-
- Sample output: ::
-
- traffic_mon # /opt/traffic_monitor/bin/traffic_monitor_config.pl https://traffic-ops.cdn.kabletown.net admin:password prompt
- DEBUG: traffic_ops selected: https://traffic-ops.cdn.kabletown.net
- DEBUG: traffic_ops login: admin:kl0tevax
- DEBUG: Config write mode: prompt
- DEBUG: Found profile from traffic_ops: RASCAL_CDN
- DEBUG: Found CDN name from traffic_ops: kabletown_cdn
- DEBUG: Found location for rascal-config.txt from traffic_ops: /opt/traffic_monitor/conf
- WARN: Param not in traffic_ops: allow.config.edit description: Allow the running configuration to be edited through the UI Using default value of: false
- WARN: Param not in traffic_ops: default.accessControlAllowOrigin description: The value for the header: Access-Control-Allow-Origin for published jsons... should be narrowed down to TMs Using default value of: *
- WARN: Param not in traffic_ops: default.connection.timeout description: Default connection time for all queries (cache, peers, TM) Using default value of: 2000
- WARN: Param not in traffic_ops: hack.forceSystemExit description: Call System.exit on shutdown Using default value of: false
- WARN: Param not in traffic_ops: hack.peerOptimistic description: The assumption of a caches availability when unknown by peers Using default value of: true
- WARN: Param not in traffic_ops: hack.publishDsStates description: If true, the delivery service states will be included in the CrStates.json Using default value of: true
- WARN: Param not in traffic_ops: health.ds.interval description: The polling frequency for calculating the deliveryService states Using default value of: 1000
- WARN: Param not in traffic_ops: health.ds.leniency description: The amount of time before the deliveryService disregards the last update from a non-responsive cache Using default value of: 30000
- WARN: Param not in traffic_ops: health.event-count description: The number of historical events that will be kept Using default value of: 200
- WARN: Param not in traffic_ops: health.polling.interval description: The polling frequency for getting the states from caches Using default value of: 5000
- WARN: Param not in traffic_ops: health.startupMinCycles description: The number of query cycles that must be completed before this Traffic Monitor will start reporting Using default value of: 2
- WARN: Param not in traffic_ops: health.timepad description: A delay between each separate cache query Using default value of: 10
- WARN: Param not in traffic_ops: peers.polling.interval description: Polling frequency for getting states from peer monitors Using default value of: 5000
- WARN: Param not in traffic_ops: peers.polling.url description: The url for current, unfiltered states from peer monitors Using default value of: http://${hostname}/publish/CrStates?raw
- WARN: Param not in traffic_ops: peers.threadPool description: The number of threads given to the pool for querying peers Using default value of: 1
- WARN: Param not in traffic_ops: tm.auth.url description: The url for the authentication form Using default value of: https://${tmHostname}/login
- WARN: Param not in traffic_ops: tm.crConfig.json.polling.url description: Url for the cr-config (json) Using default value of: https://${tmHostname}/CRConfig-Snapshots/${cdnName}/CRConfig.json
- WARN: Param not in traffic_ops: tm.healthParams.polling.url description: The url for the heath params (json) Using default value of: https://${tmHostname}/health/${cdnName}
- WARN: Param not in traffic_ops: tm.polling.interval description: The polling frequency for getting updates from TM Using default value of: 10000
- DEBUG: allow.config.edit needed in config, but does not exist in config on disk.
- DEBUG: cdnName value on disk () does not match value needed in config (kabletown_cdn).
- DEBUG: default.accessControlAllowOrigin needed in config, but does not exist in config on disk.
- DEBUG: default.connection.timeout needed in config, but does not exist in config on disk.
- DEBUG: hack.forceSystemExit needed in config, but does not exist in config on disk.
- DEBUG: hack.peerOptimistic needed in config, but does not exist in config on disk.
- DEBUG: hack.publishDsStates needed in config, but does not exist in config on disk.
- DEBUG: health.ds.interval needed in config, but does not exist in config on disk.
- DEBUG: health.ds.leniency needed in config, but does not exist in config on disk.
- DEBUG: health.startupMinCycles needed in config, but does not exist in config on disk.
- DEBUG: health.timepad value on disk (20) does not match value needed in config (10).
- DEBUG: peers.polling.interval needed in config, but does not exist in config on disk.
- DEBUG: peers.threadPool needed in config, but does not exist in config on disk.
- DEBUG: tm.auth.password value on disk () does not match value needed in config (kl0tevax).
- DEBUG: tm.auth.username value on disk () does not match value needed in config (admin).
- DEBUG: tm.hostname value on disk () does not match value needed in config (traffic-ops.cdn.kabletown.net).
- DEBUG: Proposed traffic_monitor_config:
- {
- "traffic_monitor_config":{
- "default.accessControlAllowOrigin":"*",
- "health.startupMinCycles":"2",
- "tm.auth.password":"kl0tevax",
- "tm.auth.url":"https://${tmHostname}/login",
- "tm.healthParams.polling.url":"https://${tmHostname}/health/${cdnName}",
- "allow.config.edit":"false",
- "tm.crConfig.json.polling.url":"https://${tmHostname}/CRConfig-Snapshots/${cdnName}/CRConfig.json",
- "tm.auth.username":"admin",
- "peers.polling.url":"http://${hostname}/publish/CrStates?raw",
- "health.timepad":"10",
- "hack.publishDsStates":"true",
- "default.connection.timeout":"2000",
- "health.ds.interval":"1000",
- "peers.polling.interval":"5000",
- "hack.forceSystemExit":"false",
- "health.ds.leniency":"30000",
- "cdnName":"kabletown_cdn",
- "peers.threadPool":"1",
- "tm.polling.interval":"10000",
- "health.polling.interval":"5000",
- "health.event-count":"200",
- "hack.peerOptimistic":"true",
- "tm.hostname":"traffic-ops.cdn.kabletown.net"
- }
- }
- ----------------------------------------------
- ----OK to write this config to disk? (Y/n) [n]y
- ----------------------------------------------
- ----------------------------------------------
- ----OK to write this config to disk? (Y/n) [n]Y
- ----------------------------------------------
- DEBUG: Writing /opt/traffic_monitor/conf/traffic_monitor_config.js
- traffic_mon #
-
-5. Start Tomcat: ``sudo service tomcat start`` ::
+#. Enter the Traffic Monitor server into Traffic Ops. Set the 'Type' field to 'RASCAL'.
+#. Make sure the FQDN of the Traffic Monitor is resolvable in DNS.
+
+#. Get the Traffic Monitor RPM.
+
+ Sample command: ::
+
+ wget http://traffic-control-cdn.net/downloads/1.7.0/RELEASE-1.7.0/traffic_monitor-1.7.0-3908.5b77f60f.el6.x86_64.rpm
+
+#. Install Traffic Monitor and Perl modules: ::
+
+ sudo yum -y install traffic_monitor-*.rpm perl-JSON perl-WWW-Curl
+
+#. Take the config from Traffic Ops: ::
+
+ sudo /opt/traffic_monitor/bin/traffic_monitor_config.pl https://<traffic-ops-URL> <traffic-ops-user>:<traffic-ops-password> prompt
+
+ Sample session: ::
+
+ traffic_mon # /opt/traffic_monitor/bin/traffic_monitor_config.pl https://traffic-ops.cdn.kabletown.net admin:kl0tevax prompt
+ DEBUG: traffic_ops selected: https://traffic-ops.cdn.kabletown.net
+ DEBUG: traffic_ops login: admin:kl0tevax
+ DEBUG: Config write mode: prompt
+ DEBUG: Found profile from traffic_ops: RASCAL_CDN
+ DEBUG: Found CDN name from traffic_ops: kabletown_cdn
+ DEBUG: Found location for rascal-config.txt from traffic_ops: /opt/traffic_monitor/conf
+ WARN: Param not in traffic_ops: allow.config.edit description: Allow the running configuration to be edited through the UI Using default value of: false
+ WARN: Param not in traffic_ops: default.accessControlAllowOrigin description: The value for the header: Access-Control-Allow-Origin for published jsons... should be narrowed down to TMs Using default value of: *
+ WARN: Param not in traffic_ops: default.connection.timeout description: Default connection time for all queries (cache, peers, TM) Using default value of: 2000
+ WARN: Param not in traffic_ops: hack.forceSystemExit description: Call System.exit on shutdown Using default value of: false
+ WARN: Param not in traffic_ops: hack.peerOptimistic description: The assumption of a caches availability when unknown by peers Using default value of: true
+ WARN: Param not in traffic_ops: hack.publishDsStates description: If true, the delivery service states will be included in the CrStates.json Using default value of: true
+ WARN: Param not in traffic_ops: health.ds.interval description: The polling frequency for calculating the deliveryService states Using default value of: 1000
+ WARN: Param not in traffic_ops: health.ds.leniency description: The amount of time before the deliveryService disregards the last update from a non-responsive cache Using default value of: 30000
+ WARN: Param not in traffic_ops: health.event-count description: The number of historical events that will be kept Using default value of: 200
+ WARN: Param not in traffic_ops: health.polling.interval description: The polling frequency for getting the states from caches Using default value of: 5000
+ WARN: Param not in traffic_ops: health.startupMinCycles description: The number of query cycles that must be completed before this Traffic Monitor will start reporting Using default value of: 2
+ WARN: Param not in traffic_ops: health.timepad description: A delay between each separate cache query Using default value of: 10
+ WARN: Param not in traffic_ops: peers.polling.interval description: Polling frequency for getting states from peer monitors Using default value of: 5000
+ WARN: Param not in traffic_ops: peers.polling.url description: The url for current, unfiltered states from peer monitors Using default value of: http://${hostname}/publish/CrStates?raw
+ WARN: Param not in traffic_ops: peers.threadPool description: The number of threads given to the pool for querying peers Using default value of: 1
+ WARN: Param not in traffic_ops: tm.auth.url description: The url for the authentication form Using default value of: https://${tmHostname}/login
+ WARN: Param not in traffic_ops: tm.crConfig.json.polling.url description: Url for the cr-config (json) Using default value of: https://${tmHostname}/CRConfig-Snapshots/${cdnName}/CRConfig.json
+ WARN: Param not in traffic_ops: tm.healthParams.polling.url description: The url for the heath params (json) Using default value of: https://${tmHostname}/health/${cdnName}
+ WARN: Param not in traffic_ops: tm.polling.interval description: The polling frequency for getting updates from TM Using default value of: 10000
+ DEBUG: allow.config.edit needed in config, but does not exist in config on disk.
+ DEBUG: cdnName value on disk () does not match value needed in config (kabletown_cdn).
+ DEBUG: default.accessControlAllowOrigin needed in config, but does not exist in config on disk.
+ DEBUG: default.connection.timeout needed in config, but does not exist in config on disk.
+ DEBUG: hack.forceSystemExit needed in config, but does not exist in config on disk.
+ DEBUG: hack.peerOptimistic needed in config, but does not exist in config on disk.
+ DEBUG: hack.publishDsStates needed in config, but does not exist in config on disk.
+ DEBUG: health.ds.interval needed in config, but does not exist in config on disk.
+ DEBUG: health.ds.leniency needed in config, but does not exist in config on disk.
+ DEBUG: health.startupMinCycles needed in config, but does not exist in config on disk.
+ DEBUG: health.timepad value on disk (20) does not match value needed in config (10).
+ DEBUG: peers.polling.interval needed in config, but does not exist in config on disk.
+ DEBUG: peers.threadPool needed in config, but does not exist in config on disk.
+ DEBUG: tm.auth.password value on disk () does not match value needed in config (kl0tevax).
+ DEBUG: tm.auth.username value on disk () does not match value needed in config (admin).
+ DEBUG: tm.hostname value on disk () does not match value needed in config (traffic-ops.cdn.kabletown.net).
+ DEBUG: Proposed traffic_monitor_config:
+ {
+ "traffic_monitor_config":{
+ "default.accessControlAllowOrigin":"*",
+ "health.startupMinCycles":"2",
+ "tm.auth.password":"kl0tevax",
+ "tm.auth.url":"https://${tmHostname}/login",
+ "tm.healthParams.polling.url":"https://${tmHostname}/health/${cdnName}",
+ "allow.config.edit":"false",
+ "tm.crConfig.json.polling.url":"https://${tmHostname}/CRConfig-Snapshots/${cdnName}/CRConfig.json",
+ "tm.auth.username":"admin",
+ "peers.polling.url":"http://${hostname}/publish/CrStates?raw",
+ "health.timepad":"10",
+ "hack.publishDsStates":"true",
+ "default.connection.timeout":"2000",
+ "health.ds.interval":"1000",
+ "peers.polling.interval":"5000",
+ "hack.forceSystemExit":"false",
+ "health.ds.leniency":"30000",
+ "cdnName":"kabletown_cdn",
+ "peers.threadPool":"1",
+ "tm.polling.interval":"10000",
+ "health.polling.interval":"5000",
+ "health.event-count":"200",
+ "hack.peerOptimistic":"true",
+ "tm.hostname":"traffic-ops.cdn.kabletown.net"
+ }
+ }
+ ----------------------------------------------
+ ----OK to write this config to disk? (Y/n) [n]y
+ ----------------------------------------------
+ ----------------------------------------------
+ ----OK to write this config to disk? (Y/n) [n]Y
+ ----------------------------------------------
+ DEBUG: Writing /opt/traffic_monitor/conf/traffic_monitor_config.js
+ traffic_mon #
+
+#. Update the 'allow_ip' and 'allow_ip6' parameters in the profiles of all caches defined in traffic ops, both edge and mid,
+ with the address of the traffic monitor being installed, so that the traffic servers will allow this Traffic Monitor
+ to access the astats plugin.
+ For details see :ref:`rl-param-prof` in the *Configuring Traffic Ops* section.
+
+#. Start Tomcat: ``sudo service tomcat start`` ::
Using CATALINA_BASE: /opt/tomcat
Using CATALINA_HOME: /opt/tomcat
@@ -127,14 +144,24 @@ The following are requirements to ensure an accurate set up:
Using CATALINA_PID:/var/run/tomcat/tomcat.pid
Starting tomcat [ OK ]
-6. Verify Traffic Monitor is running by pointing your browser to port 80 on the Traffic Monitor host.
+#. Configure tomcat to start automatically: ``sudo chkconfig tomcat on``
+
+#. Verify Traffic Monitor is running by pointing your browser to port 80 on the Traffic Monitor host.
+
+#. In Traffic Ops servers table, click 'Edit' for this server, then click 'Online'.
+
Configuring Traffic Monitor
===========================
Configuration Overview
----------------------
-Traffic Monitor is configured using its JSON configuration file, ``traffic_monitor_config.js``. Specify the URL, username, password, and CDN name for the instance of Traffic Ops for which this Traffic Monitor is a member, and start the software. Once started with the correct configuration, Traffic Monitor downloads its configuration from Traffic Ops and begins polling caches. Once a configurable number of polling cycles completes, health protocol state is available via RESTful JSON endpoints.
+Traffic Monitor is configured using its JSON configuration file, ``/opt/traffic_monitor/conf/traffic_monitor_config.js``.
+This file is created by ``traffic_monitor_config.pl`` script, and among other things, it contains the Traffic Ops URL and the user:password
+specified during the invocation of that script.
+
+When started, Traffic Monitor uses this basic configuration to downloads its configuration from Traffic Ops, and begins polling caches.
+Once a configurable number of polling cycles completes, health protocol state is available via RESTful JSON endpoints.
Troubleshooting and log files
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/blob/278c01a5/docs/source/index.rst
----------------------------------------------------------------------
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 2a12096..50b604b 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -23,7 +23,7 @@ Traffic Control is an Open Source implementation of a Content Delivery Network.
The following documentation sections are available:
-CDN Basics
+CDN Basics
==========
A review of the basic functionality of a Content Delivery Network.
@@ -53,7 +53,7 @@ How to deploy and manage a Traffic Control CDN.
Developer's Guide
==================
-A guide to the various internal and external APIs, and a introduction for the Traffic Control developer.
+A guide to the various internal and external APIs, and an introduction for the Traffic Control developer.
.. toctree::
:maxdepth: 3