http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/5521f214/docs/latest/_sources/overview/traffic_router.rst.txt ---------------------------------------------------------------------- diff --git a/docs/latest/_sources/overview/traffic_router.rst.txt b/docs/latest/_sources/overview/traffic_router.rst.txt deleted file mode 100644 index f9ed1bc..0000000 --- a/docs/latest/_sources/overview/traffic_router.rst.txt +++ /dev/null @@ -1,108 +0,0 @@ -.. -.. -.. Licensed under the Apache License, Version 2.0 (the "License"); -.. you may not use this file except in compliance with the License. -.. You may obtain a copy of the License at -.. -.. http://www.apache.org/licenses/LICENSE-2.0 -.. -.. Unless required by applicable law or agreed to in writing, software -.. distributed under the License is distributed on an "AS IS" BASIS, -.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -.. See the License for the specific language governing permissions and -.. limitations under the License. -.. - -.. _reference-label-tc-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 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/5521f214/docs/latest/_sources/overview/traffic_router.txt ---------------------------------------------------------------------- diff --git a/docs/latest/_sources/overview/traffic_router.txt b/docs/latest/_sources/overview/traffic_router.txt new file mode 100644 index 0000000..dd021ac --- /dev/null +++ b/docs/latest/_sources/overview/traffic_router.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/5521f214/docs/latest/_sources/overview/traffic_server.rst.txt ---------------------------------------------------------------------- diff --git a/docs/latest/_sources/overview/traffic_server.rst.txt b/docs/latest/_sources/overview/traffic_server.rst.txt deleted file mode 100644 index 4928e4e..0000000 --- a/docs/latest/_sources/overview/traffic_server.rst.txt +++ /dev/null @@ -1,49 +0,0 @@ -.. -.. -.. Licensed under the Apache License, Version 2.0 (the "License"); -.. you may not use this file except in compliance with the License. -.. You may obtain a copy of the License at -.. -.. http://www.apache.org/licenses/LICENSE-2.0 -.. -.. Unless required by applicable law or agreed to in writing, software -.. distributed under the License is distributed on an "AS IS" BASIS, -.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -.. See the License for the specific language governing permissions and -.. limitations under the License. -.. - -Traffic Server -============== -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. 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/5521f214/docs/latest/_sources/overview/traffic_server.txt ---------------------------------------------------------------------- diff --git a/docs/latest/_sources/overview/traffic_server.txt b/docs/latest/_sources/overview/traffic_server.txt new file mode 100644 index 0000000..520c8be --- /dev/null +++ b/docs/latest/_sources/overview/traffic_server.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/5521f214/docs/latest/_sources/overview/traffic_stats.rst.txt ---------------------------------------------------------------------- diff --git a/docs/latest/_sources/overview/traffic_stats.rst.txt b/docs/latest/_sources/overview/traffic_stats.rst.txt deleted file mode 100644 index 10981de..0000000 --- a/docs/latest/_sources/overview/traffic_stats.rst.txt +++ /dev/null @@ -1,35 +0,0 @@ -.. -.. -.. Licensed under the Apache License, Version 2.0 (the "License"); -.. you may not use this file except in compliance with the License. -.. You may obtain a copy of the License at -.. -.. http://www.apache.org/licenses/LICENSE-2.0 -.. -.. Unless required by applicable law or agreed to in writing, software -.. distributed under the License is distributed on an "AS IS" BASIS, -.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -.. See the License for the specific language governing permissions and -.. limitations under the License. -.. - -.. _reference-label-tc-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/5521f214/docs/latest/_sources/overview/traffic_stats.txt ---------------------------------------------------------------------- diff --git a/docs/latest/_sources/overview/traffic_stats.txt b/docs/latest/_sources/overview/traffic_stats.txt new file mode 100644 index 0000000..10981de --- /dev/null +++ b/docs/latest/_sources/overview/traffic_stats.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/5521f214/docs/latest/_sources/overview/traffic_vault.rst.txt ---------------------------------------------------------------------- diff --git a/docs/latest/_sources/overview/traffic_vault.rst.txt b/docs/latest/_sources/overview/traffic_vault.rst.txt deleted file mode 100644 index 933b86b..0000000 --- a/docs/latest/_sources/overview/traffic_vault.rst.txt +++ /dev/null @@ -1,36 +0,0 @@ -.. -.. -.. Licensed under the Apache License, Version 2.0 (the "License"); -.. you may not use this file except in compliance with the License. -.. You may obtain a copy of the License at -.. -.. http://www.apache.org/licenses/LICENSE-2.0 -.. -.. Unless required by applicable law or agreed to in writing, software -.. distributed under the License is distributed on an "AS IS" BASIS, -.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -.. See the License for the specific language governing permissions and -.. limitations under the License. -.. - -Traffic 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/5521f214/docs/latest/_sources/overview/traffic_vault.txt ---------------------------------------------------------------------- diff --git a/docs/latest/_sources/overview/traffic_vault.txt b/docs/latest/_sources/overview/traffic_vault.txt new file mode 100644 index 0000000..933b86b --- /dev/null +++ b/docs/latest/_sources/overview/traffic_vault.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/5521f214/docs/latest/_static/basic.css ---------------------------------------------------------------------- diff --git a/docs/latest/_static/basic.css b/docs/latest/_static/basic.css index dc88b5a..2b513f0 100644 --- a/docs/latest/_static/basic.css +++ b/docs/latest/_static/basic.css @@ -4,7 +4,7 @@ * * Sphinx stylesheet -- basic theme. * - * :copyright: Copyright 2007-2017 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ @@ -122,8 +122,6 @@ ul.keywordmatches li.goodmatch a { table.contentstable { width: 90%; - margin-left: auto; - margin-right: auto; } table.contentstable p.biglink { @@ -151,14 +149,9 @@ table.indextable td { vertical-align: top; } -table.indextable ul { +table.indextable dl, table.indextable dd { margin-top: 0; margin-bottom: 0; - list-style-type: none; -} - -table.indextable > tbody > tr > td > ul { - padding-left: 0em; } table.indextable tr.pcap { @@ -190,13 +183,6 @@ div.genindex-jumpbox { 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 { @@ -231,6 +217,10 @@ div.body td { text-align: left; } +.field-list ul { + padding-left: 1em; +} + .first { margin-top: 0 !important; } @@ -347,6 +337,10 @@ table.docutils td, table.docutils th { border-bottom: 1px solid #aaa; } +table.field-list td, table.field-list th { + border: 0 !important; +} + table.footnote td, table.footnote th { border: 0 !important; } @@ -383,20 +377,6 @@ div.figure p.caption span.caption-number { 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 ----------------------------------------------------- */ @@ -447,6 +427,15 @@ dl.glossary dt { font-size: 1.1em; } +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + .optional { font-size: 1.3em; } @@ -505,13 +494,6 @@ pre { 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; @@ -603,16 +585,6 @@ 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 { http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/5521f214/docs/latest/_static/comment-bright.png ---------------------------------------------------------------------- diff --git a/docs/latest/_static/comment-bright.png b/docs/latest/_static/comment-bright.png index 15e27ed..551517b 100644 Binary files a/docs/latest/_static/comment-bright.png and b/docs/latest/_static/comment-bright.png differ http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/5521f214/docs/latest/_static/comment-close.png ---------------------------------------------------------------------- diff --git a/docs/latest/_static/comment-close.png b/docs/latest/_static/comment-close.png index 4d91bcf..09b54be 100644 Binary files a/docs/latest/_static/comment-close.png and b/docs/latest/_static/comment-close.png differ http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/5521f214/docs/latest/_static/comment.png ---------------------------------------------------------------------- diff --git a/docs/latest/_static/comment.png b/docs/latest/_static/comment.png index dfbc0cb..92feb52 100644 Binary files a/docs/latest/_static/comment.png and b/docs/latest/_static/comment.png differ http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/5521f214/docs/latest/_static/doctools.js ---------------------------------------------------------------------- diff --git a/docs/latest/_static/doctools.js b/docs/latest/_static/doctools.js index 5654977..8163495 100644 --- a/docs/latest/_static/doctools.js +++ b/docs/latest/_static/doctools.js @@ -4,7 +4,7 @@ * * Sphinx JavaScript utilities for all documentation. * - * :copyright: Copyright 2007-2017 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/5521f214/docs/latest/_static/down-pressed.png ---------------------------------------------------------------------- diff --git a/docs/latest/_static/down-pressed.png b/docs/latest/_static/down-pressed.png index 5756c8c..7c30d00 100644 Binary files a/docs/latest/_static/down-pressed.png and b/docs/latest/_static/down-pressed.png differ http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/5521f214/docs/latest/_static/down.png ---------------------------------------------------------------------- diff --git a/docs/latest/_static/down.png b/docs/latest/_static/down.png index 1b3bdad..f48098a 100644 Binary files a/docs/latest/_static/down.png and b/docs/latest/_static/down.png differ http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/5521f214/docs/latest/_static/file.png ---------------------------------------------------------------------- diff --git a/docs/latest/_static/file.png b/docs/latest/_static/file.png index a858a41..254c60b 100644 Binary files a/docs/latest/_static/file.png and b/docs/latest/_static/file.png differ
