You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficcontrol.apache.org by da...@apache.org on 2017/06/07 23:54:30 UTC
[20/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_router.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_router.txt b/docs/latest/_sources/development/traffic_router.txt
new file mode 100644
index 0000000..6df7627
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_router.txt
@@ -0,0 +1,143 @@
+..
+..
+.. Licensed 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.
+..
+
+Traffic Router
+**************
+Introduction
+============
+Traffic Router is a Java Tomcat application that routes clients to the closest available cache on the CDN using both HTTP and DNS. Cache availability is determined by Traffic Monitor; consequently Traffic Router polls Traffic Monitor for its configuration and cache health state information, and uses this data to make routing decisions. HTTP routing is performed by localizing the client based on the request's source IP address (IPv4 or IPv6), and issues an HTTP 302 redirect to the nearest cache. HTTP routing utilizes consistent hashing on request URLs to optimize cache performance and request distribution. DNS routing is performed by localizing clients, resolvers in most cases, requesting ``A`` and ``AAAA`` records for a configurable name such as ``edge.deliveryservice.somecdn.net``. Traffic Router is comprised of four separate Maven modules:
+
+ * api - Provides a simple JSON interface into certain aspects of core and is deployed as a WAR to a Service (read: connector/listen port) within Tomcat which is separate from core
+ * connector - A JAR that overrides Tomcat's standard Http11Protocol Connector class and allows Traffic Router to delay opening listen sockets until it is in a state suitable for routing traffic
+ * geolocation - Submodule for defining geolocation services
+ * testServer - A convenience server for easier manual testing of the API portion of Traffic Router on a development machine
+ * core - Services DNS and HTTP requests, performs localization on routing requests, and is deployed as a WAR to a Service (read: connector/listen port) within Tomcat which is separate from api
+ * rpm - A simple Maven project which gathers the artifacts from the prior three modules and builds an RPM
+
+Software Requirements
+=====================
+To work on Traffic Router you need a \*nix (MacOS and Linux are most commonly used) environment that has the following installed:
+
+* Eclipse >= Kepler SR2 (or another Java IDE)
+* Maven >= 3.3.1
+* JDK >= 6.0
+
+Traffic Router Project Tree Overview
+=====================================
+* ``traffic_control/traffic_traffic_router/`` - base directory for Traffic Router
+
+ * ``api/`` - Source code for Traffic Router API, which is built as its own deployable WAR file and communicates with Traffic Router Core using JMX
+
+ * ``src/main`` - Main source directory for Traffic Router API
+
+ * ``java/`` - Java source code for Traffic Router API
+ * ``resources/`` - Spring resources pulled in during an RPM build
+ * ``webapp/`` - Java webapp resources
+
+ * ``src/test`` - Test source directory for Traffic Router API
+
+ * ``java/`` - JUnit based unit tests for Traffic Router API
+ * ``resources/`` - Resources pulled in by unit tests
+
+ * ``connector/`` - Source code for Traffic Router Connector;
+
+ * ``src/main/java`` - Java source directory for Traffic Router Connector
+
+ * ``core/`` - Source code for Traffic Router Core, which is built as its own deployable WAR file and communicates with Traffic Router API using JMX
+
+ * ``src/main`` - Main source directory for Traffic Router Core
+
+ * ``etc/init.d`` - Init script for Tomcat
+ * ``conf/`` - Minimum required configuration files
+ * ``java/`` - Java source code for Traffic Router Core
+ * ``opt/tomcat/conf`` - Contains Tomcat configuration file(s) pulled in during an RPM build
+ * ``resources/`` - Resources pulled in during an RPM build
+ * ``scripts/`` - Scripts used by the RPM build process
+ * ``webapp/`` - Java webapp resources
+
+ * ``src/test`` - Test source directory for Traffic Router Core
+
+ * ``conf/`` - Minimal Configuration files that make it possible to run junit tests
+ * ``db/`` - Files downloaded by unit tests
+ * ``java/`` - JUnit based unit tests for Traffic Router Core
+ * ``resources/`` - Example data files used by junit tests
+
+ * ``var/auto-zones`` - BIND formatted zone files generated by Traffic Router Core during unit testing
+
+Java Formatting Conventions
+===========================
+None at this time. The codebase will eventually be formatted per Java standards.
+
+Installing The Developer Environment
+====================================
+To install the Traffic Router Developer environment:
+
+1. Clone the traffic_control repository using Git.
+2. Change directories into ``traffic_control/traffic_router``.
+3. Set the environment variable TRAFFIC_MONITOR_HOSTS to be a semicolon delimited list of Traffic Monitors that can be accessed during integration tests
+4. core/src/test/resources no longer exists
+5. core/src/test/conf contains a properties file for accessing Traffic Ops
+6. Default configuration values now reside in core/src/main/webapp/WEB-INF/applicationContext.xml
+7. The above values may be overridden by creating and/or modifying the property files listed in core/src/main/resources/applicationProperties.xml
+8. Pre-existing properties files are still honored by Traffic Router
+
++-------------------------------------+------------------------------------------------------------------------------------------------------------------+
+| Parameter | Value |
++=====================================+==================================================================================================================+
+| ``traffic_monitor.bootstrap.hosts`` | FQDN and port of the Traffic Monitor instance(s), separated by semicolons as necessary (do not include http://). |
++-------------------------------------+------------------------------------------------------------------------------------------------------------------+
+
+4. Import the existing git repo into Eclipse:
+
+ a. File -> Import -> Git -> Projects from Git; Next
+ b. Existing local repository; Next
+ c. Add -> browse to find ``traffic_control``; Open
+ d. Select ``traffic_control``; Next
+ e. Ensure "Import existing projects" is selected, expand ``traffic_control``, select ``traffic_router``; Next
+ f. Ensure ``traffic_router_api``, ``traffic_router_connector``, and ``traffic_router_core`` are checked; Finish (this step can take several minutes to complete)
+ g. Ensure ``traffic_router_api``, ``traffic_router_connector``, and ``traffic_router_core`` have been opened by Eclipse after importing
+
+5. From the terminal, run ``mvn clean verify`` from the ``traffic_router`` directory
+
+6. Start the embedded Jetty instance for Core from within Eclipse
+
+ a. In the package explorer, expand ``traffic_router_core``
+ b. Expand ``src/test/java``
+ c. Expand the package ``com.comcast.cdn.traffic_control.traffic_router.core``
+ d. Open and run ``TrafficRouterStart.java``
+
+ .. Note:: If an error is displayed in the Console, run ``mvn clean verify`` from the ``traffic_router`` directory
+
+7. Traffic Router Core should now be running; the HTTP routing interface is available on http://localhost:8081, while the DNS server and routing interface is available on localhost:1053 via TCP and UDP.
+
+Test Cases
+==========
+* Unit tests can be executed using Maven by running ``mvn test`` at the root of the ``traffic_router`` project.
+* Unit and Integration tests can be executed using Maven by running ``mvn verify`` at the root of the ``traffic_router`` project.
+
+RPM Packaging
+=============
+Running ``mvn package`` on a Linux based distribution will trigger the build process to create the Traffic Router rpm.
+
+API
+===
+
+:ref:`reference-tr-api`
+
+.. toctree::
+ :hidden:
+ :maxdepth: 1
+
+ traffic_router/traffic_router_api
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_router/traffic_router_api.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_router/traffic_router_api.rst.txt b/docs/latest/_sources/development/traffic_router/traffic_router_api.rst.txt
deleted file mode 100644
index d742276..0000000
--- a/docs/latest/_sources/development/traffic_router/traffic_router_api.rst.txt
+++ /dev/null
@@ -1,48 +0,0 @@
-..
-..
-.. Licensed 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.
-..
-
-.. _reference-tr-api:
-
-Traffic Router API
-==================
-
-**/crs/stats**
-
-General stats.
-
-|
-
-**/crs/stats/ip/:ipaddress**
-
-Geolocation information for an IPv4 or IPv6 address.
-
-|
-
-**/crs/locations**
-
-A list of configured cache groups.
-
-|
-
-**/crs/locations/caches**
-
-A mapping of caches to cache groups and their current health state.
-
-|
-
-/crs/locations/:location/caches
-
-A list of caches for this cache group only.
-
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_router/traffic_router_api.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_router/traffic_router_api.txt b/docs/latest/_sources/development/traffic_router/traffic_router_api.txt
new file mode 100644
index 0000000..d742276
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_router/traffic_router_api.txt
@@ -0,0 +1,48 @@
+..
+..
+.. Licensed 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.
+..
+
+.. _reference-tr-api:
+
+Traffic Router API
+==================
+
+**/crs/stats**
+
+General stats.
+
+|
+
+**/crs/stats/ip/:ipaddress**
+
+Geolocation information for an IPv4 or IPv6 address.
+
+|
+
+**/crs/locations**
+
+A list of configured cache groups.
+
+|
+
+**/crs/locations/caches**
+
+A mapping of caches to cache groups and their current health state.
+
+|
+
+/crs/locations/:location/caches
+
+A list of caches for this cache group only.
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_server.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_server.rst.txt b/docs/latest/_sources/development/traffic_server.rst.txt
deleted file mode 100644
index f8a78fb..0000000
--- a/docs/latest/_sources/development/traffic_server.rst.txt
+++ /dev/null
@@ -1,19 +0,0 @@
-..
-..
-.. Licensed 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.
-..
-
-Traffic Server
-**************
-See the `Apache Traffic Server documentation <https://docs.trafficserver.apache.org/en/latest/index.html>`_.
-
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_server.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_server.txt b/docs/latest/_sources/development/traffic_server.txt
new file mode 100644
index 0000000..f8a78fb
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_server.txt
@@ -0,0 +1,19 @@
+..
+..
+.. Licensed 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.
+..
+
+Traffic Server
+**************
+See the `Apache Traffic Server documentation <https://docs.trafficserver.apache.org/en/latest/index.html>`_.
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_stats.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_stats.rst.txt b/docs/latest/_sources/development/traffic_stats.rst.txt
deleted file mode 100644
index 02317f7..0000000
--- a/docs/latest/_sources/development/traffic_stats.rst.txt
+++ /dev/null
@@ -1,58 +0,0 @@
-..
-..
-.. Licensed 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.
-..
-
-Traffic Stats
-*************
-
-Introduction
-============
-Traffic Stats is a utility written in `Go <http.golang.org>`_ that is used to acquire and store statistics about CDNs controlled by Traffic Control. Traffic Stats mines metrics from Traffic Monitor's JSON APIs and stores the data in `InfluxDb <http://influxdb.com>`_. Data is typically stored in InfluxDb on a short-term basis (30 days or less) and is used to drive graphs created by `Grafana <http://grafana.org>`_ which are linked from Traffic Ops. Traffic Stats also calculates daily statistics from InfluxDb and stores them in the Traffic Ops database.
-
-Software Requirements
-=====================
-To work on Traffic Stats you need a \*nix (MacOS and Linux are most commonly used) environment that has the following installed:
-
- * `Go 1.7.x or above <https://golang.org/doc/install>`_
- * Access to a working instance of Traffic Ops
- * Access to a working instance of Traffic Monitor
- * `InfluxDb version 1.0.0 or greater <https://influxdb.com/download/index.html>`_
-
-Traffic Stats Project Tree Overview
-=====================================
- * **traffic_control/traffic_stats** - contains Go source files and Files used to create the Traffic Stats rpm.
- * **traffic_control/traffic_stats/grafana/** - contains a javascript file which is installed on the grafana server. This allows Traffic Ops to create custom dashboards for Delivery Services, Caches, etc.
- * **traffic_control/traffic_stats/influxdb_tools/** - contains one tool to create the databases and retention policies needed by Traffic Stats as well as continuous queries to downsample data; contains another tool to sync downsampled data between influxdb instances. This is is helpful if you have multiple instances and they get out of sync with data.
-
-
-Go Formatting Conventions
-============================
-In general `Go fmt <https://golang.org/cmd/gofmt/>`_ is the standard for formatting go code. It is also recommended to use `Go lint <https://github.com/golang/lint>`_.
-
-Installing The Developer Environment
-====================================
-To install the Traffic Ops Developer environment:
-
- - Clone the traffic_control repository using Git into a location accessible by your $GOPATH
- - Navigate to the traffic_ops/client directory of your cloned repository. (This is the directory containing Traffic Ops client code used by Traffic Stats)
- - From the traffic_ops/client directory run ``go test`` to test the client code. This will run all unit tests for the client and return the results. If there are missing dependencies you will need to run ``go get <dependency name>`` to get the dependency
- - Once the tests pass, run ``go install`` to build and install the Traffic Ops client package. This makes it accessible to Traffic Stats.
- - Navigate to your cloned repo under Traffic Stats
- - Run ``go build traffic_stats.go`` to build traffic_stats. You will need to run ``go get`` for any missing dependencies.
-
-
-Test Cases
-==========
- Currently there are no automated tests for Traffic Stats :( but pull requests are always welcome to fix this problem!
-
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_stats.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_stats.txt b/docs/latest/_sources/development/traffic_stats.txt
new file mode 100644
index 0000000..02317f7
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_stats.txt
@@ -0,0 +1,58 @@
+..
+..
+.. Licensed 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.
+..
+
+Traffic Stats
+*************
+
+Introduction
+============
+Traffic Stats is a utility written in `Go <http.golang.org>`_ that is used to acquire and store statistics about CDNs controlled by Traffic Control. Traffic Stats mines metrics from Traffic Monitor's JSON APIs and stores the data in `InfluxDb <http://influxdb.com>`_. Data is typically stored in InfluxDb on a short-term basis (30 days or less) and is used to drive graphs created by `Grafana <http://grafana.org>`_ which are linked from Traffic Ops. Traffic Stats also calculates daily statistics from InfluxDb and stores them in the Traffic Ops database.
+
+Software Requirements
+=====================
+To work on Traffic Stats you need a \*nix (MacOS and Linux are most commonly used) environment that has the following installed:
+
+ * `Go 1.7.x or above <https://golang.org/doc/install>`_
+ * Access to a working instance of Traffic Ops
+ * Access to a working instance of Traffic Monitor
+ * `InfluxDb version 1.0.0 or greater <https://influxdb.com/download/index.html>`_
+
+Traffic Stats Project Tree Overview
+=====================================
+ * **traffic_control/traffic_stats** - contains Go source files and Files used to create the Traffic Stats rpm.
+ * **traffic_control/traffic_stats/grafana/** - contains a javascript file which is installed on the grafana server. This allows Traffic Ops to create custom dashboards for Delivery Services, Caches, etc.
+ * **traffic_control/traffic_stats/influxdb_tools/** - contains one tool to create the databases and retention policies needed by Traffic Stats as well as continuous queries to downsample data; contains another tool to sync downsampled data between influxdb instances. This is is helpful if you have multiple instances and they get out of sync with data.
+
+
+Go Formatting Conventions
+============================
+In general `Go fmt <https://golang.org/cmd/gofmt/>`_ is the standard for formatting go code. It is also recommended to use `Go lint <https://github.com/golang/lint>`_.
+
+Installing The Developer Environment
+====================================
+To install the Traffic Ops Developer environment:
+
+ - Clone the traffic_control repository using Git into a location accessible by your $GOPATH
+ - Navigate to the traffic_ops/client directory of your cloned repository. (This is the directory containing Traffic Ops client code used by Traffic Stats)
+ - From the traffic_ops/client directory run ``go test`` to test the client code. This will run all unit tests for the client and return the results. If there are missing dependencies you will need to run ``go get <dependency name>`` to get the dependency
+ - Once the tests pass, run ``go install`` to build and install the Traffic Ops client package. This makes it accessible to Traffic Stats.
+ - Navigate to your cloned repo under Traffic Stats
+ - Run ``go build traffic_stats.go`` to build traffic_stats. You will need to run ``go get`` for any missing dependencies.
+
+
+Test Cases
+==========
+ Currently there are no automated tests for Traffic Stats :( but pull requests are always welcome to fix this problem!
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/faq/administration.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/faq/administration.rst.txt b/docs/latest/_sources/faq/administration.rst.txt
deleted file mode 100644
index feecff7..0000000
--- a/docs/latest/_sources/faq/administration.rst.txt
+++ /dev/null
@@ -1,66 +0,0 @@
-..
-..
-.. Licensed 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.
-..
-
-Running a Traffic Control CDN
-*****************************
-
-
-Why is my CRConfig.json rejected?
-=================================
- Especially in version 1.1.0, there's a number of manual steps that need to be done after the initial install. Make sure that after the initial install, you perform these steps in order:
-
- .. Note:: Even though Traffic Ops allows you to enter the servers with no IPv6 address information, the CRConfig will not be accepted by Traffic Router without IPv6 address information for at least Traffic Router and Traffic Monitor. Traffic Control assumes in a lot of places that all servers have at least an IPv4 and an IPv6 address. If you are not using IPv6, it is best to enter dummy addresses for all server types, and turn IPv6 off in all delivery services. (https://github.com/Comcast/traffic_control/issues/44).
-
-
- * Add users
- Not necessarily needed for getting your CRConfig accepted, but always a good idea.
-
- * Add Divisions
- You will need at least one.
-
- * Add Regions
- You will need at least one.
-
- * Add Physical Locations
- You will need at least one.
-
- * Add Mid tier Cache Groups
- You will need at least one.
-
- * Add Edge tier Cache Groups
- You will need at least one.
-
- * Add Traffic Monitors
- You will need to enter at least one Traffic Monitor - make sure to change the server status to *ONLINE*.
-
- * Add Traffic Routers
- You will need to enter at least one Traffic Router - make sure to change the server status to *ONLINE*.
-
- * Add Edges
- You will need at least one edge cache to make Traffic Router accept the CRConfig.
-
- * Add Mid
- Technically you don't need a mid tier, but if you have one, best to enter the info before continuing.
-
- * Change the ``polling.url`` parameters to reflect your CDN
- Set where to get the coverage zone map, and the geo IP database.
-
- * Create at least one delivery service, and assign at least one edge cache in REPORTED state to it.
- Even if it is a dummy DS, without a single DS, the CRConfig will not be accepted by Traffic Router.
-
- * Snapshot CRConfig
- **Tools > Snapshot CRConfig** diff, and write.
-
- Now you are ready to install the sw on Traffic Monitor and then Traffic Router.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/faq/administration.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/faq/administration.txt b/docs/latest/_sources/faq/administration.txt
new file mode 100644
index 0000000..feecff7
--- /dev/null
+++ b/docs/latest/_sources/faq/administration.txt
@@ -0,0 +1,66 @@
+..
+..
+.. Licensed 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.
+..
+
+Running a Traffic Control CDN
+*****************************
+
+
+Why is my CRConfig.json rejected?
+=================================
+ Especially in version 1.1.0, there's a number of manual steps that need to be done after the initial install. Make sure that after the initial install, you perform these steps in order:
+
+ .. Note:: Even though Traffic Ops allows you to enter the servers with no IPv6 address information, the CRConfig will not be accepted by Traffic Router without IPv6 address information for at least Traffic Router and Traffic Monitor. Traffic Control assumes in a lot of places that all servers have at least an IPv4 and an IPv6 address. If you are not using IPv6, it is best to enter dummy addresses for all server types, and turn IPv6 off in all delivery services. (https://github.com/Comcast/traffic_control/issues/44).
+
+
+ * Add users
+ Not necessarily needed for getting your CRConfig accepted, but always a good idea.
+
+ * Add Divisions
+ You will need at least one.
+
+ * Add Regions
+ You will need at least one.
+
+ * Add Physical Locations
+ You will need at least one.
+
+ * Add Mid tier Cache Groups
+ You will need at least one.
+
+ * Add Edge tier Cache Groups
+ You will need at least one.
+
+ * Add Traffic Monitors
+ You will need to enter at least one Traffic Monitor - make sure to change the server status to *ONLINE*.
+
+ * Add Traffic Routers
+ You will need to enter at least one Traffic Router - make sure to change the server status to *ONLINE*.
+
+ * Add Edges
+ You will need at least one edge cache to make Traffic Router accept the CRConfig.
+
+ * Add Mid
+ Technically you don't need a mid tier, but if you have one, best to enter the info before continuing.
+
+ * Change the ``polling.url`` parameters to reflect your CDN
+ Set where to get the coverage zone map, and the geo IP database.
+
+ * Create at least one delivery service, and assign at least one edge cache in REPORTED state to it.
+ Even if it is a dummy DS, without a single DS, the CRConfig will not be accepted by Traffic Router.
+
+ * Snapshot CRConfig
+ **Tools > Snapshot CRConfig** diff, and write.
+
+ Now you are ready to install the sw on Traffic Monitor and then Traffic Router.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/faq/development.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/faq/development.rst.txt b/docs/latest/_sources/faq/development.rst.txt
deleted file mode 100644
index 8518eeb..0000000
--- a/docs/latest/_sources/faq/development.rst.txt
+++ /dev/null
@@ -1,21 +0,0 @@
-..
-..
-.. Licensed 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.
-..
-
-Development
-***********
-
-How can I become involved?
-==========================
- See our `CONTRIBUTING <https://github.com/apache/incubator-trafficcontrol/blob/master/CONTRIBUTING.md>`_ page.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/faq/development.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/faq/development.txt b/docs/latest/_sources/faq/development.txt
new file mode 100644
index 0000000..8518eeb
--- /dev/null
+++ b/docs/latest/_sources/faq/development.txt
@@ -0,0 +1,21 @@
+..
+..
+.. Licensed 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.
+..
+
+Development
+***********
+
+How can I become involved?
+==========================
+ See our `CONTRIBUTING <https://github.com/apache/incubator-trafficcontrol/blob/master/CONTRIBUTING.md>`_ page.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/faq/general.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/faq/general.rst.txt b/docs/latest/_sources/faq/general.rst.txt
deleted file mode 100644
index 747aa60..0000000
--- a/docs/latest/_sources/faq/general.rst.txt
+++ /dev/null
@@ -1,52 +0,0 @@
-..
-..
-.. Licensed 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.
-..
-
-General
-*******
-
-Who is using Traffic Control?
-=============================
- `Comcast Cable <http://www.comcast.com/>`_
- Comcast is the original developer of Traffic Control and is using it for all it's IP video delivery, delivering images and software to it's X1 platform, and for `delivering third party content <https://www.comcastwholesale.com/products-services/content-delivery-network>`_ to it's footprint.
-
- `Cox Communications <http://www.cox.com/>`_
-
- `Cisco <http://www.cisco.com/>`_
- Cisco has a product called `Open Media Distribution <http://www.cisco.com/c/en/us/products/video/open-media-distribution/index.html>`_ that is based on Traffic Control.
-
- `Concurrent <https://www.ccur.com/>`_
- Concurrent has a product that uses Traffic Control, see their `github page <https://github.com/concurrentlabs/laguna>`_ for more info.
-
- `Augere Pakistan / QUBEE <http://www.qubee.com.pk>`_
-
-How do I get help with Traffic Control?
-=======================================
- Hop on to our Slack Channel by filling out `this form <https://goo.gl/Suzakj>`_, or send a question to our mailing list `here <ma...@trafficcontrol.incubator.apache.org>`_.
-
-What is Rascal?
-===============
- Rascal was the original name for Traffic Monitor. You will sometimes still see this name in the source, or in older documents.
-
-What is the CCR?
-================
- Comcast Content Router was the original name for Traffic Router. You will sometimes still see this name in the source, or in older documents.
-
-What is Twelve Monkeys?
-=======================
- Twelve Monkeys was the the original internal name for Traffic Ops. You will sometimes still see this name in the source, or in older documents. It's also a good movie.
-
-What license is Traffic Control released under?
-===============================================
- See the `LICENSE file <https://github.com/apache/incubator-trafficcontrol/blob/master/LICENSE>`_
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/faq/general.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/faq/general.txt b/docs/latest/_sources/faq/general.txt
new file mode 100644
index 0000000..747aa60
--- /dev/null
+++ b/docs/latest/_sources/faq/general.txt
@@ -0,0 +1,52 @@
+..
+..
+.. Licensed 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.
+..
+
+General
+*******
+
+Who is using Traffic Control?
+=============================
+ `Comcast Cable <http://www.comcast.com/>`_
+ Comcast is the original developer of Traffic Control and is using it for all it's IP video delivery, delivering images and software to it's X1 platform, and for `delivering third party content <https://www.comcastwholesale.com/products-services/content-delivery-network>`_ to it's footprint.
+
+ `Cox Communications <http://www.cox.com/>`_
+
+ `Cisco <http://www.cisco.com/>`_
+ Cisco has a product called `Open Media Distribution <http://www.cisco.com/c/en/us/products/video/open-media-distribution/index.html>`_ that is based on Traffic Control.
+
+ `Concurrent <https://www.ccur.com/>`_
+ Concurrent has a product that uses Traffic Control, see their `github page <https://github.com/concurrentlabs/laguna>`_ for more info.
+
+ `Augere Pakistan / QUBEE <http://www.qubee.com.pk>`_
+
+How do I get help with Traffic Control?
+=======================================
+ Hop on to our Slack Channel by filling out `this form <https://goo.gl/Suzakj>`_, or send a question to our mailing list `here <ma...@trafficcontrol.incubator.apache.org>`_.
+
+What is Rascal?
+===============
+ Rascal was the original name for Traffic Monitor. You will sometimes still see this name in the source, or in older documents.
+
+What is the CCR?
+================
+ Comcast Content Router was the original name for Traffic Router. You will sometimes still see this name in the source, or in older documents.
+
+What is Twelve Monkeys?
+=======================
+ Twelve Monkeys was the the original internal name for Traffic Ops. You will sometimes still see this name in the source, or in older documents. It's also a good movie.
+
+What license is Traffic Control released under?
+===============================================
+ See the `LICENSE file <https://github.com/apache/incubator-trafficcontrol/blob/master/LICENSE>`_
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/faq/index.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/faq/index.rst.txt b/docs/latest/_sources/faq/index.rst.txt
deleted file mode 100644
index 82ea912..0000000
--- a/docs/latest/_sources/faq/index.rst.txt
+++ /dev/null
@@ -1,26 +0,0 @@
-..
-..
-.. Licensed 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.
-..
-
-FAQ
-***
-
-Table of Contents:
-
-.. toctree::
- :maxdepth: 2
-
- general
- development
- administration
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/faq/index.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/faq/index.txt b/docs/latest/_sources/faq/index.txt
new file mode 100644
index 0000000..82ea912
--- /dev/null
+++ b/docs/latest/_sources/faq/index.txt
@@ -0,0 +1,26 @@
+..
+..
+.. Licensed 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.
+..
+
+FAQ
+***
+
+Table of Contents:
+
+.. toctree::
+ :maxdepth: 2
+
+ general
+ development
+ administration
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/glossary.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/glossary.rst.txt b/docs/latest/_sources/glossary.rst.txt
deleted file mode 100644
index a932579..0000000
--- a/docs/latest/_sources/glossary.rst.txt
+++ /dev/null
@@ -1,81 +0,0 @@
-..
-..
-.. Licensed 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.
-..
-
-.. _glossary:
-
-Glossary
-========
-
-.. glossary::
-
- 302 content routing
- :ref:`rl-http-cr`.
-
- astats (stats_over_http)
- An ATS plugin that allows you to monitor vitals of the ATS server. See :ref:`rl-astats`.
-
- cache
- A caching proxy server. See :ref:`rl-caching_proxy`.
-
- cachegroup
- A group of caches that together create a combined larger cache using consistent hashing. See :ref:`rl-cachegroup`.
-
- consistent hashing
- See `the Wikipedia article <http://en.wikipedia.org/wiki/Consistent_hashing>`_; Traffic Control uses consistent hashing when using :ref:`rl-http-cr` for the edge tier and when selecting parents in the mid tier.
-
- content routing
- Directing clients (or client systems) to a particular location or device in a location for optimal delivery of content See also :ref:`rl-http-cr` and :ref:`rl-dns-cr`.
-
- coverage zone map
- The coverage zone map (czm) or coverage zone file (zcf) is a file that maps network prefixes to cachegroups. See :ref:`rl-localization`.
-
- delivery service
- A grouping of content in the CDN, usually a determined by the URL hostname. See :ref:`rl-ds`.
-
- edge (tier or cache)
- Closest to the client or end-user. The edge tier is the tier that serves the client, edge caches are caches in the edge tier. In a Traffic Control CDN the basic function of the edge cache is that of a :ref:`rl-rev-proxy`. See also :ref:`rl-cachegroup`.
-
- (traffic ops) extension
- Using *extensions*, Traffic Ops be extended to use proprietary checks or monitoring sources. See :ref:`rl-trops-ext`.
-
- forward proxy
- A proxy that works that acts like it is the client to the origin. See :ref:`rl-fwd-proxy`.
-
- geo localization or geo routing
- Localizing clients to the nearest caches using a geo database like the one from Maxmind.
-
- health protocol
- The protocol to monitor the health of all the caches. See :ref:`rl-health-proto`.
-
- localization
- Finding location on the network, or on planet earth. See :ref:`rl-localization`.
-
- mid (tier or cache)
- The tier above the edge tier. The mid tier does not directly serves the end-user and is used as an additional layer between the edge and the origin. In a Traffic Control CDN the basic function of the mid cache is that of a :ref:`rl-fwd-proxy`. See also :ref:`rl-cachegroup`.
-
- origin
- The source of content for the CDN. Usually a redundant HTTP/1.1 webserver.
-
- parent (cache or cachegroup)
- The (group of) cache(s) in the higher tier. See :ref:`rl-cachegroup`.
-
- profile
- A group of settings (parameters) that will be applied to a server. See :ref:`rl-profile`.
-
- reverse proxy
- A proxy that acts like it is the origin to the client. See :ref:`rl-rev-proxy`.
-
-
-
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/glossary.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/glossary.txt b/docs/latest/_sources/glossary.txt
new file mode 100644
index 0000000..b32bea9
--- /dev/null
+++ b/docs/latest/_sources/glossary.txt
@@ -0,0 +1,66 @@
+.. _glossary:
+
+Glossary
+========
+
+.. glossary::
+
+ 302 content routing
+ :ref:`rl-http-cr`.
+
+ astats (stats_over_http)
+ An ATS plugin that allows you to monitor vitals of the ATS server. See :ref:`rl-astats`.
+
+ cache
+ A caching proxy server. See :ref:`rl-caching_proxy`.
+
+ cachegroup
+ A group of caches that together create a combined larger cache using consistent hashing. See :ref:`rl-cachegroup`.
+
+ consistent hashing
+ See `the Wikipedia article <http://en.wikipedia.org/wiki/Consistent_hashing>`_; Traffic Control uses consistent hashing when using :ref:`rl-http-cr` for the edge tier and when selecting parents in the mid tier.
+
+ content routing
+ Directing clients (or client systems) to a particular location or device in a location for optimal delivery of content See also :ref:`rl-http-cr` and :ref:`rl-dns-cr`.
+
+ coverage zone map
+ The coverage zone map (czm) or coverage zone file (zcf) is a file that maps network prefixes to cachegroups. See :ref:`rl-localization`.
+
+ delivery service
+ A grouping of content in the CDN, usually a determined by the URL hostname. See :ref:`rl-ds`.
+
+ edge (tier or cache)
+ Closest to the client or end-user. The edge tier is the tier that serves the client, edge caches are caches in the edge tier. In a Traffic Control CDN the basic function of the edge cache is that of a :ref:`rl-rev-proxy`. See also :ref:`rl-cachegroup`.
+
+ (traffic ops) extension
+ Using *extensions*, Traffic Ops be extended to use proprietary checks or monitoring sources. See :ref:`rl-trops-ext`.
+
+ forward proxy
+ A proxy that works that acts like it is the client to the origin. See :ref:`rl-fwd-proxy`.
+
+ geo localization or geo routing
+ Localizing clients to the nearest caches using a geo database like the one from Maxmind.
+
+ health protocol
+ The protocol to monitor the health of all the caches. See :ref:`rl-health-proto`.
+
+ localization
+ Finding location on the network, or on planet earth. See :ref:`rl-localization`.
+
+ mid (tier or cache)
+ The tier above the edge tier. The mid tier does not directly serves the end-user and is used as an additional layer between the edge and the origin. In a Traffic Control CDN the basic function of the mid cache is that of a :ref:`rl-fwd-proxy`. See also :ref:`rl-cachegroup`.
+
+ origin
+ The source of content for the CDN. Usually a redundant HTTP/1.1 webserver.
+
+ parent (cache or cachegroup)
+ The (group of) cache(s) in the higher tier. See :ref:`rl-cachegroup`.
+
+ profile
+ A group of settings (parameters) that will be applied to a server. See :ref:`rl-profile`.
+
+ reverse proxy
+ A proxy that acts like it is the origin to the client. See :ref:`rl-rev-proxy`.
+
+
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/index.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/index.rst.txt b/docs/latest/_sources/index.rst.txt
deleted file mode 100644
index 2a12096..0000000
--- a/docs/latest/_sources/index.rst.txt
+++ /dev/null
@@ -1,80 +0,0 @@
-..
-..
-.. Licensed 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.
-..
-
-%%%%%%%%%%%%%%%
-Traffic Control
-%%%%%%%%%%%%%%%
-
-The vast majority of today's Internet traffic is media files being sent from a single source to many thousands or even millions of destinations. Content Delivery Networks make that one-to-many distribution possible in an economical way.
-
-Traffic Control is an Open Source implementation of a Content Delivery Network.
-
-The following documentation sections are available:
-
-CDN Basics
-==========
-A review of the basic functionality of a Content Delivery Network.
-
-.. toctree::
- :maxdepth: 2
-
- basics/index
-
-
-Traffic Control Overview
-========================
-An introduction to the Traffic Control architecture, components, and their integration.
-
-.. toctree::
- :maxdepth: 0
-
- overview/index
-
-Administrator's Guide
-=====================
-How to deploy and manage a Traffic Control CDN.
-
-.. toctree::
- :maxdepth: 3
-
- admin/index
-
-Developer's Guide
-==================
-A guide to the various internal and external APIs, and a introduction for the Traffic Control developer.
-
-.. toctree::
- :maxdepth: 3
-
- development/index
-
-
-FAQ
-===
-
-.. toctree::
- :maxdepth: 3
-
- faq/index
-
-Indices and Tables
-==================
-
-.. toctree::
- :maxdepth: 3
-
- glossary.rst
-
-
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/index.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/index.txt b/docs/latest/_sources/index.txt
new file mode 100644
index 0000000..2a12096
--- /dev/null
+++ b/docs/latest/_sources/index.txt
@@ -0,0 +1,80 @@
+..
+..
+.. Licensed 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.
+..
+
+%%%%%%%%%%%%%%%
+Traffic Control
+%%%%%%%%%%%%%%%
+
+The vast majority of today's Internet traffic is media files being sent from a single source to many thousands or even millions of destinations. Content Delivery Networks make that one-to-many distribution possible in an economical way.
+
+Traffic Control is an Open Source implementation of a Content Delivery Network.
+
+The following documentation sections are available:
+
+CDN Basics
+==========
+A review of the basic functionality of a Content Delivery Network.
+
+.. toctree::
+ :maxdepth: 2
+
+ basics/index
+
+
+Traffic Control Overview
+========================
+An introduction to the Traffic Control architecture, components, and their integration.
+
+.. toctree::
+ :maxdepth: 0
+
+ overview/index
+
+Administrator's Guide
+=====================
+How to deploy and manage a Traffic Control CDN.
+
+.. toctree::
+ :maxdepth: 3
+
+ admin/index
+
+Developer's Guide
+==================
+A guide to the various internal and external APIs, and a introduction for the Traffic Control developer.
+
+.. toctree::
+ :maxdepth: 3
+
+ development/index
+
+
+FAQ
+===
+
+.. toctree::
+ :maxdepth: 3
+
+ faq/index
+
+Indices and Tables
+==================
+
+.. toctree::
+ :maxdepth: 3
+
+ glossary.rst
+
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/overview/index.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/overview/index.rst.txt b/docs/latest/_sources/overview/index.rst.txt
deleted file mode 100644
index 65dd20e..0000000
--- a/docs/latest/_sources/overview/index.rst.txt
+++ /dev/null
@@ -1,30 +0,0 @@
-..
-..
-.. Licensed 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.
-..
-
-Traffic Control Overview
-************************
-Introduces the Traffic Control architecture, components, and their integration.
-
-.. toctree::
- :maxdepth: 2
-
- introduction.rst
- traffic_ops
- traffic_portal
- traffic_router
- traffic_monitor
- traffic_stats
- traffic_server
- traffic_vault
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/overview/index.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/overview/index.txt b/docs/latest/_sources/overview/index.txt
new file mode 100644
index 0000000..65dd20e
--- /dev/null
+++ b/docs/latest/_sources/overview/index.txt
@@ -0,0 +1,30 @@
+..
+..
+.. Licensed 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.
+..
+
+Traffic Control Overview
+************************
+Introduces the Traffic Control architecture, components, and their integration.
+
+.. toctree::
+ :maxdepth: 2
+
+ introduction.rst
+ traffic_ops
+ traffic_portal
+ traffic_router
+ traffic_monitor
+ traffic_stats
+ traffic_server
+ traffic_vault
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/overview/introduction.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/overview/introduction.rst.txt b/docs/latest/_sources/overview/introduction.rst.txt
deleted file mode 100644
index a983820..0000000
--- a/docs/latest/_sources/overview/introduction.rst.txt
+++ /dev/null
@@ -1,28 +0,0 @@
-..
-..
-.. Licensed 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.
-..
-
-Introduction
-============
-Traffic Control is a control plane for a CDN, which includes all of the components mentioned in the CDN Basics section, except for the Log File Analysis System. The caching software chosen for Traffic Control is `Apache Traffic Server <http://trafficserver.apache.org/>`_ (ATS). Although the current release only supports ATS as a cache, this may change with future releases.
-
-Traffic Control was first developed at Comcast for internal use and released to Open Source in April of 2015. Traffic Control moved into the Apache Incubator in August of 2016.
-
-Traffic Control implements the blue boxes in the architecture diagram below.
-
-
-.. image:: traffic_control_overview_3.png
- :align: center
-
-In the next sections each of these components will be explained further.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/overview/introduction.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/overview/introduction.txt b/docs/latest/_sources/overview/introduction.txt
new file mode 100644
index 0000000..a983820
--- /dev/null
+++ b/docs/latest/_sources/overview/introduction.txt
@@ -0,0 +1,28 @@
+..
+..
+.. Licensed 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.
+..
+
+Introduction
+============
+Traffic Control is a control plane for a CDN, which includes all of the components mentioned in the CDN Basics section, except for the Log File Analysis System. The caching software chosen for Traffic Control is `Apache Traffic Server <http://trafficserver.apache.org/>`_ (ATS). Although the current release only supports ATS as a cache, this may change with future releases.
+
+Traffic Control was first developed at Comcast for internal use and released to Open Source in April of 2015. Traffic Control moved into the Apache Incubator in August of 2016.
+
+Traffic Control implements the blue boxes in the architecture diagram below.
+
+
+.. image:: traffic_control_overview_3.png
+ :align: center
+
+In the next sections each of these components will be explained further.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/overview/traffic_monitor.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/overview/traffic_monitor.rst.txt b/docs/latest/_sources/overview/traffic_monitor.rst.txt
deleted file mode 100644
index 1a3222f..0000000
--- a/docs/latest/_sources/overview/traffic_monitor.rst.txt
+++ /dev/null
@@ -1,66 +0,0 @@
-..
-..
-.. Licensed 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.
-..
-
-.. _reference-label-tc-tm:
-
-.. index::
- Traffic Monitor - Overview
-
-.. |arrow| image:: fwda.png
-
-Traffic Monitor
-===============
-Traffic Monitor is a Java/Tomcat application that monitors the caches in a CDN for a variety of metrics. These metrics are for use in determining the overall health of a given cache and the related delivery services. A given CDN can operate a number of Traffic Monitors, from a number of geographically diverse locations, to prevent false positives caused by network problems at a given site.
-
-Traffic Monitors operate independently, but use the state of other Traffic Monitors in conjunction with their own state, to provide a consistent view of CDN cache health to upstream applications such as Traffic Router. Health Protocol governs the cache and Delivery Service availability.
-
-Traffic Monitor provides a view into CDN health using several RESTful JSON endpoints, which are consumed by other Traffic Monitors and upstream components such as Traffic Router. Traffic Monitor is also responsible for serving the overall CDN configuration to Traffic Router, which ensures that the configuration of these two critical components remain synchronized as operational and health related changes propagate through the CDN.
-
-
-.. _rl-astats:
-
-|arrow| Cache Monitoring
--------------------------
- Traffic Monitor polls all caches configured with a status of ``REPORTED`` or ``ADMIN_DOWN`` at an interval specified as a configuration parameter in Traffic Ops. If the cache is set to ``ADMIN_DOWN`` it is marked as unavailable but still polled for availability and statistics. If the cache is explicitly configured with a status of ``ONLINE`` or ``OFFLINE``, it is not polled by Traffic Monitor and presented to Traffic Router as configured, regardless of actual availability.
-
- Traffic Monitor makes HTTP requests at regular intervals to a special URL on each EDGE cache and consumes the JSON output. The special URL is a plugin running on the Apache Traffic Server (ATS) caches called astats, which is restricted to Traffic Monitor only. The astats plugin provides insight into application and system performance, such as:
-
- - Throughput (e.g. bytes in, bytes out, etc).
- - Transactions (e.g. number of 2xx, 3xx, 4xx responses, etc).
- - Connections (e.g. from clients, to parents, origins, etc).
- - Cache performance (e.g.: hits, misses, refreshes, etc).
- - Storage performance (e.g.: writes, reads, frags, directories, etc).
- - System performance (e.g: load average, network interface throughput, etc).
-
- Many of the application level statistics are available at the global or aggregate level, some at the Delivery Service (remap rule) level. Traffic Monitor uses the system level performance to determine the overall health of the cache by evaluating network throughput and load against values configured in Traffic Ops. Traffic Monitor also uses throughput and transaction statistics at the remap rule level to determine Delivery Service health.
-
-If astats is unavailable due to a network related issue or the system statistics have exceeded the configured thresholds, Traffic Monitor will mark the cache as unavailable. If the delivery service statistics exceed the configured thresholds, the delivery service is marked as unavailable, and Traffic Router will start sending clients to the overflow destinations for that delivery service, but the cache remains available to serve other content,
-
-.. seealso:: For more information on ATS Statistics, see the `ATS documentation <https://docs.trafficserver.apache.org/en/latest/index.html>`_
-
-.. _rl-health-proto:
-
-|arrow| Health Protocol
------------------------
- Redundant Traffic Monitor servers operate independently from each other but take the state of other Traffic Monitors into account when asked for health state information. In the above overview of cache monitoring, the behavior of Traffic Monitor pertains only to how an individual instance detects and handles failures. The Health Protocol adds another dimension to the health state of the CDN by merging the states of all Traffic Monitors into one, and then taking the *optimistic* approach when dealing with a cache or Delivery Service that might have been marked as unavailable by this particular instance or a peer instance of Traffic Monitor.
-
- Upon startup or configuration change in Traffic Ops, in addition to caches, Traffic Monitor begins polling its peer Traffic Monitors whose state is set to ``ONLINE``. Each ``ONLINE`` Traffic Monitor polls all of its peers at a configurable interval and saves the peer's state for later use. When polling its peers, Traffic Monitor asks for the raw health state from each respective peer, which is strictly that instance's view of the CDN's health. When any ``ONLINE`` Traffic Monitor is asked for CDN health by an upstream component, such as Traffic Router, the component gets the health protocol influenced version of CDN health (non-raw view).
-
- In operation of the health protocol, Traffic Monitor takes all health states from all peers, including the locally known health state, and serves an optimistic outlook to the requesting client. This means that, for example, if three of the four Traffic Monitors see a given cache or Delivery Service as exceeding its thresholds and unavailable, it is still considered available. Only if all Traffic Monitors agree that the given object is unavailable is that state propagated to upstream components. This optimistic approach to the Health Protocol is counter to the "fail fast" philosophy, but serves well for large networks with complicated geography and or routing. The optimistic Health Protocol allows network failures or latency to occur without affecting overall traffic routing, as Traffic Monitors can and do have a different view of the network when deployed in geographically diverse locations. Short polling intervals of both the caches and Traffic Monitor peers help to reduce custom
er impact of outages.
-
-It is not uncommon for a cache to be marked unavailable by Traffic Monitor - in fact, it is business as usual for many CDNs. A hot video asset may cause a single cache (say cache-03) to get close to it's interface capacity, the health protocol "kicks in", and Traffic Monitor marks cache-03 as unavailable. New clients want to see the same asset, and now, Traffic Router will send these customers to another cache (say cache-01) in the same cachegroup. The load is now shared between cache-01 and cache-03. As clients finish watching the asset on cache-03, it will drop below the threshold and gets marked available again, and new clients will now go back to cache-03 again.
-
-It is less common for a delivery service to be marked unavailable by Traffic Monitor, the delivery service thresholds are usually used for overflow situations at extreme peaks to protect other delivery services in the CDN from getting impacted.
-
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/overview/traffic_monitor.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/overview/traffic_monitor.txt b/docs/latest/_sources/overview/traffic_monitor.txt
new file mode 100644
index 0000000..1a3222f
--- /dev/null
+++ b/docs/latest/_sources/overview/traffic_monitor.txt
@@ -0,0 +1,66 @@
+..
+..
+.. Licensed 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.
+..
+
+.. _reference-label-tc-tm:
+
+.. index::
+ Traffic Monitor - Overview
+
+.. |arrow| image:: fwda.png
+
+Traffic Monitor
+===============
+Traffic Monitor is a Java/Tomcat application that monitors the caches in a CDN for a variety of metrics. These metrics are for use in determining the overall health of a given cache and the related delivery services. A given CDN can operate a number of Traffic Monitors, from a number of geographically diverse locations, to prevent false positives caused by network problems at a given site.
+
+Traffic Monitors operate independently, but use the state of other Traffic Monitors in conjunction with their own state, to provide a consistent view of CDN cache health to upstream applications such as Traffic Router. Health Protocol governs the cache and Delivery Service availability.
+
+Traffic Monitor provides a view into CDN health using several RESTful JSON endpoints, which are consumed by other Traffic Monitors and upstream components such as Traffic Router. Traffic Monitor is also responsible for serving the overall CDN configuration to Traffic Router, which ensures that the configuration of these two critical components remain synchronized as operational and health related changes propagate through the CDN.
+
+
+.. _rl-astats:
+
+|arrow| Cache Monitoring
+-------------------------
+ Traffic Monitor polls all caches configured with a status of ``REPORTED`` or ``ADMIN_DOWN`` at an interval specified as a configuration parameter in Traffic Ops. If the cache is set to ``ADMIN_DOWN`` it is marked as unavailable but still polled for availability and statistics. If the cache is explicitly configured with a status of ``ONLINE`` or ``OFFLINE``, it is not polled by Traffic Monitor and presented to Traffic Router as configured, regardless of actual availability.
+
+ Traffic Monitor makes HTTP requests at regular intervals to a special URL on each EDGE cache and consumes the JSON output. The special URL is a plugin running on the Apache Traffic Server (ATS) caches called astats, which is restricted to Traffic Monitor only. The astats plugin provides insight into application and system performance, such as:
+
+ - Throughput (e.g. bytes in, bytes out, etc).
+ - Transactions (e.g. number of 2xx, 3xx, 4xx responses, etc).
+ - Connections (e.g. from clients, to parents, origins, etc).
+ - Cache performance (e.g.: hits, misses, refreshes, etc).
+ - Storage performance (e.g.: writes, reads, frags, directories, etc).
+ - System performance (e.g: load average, network interface throughput, etc).
+
+ Many of the application level statistics are available at the global or aggregate level, some at the Delivery Service (remap rule) level. Traffic Monitor uses the system level performance to determine the overall health of the cache by evaluating network throughput and load against values configured in Traffic Ops. Traffic Monitor also uses throughput and transaction statistics at the remap rule level to determine Delivery Service health.
+
+If astats is unavailable due to a network related issue or the system statistics have exceeded the configured thresholds, Traffic Monitor will mark the cache as unavailable. If the delivery service statistics exceed the configured thresholds, the delivery service is marked as unavailable, and Traffic Router will start sending clients to the overflow destinations for that delivery service, but the cache remains available to serve other content,
+
+.. seealso:: For more information on ATS Statistics, see the `ATS documentation <https://docs.trafficserver.apache.org/en/latest/index.html>`_
+
+.. _rl-health-proto:
+
+|arrow| Health Protocol
+-----------------------
+ Redundant Traffic Monitor servers operate independently from each other but take the state of other Traffic Monitors into account when asked for health state information. In the above overview of cache monitoring, the behavior of Traffic Monitor pertains only to how an individual instance detects and handles failures. The Health Protocol adds another dimension to the health state of the CDN by merging the states of all Traffic Monitors into one, and then taking the *optimistic* approach when dealing with a cache or Delivery Service that might have been marked as unavailable by this particular instance or a peer instance of Traffic Monitor.
+
+ Upon startup or configuration change in Traffic Ops, in addition to caches, Traffic Monitor begins polling its peer Traffic Monitors whose state is set to ``ONLINE``. Each ``ONLINE`` Traffic Monitor polls all of its peers at a configurable interval and saves the peer's state for later use. When polling its peers, Traffic Monitor asks for the raw health state from each respective peer, which is strictly that instance's view of the CDN's health. When any ``ONLINE`` Traffic Monitor is asked for CDN health by an upstream component, such as Traffic Router, the component gets the health protocol influenced version of CDN health (non-raw view).
+
+ In operation of the health protocol, Traffic Monitor takes all health states from all peers, including the locally known health state, and serves an optimistic outlook to the requesting client. This means that, for example, if three of the four Traffic Monitors see a given cache or Delivery Service as exceeding its thresholds and unavailable, it is still considered available. Only if all Traffic Monitors agree that the given object is unavailable is that state propagated to upstream components. This optimistic approach to the Health Protocol is counter to the "fail fast" philosophy, but serves well for large networks with complicated geography and or routing. The optimistic Health Protocol allows network failures or latency to occur without affecting overall traffic routing, as Traffic Monitors can and do have a different view of the network when deployed in geographically diverse locations. Short polling intervals of both the caches and Traffic Monitor peers help to reduce custom
er impact of outages.
+
+It is not uncommon for a cache to be marked unavailable by Traffic Monitor - in fact, it is business as usual for many CDNs. A hot video asset may cause a single cache (say cache-03) to get close to it's interface capacity, the health protocol "kicks in", and Traffic Monitor marks cache-03 as unavailable. New clients want to see the same asset, and now, Traffic Router will send these customers to another cache (say cache-01) in the same cachegroup. The load is now shared between cache-01 and cache-03. As clients finish watching the asset on cache-03, it will drop below the threshold and gets marked available again, and new clients will now go back to cache-03 again.
+
+It is less common for a delivery service to be marked unavailable by Traffic Monitor, the delivery service thresholds are usually used for overflow situations at extreme peaks to protect other delivery services in the CDN from getting impacted.
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/overview/traffic_ops.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/overview/traffic_ops.rst.txt b/docs/latest/_sources/overview/traffic_ops.rst.txt
deleted file mode 100644
index 9cc72ee..0000000
--- a/docs/latest/_sources/overview/traffic_ops.rst.txt
+++ /dev/null
@@ -1,39 +0,0 @@
-..
-..
-.. Licensed 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.
-..
-
-.. |arrow| image:: fwda.png
-
-Traffic Ops
-===========
-Traffic Ops is the tool for administration (configuration and monitoring) of all components in a Traffic Control CDN. The CDN administrator uses Traffic Ops to manage servers, cache groups, delivery services, etc. In many cases, a configuration change requires propagation to several, or even all, caches and only explicitly after or before the same change propagates to Traffic Router. Traffic Ops takes care of this required consistency between the different components and their configuration. Traffic Ops exposes its data through a series of HTTP APIs and has a user interface that is interactive and viewable using a standard web browser.
-
-Traffic Ops uses a MySQL or PostgreSQL database to store the configuration information, and the `Mojolicious framework <http://mojolicio.us/>`_ to generate the user interface and APIs. Not all configuration data is in this database however; for sensitive data, like SSL private keys or token based authentication shared secrets, a separate key-value store is used, allowing the operator to harden the server that runs this key-value store better from a security perspective (i.e only allow Traffic Ops access it with a cert). The Traffic Ops server, by design, needs to be accessible from all the other servers in the Traffic Control CDN.
-
-Traffic Ops generates all the application specific configuration files for the caches and other servers. The caches and other servers check in with Traffic Ops at a regular interval (default 15 minutes) to see if updated configuration files require application.
-
-Traffic Ops also runs a collection of periodic checks to determine the operational readiness of the caches. These periodic checks are customizable by the Traffic Ops admin using extensions.
-
-|
-
-.. _rl-trops-ext:
-
-|arrow| Traffic Ops Extension
------------------------------
- Traffic Ops Extensions are a way to enhance the basic functionality of Traffic Ops in a custom manner. There are three types of extensions:
-
- * Check Extensions - Allows you to add custom checks to the "Health->Server Checks" view.
- * Configuration Extension - Allows you to add custom configuration file generators.
- * Data source Extensions - Allows you to add data sources for the graph views and usage APIs.
-
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/overview/traffic_ops.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/overview/traffic_ops.txt b/docs/latest/_sources/overview/traffic_ops.txt
new file mode 100644
index 0000000..9cc72ee
--- /dev/null
+++ b/docs/latest/_sources/overview/traffic_ops.txt
@@ -0,0 +1,39 @@
+..
+..
+.. Licensed 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.
+..
+
+.. |arrow| image:: fwda.png
+
+Traffic Ops
+===========
+Traffic Ops is the tool for administration (configuration and monitoring) of all components in a Traffic Control CDN. The CDN administrator uses Traffic Ops to manage servers, cache groups, delivery services, etc. In many cases, a configuration change requires propagation to several, or even all, caches and only explicitly after or before the same change propagates to Traffic Router. Traffic Ops takes care of this required consistency between the different components and their configuration. Traffic Ops exposes its data through a series of HTTP APIs and has a user interface that is interactive and viewable using a standard web browser.
+
+Traffic Ops uses a MySQL or PostgreSQL database to store the configuration information, and the `Mojolicious framework <http://mojolicio.us/>`_ to generate the user interface and APIs. Not all configuration data is in this database however; for sensitive data, like SSL private keys or token based authentication shared secrets, a separate key-value store is used, allowing the operator to harden the server that runs this key-value store better from a security perspective (i.e only allow Traffic Ops access it with a cert). The Traffic Ops server, by design, needs to be accessible from all the other servers in the Traffic Control CDN.
+
+Traffic Ops generates all the application specific configuration files for the caches and other servers. The caches and other servers check in with Traffic Ops at a regular interval (default 15 minutes) to see if updated configuration files require application.
+
+Traffic Ops also runs a collection of periodic checks to determine the operational readiness of the caches. These periodic checks are customizable by the Traffic Ops admin using extensions.
+
+|
+
+.. _rl-trops-ext:
+
+|arrow| Traffic Ops Extension
+-----------------------------
+ Traffic Ops Extensions are a way to enhance the basic functionality of Traffic Ops in a custom manner. There are three types of extensions:
+
+ * Check Extensions - Allows you to add custom checks to the "Health->Server Checks" view.
+ * Configuration Extension - Allows you to add custom configuration file generators.
+ * Data source Extensions - Allows you to add data sources for the graph views and usage APIs.
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/overview/traffic_portal.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/overview/traffic_portal.rst.txt b/docs/latest/_sources/overview/traffic_portal.rst.txt
deleted file mode 100644
index 20325e4..0000000
--- a/docs/latest/_sources/overview/traffic_portal.rst.txt
+++ /dev/null
@@ -1,43 +0,0 @@
-..
-..
-.. Licensed 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.
-..
-
-.. index::
- Traffic Portal - Overview
-
-Traffic Portal
-==============
-Traffic Portal is an `AngularJS 1.x <https://angularjs.org/>`_ client served from a `Node.js <https://nodejs.org/en/>`_ web server designed to consume the Traffic Ops 1.x API. Traffic Portal provides a set of functionality restricted to the delivery service(s) of the authenticated user. Functionality primarily includes a set of charts / graphs designed to provide insight into the performance of a user's delivery service(s).
-
-Charts / Graphs include:
-
- - Overall Cache Group Status
- - Delivery Service Bandwidth Per Second
- - Delivery Service Transactions Per Second
- - Delivery Service HTTP Status By Class
- - Delivery Service Capacity
- - Delivery Service Routing Methods
- - Delivery Service Cache Group Status
-
-Other features:
-
- - Ability to manager user profile
- - Ability to reset user password
- - Ability to view delivery service configuration
- - Ability to invalidate content for a delivery service
- - Ability to retrieve all caches associated with a delivery service
- - Ability to request a new delivery service
-
-
-
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/overview/traffic_portal.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/overview/traffic_portal.txt b/docs/latest/_sources/overview/traffic_portal.txt
new file mode 100644
index 0000000..20325e4
--- /dev/null
+++ b/docs/latest/_sources/overview/traffic_portal.txt
@@ -0,0 +1,43 @@
+..
+..
+.. Licensed 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.
+..
+
+.. index::
+ Traffic Portal - Overview
+
+Traffic Portal
+==============
+Traffic Portal is an `AngularJS 1.x <https://angularjs.org/>`_ client served from a `Node.js <https://nodejs.org/en/>`_ web server designed to consume the Traffic Ops 1.x API. Traffic Portal provides a set of functionality restricted to the delivery service(s) of the authenticated user. Functionality primarily includes a set of charts / graphs designed to provide insight into the performance of a user's delivery service(s).
+
+Charts / Graphs include:
+
+ - Overall Cache Group Status
+ - Delivery Service Bandwidth Per Second
+ - Delivery Service Transactions Per Second
+ - Delivery Service HTTP Status By Class
+ - Delivery Service Capacity
+ - Delivery Service Routing Methods
+ - Delivery Service Cache Group Status
+
+Other features:
+
+ - Ability to manager user profile
+ - Ability to reset user password
+ - Ability to view delivery service configuration
+ - Ability to invalidate content for a delivery service
+ - Ability to retrieve all caches associated with a delivery service
+ - Ability to request a new delivery service
+
+
+