Update docs from commit 83d713b2be2084c33ec8518401af30341398278b
Project: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/commit/1ba9fff3 Tree: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/tree/1ba9fff3 Diff: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/diff/1ba9fff3 Branch: refs/heads/asf-site Commit: 1ba9fff3fb2b08a0618da496b47a2f8e1b7f5a4a Parents: 0cfe237 Author: jenkins <bui...@apache.org> Authored: Wed Nov 8 15:41:04 2017 +0000 Committer: jenkins <bui...@apache.org> Committed: Wed Nov 8 15:41:04 2017 +0000 ---------------------------------------------------------------------- .../admin/traffic_monitor_golang.rst.txt | 2 +- .../_sources/admin/traffic_ops/using.rst.txt | 2 +- .../development/traffic_monitor_golang.rst.txt | 22 +- .../traffic_ops_api/v12/deliveryservice.rst.txt | 128 ++--- docs/master/admin/traffic_monitor_golang.html | 2 +- docs/master/admin/traffic_ops/using.html | 4 +- .../development/traffic_monitor_golang.html | 27 +- .../traffic_ops_api/v12/deliveryservice.html | 509 +++++++++++++++---- docs/master/objects.inv | Bin 4387 -> 4469 bytes docs/master/searchindex.js | 2 +- 10 files changed, 522 insertions(+), 176 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/1ba9fff3/docs/master/_sources/admin/traffic_monitor_golang.rst.txt ---------------------------------------------------------------------- diff --git a/docs/master/_sources/admin/traffic_monitor_golang.rst.txt b/docs/master/_sources/admin/traffic_monitor_golang.rst.txt index 6689374..bbd3bae 100644 --- a/docs/master/_sources/admin/traffic_monitor_golang.rst.txt +++ b/docs/master/_sources/admin/traffic_monitor_golang.rst.txt @@ -36,7 +36,7 @@ The following are requirements to ensure an accurate set up: 1. Enter the Traffic Monitor server into Traffic Ops 2. Make sure the FQDN of the Traffic Monitor is resolvable in DNS. 3. Install Traffic Monitor: ``sudo yum -y install traffic_monitor`` -4. Configure Traffic Monitor. See :ref:`rl-tm-configure` +4. Configure Traffic Monitor. See :ref:`here <rl-tm-configure>` 5. Start the service: ``sudo service traffic_monitor start`` :: Starting traffic_monitor: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/1ba9fff3/docs/master/_sources/admin/traffic_ops/using.rst.txt ---------------------------------------------------------------------- diff --git a/docs/master/_sources/admin/traffic_ops/using.rst.txt b/docs/master/_sources/admin/traffic_ops/using.rst.txt index 120a41c..58ed6b8 100644 --- a/docs/master/_sources/admin/traffic_ops/using.rst.txt +++ b/docs/master/_sources/admin/traffic_ops/using.rst.txt @@ -617,7 +617,7 @@ Delivery services have a Query String Handling option that, when set to ignore, Multi Site Origin +++++++++++++++++ -.. Note:: The configuration of this feature changed significantly between ATS version 5 and >= 6. Some configuration in Traffic Control is different as well. This documentation assumes ATS 6 or higher. See :ref:`rl-multi-site-origin-qht-ats5` for the ATS version 5.x configuration details. +.. Note:: The configuration of this feature changed significantly between ATS version 5 and >= 6. Some configuration in Traffic Control is different as well. This documentation assumes ATS 6 or higher. See :ref:`rl-multi-site-origin-qht` for more details. Normally, the mid servers are not aware of any redundancy at the origin layer. With Multi Site Origin enabled this changes - Traffic Server (and Traffic Ops) are now made aware of the fact there are multiple origins, and can be configured to do more advanced failover and loadbalancing actions. A prerequisite for MSO to work is that the multiple origin sites serve identical content with identical paths, and both are configured to serve the same origin hostname as is configured in the deliveryservice `Origin Server Base URL` field. See the `Apache Traffic Server docs <https://docs.trafficserver.apache.org/en/latest/admin-guide/files/parent.config.en.html>`_ for more information on that cache's implementation. http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/1ba9fff3/docs/master/_sources/development/traffic_monitor_golang.rst.txt ---------------------------------------------------------------------- diff --git a/docs/master/_sources/development/traffic_monitor_golang.rst.txt b/docs/master/_sources/development/traffic_monitor_golang.rst.txt index 118a623..e674268 100644 --- a/docs/master/_sources/development/traffic_monitor_golang.rst.txt +++ b/docs/master/_sources/development/traffic_monitor_golang.rst.txt @@ -59,7 +59,7 @@ Architecture ============ At the highest level, Traffic Monitor polls caches, aggregates their data and availability, and serves it at HTTP JSON endpoints. -In the code, the data flows thru microthread (goroutine) pipelines. All stages of the pipeline are independent running microthreads:sup:`1`. The pipelines are: +In the code, the data flows thru microthread (goroutine) pipelines. All stages of the pipeline are independent running microthreads [#f1]_ . The pipelines are: * **stat poll** - polls caches for all statistics data. This should be a slower poll, which gets a lot of data. * **health poll** - polls caches for a tiny amount of data, typically system information. This poll is designed to be a heartbeat, determining quickly whether the cache is reachable. Since it's a small amount of data, it should poll more frequently. @@ -124,7 +124,7 @@ All microthreads in the pipeline are started by ``manager/manager.go:Start()``. | -------------- -------------- | ----------------------- ... ... -:sup:`1`Technically, some stages which are one-to-one simply call the next stage as a function. For example, the Fetcher calls the Handler as a function in the same microthread. But this isn't architecturally significant. +.. [#f1] Technically, some stages which are one-to-one simply call the next stage as a function. For example, the Fetcher calls the Handler as a function in the same microthread. But this isn't architecturally significant. Stat Pipeline @@ -147,7 +147,7 @@ Stat Pipeline * **handler** - ``traffic_monitor/cache/cache.go:Handler.Handle()``. Takes the given result and does all data computation possible with the single result. Currently, this computation primarily involves processing the denormalized ATS data into Go structs, and processing System data into OutBytes, Kbps, etc. Precomputed data is then passed to its result channel, which is picked up by the Manager. -* **manager** - ``traffic_monitor/manager/stat.go:StartStatHistoryManager()``. Takes preprocessed results, and aggregates them. Aggregated results are then placed in shared data structures. The major data aggregated are delivery service statistics, and cache availability data. See :ref:`Aggregated Stat Data` and :ref:`Aggregated Availability Data`. +* **manager** - ``traffic_monitor/manager/stat.go:StartStatHistoryManager()``. Takes preprocessed results, and aggregates them. Aggregated results are then placed in shared data structures. The major data aggregated are delivery service statistics, and cache availability data. See :ref:`Aggregated Stat Data <agg-stat-data>` and :ref:`Aggregated Availability Data <agg-avail-data>`. Health Pipeline @@ -169,7 +169,7 @@ Health Pipeline * **handler** - ``traffic_monitor/cache/cache.go:Handler.Handle()``. Same handler type as the Stat Poller pipeline, but constructed with a flag to not precompute. The health endpoint is of the same form as the stat endpoint, but doesn't return all stat data. So, it doesn't precompute like the Stat Handler, but only processes the system data, and passes the processed result to its result channel, which is picked up by the Manager. -* **manager** - ``traffic_monitor/manager/health.go:StartHealthResultManager()``. Takes preprocessed results, and aggregates them. For the Health pipeline, only health availability data is aggregated. Aggregated results are then placed in shared data structures (lastHealthDurationsThreadsafe, lastHealthEndTimes, etc). See :ref:`Aggregated Availability Data`. +* **manager** - ``traffic_monitor/manager/health.go:StartHealthResultManager()``. Takes preprocessed results, and aggregates them. For the Health pipeline, only health availability data is aggregated. Aggregated results are then placed in shared data structures (lastHealthDurationsThreadsafe, lastHealthEndTimes, etc). See :ref:`Aggregated Availability Data <agg-avail-data>`. Peer Pipeline @@ -191,7 +191,7 @@ Peer Pipeline * **handler** - ``traffic_monitor/cache/peer.go:Handler.Handle()``. Decodes the JSON result into an object, and without further processing passes to its result channel, which is picked up by the Manager. -* **manager** - ``traffic_monitor/manager/peer.go:StartPeerManager()``. Takes JSON peer Traffic Monitor results, and aggregates them. The availability of the Peer Traffic Monitor itself, as well as all cache availability from the given peer result, is stored in the shared ``peerStates`` object. Results are then aggregated via a call to the ``combineState()`` lambda, which signals the State Combiner microthread (which stores the combined availability in the shared object ``combinedStates``; See :ref:`State Combiner`). +* **manager** - ``traffic_monitor/manager/peer.go:StartPeerManager()``. Takes JSON peer Traffic Monitor results, and aggregates them. The availability of the Peer Traffic Monitor itself, as well as all cache availability from the given peer result, is stored in the shared ``peerStates`` object. Results are then aggregated via a call to the ``combineState()`` lambda, which signals the State Combiner microthread (which stores the combined availability in the shared object ``combinedStates``; See :ref:`State Combiner <state-combiner>`). Monitor Config Pipeline @@ -232,6 +232,8 @@ Events The ``events`` shared data object is passed to each pipeline microthread which needs to signal events. Most of them do. Events are then logged, and visible in the UI as well as an HTTP JSON endpoint. Most events are caches becoming available or unavailable, but include other things such as peer availability changes. +.. _state-combiner: + State Combiner -------------- The State Combiner is a microthread started in ``traffic_monitor/manager/manager.go:Start()`` via ``traffic_monitor/manager/statecombiner.go:StartStateCombiner()``, which listens for signals to combine states. It should be signaled by any pipeline which updates the local or peer availability shared data objects, ``localStates`` and ``peerStates``. It holds the threadsafe shared data objects for local states and peer states, so no data is passed or returned, only a signal. @@ -239,11 +241,15 @@ The State Combiner is a microthread started in ``traffic_monitor/manager/manager When a signal is received, it combines the local and peer states optimistically. That is, if a cache is marked available locally or by any peer, that cache is marked available in the combined states. There exists a variable to combine pessimistically, which may be set at compile time (it's unusual for a CDN to operate well with pessimistic cache availability). Combined data is stored in the threadsafe shared data object ``combinedStates``. +.. _agg-stat-data: + Aggregated Stat Data -------------------- The Stat pipeline Manager is responsible for aggregating stats from all caches, into delivery services statistics. This is done via a call to ``traffic_monitor/deliveryservice/stat.go:CreateStats()``. +.. _agg-avail-data: + Aggregated Availability Data ---------------------------- Both the Stat and Health pipelines aggregate availability data received from caches. This is done via a call to ``traffic_monitor/deliveryservice/health.go:CalcAvailability()`` followed by a call to ``combineState()``. The ``CalcAvailability`` function calculates the availability of each cache from the result of polling it, that is, local availability. The ``combineState()`` function is a lambda passed to the Manager, which signals the State Combiner microthread, which will combine the local and peer Traffic Monitor availability data, and insert it into the shared data ``combinedStates`` object. @@ -251,11 +257,13 @@ Both the Stat and Health pipelines aggregate availability data received from cac HTTP Data Requests ------------------ -Data is provided to HTTP requests via the threadsafe shared data objects (see :ref:`Shared Data`). These objects are closed in lambdas created via ``traffic_monitor/datareq/datareq.go:MakeDispatchMap()``. This is called by the Ops Config Manager when it recreates the HTTP server. +Data is provided to HTTP requests via the threadsafe shared data objects (see :ref:`Shared Data <shared-data>`). These objects are closed in lambdas created via ``traffic_monitor/datareq/datareq.go:MakeDispatchMap()``. This is called by the Ops Config Manager when it recreates the HTTP server. Each HTTP endpoint is mapped to a function which closes around the shared data objects it needs, and takes the request data it needs (such as query parameters). Each endpoint function resides in its own file in ``traffic_monitor/datareq/``. Because each Go HTTP routing function must be a ``http.HandlerFunc``, wrapper functions take the endpoint functions and return ``http.HandlerFunc`` functions which call them, and which are stored in the dispatch map, to be registered with the HTTP server. +.. _shared-data: + Shared Data ----------- Processed and aggregated data must be shared between the end of the stat and health processing pipelines, and HTTP requests. The CSP paradigm of idiomatic Go does not work efficiently with storing and sharing state. While not idiomatic Go, shared mutexed data structures are faster and simpler than CSP manager microthreads for each data object. @@ -267,7 +275,7 @@ Currently, all Threadsafe shared data types use mutexes. In the future, these co Formatting Conventions -=========================== +====================== Go code should be formatted with ``gofmt``. See also ``CONTRIBUTING.md``. Installing The Developer Environment http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/1ba9fff3/docs/master/_sources/development/traffic_ops_api/v12/deliveryservice.rst.txt ---------------------------------------------------------------------- diff --git a/docs/master/_sources/development/traffic_ops_api/v12/deliveryservice.rst.txt b/docs/master/_sources/development/traffic_ops_api/v12/deliveryservice.rst.txt index 00dbc85..b141212 100644 --- a/docs/master/_sources/development/traffic_ops_api/v12/deliveryservice.rst.txt +++ b/docs/master/_sources/development/traffic_ops_api/v12/deliveryservice.rst.txt @@ -176,7 +176,7 @@ Delivery Service | ``signed`` | bool | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. | | | | - true: token based auth is enabled for this deliveryservice. | +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ - | ``signingAlgorithm`` | string | - null: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. | + | ``signingAlgorithm`` | string | - null: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. | | | | - "url_sig": URL Sign token based auth is enabled for this deliveryservice. | | | | - "uri_signing": URI Signing token based auth is enabled for this deliveryservice. | +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ @@ -3199,9 +3199,9 @@ URL Sig Keys | URI Signing Keys -++++++++++++ +++++++++++++++++ -**DELETE /api/1.2/deliveryservices/:xml_id/urisignkeys +**DELETE /api/1.2/deliveryservices/:xml_id/urisignkeys** Deletes URISigning objects for a delivery service. @@ -3214,10 +3214,10 @@ URI Signing Keys +-----------+----------+----------------------------------------+ | Name | Required | Description | +===========+==========+========================================+ - | ``xml_id`` | yes | xml_id of the desired delivery service | + | xml_id | yes | xml_id of the desired delivery service | +-----------+----------+----------------------------------------+ -**GET /api/1.2/deliveryservices/:xml_id/urisignkeys +**GET /api/1.2/deliveryservices/:xml_id/urisignkeys** Retrieves one or more URISigning objects for a delivery service. @@ -3230,7 +3230,7 @@ URI Signing Keys +-----------+----------+----------------------------------------+ | Name | Required | Description | +===========+==========+========================================+ - | ``xml_id`` | yes | xml_id of the desired delivery service | + | xml_id | yes | xml_id of the desired delivery service | +-----------+----------+----------------------------------------+ **Response Properties** @@ -3255,28 +3255,28 @@ URI Signing Keys **Response Example** :: - { - "Kabletown URI Authority": { - "renewal_kid": "Second Key", - "keys": [ - { - "alg": "HS256", - "kid": "First Key", - "kty": "oct", - "k": "Kh_RkUMj-fzbD37qBnDf_3e_RvQ3RP9PaSmVEpE24AM" - }, - { - "alg": "HS256", - "kid": "Second Key", - "kty": "oct", - "k": "fZBpDBNbk2GqhwoB_DGBAsBxqQZVix04rIoLJ7p_RlE" - } - ] + { + "Kabletown URI Authority": { + "renewal_kid": "Second Key", + "keys": [ + { + "alg": "HS256", + "kid": "First Key", + "kty": "oct", + "k": "Kh_RkUMj-fzbD37qBnDf_3e_RvQ3RP9PaSmVEpE24AM" + }, + { + "alg": "HS256", + "kid": "Second Key", + "kty": "oct", + "k": "fZBpDBNbk2GqhwoB_DGBAsBxqQZVix04rIoLJ7p_RlE" + } + ] + } } - } -**POST /api/1.2/deliveryservices/:xml_id/urisignkeys +**POST /api/1.2/deliveryservices/:xml_id/urisignkeys** Assigns URISigning objects to a delivery service. @@ -3289,7 +3289,7 @@ URI Signing Keys +-----------+----------+----------------------------------------+ | Name | Required | Description | +===========+==========+========================================+ - | ``xml_id`` | yes | xml_id of the desired delivery service | + | xml_id | yes | xml_id of the desired delivery service | +-----------+----------+----------------------------------------+ **Request Properties** @@ -3314,27 +3314,27 @@ URI Signing Keys **Request Example** :: - { - "Kabletown URI Authority": { - "renewal_kid": "Second Key", - "keys": [ - { - "alg": "HS256", - "kid": "First Key", - "kty": "oct", - "k": "Kh_RkUMj-fzbD37qBnDf_3e_RvQ3RP9PaSmVEpE24AM" - }, - { - "alg": "HS256", - "kid": "Second Key", - "kty": "oct", - "k": "fZBpDBNbk2GqhwoB_DGBAsBxqQZVix04rIoLJ7p_RlE" - } - ] + { + "Kabletown URI Authority": { + "renewal_kid": "Second Key", + "keys": [ + { + "alg": "HS256", + "kid": "First Key", + "kty": "oct", + "k": "Kh_RkUMj-fzbD37qBnDf_3e_RvQ3RP9PaSmVEpE24AM" + }, + { + "alg": "HS256", + "kid": "Second Key", + "kty": "oct", + "k": "fZBpDBNbk2GqhwoB_DGBAsBxqQZVix04rIoLJ7p_RlE" + } + ] + } } - } -**PUT /api/1.2/deliveryservices/:xml_id/urisignkeys +**PUT /api/1.2/deliveryservices/:xml_id/urisignkeys** updates URISigning objects on a delivery service. @@ -3347,7 +3347,7 @@ URI Signing Keys +-----------+----------+----------------------------------------+ | Name | Required | Description | +===========+==========+========================================+ - | ``xml_id`` | yes | xml_id of the desired delivery service | + | xml_id | yes | xml_id of the desired delivery service | +-----------+----------+----------------------------------------+ **Request Properties** @@ -3372,25 +3372,25 @@ URI Signing Keys **Request Example** :: - { - "Kabletown URI Authority": { - "renewal_kid": "Second Key", - "keys": [ - { - "alg": "HS256", - "kid": "First Key", - "kty": "oct", - "k": "Kh_RkUMj-fzbD37qBnDf_3e_RvQ3RP9PaSmVEpE24AM" - }, - { - "alg": "HS256", - "kid": "Second Key", - "kty": "oct", - "k": "fZBpDBNbk2GqhwoB_DGBAsBxqQZVix04rIoLJ7p_RlE" - } - ] + { + "Kabletown URI Authority": { + "renewal_kid": "Second Key", + "keys": [ + { + "alg": "HS256", + "kid": "First Key", + "kty": "oct", + "k": "Kh_RkUMj-fzbD37qBnDf_3e_RvQ3RP9PaSmVEpE24AM" + }, + { + "alg": "HS256", + "kid": "Second Key", + "kty": "oct", + "k": "fZBpDBNbk2GqhwoB_DGBAsBxqQZVix04rIoLJ7p_RlE" + } + ] + } } - } | http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/1ba9fff3/docs/master/admin/traffic_monitor_golang.html ---------------------------------------------------------------------- diff --git a/docs/master/admin/traffic_monitor_golang.html b/docs/master/admin/traffic_monitor_golang.html index 968a999..6c8011e 100644 --- a/docs/master/admin/traffic_monitor_golang.html +++ b/docs/master/admin/traffic_monitor_golang.html @@ -217,7 +217,7 @@ </li> <li><p class="first">Install Traffic Monitor: <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">yum</span> <span class="pre">-y</span> <span class="pre">install</span> <span class="pre">traffic_monitor</span></code></p> </li> -<li><p class="first">Configure Traffic Monitor. See <span class="xref std std-ref">rl-tm-configure</span></p> +<li><p class="first">Configure Traffic Monitor. See <a class="reference internal" href="#rl-tm-configure"><span class="std std-ref">here</span></a></p> </li> <li><p class="first">Start the service: <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">service</span> <span class="pre">traffic_monitor</span> <span class="pre">start</span></code></p> <div class="highlight-default"><div class="highlight"><pre><span class="n">Starting</span> <span class="n">traffic_monitor</span><span class="p">:</span> http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/1ba9fff3/docs/master/admin/traffic_ops/using.html ---------------------------------------------------------------------- diff --git a/docs/master/admin/traffic_ops/using.html b/docs/master/admin/traffic_ops/using.html index b92c4c4..1076a27 100644 --- a/docs/master/admin/traffic_ops/using.html +++ b/docs/master/admin/traffic_ops/using.html @@ -114,7 +114,7 @@ <li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Ops - Using</a></li> <li class="toctree-l2"><a class="reference internal" href="extensions.html">Managing Traffic Ops Extensions</a></li> <li class="toctree-l2"><a class="reference internal" href="../traffic_portal.html">Traffic Portal Administration</a></li> -<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor.html">Traffic Monitor Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li> <li class="toctree-l2"><a class="reference internal" href="../traffic_monitor_golang.html">Traffic Monitor Administration</a></li> <li class="toctree-l2"><a class="reference internal" href="../traffic_router.html">Traffic Router Administration</a></li> <li class="toctree-l2"><a class="reference internal" href="../traffic_stats.html">Traffic Stats Administration</a></li> @@ -1056,7 +1056,7 @@ for associated servers when assigned to a server profile. Value must be “c <span id="rl-multi-site-origin"></span><h3>Multi Site Origin<a class="headerlink" href="#multi-site-origin" title="Permalink to this headline">¶</a></h3> <div class="admonition note"> <p class="first admonition-title">Note</p> -<p class="last">The configuration of this feature changed significantly between ATS version 5 and >= 6. Some configuration in Traffic Control is different as well. This documentation assumes ATS 6 or higher. See <span class="xref std std-ref">rl-multi-site-origin-qht-ats5</span> for the ATS version 5.x configuration details.</p> +<p class="last">The configuration of this feature changed significantly between ATS version 5 and >= 6. Some configuration in Traffic Control is different as well. This documentation assumes ATS 6 or higher. See <a class="reference internal" href="../quick_howto/multi_site.html#rl-multi-site-origin-qht"><span class="std std-ref">Configure Multi Site Origin</span></a> for more details.</p> </div> <p>Normally, the mid servers are not aware of any redundancy at the origin layer. With Multi Site Origin enabled this changes - Traffic Server (and Traffic Ops) are now made aware of the fact there are multiple origins, and can be configured to do more advanced failover and loadbalancing actions. A prerequisite for MSO to work is that the multiple origin sites serve identical content with identical paths, and both are configured to serve the same origin hostname as is configured in the deliveryservice <cite>Origin Server Base URL</cite> field. See the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/admin-guide/files/parent.config.en.html";>Apache Traffic Server docs</a> for more information on that cache’s implementation.</p> <p>With This feature enabled, origin servers (or origin server VIP names for a site) are going to be entered as servers in to the Traiffic Ops UI. Server type is “ORG”.</p> http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/1ba9fff3/docs/master/development/traffic_monitor_golang.html ---------------------------------------------------------------------- diff --git a/docs/master/development/traffic_monitor_golang.html b/docs/master/development/traffic_monitor_golang.html index 472d406..abda570 100644 --- a/docs/master/development/traffic_monitor_golang.html +++ b/docs/master/development/traffic_monitor_golang.html @@ -114,7 +114,7 @@ <li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/using.html">Traffic Ops - Using</a></li> <li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li> <li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal.html">Traffic Portal Administration</a></li> -<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li> <li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li> <li class="toctree-l2"><a class="reference internal" href="../admin/traffic_router.html">Traffic Router Administration</a></li> <li class="toctree-l2"><a class="reference internal" href="../admin/traffic_stats.html">Traffic Stats Administration</a></li> @@ -245,7 +245,7 @@ <div class="section" id="architecture"> <h2>Architecture<a class="headerlink" href="#architecture" title="Permalink to this headline">¶</a></h2> <p>At the highest level, Traffic Monitor polls caches, aggregates their data and availability, and serves it at HTTP JSON endpoints.</p> -<p>In the code, the data flows thru microthread (goroutine) pipelines. All stages of the pipeline are independent running microthreads:sup:<cite>1</cite>. The pipelines are:</p> +<p>In the code, the data flows thru microthread (goroutine) pipelines. All stages of the pipeline are independent running microthreads <a class="footnote-reference" href="#f1" id="id1">[1]</a> . The pipelines are:</p> <ul class="simple"> <li><strong>stat poll</strong> - polls caches for all statistics data. This should be a slower poll, which gets a lot of data.</li> <li><strong>health poll</strong> - polls caches for a tiny amount of data, typically system information. This poll is designed to be a heartbeat, determining quickly whether the cache is reachable. Since it’s a small amount of data, it should poll more frequently.</li> @@ -308,7 +308,12 @@ <span class="o">...</span> <span class="o">...</span> </pre></div> </div> -<p>:sup:<a href="#id1"><span class="problematic" id="id2">`</span></a>1`Technically, some stages which are one-to-one simply call the next stage as a function. For example, the Fetcher calls the Handler as a function in the same microthread. But this isn’t architecturally significant.</p> +<table class="docutils footnote" frame="void" id="f1" rules="none"> +<colgroup><col class="label" /><col /></colgroup> +<tbody valign="top"> +<tr><td class="label"><a class="fn-backref" href="#id1">[1]</a></td><td>Technically, some stages which are one-to-one simply call the next stage as a function. For example, the Fetcher calls the Handler as a function in the same microthread. But this isn’t architecturally significant.</td></tr> +</tbody> +</table> <div class="section" id="stat-pipeline"> <h3>Stat Pipeline<a class="headerlink" href="#stat-pipeline" title="Permalink to this headline">¶</a></h3> <div class="highlight-default"><div class="highlight"><pre><span class="o">---------</span> <span class="o">---------</span> <span class="o">---------</span> <span class="o">---------</span> @@ -324,7 +329,7 @@ <li><strong>poller</strong> - <code class="docutils literal"><span class="pre">common/poller/poller.go:HttpPoller.Poll()</span></code>. Listens for config changes (from the ops config manager), and starts its own internal microthreads, one for each cache to poll. These internal microthreads call the Fetcher at each cache’s poll interval.</li> <li><strong>fetcher</strong> - <code class="docutils literal"><span class="pre">common/fetcher/fetcher.go:HttpFetcher.Fetch()</span></code>. Fetches the given URL, and passes the returned data to the Handler, along with any errors.</li> <li><strong>handler</strong> - <code class="docutils literal"><span class="pre">traffic_monitor/cache/cache.go:Handler.Handle()</span></code>. Takes the given result and does all data computation possible with the single result. Currently, this computation primarily involves processing the denormalized ATS data into Go structs, and processing System data into OutBytes, Kbps, etc. Precomputed data is then passed to its result channel, which is picked up by the Manager.</li> -<li><strong>manager</strong> - <code class="docutils literal"><span class="pre">traffic_monitor/manager/stat.go:StartStatHistoryManager()</span></code>. Takes preprocessed results, and aggregates them. Aggregated results are then placed in shared data structures. The major data aggregated are delivery service statistics, and cache availability data. See <span class="xref std std-ref">Aggregated Stat Data</span> and <span class="xref std std-ref">Aggregated Availability Data</span>.</li> +<li><strong>manager</strong> - <code class="docutils literal"><span class="pre">traffic_monitor/manager/stat.go:StartStatHistoryManager()</span></code>. Takes preprocessed results, and aggregates them. Aggregated results are then placed in shared data structures. The major data aggregated are delivery service statistics, and cache availability data. See <a class="reference internal" href="#agg-stat-data"><span class="std std-ref">Aggregated Stat Data</span></a> and <a class="reference internal" href="#agg-avail-data"><span class="std std-ref">Aggregated Availability Data</span></a>.</li> </ul> </div> <div class="section" id="health-pipeline"> @@ -342,7 +347,7 @@ <li><strong>poller</strong> - <code class="docutils literal"><span class="pre">common/poller/poller.go:HttpPoller.Poll()</span></code>. Same poller type as the Stat Poller pipeline, with a different handler object.</li> <li><strong>fetcher</strong> - <code class="docutils literal"><span class="pre">common/fetcher/fetcher.go:HttpFetcher.Fetch()</span></code>. Same fetcher type as the Stat Poller pipeline, with a different handler object.</li> <li><strong>handler</strong> - <code class="docutils literal"><span class="pre">traffic_monitor/cache/cache.go:Handler.Handle()</span></code>. Same handler type as the Stat Poller pipeline, but constructed with a flag to not precompute. The health endpoint is of the same form as the stat endpoint, but doesn’t return all stat data. So, it doesn’t precompute like the Stat Handler, but only processes the system data, and passes the processed result to its result channel, which is picked up by the Manager.</li> -<li><strong>manager</strong> - <code class="docutils literal"><span class="pre">traffic_monitor/manager/health.go:StartHealthResultManager()</span></code>. Takes preprocessed results, and aggregates them. For the Health pipeline, only health availability data is aggregated. Aggregated results are then placed in shared data structures (lastHealthDurationsThreadsafe, lastHealthEndTimes, etc). See <span class="xref std std-ref">Aggregated Availability Data</span>.</li> +<li><strong>manager</strong> - <code class="docutils literal"><span class="pre">traffic_monitor/manager/health.go:StartHealthResultManager()</span></code>. Takes preprocessed results, and aggregates them. For the Health pipeline, only health availability data is aggregated. Aggregated results are then placed in shared data structures (lastHealthDurationsThreadsafe, lastHealthEndTimes, etc). See <a class="reference internal" href="#agg-avail-data"><span class="std std-ref">Aggregated Availability Data</span></a>.</li> </ul> </div> <div class="section" id="peer-pipeline"> @@ -360,7 +365,7 @@ <li><strong>poller</strong> - <code class="docutils literal"><span class="pre">common/poller/poller.go:HttpPoller.Poll()</span></code>. Same poller type as the Stat and Health Poller pipelines, with a different handler object. Its config changes come from the Monitor Config Manager, and it starts an internal microthread for each peer to poll.</li> <li><strong>fetcher</strong> - <code class="docutils literal"><span class="pre">common/fetcher/fetcher.go:HttpFetcher.Fetch()</span></code>. Same fetcher type as the Stat and Health Poller pipeline, with a different handler object.</li> <li><strong>handler</strong> - <code class="docutils literal"><span class="pre">traffic_monitor/cache/peer.go:Handler.Handle()</span></code>. Decodes the JSON result into an object, and without further processing passes to its result channel, which is picked up by the Manager.</li> -<li><strong>manager</strong> - <code class="docutils literal"><span class="pre">traffic_monitor/manager/peer.go:StartPeerManager()</span></code>. Takes JSON peer Traffic Monitor results, and aggregates them. The availability of the Peer Traffic Monitor itself, as well as all cache availability from the given peer result, is stored in the shared <code class="docutils literal"><span class="pre">peerStates</span></code> object. Results are then aggregated via a call to the <code class="docutils literal"><span class="pre">combineState()</span></code> lambda, which signals the State Combiner microthread (which stores the combined availability in the shared object <code class="docutils literal"><span class="pre">combinedStates</span></code>; See <span class="xref std std-ref">State Combiner</span>).</li> +<li><strong>manager</strong> - <code class="docutils literal"><span class="pre">traffic_monitor/manager/peer.go:StartPeerManager()</span></code>. Takes JSON peer Traffic Monitor results, and aggregates them. The availability of the Peer Traffic Monitor itself, as well as all cache availability from the given peer result, is stored in the shared <code class="docutils literal"><span class="pre">peerStates</span></code> object. Results are then aggregated via a call to the <code class="docutils literal"><span class="pre">combineState()</span></code> lambda, which signals the State Combiner microthread (which stores the combined availability in the shared object <code class="docutils literal"><span class="pre">combinedStates</span></code>; See <a class="reference internal" href="#state-combiner"><span class="std std-ref">State Combiner</span></a>).</li> </ul> </div> <div class="section" id="monitor-config-pipeline"> @@ -397,25 +402,25 @@ <p>The <code class="docutils literal"><span class="pre">events</span></code> shared data object is passed to each pipeline microthread which needs to signal events. Most of them do. Events are then logged, and visible in the UI as well as an HTTP JSON endpoint. Most events are caches becoming available or unavailable, but include other things such as peer availability changes.</p> </div> <div class="section" id="state-combiner"> -<h3>State Combiner<a class="headerlink" href="#state-combiner" title="Permalink to this headline">¶</a></h3> +<span id="id2"></span><h3>State Combiner<a class="headerlink" href="#state-combiner" title="Permalink to this headline">¶</a></h3> <p>The State Combiner is a microthread started in <code class="docutils literal"><span class="pre">traffic_monitor/manager/manager.go:Start()</span></code> via <code class="docutils literal"><span class="pre">traffic_monitor/manager/statecombiner.go:StartStateCombiner()</span></code>, which listens for signals to combine states. It should be signaled by any pipeline which updates the local or peer availability shared data objects, <code class="docutils literal"><span class="pre">localStates</span></code> and <code class="docutils literal"><span class="pre">peerStates</span></code>. It holds the threadsafe shared data objects for local states and peer states, so no data is passed or returned, only a signal.</p> <p>When a signal is received, it combines the local and peer states optimistically. That is, if a cache is marked available locally or by any peer, that cache is marked available in the combined states. There exists a variable to combine pessimistically, which may be set at compile time (it’s unusual for a CDN to operate well with pessimistic cache availability). Combined data is stored in the threadsafe shared data object <code class="docutils literal"><span class="pre">combinedStates</span></code>.</p> </div> <div class="section" id="aggregated-stat-data"> -<h3>Aggregated Stat Data<a class="headerlink" href="#aggregated-stat-data" title="Permalink to this headline">¶</a></h3> +<span id="agg-stat-data"></span><h3>Aggregated Stat Data<a class="headerlink" href="#aggregated-stat-data" title="Permalink to this headline">¶</a></h3> <p>The Stat pipeline Manager is responsible for aggregating stats from all caches, into delivery services statistics. This is done via a call to <code class="docutils literal"><span class="pre">traffic_monitor/deliveryservice/stat.go:CreateStats()</span></code>.</p> </div> <div class="section" id="aggregated-availability-data"> -<h3>Aggregated Availability Data<a class="headerlink" href="#aggregated-availability-data" title="Permalink to this headline">¶</a></h3> +<span id="agg-avail-data"></span><h3>Aggregated Availability Data<a class="headerlink" href="#aggregated-availability-data" title="Permalink to this headline">¶</a></h3> <p>Both the Stat and Health pipelines aggregate availability data received from caches. This is done via a call to <code class="docutils literal"><span class="pre">traffic_monitor/deliveryservice/health.go:CalcAvailability()</span></code> followed by a call to <code class="docutils literal"><span class="pre">combineState()</span></code>. The <code class="docutils literal"><span class="pre">CalcAvailability</span></code> function calculates the availability of each cache from the result of polling it, that is, local availability. The <code class="docutils literal"><span class="pre">combineState()</span></code> function is a lambda passed to the Manager, which signals the State Combiner microthread, which will combine the local and peer Traffic Monitor availability data, and insert it into the shared data <code class="docutils literal"><span class="pre">combinedStates</span></code> object.</p> </div> <div class="section" id="http-data-requests"> <h3>HTTP Data Requests<a class="headerlink" href="#http-data-requests" title="Permalink to this headline">¶</a></h3> -<p>Data is provided to HTTP requests via the threadsafe shared data objects (see <span class="xref std std-ref">Shared Data</span>). These objects are closed in lambdas created via <code class="docutils literal"><span class="pre">traffic_monitor/datareq/datareq.go:MakeDispatchMap()</span></code>. This is called by the Ops Config Manager when it recreates the HTTP server.</p> +<p>Data is provided to HTTP requests via the threadsafe shared data objects (see <a class="reference internal" href="#shared-data"><span class="std std-ref">Shared Data</span></a>). These objects are closed in lambdas created via <code class="docutils literal"><span class="pre">traffic_monitor/datareq/datareq.go:MakeDispatchMap()</span></code>. This is called by the Ops Config Manager when it recreates the HTTP server.</p> <p>Each HTTP endpoint is mapped to a function which closes around the shared data objects it needs, and takes the request data it needs (such as query parameters). Each endpoint function resides in its own file in <code class="docutils literal"><span class="pre">traffic_monitor/datareq/</span></code>. Because each Go HTTP routing function must be a <code class="docutils literal"><span class="pre">http.HandlerFunc</span></code>, wrapper functions take the endpoint functions and return <code class="docutils literal"><span class="pre">http.HandlerFunc</span></code> functions which call them, and which are stored in the dispatch map, to be registered with the HTTP server.</p> </div> <div class="section" id="shared-data"> -<h3>Shared Data<a class="headerlink" href="#shared-data" title="Permalink to this headline">¶</a></h3> +<span id="id3"></span><h3>Shared Data<a class="headerlink" href="#shared-data" title="Permalink to this headline">¶</a></h3> <p>Processed and aggregated data must be shared between the end of the stat and health processing pipelines, and HTTP requests. The CSP paradigm of idiomatic Go does not work efficiently with storing and sharing state. While not idiomatic Go, shared mutexed data structures are faster and simpler than CSP manager microthreads for each data object.</p> <p>Traffic Monitor has many threadsafe shared data types and objects. All shared data objects can be seen in <code class="docutils literal"><span class="pre">manager/manager.go:Start()</span></code>, where they are created and passed to the various pipeline stage microthreads that need them. Their respective types all include the word <code class="docutils literal"><span class="pre">Threadsafe</span></code>, and can be found in <code class="docutils literal"><span class="pre">traffic_monitor/threadsafe/</span></code> as well as, for dependency reasons, various appropriate directories.</p> <p>Currently, all Threadsafe shared data types use mutexes. In the future, these could be changed to lock-free or wait-free structures, if the performance needs outweighed the readability and correctness costs. They could also easily be changed to internally be manager microthreads and channels, if being idiomatic were deemed more important than readability or performance.</p> http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/1ba9fff3/docs/master/development/traffic_ops_api/v12/deliveryservice.html ---------------------------------------------------------------------- diff --git a/docs/master/development/traffic_ops_api/v12/deliveryservice.html b/docs/master/development/traffic_ops_api/v12/deliveryservice.html index 80f3989..6065d36 100644 --- a/docs/master/development/traffic_ops_api/v12/deliveryservice.html +++ b/docs/master/development/traffic_ops_api/v12/deliveryservice.html @@ -242,6 +242,293 @@ </tbody> </table> <p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="15%" /> +<col width="5%" /> +<col width="80%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">active</span></code></td> +<td>bool</td> +<td>true if active, false if inactive.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cacheurl</span></code></td> +<td>string</td> +<td>Cache URL rule to apply to this delivery service.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">ccrDnsTtl</span></code></td> +<td>int</td> +<td>The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cdnId</span></code></td> +<td>int</td> +<td>Id of the CDN to which the delivery service belongs to.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">cdnName</span></code></td> +<td>string</td> +<td>Name of the CDN to which the delivery service belongs to.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">checkPath</span></code></td> +<td>string</td> +<td>The path portion of the URL to check this deliveryservice for health.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">displayName</span></code></td> +<td>string</td> +<td>The display name of the delivery service.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassCname</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnsBypassIp</span></code></td> +<td>string</td> +<td>The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the +globalMaxMbps traffic on this deliveryservice.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassIp6</span></code></td> +<td>string</td> +<td>The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the +globalMaxMbps traffic on this deliveryservice.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnsBypassTtl</span></code></td> +<td>int</td> +<td>The TTL of the DNS bypass response.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dscp</span></code></td> +<td>int</td> +<td>The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">edgeHeaderRewrite</span></code></td> +<td>string</td> +<td>The EDGE header rewrite actions to perform.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">exampleURLs</span></code></td> +<td>array</td> +<td>Entry points into the CDN for this deliveryservice.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">geoLimitRedirectUrl</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">geoLimit</span></code></td> +<td>int</td> +<td><ul class="first simple"> +<li>0: None - no limitations</li> +<li>1: Only route on CZF file hit</li> +<li>2: Only route on CZF hit or when from USA</li> +</ul> +<p class="last">Note that this does not prevent access to content or makes content secure; it just prevents +routing to the content by Traffic Router.</p> +</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">geoLimitCountries</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">geoProvider</span></code></td> +<td>int</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">globalMaxMbps</span></code></td> +<td>int</td> +<td>The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the +dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">globalMaxTps</span></code></td> +<td>int</td> +<td>The maximum global transactions per second allowed on this deliveryservice. When this is exceeded +traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for +HTTP deliveryservices</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">httpBypassFqdn</span></code></td> +<td>string</td> +<td>The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the +globalMaxMbps traffic on this deliveryservice.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td> +<td>int</td> +<td>The deliveryservice id (database row number).</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">infoUrl</span></code></td> +<td>string</td> +<td>Use this to add a URL that points to more information about that deliveryservice.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">initialDispersion</span></code></td> +<td>int</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">ipv6RoutingEnabled</span></code></td> +<td>bool</td> +<td>false: send IPv4 address of Traffic Router to client on HTTP type del.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">logsEnabled</span></code></td> +<td>bool</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">longDesc</span></code></td> +<td>string</td> +<td>Description field.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">longDesc1</span></code></td> +<td>string</td> +<td>Description field 1.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">longDesc2</span></code></td> +<td>string</td> +<td>Description field 2.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">maxDnsAnswers</span></code></td> +<td>int</td> +<td>The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all +available).</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">midHeaderRewrite</span></code></td> +<td>string</td> +<td>The MID header rewrite actions to perform.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">missLat</span></code></td> +<td>float</td> +<td><p class="first">The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup.</p> +<ul class="last simple"> +<li>e.g. 39.7391500 or null</li> +</ul> +</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">missLong</span></code></td> +<td>float</td> +<td><p class="first">The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup.</p> +<ul class="last simple"> +<li>e.g. -104.9847000 or null</li> +</ul> +</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">multiSiteOrigin</span></code></td> +<td>bool</td> +<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops/using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">orgServerFqdn</span></code></td> +<td>string</td> +<td>The origin server base URL (FQDN when used in this instance, includes the +protocol (<a class="reference external" href="http://";>http://</a> or <a class="reference external" href="https://";>https://</a>) for use in retrieving content from the origin server.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">originShield</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileDescription</span></code></td> +<td>string</td> +<td>The description of the Traffic Router Profile with which this deliveryservice is associated.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">profileId</span></code></td> +<td>int</td> +<td>The id of the Traffic Router Profile with which this deliveryservice is associated.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileName</span></code></td> +<td>string</td> +<td>The name of the Traffic Router Profile with which this deliveryservice is associated.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">protocol</span></code></td> +<td>int</td> +<td><ul class="first last simple"> +<li>0: serve with <a class="reference external" href="http://";>http://</a> at EDGE</li> +<li>1: serve with <a class="reference external" href="https://";>https://</a> at EDGE</li> +<li>2: serve with both <a class="reference external" href="http://";>http://</a> and <a class="reference external" href="https://";>https://</a> at EDGE</li> +</ul> +</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">qstringIgnore</span></code></td> +<td>int</td> +<td><ul class="first last simple"> +<li>0: no special query string handling; it is for use in the cache-key and pass up to origin.</li> +<li>1: ignore query string in cache-key, but pass it up to parent and or origin.</li> +<li>2: drop query string at edge, and do not use it in the cache-key.</li> +</ul> +</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">rangeRequestHandling</span></code></td> +<td>int</td> +<td><p class="first">How to treat range requests:</p> +<ul class="last simple"> +<li>0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT)</li> +<li>1 Use the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html";>background_fetch</a> plugin.</li> +<li>2 Use the cache_range_requests plugin.</li> +</ul> +</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">regexRemap</span></code></td> +<td>string</td> +<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">regionalGeoBlocking</span></code></td> +<td>bool</td> +<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">remapText</span></code></td> +<td>string</td> +<td>Additional raw remap line text.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">routingName</span></code></td> +<td>string</td> +<td>The routing name of this deliveryservice, e.g. <routingName>.<xmlId>.cdn.com.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">signed</span></code></td> +<td>bool</td> +<td><ul class="first last simple"> +<li>false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice.</li> +<li>true: token based auth is enabled for this deliveryservice.</li> +</ul> +</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">signingAlgorithm</span></code></td> +<td>string</td> +<td><ul class="first last simple"> +<li>null: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice.</li> +<li>“url_sig”: URL Sign token based auth is enabled for this deliveryservice.</li> +<li>“uri_signing”: URI Signing token based auth is enabled for this deliveryservice.</li> +</ul> +</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">sslKeyVersion</span></code></td> +<td>int</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">tenant</span></code></td> +<td>string</td> +<td>Owning tenant name</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">tenantId</span></code></td> +<td>int</td> +<td>Owning tenant ID</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">trRequestHeaders</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">trResponseHeaders</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">typeId</span></code></td> +<td>int</td> +<td>The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=’deliveryservice’).</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">xmlId</span></code></td> +<td>string</td> +<td>Unique string that describes this deliveryservice.</td> +</tr> +</tbody> +</table> <p><strong>Response Example</strong></p> <div class="highlight-default"><div class="highlight"><pre><span class="p">{</span> <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span> @@ -5171,19 +5458,57 @@ protocol (<a class="reference external" href="http://";>http://</a> or <a class=" </div> <div class="section" id="uri-signing-keys"> <h2>URI Signing Keys<a class="headerlink" href="#uri-signing-keys" title="Permalink to this headline">¶</a></h2> -<p><a href="#id5"><span class="problematic" id="id6">**</span></a>DELETE /api/1.2/deliveryservices/:xml_id/urisignkeys</p> +<p><strong>DELETE /api/1.2/deliveryservices/:xml_id/urisignkeys</strong></p> <blockquote> <div><p>Deletes URISigning objects for a delivery service.</p> <p>Authentication Required: Yes</p> <p>Role(s) Required: admin</p> <p><strong>Request Route Parameters</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="18%" /> +<col width="16%" /> +<col width="66%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Name</th> +<th class="head">Required</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td>xml_id</td> +<td>yes</td> +<td>xml_id of the desired delivery service</td> +</tr> +</tbody> +</table> </div></blockquote> -<p><a href="#id7"><span class="problematic" id="id8">**</span></a>GET /api/1.2/deliveryservices/:xml_id/urisignkeys</p> +<p><strong>GET /api/1.2/deliveryservices/:xml_id/urisignkeys</strong></p> <blockquote> <div><p>Retrieves one or more URISigning objects for a delivery service.</p> <p>Authentication Required: Yes</p> <p>Role(s) Required: admin</p> <p><strong>Request Route Parameters</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="18%" /> +<col width="16%" /> +<col width="66%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Name</th> +<th class="head">Required</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td>xml_id</td> +<td>yes</td> +<td>xml_id of the desired delivery service</td> +</tr> +</tbody> +</table> <p><strong>Response Properties</strong></p> <table border="1" class="docutils"> <colgroup> @@ -5230,43 +5555,52 @@ protocol (<a class="reference external" href="http://";>http://</a> or <a class=" </table> <p><strong>Response Example</strong></p> <div class="highlight-default"><div class="highlight"><pre><span class="p">{</span> + <span class="s2">"Kabletown URI Authority"</span><span class="p">:</span> <span class="p">{</span> + <span class="s2">"renewal_kid"</span><span class="p">:</span> <span class="s2">"Second Key"</span><span class="p">,</span> + <span class="s2">"keys"</span><span class="p">:</span> <span class="p">[</span> + <span class="p">{</span> + <span class="s2">"alg"</span><span class="p">:</span> <span class="s2">"HS256"</span><span class="p">,</span> + <span class="s2">"kid"</span><span class="p">:</span> <span class="s2">"First Key"</span><span class="p">,</span> + <span class="s2">"kty"</span><span class="p">:</span> <span class="s2">"oct"</span><span class="p">,</span> + <span class="s2">"k"</span><span class="p">:</span> <span class="s2">"Kh_RkUMj-fzbD37qBnDf_3e_RvQ3RP9PaSmVEpE24AM"</span> + <span class="p">},</span> + <span class="p">{</span> + <span class="s2">"alg"</span><span class="p">:</span> <span class="s2">"HS256"</span><span class="p">,</span> + <span class="s2">"kid"</span><span class="p">:</span> <span class="s2">"Second Key"</span><span class="p">,</span> + <span class="s2">"kty"</span><span class="p">:</span> <span class="s2">"oct"</span><span class="p">,</span> + <span class="s2">"k"</span><span class="p">:</span> <span class="s2">"fZBpDBNbk2GqhwoB_DGBAsBxqQZVix04rIoLJ7p_RlE"</span> + <span class="p">}</span> + <span class="p">]</span> + <span class="p">}</span> +<span class="p">}</span> </pre></div> </div> -<blockquote> -<div><dl class="docutils"> -<dt>“Kabletown URI Authority”: {</dt> -<dd><p class="first">“renewal_kid”: “Second Key”, -“keys”: [</p> -<blockquote> -<div><dl class="docutils"> -<dt>{</dt> -<dd>“alg”: “HS256”, -“kid”: “First Key”, -“kty”: “oct”, -“k”: “Kh_RkUMj-fzbD37qBnDf_3e_RvQ3RP9PaSmVEpE24AM”</dd> -</dl> -<p>}, -{</p> -<blockquote> -<div>“alg”: “HS256”, -“kid”: “Second Key”, -“kty”: “oct”, -“k”: “fZBpDBNbk2GqhwoB_DGBAsBxqQZVix04rIoLJ7p_RlE”</div></blockquote> -<p>}</p> -</div></blockquote> -<p class="last">]</p> -</dd> -</dl> -<p>}</p> -</div></blockquote> -<p>}</p> </div></blockquote> -<p><a href="#id9"><span class="problematic" id="id10">**</span></a>POST /api/1.2/deliveryservices/:xml_id/urisignkeys</p> +<p><strong>POST /api/1.2/deliveryservices/:xml_id/urisignkeys</strong></p> <blockquote> <div><p>Assigns URISigning objects to a delivery service.</p> <p>Authentication Required: Yes</p> <p>Role(s) Required: admin</p> <p><strong>Request Route Parameters</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="18%" /> +<col width="16%" /> +<col width="66%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Name</th> +<th class="head">Required</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td>xml_id</td> +<td>yes</td> +<td>xml_id of the desired delivery service</td> +</tr> +</tbody> +</table> <p><strong>Request Properties</strong></p> <table border="1" class="docutils"> <colgroup> @@ -5313,43 +5647,52 @@ protocol (<a class="reference external" href="http://";>http://</a> or <a class=" </table> <p><strong>Request Example</strong></p> <div class="highlight-default"><div class="highlight"><pre><span class="p">{</span> + <span class="s2">"Kabletown URI Authority"</span><span class="p">:</span> <span class="p">{</span> + <span class="s2">"renewal_kid"</span><span class="p">:</span> <span class="s2">"Second Key"</span><span class="p">,</span> + <span class="s2">"keys"</span><span class="p">:</span> <span class="p">[</span> + <span class="p">{</span> + <span class="s2">"alg"</span><span class="p">:</span> <span class="s2">"HS256"</span><span class="p">,</span> + <span class="s2">"kid"</span><span class="p">:</span> <span class="s2">"First Key"</span><span class="p">,</span> + <span class="s2">"kty"</span><span class="p">:</span> <span class="s2">"oct"</span><span class="p">,</span> + <span class="s2">"k"</span><span class="p">:</span> <span class="s2">"Kh_RkUMj-fzbD37qBnDf_3e_RvQ3RP9PaSmVEpE24AM"</span> + <span class="p">},</span> + <span class="p">{</span> + <span class="s2">"alg"</span><span class="p">:</span> <span class="s2">"HS256"</span><span class="p">,</span> + <span class="s2">"kid"</span><span class="p">:</span> <span class="s2">"Second Key"</span><span class="p">,</span> + <span class="s2">"kty"</span><span class="p">:</span> <span class="s2">"oct"</span><span class="p">,</span> + <span class="s2">"k"</span><span class="p">:</span> <span class="s2">"fZBpDBNbk2GqhwoB_DGBAsBxqQZVix04rIoLJ7p_RlE"</span> + <span class="p">}</span> + <span class="p">]</span> + <span class="p">}</span> +<span class="p">}</span> </pre></div> </div> -<blockquote> -<div><dl class="docutils"> -<dt>“Kabletown URI Authority”: {</dt> -<dd><p class="first">“renewal_kid”: “Second Key”, -“keys”: [</p> -<blockquote> -<div><dl class="docutils"> -<dt>{</dt> -<dd>“alg”: “HS256”, -“kid”: “First Key”, -“kty”: “oct”, -“k”: “Kh_RkUMj-fzbD37qBnDf_3e_RvQ3RP9PaSmVEpE24AM”</dd> -</dl> -<p>}, -{</p> -<blockquote> -<div>“alg”: “HS256”, -“kid”: “Second Key”, -“kty”: “oct”, -“k”: “fZBpDBNbk2GqhwoB_DGBAsBxqQZVix04rIoLJ7p_RlE”</div></blockquote> -<p>}</p> -</div></blockquote> -<p class="last">]</p> -</dd> -</dl> -<p>}</p> -</div></blockquote> -<p>}</p> </div></blockquote> -<p><a href="#id11"><span class="problematic" id="id12">**</span></a>PUT /api/1.2/deliveryservices/:xml_id/urisignkeys</p> +<p><strong>PUT /api/1.2/deliveryservices/:xml_id/urisignkeys</strong></p> <blockquote> <div><p>updates URISigning objects on a delivery service.</p> <p>Authentication Required: Yes</p> <p>Role(s) Required: admin</p> <p><strong>Request Route Parameters</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="18%" /> +<col width="16%" /> +<col width="66%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Name</th> +<th class="head">Required</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td>xml_id</td> +<td>yes</td> +<td>xml_id of the desired delivery service</td> +</tr> +</tbody> +</table> <p><strong>Request Properties</strong></p> <table border="1" class="docutils"> <colgroup> @@ -5396,36 +5739,26 @@ protocol (<a class="reference external" href="http://";>http://</a> or <a class=" </table> <p><strong>Request Example</strong></p> <div class="highlight-default"><div class="highlight"><pre><span class="p">{</span> + <span class="s2">"Kabletown URI Authority"</span><span class="p">:</span> <span class="p">{</span> + <span class="s2">"renewal_kid"</span><span class="p">:</span> <span class="s2">"Second Key"</span><span class="p">,</span> + <span class="s2">"keys"</span><span class="p">:</span> <span class="p">[</span> + <span class="p">{</span> + <span class="s2">"alg"</span><span class="p">:</span> <span class="s2">"HS256"</span><span class="p">,</span> + <span class="s2">"kid"</span><span class="p">:</span> <span class="s2">"First Key"</span><span class="p">,</span> + <span class="s2">"kty"</span><span class="p">:</span> <span class="s2">"oct"</span><span class="p">,</span> + <span class="s2">"k"</span><span class="p">:</span> <span class="s2">"Kh_RkUMj-fzbD37qBnDf_3e_RvQ3RP9PaSmVEpE24AM"</span> + <span class="p">},</span> + <span class="p">{</span> + <span class="s2">"alg"</span><span class="p">:</span> <span class="s2">"HS256"</span><span class="p">,</span> + <span class="s2">"kid"</span><span class="p">:</span> <span class="s2">"Second Key"</span><span class="p">,</span> + <span class="s2">"kty"</span><span class="p">:</span> <span class="s2">"oct"</span><span class="p">,</span> + <span class="s2">"k"</span><span class="p">:</span> <span class="s2">"fZBpDBNbk2GqhwoB_DGBAsBxqQZVix04rIoLJ7p_RlE"</span> + <span class="p">}</span> + <span class="p">]</span> + <span class="p">}</span> +<span class="p">}</span> </pre></div> </div> -<blockquote> -<div><dl class="docutils"> -<dt>“Kabletown URI Authority”: {</dt> -<dd><p class="first">“renewal_kid”: “Second Key”, -“keys”: [</p> -<blockquote> -<div><dl class="docutils"> -<dt>{</dt> -<dd>“alg”: “HS256”, -“kid”: “First Key”, -“kty”: “oct”, -“k”: “Kh_RkUMj-fzbD37qBnDf_3e_RvQ3RP9PaSmVEpE24AM”</dd> -</dl> -<p>}, -{</p> -<blockquote> -<div>“alg”: “HS256”, -“kid”: “Second Key”, -“kty”: “oct”, -“k”: “fZBpDBNbk2GqhwoB_DGBAsBxqQZVix04rIoLJ7p_RlE”</div></blockquote> -<p>}</p> -</div></blockquote> -<p class="last">]</p> -</dd> -</dl> -<p>}</p> -</div></blockquote> -<p>}</p> </div></blockquote> <div class="line-block"> <div class="line"><br /></div> http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/1ba9fff3/docs/master/objects.inv ---------------------------------------------------------------------- diff --git a/docs/master/objects.inv b/docs/master/objects.inv index d651a1b..9763e14 100644 Binary files a/docs/master/objects.inv and b/docs/master/objects.inv differ
