http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/8582b168/docs/1.1.2/_sources/development/traffic_ops_rest/user.txt ---------------------------------------------------------------------- diff --git a/docs/1.1.2/_sources/development/traffic_ops_rest/user.txt b/docs/1.1.2/_sources/development/traffic_ops_rest/user.txt new file mode 100644 index 0000000..0fb8ae6 --- /dev/null +++ b/docs/1.1.2/_sources/development/traffic_ops_rest/user.txt @@ -0,0 +1,643 @@ +.. +.. Copyright 2015 Comcast Cable Communications Management, LLC +.. +.. 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. +.. + +.. _to-api-users: + +Users +===== + +**GET /api/1.1/users.json** + + Retrieves all users. + + Authentication Required: Yes + + **Response Properties** + + +----------------------+--------+------------------------------------------------+ + | Parameter | Type | Description | + +======================+========+================================================+ + |``email`` | string | | + +----------------------+--------+------------------------------------------------+ + |``city`` | string | | + +----------------------+--------+------------------------------------------------+ + |``id`` | hash | | + +----------------------+--------+------------------------------------------------+ + |``phoneNumber`` | string | | + +----------------------+--------+------------------------------------------------+ + |``company`` | string | | + +----------------------+--------+------------------------------------------------+ + |``country`` | string | | + +----------------------+--------+------------------------------------------------+ + |``fullName`` | string | | + +----------------------+--------+------------------------------------------------+ + |``localUser`` | string | | + +----------------------+--------+------------------------------------------------+ + |``uid`` | string | | + +----------------------+--------+------------------------------------------------+ + |``username`` | string | | + +----------------------+--------+------------------------------------------------+ + |``rolename`` | string | | + +----------------------+--------+------------------------------------------------+ + |``newUser`` | string | | + +----------------------+--------+------------------------------------------------+ + |``addressLine2`` | string | | + +----------------------+--------+------------------------------------------------+ + |``role`` | string | | + +----------------------+--------+------------------------------------------------+ + |``addressLine1`` | string | | + +----------------------+--------+------------------------------------------------+ + |``postalCode`` | string | | + +----------------------+--------+------------------------------------------------+ + |``gid`` | string | | + +----------------------+--------+------------------------------------------------+ + + + **Response Example** :: + + + [ + { + "email": "[email protected]", + "city": "", + "id": "54", + "phoneNumber": "", + "company": "", + "country": "", + "fullName": "Bob Simpson", + "localUser": false, + "uid": "0", + "stateOrProvince": "", + "username": "bsimpson", + "rolename": "portal", + "newUser": true, + "addressLine2": "", + "role": "6", + "addressLine1": "", + "postalCode": "", + "gid": "0" + } + ] + + +| + +**GET /api/1.1/user/current.json** + + Retrieves the profile for the authenticated user. + + Authentication Required: Yes + + **Request Properties** + + +----------------------+--------+------------------------------------------------+ + | Parameter | Type | Description | + +======================+========+================================================+ + |``email`` | string | | + +----------------------+--------+------------------------------------------------+ + |``city`` | string | | + +----------------------+--------+------------------------------------------------+ + |``id`` | string | | + +----------------------+--------+------------------------------------------------+ + |``phoneNumber`` | string | | + +----------------------+--------+------------------------------------------------+ + |``company`` | string | | + +----------------------+--------+------------------------------------------------+ + |``country`` | string | | + +----------------------+--------+------------------------------------------------+ + |``fullName`` | string | | + +----------------------+--------+------------------------------------------------+ + |``localUser`` | boolean| | + +----------------------+--------+------------------------------------------------+ + |``uid`` | string | | + +----------------------+--------+------------------------------------------------+ + |``stateOrProvince`` | string | | + +----------------------+--------+------------------------------------------------+ + |``username`` | string | | + +----------------------+--------+------------------------------------------------+ + |``newUser`` | boolean| | + +----------------------+--------+------------------------------------------------+ + |``addressLine2`` | string | | + +----------------------+--------+------------------------------------------------+ + |``role`` | string | | + +----------------------+--------+------------------------------------------------+ + |``addressLine1`` | string | | + +----------------------+--------+------------------------------------------------+ + |``gid`` | string | | + +----------------------+--------+------------------------------------------------+ + |``postalCode`` | string | | + +----------------------+--------+------------------------------------------------+ + + **Response Example** :: + + { + âresponseâ: { + âemailâ: "[email protected]", + âcityâ: "", + âidâ: "50", + âphoneNumberâ: "", + âcompanyâ: "", + âcountryâ: "", + âfullNameâ: "Tom Callahan", + âlocalUserâ: true, + âuidâ: "0", + âstateOrProvinceâ: "", + âusernameâ: "tommyboy", + ânewUserâ: false, + âaddressLine2â: "", + âroleâ: "6", + âaddressLine1â: "", + âgidâ: "0", + âpostalCodeâ: "" + }, + âversionâ: "1.1" + } + +| + +**POST /api/1.1/user/current/update** + + Updates the date for the authenticated user. + + Authentication Required: Yes + + **Request Properties** + + +----------------------+--------+------------------------------------------------+ + | Parameter | Type | Description | + +======================+========+================================================+ + |``email`` | string | | + +----------------------+--------+------------------------------------------------+ + |``city`` | string | | + +----------------------+--------+------------------------------------------------+ + |``id`` | string | | + +----------------------+--------+------------------------------------------------+ + |``phoneNumber`` | string | | + +----------------------+--------+------------------------------------------------+ + |``company`` | string | | + +----------------------+--------+------------------------------------------------+ + |``country`` | string | | + +----------------------+--------+------------------------------------------------+ + |``fullName`` | string | | + +----------------------+--------+------------------------------------------------+ + |``localUser`` | boolean| | + +----------------------+--------+------------------------------------------------+ + |``uid`` | string | | + +----------------------+--------+------------------------------------------------+ + |``stateOrProvince`` | string | | + +----------------------+--------+------------------------------------------------+ + |``username`` | string | | + +----------------------+--------+------------------------------------------------+ + |``newUser`` | boolean| | + +----------------------+--------+------------------------------------------------+ + |``addressLine2`` | string | | + +----------------------+--------+------------------------------------------------+ + |``role`` | string | | + +----------------------+--------+------------------------------------------------+ + |``addressLine1`` | string | | + +----------------------+--------+------------------------------------------------+ + |``gid`` | string | | + +----------------------+--------+------------------------------------------------+ + |``postalCode`` | string | | + +----------------------+--------+------------------------------------------------+ + + **Request Example** :: + + + { + "user": { + "email": "", + "city": "", + "id": "", + "phoneNumber": "", + "company": "", + "country": "", + "fullName": "", + "localUser": true, + "uid": "0", + "stateOrProvince": "", + "username": "tommyboy", + "newUser": false, + "addressLine2": "", + "role": "6", + "addressLine1": "", + "gid": "0", + "postalCode": "" + } + } + + **Response Properties** + + +-------------+--------+----------------------------------+ + | Parameter | Type | Description | + +=============+========+==================================+ + | ``alerts`` | array | A collection of alert messages. | + +-------------+--------+----------------------------------+ + | ``>level`` | string | Success, info, warning or error. | + +-------------+--------+----------------------------------+ + | ``>text`` | string | Alert message. | + +-------------+--------+----------------------------------+ + | ``version`` | string | | + +-------------+--------+----------------------------------+ + + **Response Example** :: + + { + "alerts": [ + { + "level": "success", + "text": "UserProfile was successfully updated." + } + ], + "version": "1.1" + } + + +**GET /api/1.1/user/current/jobs.json** + + Retrieves user purge jobs. + + Authentication Required: Yes + + **Response Properties** + + +----------------------+--------+------------------------------------------------+ + | Parameter | Type | Description | + +======================+========+================================================+ + |``keyword`` | string | | + +----------------------+--------+------------------------------------------------+ + |``objectName`` | string | | + +----------------------+--------+------------------------------------------------+ + |``assetUrl`` | string | | + +----------------------+--------+------------------------------------------------+ + |``assetType`` | string | | + +----------------------+--------+------------------------------------------------+ + |``status`` | string | | + +----------------------+--------+------------------------------------------------+ + |``dsId`` | string | | + +----------------------+--------+------------------------------------------------+ + |``dsXmlId`` | string | | + +----------------------+--------+------------------------------------------------+ + |``username`` | boolean| | + +----------------------+--------+------------------------------------------------+ + |``parameters`` | string | | + +----------------------+--------+------------------------------------------------+ + |``enteredTime`` | string | | + +----------------------+--------+------------------------------------------------+ + |``objectType`` | string | | + +----------------------+--------+------------------------------------------------+ + |``agent`` | string | | + +----------------------+--------+------------------------------------------------+ + |``id`` | string | | + +----------------------+--------+------------------------------------------------+ + |``startTime`` | string | | + +----------------------+--------+------------------------------------------------+ + |``version`` | string | | + +----------------------+--------+------------------------------------------------+ + + **Response Example** + :: + + { + "response": [ + { + "id": "1", + "keyword": "PURGE", + "objectName": null, + "assetUrl": "", + "assetType": "file", + "status": "PENDING", + "dsId": "73", + "dsXmlId": "cim-jitp", + "username": "peewee", + "parameters": "TTL:56h", + "enteredTime": "2015-01-21 18:00:16", + "objectType": null, + "agent": "", + "startTime": "2015-01-21 10:45:38" + } + ], + "version": "1.1" + } + + +| + +**POST/api/1.1/user/current/jobs** + + Creates a purge job. + + Authentication Required: Yes + + + **Request Properties** + + +----------------------+--------+------------------------------------------------+ + | Parameter | Type | Description | + +======================+========+================================================+ + |``dsId`` | string | | + +----------------------+--------+------------------------------------------------+ + |``dsXmlId`` | string | | + +----------------------+--------+------------------------------------------------+ + |``regex`` | string | | + +----------------------+--------+------------------------------------------------+ + |``startTime`` | string | | + +----------------------+--------+------------------------------------------------+ + |``ttl`` | int | | + +----------------------+--------+------------------------------------------------+ + + **Request Example** :: + + { + "dsId": "73", + "dsXmlId": "cim-jitp", + "regex": "/path/to/content.jpg", + "startTime": "2015-01-27 11:08:37", + "ttl": 54 + } + + Response Content Type: application/json + + **Response Properties** + + +-------------+--------+----------------------------------+ + | Parameter | Type | Description | + +=============+========+==================================+ + | ``alerts`` | array | A collection of alert messages. | + +-------------+--------+----------------------------------+ + | ``>level`` | string | Success, info, warning or error. | + +-------------+--------+----------------------------------+ + | ``>text`` | string | Alert message. | + +-------------+--------+----------------------------------+ + | ``version`` | string | | + +-------------+--------+----------------------------------+ + + **Response Example** :: + + { + âalertsâ: + [ + { + âlevelâ: "success", + âtextâ: "Successfully created purge job for: ." + } + ], + âversionâ: "1.1" + } + + +| + +**POST /api/1.1/user/login { u: '', p: '' }** + + Authentication of a user using username and password. Traffic Ops will send back a session cookie. + + Authentication Required: No + + **Request Properties** + + +----------------------+--------+------------------------------------------------+ + | Parameter | Type | Description | + +======================+========+================================================+ + |``u`` | string | username | + +----------------------+--------+------------------------------------------------+ + |``p`` | string | password | + +----------------------+--------+------------------------------------------------+ + + **Request Example** + + :: + + { + "u": "username", + "p": "password" + } + + Response Content Type: application/json + + **Response Properties** + + +-------------+--------+----------------------------------+ + | Parameter | Type | Description | + +=============+========+==================================+ + | ``alerts`` | array | A collection of alert messages. | + +-------------+--------+----------------------------------+ + | ``>level`` | string | Success, info, warning or error. | + +-------------+--------+----------------------------------+ + | ``>text`` | string | Alert message. | + +-------------+--------+----------------------------------+ + | ``version`` | string | | + +-------------+--------+----------------------------------+ + + **Response Example** :: + + { + "alerts": [ + { + "level": "success", + "text": "Successfully logged in." + } + ], + "version": "1.1" + } + +| + +**GET /api/1.1/user/:id/deliveryservices/available.json** + + Authentication Required: Yes + + **Request Route Parameters** + + +-----------------+----------+---------------------------------------------------+ + | Name | Required | Description | + +=================+==========+===================================================+ + |id | yes | | + +-----------------+----------+---------------------------------------------------+ + + **Response Properties** + + +----------------------+--------+------------------------------------------------+ + | Parameter | Type | Description | + +======================+========+================================================+ + |``xmlId`` | string | | + +----------------------+--------+------------------------------------------------+ + |``id`` | string | | + +----------------------+--------+------------------------------------------------+ + + **Response Example** :: + + + { + "response": [ + { + "xmlId": "ns-img", + "id": "90" + }, + { + "xmlId": "ns-img-secure", + "id": "280" + } + ], + "version": "1.1" + } + +| + +**POST /api/1.1/user/login/token** + + Authentication of a user using a token. + + Authentication Required: No + + **Request Route Properties** + + +----------------------+--------+------------------------------------------------+ + | Parameter | Type | Description | + +======================+========+================================================+ + |``t`` | string | token-value | + +----------------------+--------+------------------------------------------------+ + + **Request Example** + + :: + + + { + "t": "token-value" + } + + Response Content Type: application/json + + **Response Properties** + + +-------------+--------+-------------+ + | Parameter | Type | Description | + +=============+========+=============+ + | ``alerts`` | array | | + +-------------+--------+-------------+ + | ``>level`` | string | | + +-------------+--------+-------------+ + | ``>text`` | string | | + +-------------+--------+-------------+ + | ``version`` | string | | + +-------------+--------+-------------+ + + **Response Example** :: + + { + "alerts": [ + { + "level": "error", + "text": "Unauthorized, please log in." + } + ], + "version": "1.1" + } + + +| + + +**POST /api/1.1/user/logout** + + User logout. Invalidates the session cookie. + + Authentication Required: Yes + + **Response Properties** + + +----------------------+--------+------------------------------------------------+ + | Parameter | Type | Description | + +======================+========+================================================+ + |``alerts`` | array | | + +----------------------+--------+------------------------------------------------+ + |* ``level`` | string | | + +----------------------+--------+------------------------------------------------+ + |* ``text`` | string | | + +----------------------+--------+------------------------------------------------+ + |``version`` | string | | + +----------------------+--------+------------------------------------------------+ + + **Response Example** + + :: + + { + "alerts": [ + { + "level": "success", + "text": "You are logged out." + } + ], + "version": "1.1" + } + + +| + +**POST /api/1.1/user/reset_password** + + Reset user password. + + Authentication Required: No + + **Request Properties** + + +----------------------+--------+------------------------------------------------+ + | Parameter | Type | Description | + +======================+========+================================================+ + |``email`` | string | The email address of the user to initiate | + | | | password reset. | + +----------------------+--------+------------------------------------------------+ + + **Request Example** + + :: + + { + "email": "[email protected]" + } + + **Response Properties** + + +----------------------+--------+------------------------------------------------+ + | Parameter | Type | Description | + +======================+========+================================================+ + |``alerts`` | array | A collection of alert messages. | + +----------------------+--------+------------------------------------------------+ + |* ``level`` | string | Success, info, warning or error. | + +----------------------+--------+------------------------------------------------+ + |* ``text`` | string | Alert message. | + +----------------------+--------+------------------------------------------------+ + |``version`` | string | | + +----------------------+--------+------------------------------------------------+ + + **Response Example** :: + + + + { + "alerts": [ + { + "level": "success", + "text": "Successfully logged in." + } + ], + "version": "1.1" + } + + \ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/8582b168/docs/1.1.2/_sources/development/traffic_router.txt ---------------------------------------------------------------------- diff --git a/docs/1.1.2/_sources/development/traffic_router.txt b/docs/1.1.2/_sources/development/traffic_router.txt new file mode 100644 index 0000000..f8a78a0 --- /dev/null +++ b/docs/1.1.2/_sources/development/traffic_router.txt @@ -0,0 +1,131 @@ +.. +.. Copyright 2015 Comcast Cable Communications Management, LLC +.. +.. 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 + * 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/`` - 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 + + * ``db`` - Files downloaded by unit tests + * ``java/`` - JUnit based unit tests for Traffic Router Core + * ``resources/`` - Configuration files used by unit 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. If you are not running Traffic Monitor locally (http://localhost:8080) from within Eclipse, edit the following parameter in core/src/test/resources/traffic_monitor.properties and point it to an instance, or instances of Traffic Monitor for your chosen CDN: + ++-------------------------------------+------------------------------------------------------------------------------------------------------------------+ +| 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. + +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/8582b168/docs/1.1.2/_sources/development/traffic_router/traffic_router_api.txt ---------------------------------------------------------------------- diff --git a/docs/1.1.2/_sources/development/traffic_router/traffic_router_api.txt b/docs/1.1.2/_sources/development/traffic_router/traffic_router_api.txt new file mode 100644 index 0000000..e00a30e --- /dev/null +++ b/docs/1.1.2/_sources/development/traffic_router/traffic_router_api.txt @@ -0,0 +1,49 @@ +.. +.. Copyright 2015 Comcast Cable Communications Management, LLC +.. +.. 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/8582b168/docs/1.1.2/_sources/development/traffic_server.txt ---------------------------------------------------------------------- diff --git a/docs/1.1.2/_sources/development/traffic_server.txt b/docs/1.1.2/_sources/development/traffic_server.txt new file mode 100644 index 0000000..25014b3 --- /dev/null +++ b/docs/1.1.2/_sources/development/traffic_server.txt @@ -0,0 +1,20 @@ +.. +.. Copyright 2015 Comcast Cable Communications Management, LLC +.. +.. 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/8582b168/docs/1.1.2/_sources/development/traffic_stats.txt ---------------------------------------------------------------------- diff --git a/docs/1.1.2/_sources/development/traffic_stats.txt b/docs/1.1.2/_sources/development/traffic_stats.txt new file mode 100644 index 0000000..0e5a232 --- /dev/null +++ b/docs/1.1.2/_sources/development/traffic_stats.txt @@ -0,0 +1,45 @@ +.. +.. Copyright 2015 Comcast Cable Communications Management, LLC +.. +.. 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 ... + +Software Requirements +===================== +To work on Traffic Stats you need a \*nix (MacOS and Linux are most commonly used) environment that has the following installed: + +* ? + +Traffic Stats Project Tree Overview +===================================== + +Go Formatting Conventions +============================ + +Installing The Developer Environment +==================================== +To install the Traffic Ops Developer environment: + +1. Clone the traffic_control repository using Git. + +Test Cases +========== +The test harness ... + http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/8582b168/docs/1.1.2/_sources/faq/administration.txt ---------------------------------------------------------------------- diff --git a/docs/1.1.2/_sources/faq/administration.txt b/docs/1.1.2/_sources/faq/administration.txt new file mode 100644 index 0000000..172783c --- /dev/null +++ b/docs/1.1.2/_sources/faq/administration.txt @@ -0,0 +1,69 @@ +.. +.. Copyright 2015 Comcast Cable Communications Management, LLC +.. +.. 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. After creating the edge cache group, go to **Parameters > All Profiles**, type CDN_Name in the search box, and click "Edit" for any row of this parameter. Then in the Parameter detail view, click the **Add Cachegroup** button, select your newly created cachegroup, and click **Save**. + + add CDN_Name parameter + + * 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/8582b168/docs/1.1.2/_sources/faq/development.txt ---------------------------------------------------------------------- diff --git a/docs/1.1.2/_sources/faq/development.txt b/docs/1.1.2/_sources/faq/development.txt new file mode 100644 index 0000000..4c0c13b --- /dev/null +++ b/docs/1.1.2/_sources/faq/development.txt @@ -0,0 +1,21 @@ +.. +.. Copyright 2015 Comcast Cable Communications Management, LLC +.. +.. 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? +========================== \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/8582b168/docs/1.1.2/_sources/faq/general.txt ---------------------------------------------------------------------- diff --git a/docs/1.1.2/_sources/faq/general.txt b/docs/1.1.2/_sources/faq/general.txt new file mode 100644 index 0000000..8fa97cf --- /dev/null +++ b/docs/1.1.2/_sources/faq/general.txt @@ -0,0 +1,38 @@ +.. +.. Copyright 2015 Comcast Cable Communications Management, LLC +.. +.. 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 or Traffic Control and is using it for all it's video delivery to so-called 'second screen applications' (PCs, tablets, phones), but also for delivering images and software to it's X1 platform, and other applications. The Traffic Control CDN at Comcast serves more than a peta byte of content a day. + + `Cox Communications <http://www.cox.com/>`_ + . + +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 name for Traffic Ops. You will sometimes still see this name in the source, or in older documents. It's also a good movie. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/8582b168/docs/1.1.2/_sources/faq/index.txt ---------------------------------------------------------------------- diff --git a/docs/1.1.2/_sources/faq/index.txt b/docs/1.1.2/_sources/faq/index.txt new file mode 100644 index 0000000..c72fbe4 --- /dev/null +++ b/docs/1.1.2/_sources/faq/index.txt @@ -0,0 +1,27 @@ +.. +.. Copyright 2015 Comcast Cable Communications Management, LLC +.. +.. 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/8582b168/docs/1.1.2/_sources/glossary.txt ---------------------------------------------------------------------- diff --git a/docs/1.1.2/_sources/glossary.txt b/docs/1.1.2/_sources/glossary.txt new file mode 100644 index 0000000..b32bea9 --- /dev/null +++ b/docs/1.1.2/_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/8582b168/docs/1.1.2/_sources/index.txt ---------------------------------------------------------------------- diff --git a/docs/1.1.2/_sources/index.txt b/docs/1.1.2/_sources/index.txt new file mode 100644 index 0000000..2c49467 --- /dev/null +++ b/docs/1.1.2/_sources/index.txt @@ -0,0 +1,81 @@ +.. +.. Copyright 2015 Comcast Cable Communications Management, LLC +.. +.. 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/8582b168/docs/1.1.2/_sources/overview/index.txt ---------------------------------------------------------------------- diff --git a/docs/1.1.2/_sources/overview/index.txt b/docs/1.1.2/_sources/overview/index.txt new file mode 100644 index 0000000..b3f21d5 --- /dev/null +++ b/docs/1.1.2/_sources/overview/index.txt @@ -0,0 +1,31 @@ +.. +.. Copyright 2015 Comcast Cable Communications Management, LLC +.. +.. 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_router + traffic_monitor + traffic_stats + traffic_portal + traffic_server + traffic_vault http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/8582b168/docs/1.1.2/_sources/overview/introduction.txt ---------------------------------------------------------------------- diff --git a/docs/1.1.2/_sources/overview/introduction.txt b/docs/1.1.2/_sources/overview/introduction.txt new file mode 100644 index 0000000..c379578 --- /dev/null +++ b/docs/1.1.2/_sources/overview/introduction.txt @@ -0,0 +1,29 @@ +.. +.. Copyright 2015 Comcast Cable Communications Management, LLC +.. +.. 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 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/8582b168/docs/1.1.2/_sources/overview/traffic_monitor.txt ---------------------------------------------------------------------- diff --git a/docs/1.1.2/_sources/overview/traffic_monitor.txt b/docs/1.1.2/_sources/overview/traffic_monitor.txt new file mode 100644 index 0000000..e25fcbc --- /dev/null +++ b/docs/1.1.2/_sources/overview/traffic_monitor.txt @@ -0,0 +1,67 @@ +.. +.. Copyright 2015 Comcast Cable Communications Management, LLC +.. +.. 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/8582b168/docs/1.1.2/_sources/overview/traffic_ops.txt ---------------------------------------------------------------------- diff --git a/docs/1.1.2/_sources/overview/traffic_ops.txt b/docs/1.1.2/_sources/overview/traffic_ops.txt new file mode 100644 index 0000000..59720e2 --- /dev/null +++ b/docs/1.1.2/_sources/overview/traffic_ops.txt @@ -0,0 +1,40 @@ +.. +.. Copyright 2015 Comcast Cable Communications Management, LLC +.. +.. 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/8582b168/docs/1.1.2/_sources/overview/traffic_portal.txt ---------------------------------------------------------------------- diff --git a/docs/1.1.2/_sources/overview/traffic_portal.txt b/docs/1.1.2/_sources/overview/traffic_portal.txt new file mode 100644 index 0000000..21d7438 --- /dev/null +++ b/docs/1.1.2/_sources/overview/traffic_portal.txt @@ -0,0 +1,24 @@ +.. +.. Copyright 2015 Comcast Cable Communications Management, LLC +.. +.. 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 a user interface for CDN tenants to view performance, and in most cases, change settings of their delivery services. Traffic Portal is an Angular JS application written against the Traffic Ops APIs. + +.. Note:: The Traffic Portal is not being released to Open Source in the initial release. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/8582b168/docs/1.1.2/_sources/overview/traffic_router.txt ---------------------------------------------------------------------- diff --git a/docs/1.1.2/_sources/overview/traffic_router.txt b/docs/1.1.2/_sources/overview/traffic_router.txt new file mode 100644 index 0000000..d1bf596 --- /dev/null +++ b/docs/1.1.2/_sources/overview/traffic_router.txt @@ -0,0 +1,109 @@ +.. +.. Copyright 2015 Comcast Cable Communications Management, LLC +.. +.. 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-tr: + +.. |arrow| image:: fwda.png + +.. index:: + Traffic Router - Overview + +Traffic Router +============== +Traffic Router's function is to send clients to the most optimal cache. Optimal in this case is based on a number of factors: + +* Distance between the cache and the client (not necessarily measured in meters, but quite often in layer 3 network hops). Less network distance between the client and cache yields better performance, and lower network load. Traffic Router helps clients connect to the best performing cache for their location at the lowest network cost. + +* Availability of caches and health / load on the caches. A common issue in Internet and television distribution scenarios is having many clients attempting to retrieve the same content at the same time. Traffic Router helps clients route around overloaded or down caches. + +* Availability of content on a particular cache. Reusing of content through cache HITs is the most important performance gain a CDN can offer. Traffic Router sends clients to the cache that is most likely to already have the desired content. + +Traffic routing options are often configured at the Delivery Service level. + +| + + +.. _rl-ds: + +|arrow| Delivery Service +------------------------ + As discussed in the basic concepts section, the EDGE caches are configured as reverse proxies, and the Traffic Control CDN looks from the outside as a very large reverse proxy. Delivery Services are often referred to a reverse proxy remap rule. In most cases, a Delivery Service is a one to one mapping to a FQDN that is used as a hostname to deliver the content. Many options and settings regarding how to optimize the content delivery, which is configurable on a Delivery Service basis. Some examples of these Delivery Service settings are: + + * Cache in RAM, cache on disk, or do not cache at all. + * Use DNS or HTTP Content routing (see below). + * Limits on transactions per second and bandwidth. + * Protocol (http or https). + * Token based authentication settings. + * Header rewrite rules. + + Delivery Services are also for use in allowing multi-tenants to coexist in the Traffic Control CDN without interfering with each other, and to keep information about their content separated. + +| + +.. _rl-localization: + +|arrow| Localization +-------------------- + Traffic Router uses a SJON input file called the *coverage zone map* to determine what *cachegroup* is closest to the client. If the client IP address is not in this coverage zone map, it falls back to *geo*, using the maxmind database to find the client's location, and the geo coordinates from Traffic Ops for the cachegroup. + +| + +Traffic Router is inserted into the HTTP retrieval process by making it DNS authoritative for the domain of the CDN delivery service. In the example of the reverse proxy, the client was given the ``http://www-origin-cache.cdn.com/foo/bar/fun.html url``. In a Traffic Control CDN, URLs start with either ``tr.`` or ``edge.``, for HTTP or DNS content routing respectively. These names are configurable via properties files within the Traffic Router installation. + +| + +.. index:: + Content Routing + +.. _rl-dns-cr: + +|arrow| DNS Content Routing +--------------------------- + For a DNS delivery service the client receives a URL with a hostname beginning with ``edge.`` (e.g. http://edge.dsname.cdn.com/foo/bar/fun.html). When the LDNS server is resolving this ``edge.dsname.cdn.com`` hostname to an IP address, it ends at Traffic Router because it is the authoritative DNS server for ``cdn.com`` and the domains below it, and subsequently responds with a list of IP addresses from the eligible caches based on the location of the LDNS server. When responding, Traffic Router does not know the actual client IP address or the path that the client is going to request. The decision on what cache IP address (or list of cache IP addresses) to return is solely based on the location of the LDNS server and the health of the caches. The client then connects to port 80 on the cache, and sends the ``Host: edge.dsname.cdn.com`` header. The configuration of the cache includes the remap rule ``http://edge.dsname.cdn.com http://origin.dsname.com`` to map that edge name to an o rigin hostname. + +| + +.. _rl-http-cr: + +|arrow| HTTP Content Routing +---------------------------- + For an HTTP delivery service the client receives a URL with a hostname beginning with ``tr.`` (e.g. http://tr.dsname.cdn.com/foo/bar/fun.html), the LDNS server resolves this ``tr.dsname.cdn.com`` to an IP address, but in this case Traffic Router returns its own IP address. The client opens a connection to port 80 on the Traffic Router's IP address, and sends: :: + + GET /foo/bar/fun.html HTTP/1.1 + Host: tr.dsname.cdn.com + + Traffic Router uses an HTTP 302 to redirect the client to the best cache. For example: :: + + HTTP/1.1 302 Moved Temporarily + Server: Apache-Coyote/1.1 + Location: http://atsec-nyc-02.dsname.cdn.com/foo/bar/fun.html + Content-Length: 0 + Date: Tue, 13 Jan 2015 20:01:41 GMT + + The information Traffic Router can consider when selecting a cache in this case is much better: + + * The client's IP address (the other side of the socket). + * The URL path the client is requesting. + * All HTTP 1.1 headers. + + The client follows the redirect and performs a DNS request for the IP address for ``atsec-nyc-02.dsname.cdn.com``, and normal HTTP steps follow, except the sending of the Host: header when connected to the cache is ``Host: atsec-nyc-02.dsname.cdn``, and the configuration of the cache includes the remap rule (e.g.``http://atsec-nyc-02.dsname.cdn http://origin.dsname.com``). + + Traffic Router sends all requests for the same path in a delivery service to the same cache in a cache group using consistent hashing, in this case all caches in a cache group are not carrying the same content, and there is a much larger combined cache in the cache group. + +In many cases DNS content routing is the best possible option, especially in cases where the client is receiving small objects from the CDN like images and web pages. + +Traffic Router is redundant and horizontally scalable by adding more instances into the DNS hierarchy +.. (MAT/JSE to expand or word better) http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/8582b168/docs/1.1.2/_sources/overview/traffic_server.txt ---------------------------------------------------------------------- diff --git a/docs/1.1.2/_sources/overview/traffic_server.txt b/docs/1.1.2/_sources/overview/traffic_server.txt new file mode 100644 index 0000000..d99aa92 --- /dev/null +++ b/docs/1.1.2/_sources/overview/traffic_server.txt @@ -0,0 +1,50 @@ +.. +.. Copyright 2015 Comcast Cable Communications Management, LLC +.. +.. 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 +============== +The caches in a Traffic Control CDN are servers running the Apache Traffic Server software. See `ATS documentation <http://trafficserver.readthedocs.org/en/latest/>`_ for more information. Caches in a Traffic Control CDN are deployed in cache groups. + +.. |arrow| image:: fwda.png + +.. _rl-cachegroup: + +|arrow| Cache Group +------------------- + A cache group is a logical group of caches that Traffic Router tries to use as a combined cache. Traffic Router treats all servers in a cache group as though they are in the same physical location, though they are in fact only in the same region (network). A cache group has one single set of geographical coordinates even if the caches that make up the cache group are in different physical locations. The caches in a cache group are not aware of the other caches in the group - there is no clustering software or communications between caches in a cache group. + + There are two types of cache groups: EDGE and MID. Traffic Control is a two tier system, where the clients get directed to the EDGE cache group. On cache miss, the cache in the EDGE cache group obtains content from a MID cache group, rather than the origin, which is shared with multiple EDGEs. EDGE cache groups are configured to have one single parent cache group. + + .. Note:: Often the EDGE to MID relationship is based on network distance, and does not necessarily match the geographic distance. + + A cache group serves a particular part of the network as defined in the ASN listing. (MAT/JvD to expand and pull in CZF info) + + Consider the example CDN below: + + .. image:: cache_groups_1.png + :align: center + + There are two MID tier cache groups, each assigned with three EDGEs. The lax, den and chi EDGE locations are configured with the West MID as their parent, and the nyc, phl, and hou EDGEs, are configured with the East MID as their parent. On a cache miss, the EDGEs use their assigned parent. + +All caches (and other servers) are assigned a Profile in Traffic Ops. + + +.. _rl-profile: + +|arrow| Profile +--------------- + A Profile is a set of configuration settings and parameters, applied to a server. For a typical cache there are hundreds of configuration settings to apply. The Traffic Ops parameter view contains the defined settings, and bundled into groups using Profiles. Traffic Ops allows for duplication, comparison, import and export of Profiles. + http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/8582b168/docs/1.1.2/_sources/overview/traffic_stats.txt ---------------------------------------------------------------------- diff --git a/docs/1.1.2/_sources/overview/traffic_stats.txt b/docs/1.1.2/_sources/overview/traffic_stats.txt new file mode 100644 index 0000000..6df78ba --- /dev/null +++ b/docs/1.1.2/_sources/overview/traffic_stats.txt @@ -0,0 +1,23 @@ +.. +.. Copyright 2015 Comcast Cable Communications Management, LLC +.. +.. 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-ts: + +Traffic Stats +============= +Traffic Stats is a utility written in Go that mines metrics from Traffic Monitor's JSON APIs and stores the data locally in Redis for a short period of time. This data is inherently transient, rolls frequently, and is volatile due to the default in-memory nature of Redis. The transient nature of the data is acceptable, as this system's purpose is to land data in Redis for other tools to consume. + +Once in Redis, the data can be extracted and prepared to be sent elsewhere for long term storage. Any number of Traffic Stats instances may run on a given CDN to collect metrics from Traffic Monitor, however, redundancy and integration with a long term metrics storage system is implementation dependent. Traffic Stats does not influence overall CDN operation, but is required in order to display charts in Traffic Operations. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/8582b168/docs/1.1.2/_sources/overview/traffic_vault.txt ---------------------------------------------------------------------- diff --git a/docs/1.1.2/_sources/overview/traffic_vault.txt b/docs/1.1.2/_sources/overview/traffic_vault.txt new file mode 100644 index 0000000..33efdd3 --- /dev/null +++ b/docs/1.1.2/_sources/overview/traffic_vault.txt @@ -0,0 +1,37 @@ +.. +.. Copyright 2015 Comcast Cable Communications Management, LLC +.. +.. 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 Vault +============= + +Traffic Vault is a keystore used for storing the following types of information: + +* SSL Certificates + - Private Key + - CRT + - CSR +* DNSSEC Keys + - Key Signing Key + - private key + - public key + - Zone Signing Key + - private key + - public key +* URL Signing Keys + +As the name suggests, Traffic Vault is meant to be a "vault" of private keys that only certain users are allowed to access. In order to create, add, and retrieve keys a user must have admin privileges. Keys can be created via the Traffic Ops UI, but they can only be retrieved via the Traffic Ops API. The keystore used by Traffic Vault is `Riak <http://basho.com/riak/>`_. Traffic ops accesses Riak via https on port 8088. Traffic ops uses Riak's rest API with username/password authentication. Information on the API can be found `here <http://docs.basho.com/riak/latest/dev/references/http/>`_. + + http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/8582b168/docs/1.1.2/_static/ajax-loader.gif ---------------------------------------------------------------------- diff --git a/docs/1.1.2/_static/ajax-loader.gif b/docs/1.1.2/_static/ajax-loader.gif new file mode 100644 index 0000000..61faf8c Binary files /dev/null and b/docs/1.1.2/_static/ajax-loader.gif differ
