http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/ff67377d/docs/master/_sources/development/traffic_stats.rst.txt ---------------------------------------------------------------------- diff --git a/docs/master/_sources/development/traffic_stats.rst.txt b/docs/master/_sources/development/traffic_stats.rst.txt new file mode 100644 index 0000000..02317f7 --- /dev/null +++ b/docs/master/_sources/development/traffic_stats.rst.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/ff67377d/docs/master/_sources/faq/administration.rst.txt ---------------------------------------------------------------------- diff --git a/docs/master/_sources/faq/administration.rst.txt b/docs/master/_sources/faq/administration.rst.txt new file mode 100644 index 0000000..feecff7 --- /dev/null +++ b/docs/master/_sources/faq/administration.rst.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/ff67377d/docs/master/_sources/faq/development.rst.txt ---------------------------------------------------------------------- diff --git a/docs/master/_sources/faq/development.rst.txt b/docs/master/_sources/faq/development.rst.txt new file mode 100644 index 0000000..8518eeb --- /dev/null +++ b/docs/master/_sources/faq/development.rst.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/ff67377d/docs/master/_sources/faq/general.rst.txt ---------------------------------------------------------------------- diff --git a/docs/master/_sources/faq/general.rst.txt b/docs/master/_sources/faq/general.rst.txt new file mode 100644 index 0000000..747aa60 --- /dev/null +++ b/docs/master/_sources/faq/general.rst.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 <mailto:us...@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/ff67377d/docs/master/_sources/faq/index.rst.txt ---------------------------------------------------------------------- diff --git a/docs/master/_sources/faq/index.rst.txt b/docs/master/_sources/faq/index.rst.txt new file mode 100644 index 0000000..82ea912 --- /dev/null +++ b/docs/master/_sources/faq/index.rst.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/ff67377d/docs/master/_sources/glossary.rst.txt ---------------------------------------------------------------------- diff --git a/docs/master/_sources/glossary.rst.txt b/docs/master/_sources/glossary.rst.txt new file mode 100644 index 0000000..a932579 --- /dev/null +++ b/docs/master/_sources/glossary.rst.txt @@ -0,0 +1,81 @@ +.. +.. +.. 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/ff67377d/docs/master/_sources/index.rst.txt ---------------------------------------------------------------------- diff --git a/docs/master/_sources/index.rst.txt b/docs/master/_sources/index.rst.txt new file mode 100644 index 0000000..50b604b --- /dev/null +++ b/docs/master/_sources/index.rst.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 an 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/ff67377d/docs/master/_sources/overview/index.rst.txt ---------------------------------------------------------------------- diff --git a/docs/master/_sources/overview/index.rst.txt b/docs/master/_sources/overview/index.rst.txt new file mode 100644 index 0000000..65dd20e --- /dev/null +++ b/docs/master/_sources/overview/index.rst.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/ff67377d/docs/master/_sources/overview/introduction.rst.txt ---------------------------------------------------------------------- diff --git a/docs/master/_sources/overview/introduction.rst.txt b/docs/master/_sources/overview/introduction.rst.txt new file mode 100644 index 0000000..2789b46 --- /dev/null +++ b/docs/master/_sources/overview/introduction.rst.txt @@ -0,0 +1,49 @@ +.. +.. +.. 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 caching server control plane application which is used to aggregate caching servers into a Content Delivery Network (CDN). The CDN 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 elements illustrated in green in the diagram below. + + +.. image:: traffic_control_overview_3.png + :align: center + + +**Traffic Ops** + * `Traffic Ops <http://trafficcontrol.apache.org/docs/latest/overview/traffic_ops.html/>`_ is used to configure caching servers and CDN delivery services. It also contains APIs used to access CDN data. + +**Traffic Router** + * `Traffic Router <http://trafficcontrol.apache.org/docs/latest/overview/traffic_router.html/>`_ is used to route clients requests to the closest healthy cache by analyzing the health, capacity, and state of the caching servers and relative distance from each cache group to the location of the client. + +**Traffic Monitor** + * `Traffic Monitor <http://trafficcontrol.apache.org/docs/latest/overview/traffic_monitor.html/>`_ does health polling of the caching servers on a very short interval to keep track of which servers should be kept in rotation. + +**Traffic Stats** + * `Traffic Stats <http://trafficcontrol.apache.org/docs/latest/overview/traffic_stats.html/>`_ collects real time traffic statistics aggregated from each of the caching servers. This data is used by the Traffic Router to assess the available capacity of each caching server which it uses to balance traffic load and prevent overload. + +**Traffic Portal** + * `Traffic Portal <http://trafficcontrol.apache.org/docs/latest/overview/traffic_portal.html/>`_ is a web application which leverages the Traffic Ops APIs to present CDN data through a web interface. + +**Traffic Logs** + * Traffic Logs is currently under construction and is intended to aggregate Traffic Server request/response logs as well as other server logs. Logs will be parsed and indexed for search. + + +In the next sections each of these components will be explained further. + http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/ff67377d/docs/master/_sources/overview/traffic_monitor.rst.txt ---------------------------------------------------------------------- diff --git a/docs/master/_sources/overview/traffic_monitor.rst.txt b/docs/master/_sources/overview/traffic_monitor.rst.txt new file mode 100644 index 0000000..d97bddd --- /dev/null +++ b/docs/master/_sources/overview/traffic_monitor.rst.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 an HTTP service 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/ff67377d/docs/master/_sources/overview/traffic_ops.rst.txt ---------------------------------------------------------------------- diff --git a/docs/master/_sources/overview/traffic_ops.rst.txt b/docs/master/_sources/overview/traffic_ops.rst.txt new file mode 100644 index 0000000..9cc72ee --- /dev/null +++ b/docs/master/_sources/overview/traffic_ops.rst.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/ff67377d/docs/master/_sources/overview/traffic_portal.rst.txt ---------------------------------------------------------------------- diff --git a/docs/master/_sources/overview/traffic_portal.rst.txt b/docs/master/_sources/overview/traffic_portal.rst.txt new file mode 100644 index 0000000..20325e4 --- /dev/null +++ b/docs/master/_sources/overview/traffic_portal.rst.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 + + + http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/ff67377d/docs/master/_sources/overview/traffic_router.rst.txt ---------------------------------------------------------------------- diff --git a/docs/master/_sources/overview/traffic_router.rst.txt b/docs/master/_sources/overview/traffic_router.rst.txt new file mode 100644 index 0000000..dd021ac --- /dev/null +++ b/docs/master/_sources/overview/traffic_router.rst.txt @@ -0,0 +1,109 @@ +.. +.. +.. 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. + + Since Traffic Control version 2.1 deliveryservices can optionally be linked to a :ref:`rl-profile`, and have parameters associated with them. The first feature that uses deliveryservice parameters is the :ref:`rl-multi-site-origin` configuration. + 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 JSON 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, excluding query string. + * 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 using NS records. + http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/ff67377d/docs/master/_sources/overview/traffic_server.rst.txt ---------------------------------------------------------------------- diff --git a/docs/master/_sources/overview/traffic_server.rst.txt b/docs/master/_sources/overview/traffic_server.rst.txt new file mode 100644 index 0000000..520c8be --- /dev/null +++ b/docs/master/_sources/overview/traffic_server.rst.txt @@ -0,0 +1,49 @@ +.. +.. +.. 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 coverage zone file. See :ref:`rl-asn-czf`. + + 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 or deliveryservice. 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/ff67377d/docs/master/_sources/overview/traffic_stats.rst.txt ---------------------------------------------------------------------- diff --git a/docs/master/_sources/overview/traffic_stats.rst.txt b/docs/master/_sources/overview/traffic_stats.rst.txt new file mode 100644 index 0000000..10981de --- /dev/null +++ b/docs/master/_sources/overview/traffic_stats.rst.txt @@ -0,0 +1,35 @@ +.. +.. +.. 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: +.. |arrow| image:: fwda.png + + +Traffic Stats +============= +Traffic Stats is a program written in `Golang <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). The data from InfluxDb is then used to drive graphs created by `Grafana <http://grafana.org>`_ - which are linked to from Traffic Ops - as well as provide data exposed through the Traffic Ops API. Traffic Stats performs two functions: first it gathers stat data for Edge Caches and Delivery Services at a configurable interval (10 second default) from the Traffic Monitor API's and stores the data in InfluxDb; second it summarizes all of the stats once a day (around midnight UTC) and creates a daily rollup containing the Max Gbps served and the Total Bytes served. + +Stat data is stored in three different databases: + + - cache_stats: The cache_stats database is used to store data gathered from edge caches. The `measurements <https://influxdb.com/docs/v0.9/concepts/glossary.html#measurement>`_ stored by cache are: bandwidth, maxKbps, and client_connections (ats.proxy.process.http.current_client_connections). Cache Data is stored with `tags <https://influxdb.com/docs/v0.9/concepts/glossary.html#tag>`_ for hostname, cachegroup, and CDN. Data can be queried using tags. + + + - deliveryservice_stats: The deliveryservice_stats database is used to store data for delivery services. The measurements stored by delivery service are: kbps, status_4xx, status_5xx, tps_2xx, tps_3xx, tps_4xx, tps_5xx, and tps_total. Delivery Service stats are stored with tags for cachegroup, CDN, and Deliveryservice xml_id. + + - daily_stats: The daily_stats database is used to store summary data for daily activities. The stats that are currently summarized are Max Bandwidth and Bytes Served and they are stored by CDN. + +------------ + +Traffic Stats does not influence overall CDN operation, but is required in order to display charts in Traffic Ops and Traffic Portal. http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/ff67377d/docs/master/_sources/overview/traffic_vault.rst.txt ---------------------------------------------------------------------- diff --git a/docs/master/_sources/overview/traffic_vault.rst.txt b/docs/master/_sources/overview/traffic_vault.rst.txt new file mode 100644 index 0000000..933b86b --- /dev/null +++ b/docs/master/_sources/overview/traffic_vault.rst.txt @@ -0,0 +1,36 @@ +.. +.. +.. 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/ff67377d/docs/master/_static/ajax-loader.gif ---------------------------------------------------------------------- diff --git a/docs/master/_static/ajax-loader.gif b/docs/master/_static/ajax-loader.gif new file mode 100644 index 0000000..61faf8c Binary files /dev/null and b/docs/master/_static/ajax-loader.gif differ http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/ff67377d/docs/master/_static/basic.css ---------------------------------------------------------------------- diff --git a/docs/master/_static/basic.css b/docs/master/_static/basic.css new file mode 100644 index 0000000..dc88b5a --- /dev/null +++ b/docs/master/_static/basic.css @@ -0,0 +1,632 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2017 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox input[type="text"] { + width: 170px; +} + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li div.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px 7px 0 7px; + background-color: #ffe; + width: 40%; + float: right; +} + +p.sidebar-title { + font-weight: bold; +} + +/* -- topics ---------------------------------------------------------------- */ + +div.topic { + border: 1px solid #ccc; + padding: 7px 7px 0 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +div.admonition dl { + margin-bottom: 0; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + border: 0; + border-collapse: collapse; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +table.footnote td, table.footnote th { + border: 0 !important; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +dl { + margin-bottom: 15px; +} + +dd p { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +dt:target, .highlighted { + background-color: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; +} + +td.linenos pre { + padding: 5px 0px; + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + margin-left: 0.5em; +} + +table.highlighttable td { + padding: 0 0.5em 0 0.5em; +} + +div.code-block-caption { + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +div.code-block-caption + div > div.highlight > pre { + margin-top: 0; +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + padding: 1em 1em 0; +} + +div.literal-block-wrapper div.highlight { + margin: 0; +} + +code.descname { + background-color: transparent; + font-weight: bold; + font-size: 1.2em; +} + +code.descclassname { + background-color: transparent; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: relative; + left: 0px; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/ff67377d/docs/master/_static/comment-bright.png ---------------------------------------------------------------------- diff --git a/docs/master/_static/comment-bright.png b/docs/master/_static/comment-bright.png new file mode 100644 index 0000000..15e27ed Binary files /dev/null and b/docs/master/_static/comment-bright.png differ http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/ff67377d/docs/master/_static/comment-close.png ---------------------------------------------------------------------- diff --git a/docs/master/_static/comment-close.png b/docs/master/_static/comment-close.png new file mode 100644 index 0000000..4d91bcf Binary files /dev/null and b/docs/master/_static/comment-close.png differ http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/ff67377d/docs/master/_static/comment.png ---------------------------------------------------------------------- diff --git a/docs/master/_static/comment.png b/docs/master/_static/comment.png new file mode 100644 index 0000000..dfbc0cb Binary files /dev/null and b/docs/master/_static/comment.png differ http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/ff67377d/docs/master/_static/css/badge_only.css ---------------------------------------------------------------------- diff --git a/docs/master/_static/css/badge_only.css b/docs/master/_static/css/badge_only.css new file mode 100644 index 0000000..7e17fb1 --- /dev/null +++ b/docs/master/_static/css/badge_only.css @@ -0,0 +1,2 @@ +.fa:before{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:before,.clearfix:after{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-weight:normal;font-style:normal;src:url("../font/fontawesome_webfont.eot");src:url("../font/fontawesome_webfont.eot?#iefix") format("embedded-opentype"),url("../font/fontawesome_webfont.woff") format("woff"),url("../font/fontawesome_webfont.ttf") format("truetype"),url("../font/fontawesome_webfont.svg#FontAwesome") format("svg")}.fa:before{display:inline-block;font-family:FontAwesome;font-style:normal;font-weight:normal;line-height:1;text-decoration:inherit}a .fa{display:inline-block;text-decoration:inherit}li .fa{display:inline-block}li .fa-large:before,li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-0.8em}ul.fas li .fa{width:0.8em}ul.fas li .fa-large:before,ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before{content:"ï"}.icon-book:be fore{content:"ï"}.fa-caret-down:before{content:"ï"}.icon-caret-down:before{content:"ï"}.fa-caret-up:before{content:"ï"}.icon-caret-up:before{content:"ï"}.fa-caret-left:before{content:"ï"}.icon-caret-left:before{content:"ï"}.fa-caret-right:before{content:"ï"}.icon-caret-right:before{content:"ï"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;border-top:solid 10px #343131;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;z-index:400}.rst-versions a{color:#2980B9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27AE60;*zoom:1}.rst-versions .rst-current-version:before,.rst-versions .rst-current-version:after{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-cu rrent-version .fa-book{float:left}.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#E74C3C;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#F1C40F;color:#000}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:gray;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:solid 1px #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px}.rst-versions.rst-badge .icon-book{float:none}.rst-versions.rst-badge .fa-book{float:none}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-ver sion .fa-book{float:left}.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge .rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width: 768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}img{width:100%;height:auto}} +/*# sourceMappingURL=badge_only.css.map */ http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/ff67377d/docs/master/_static/css/badge_only.css.map ---------------------------------------------------------------------- diff --git a/docs/master/_static/css/badge_only.css.map b/docs/master/_static/css/badge_only.css.map new file mode 100644 index 0000000..b09cc62 --- /dev/null +++ b/docs/master/_static/css/badge_only.css.map @@ -0,0 +1,7 @@ +{ +"version": 3, +"mappings": "CAyDA,SAAY,EACV,qBAAsB,EAAE,UAAW,EAqDrC,QAAS,EARP,IAAK,EAAE,AAAC,EACR,+BAAS,EAEP,MAAO,EAAE,IAAK,EACd,MAAO,EAAE,CAAE,EACb,cAAO,EACL,IAAK,EAAE,GAAI,EC1Gb,SAkBC,EAjBC,UAAW,ECFJ,UAAW,EDGlB,UAAW,EAHqC,KAAM,EAItD,SAAU,EAJsD,KAAM,EAapE,EAAG,EAAE,qCAAwB,EAC7B,EAAG,EAAE,0PAAyE,ECZpF,SAAU,EACR,MAAO,EAAE,WAAY,EACrB,UAAW,EAAE,UAAW,EACxB,SAAU,EAAE,KAAM,EAClB,UAAW,EAAE,KAAM,EACnB,UAAW,EAAE,AAAC,EACd,cAAe,EAAE,MAAO,EAG1B,IAAK,EACH,MAAO,EAAE,WAAY,EACrB,cAAe,EAAE,MAAO,EAIxB,KAAG,EACD,MAAO,EAAE,WAAY,EACvB,sCAAiB,EAGf,IAAK,EAAE,MAAY,EAEvB,KAAM,EACJ,cAAe,EAAE,GAAI,EACrB,UAAW,EAAE,EAAG,EAChB,UAAW,EAAE,KAAM,EAEjB,YAAG,EACD,IAAK,EAAE,IAAI,EACb,oDAAiB,EAGf,aAAc,EAAE,OAAQ,EAG9B,cAAe,EACb,MAAO,EAAE,EAAO,EAElB,gBAAiB,EACf,MAAO,EAAE,EAAO,EAElB,oBAAqB,EACnB,MAAO,EAAE,EAAO,EAElB,sBAAuB,EACrB,MAAO,EAAE,EAAO,EAElB,kBAAmB,EACjB,MAAO,EAAE,EAAO,EAElB,oBAAqB,EACnB,MAAO,EAAE,EAAO,EAElB,oBAAqB,EACnB,MAAO,EAAE,EAAO,EAElB,sBAAuB,EACrB,MAAO,EAAE,EAAO,EAElB,qBAAsB,EACpB,MAAO,EAAE,EAAO,EAElB,uBAAwB,EACtB,MAAO,EA AE,EAAO,ECnElB,YAAa,EACX,OAAQ,EAAE,IAAK,EACf,KAAM,EAAE,AAAC,EACT,GAAI,EAAE,AAAC,EACP,IAAK,EC6E+B,IAAK,ED5EzC,IAAK,ECE+B,MAAyB,EDD7D,SAAU,EAAE,MAAkC,EAC9C,SAAU,EAAE,iBAAiC,EAC7C,UAAW,EEAyB,sDAAM,EFC1C,MAAO,EC+E6B,EAAG,ED9EvC,cAAC,EACC,IAAK,ECqE6B,MAAW,EDpE7C,cAAe,EAAE,GAAI,EACvB,6BAAgB,EACd,MAAO,EAAE,GAAI,EACf,iCAAoB,EAClB,MAAO,EAAE,GAAqB,EAC9B,eAAgB,EAAE,MAAkC,EACpD,MAAO,EAAE,IAAK,EACd,SAAU,EAAE,IAAK,EACjB,QAAS,EAAE,EAAG,EACd,KAAM,EAAE,MAAO,EACf,IAAK,ECiD6B,MAAM,EJgC1C,IAAK,EAAE,AAAC,EACR,iFAAS,EAEP,MAAO,EAAE,IAAK,EACd,MAAO,EAAE,CAAE,EACb,uCAAO,EACL,IAAK,EAAE,GAAI,EGrFX,qCAAG,EACD,IAAK,EClB2B,MAAyB,EDmB3D,0CAAQ,EACN,IAAK,EAAE,GAAI,EACb,4CAAU,EACR,IAAK,EAAE,GAAI,EACb,iDAAiB,EACf,eAAgB,ECQgB,MAAI,EDPpC,IAAK,EC0B2B,GAAM,EDzBxC,wDAAwB,EACtB,eAAgB,ECXgB,MAAO,EDYvC,IAAK,ECzB2B,GAAI,ED0BxC,yCAA8B,EAC5B,MAAO,EAAE,IAAK,EAChB,gCAAmB,EACjB,QAAS,EAAE,EAAG,EACd,MAAO,EAAE,GAAqB,EAC9B,IAAK,ECE6B,GAAwB,EDD1D,MAAO,EAAE,GAAI,EACb,mCAAE,EACA,MAAO,EAAE,IAAK,EACd,KAAM,EAAE,EAAG,EACX,KAAM,EAAE,AAAC,EACT, KAAM,EAAE,KAAM,EACd,MAAO,EAAE,AAAC,EACV,SAAU,EAAE,gBAA6C,EAC3D,mCAAE,EACA,MAAO,EAAE,WAAY,EACrB,KAAM,EAAE,AAAC,EACT,qCAAC,EACC,MAAO,EAAE,WAAY,EACrB,MAAO,EAAE,EAAqB,EAC9B,IAAK,ECjDyB,MAAyB,EDkD7D,sBAAW,EACT,IAAK,EAAE,GAAI,EACX,KAAM,EAAE,GAAI,EACZ,IAAK,EAAE,GAAI,EACX,GAAI,EAAE,GAAI,EACV,KAAM,EAAE,GAAI,EACZ,QAAS,ECkByB,IAAK,EDjBvC,iCAAU,EACR,IAAK,EAAE,GAAI,EACb,+BAAQ,EACN,IAAK,EAAE,GAAI,EACb,oDAA+B,EAC7B,SAAU,EAAE,IAAK,EACjB,6DAAQ,EACN,IAAK,EAAE,GAAI,EACb,+DAAU,EACR,IAAK,EAAE,GAAI,EACf,2CAAoB,EAClB,IAAK,EAAE,GAAI,EACX,KAAM,EAAE,GAAI,EACZ,UAAW,EAAE,GAAI,EACjB,MAAO,EAAE,IAAuB,EAChC,MAAO,EAAE,IAAK,EACd,SAAU,EAAE,KAAM,EGhDpB,mCAAsB,EHmDxB,YAAa,EACX,IAAK,EAAE,EAAG,EACV,MAAO,EAAE,GAAI,EACb,kBAAO,EACL,MAAO,EAAE,IAAK,EAClB,EAAG,EACD,IAAK,EAAE,GAAI,EACX,KAAM,EAAE,GAAI", +"sources": ["../../../bower_components/wyrm/sass/wyrm_core/_mixin.sass","../../../bower_components/bourbon/dist/css3/_font-face.scss","../../../sass/_theme_badge_fa.sass","../../../sass/_theme_badge.sass","../../../bower_components/wyrm/sass/wyrm_core/_wy_variables.sass","../../../sass/_theme_variables.sass","../../../bower_components/neat/app/assets/stylesheets/grid/_media.scss"], +"names": [], +"file": "badge_only.css" +}
