You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficcontrol.apache.org by gi...@apache.org on 2018/05/14 14:04:30 UTC
[2/2] incubator-trafficcontrol-website git commit: Update docs from
commit d22f85d732dd75a179a57fa81704ad01c09c143b
Update docs from commit d22f85d732dd75a179a57fa81704ad01c09c143b
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/98cf8d9a
Tree: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/tree/98cf8d9a
Diff: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/diff/98cf8d9a
Branch: refs/heads/asf-site
Commit: 98cf8d9a2be52c39d49fbc1d1408e94ada89b5b6
Parents: 52f1978
Author: jenkins <bu...@apache.org>
Authored: Mon May 14 14:04:25 2018 +0000
Committer: jenkins <bu...@apache.org>
Committed: Mon May 14 14:04:25 2018 +0000
----------------------------------------------------------------------
.../master/_sources/api/traffic_ops_api.rst.txt | 4 ++
.../traffic_router/traffic_router_api.rst.txt | 19 +++++-----
docs/master/api/index.html | 1 +
docs/master/api/traffic_ops_api.html | 7 +++-
docs/master/development/traffic_router.html | 15 ++++++--
.../traffic_router/traffic_router_api.html | 39 ++++++++++++--------
docs/master/index.html | 1 +
docs/master/searchindex.js | 2 +-
8 files changed, 56 insertions(+), 32 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/98cf8d9a/docs/master/_sources/api/traffic_ops_api.rst.txt
----------------------------------------------------------------------
diff --git a/docs/master/_sources/api/traffic_ops_api.rst.txt b/docs/master/_sources/api/traffic_ops_api.rst.txt
index 2ae61d3..0ced0ae 100644
--- a/docs/master/_sources/api/traffic_ops_api.rst.txt
+++ b/docs/master/_sources/api/traffic_ops_api.rst.txt
@@ -190,3 +190,7 @@ The 3 most common errors returned by Traffic Ops are:
The rest of the API documentation will only document the ``200 OK`` case, where no errors have occured.
+TrafficOps Native Client Libraries
+----------------------------------
+
+TrafficOps client libraries are available in both Golang and Python. You can read more about them at https://github.com/apache/incubator-trafficcontrol/tree/master/traffic_control/clients
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/98cf8d9a/docs/master/_sources/development/traffic_router/traffic_router_api.rst.txt
----------------------------------------------------------------------
diff --git a/docs/master/_sources/development/traffic_router/traffic_router_api.rst.txt b/docs/master/_sources/development/traffic_router/traffic_router_api.rst.txt
index 2ae902f..f56ca2e 100644
--- a/docs/master/_sources/development/traffic_router/traffic_router_api.rst.txt
+++ b/docs/master/_sources/development/traffic_router/traffic_router_api.rst.txt
@@ -15,6 +15,7 @@
.. _reference-tr-api:
+
Traffic Router API
==================
@@ -24,7 +25,7 @@ General stats.
|
-**/crs/stats/ip/:ipaddress**
+**/crs/stats/ip/<ipaddress>**
Geolocation information for an IPv4 or IPv6 address.
@@ -42,49 +43,49 @@ A mapping of caches to cache groups and their current health state.
|
-**/crs/locations/:location/caches**
+**/crs/locations/<location>/caches**
A list of caches for this cache group only.
|
-**/crs/consistenthash/cache/coveragezone/?ip=:ip&deliveryServiceId=:deliveryServiceId&requestPath=:requestPath**
+**/crs/consistenthash/cache/coveragezone/?ip=<ip>&deliveryServiceId=<deliveryServiceId>&requestPath=<requestPath>**
The resulting cache of the consistent hash using coverage zone file for a given client IP, delivery service, and request path.
|
-**/crs/consistenthash/cache/deep/coveragezone/?ip=:ip&deliveryServiceId=:deliveryServiceId&requestPath=:requestPath**
+**/crs/consistenthash/cache/deep/coveragezone/?ip=<ip>&deliveryServiceId=<deliveryServiceId>&requestPath=<requestPath>**
The resulting cache of the consistent hash using deep coverage zone file (deep caching) for a given client IP, delivery service, and request path.
|
-**/crs/consistenthash/cache/geolocation/?ip=:ip&deliveryServiceId=:deliveryServiceId&requestPath=:requestPath**
+**/crs/consistenthash/cache/geolocation/?ip=<ip>&deliveryServiceId=<deliveryServiceId>&requestPath=<requestPath>**
The resulting cache of the consistent hash using geolocation for a given client IP, delivery service, and request path.
|
-**/crs/consistenthash/deliveryservice/?deliveryServiceId=:deliveryServiceId&requestPath=:requestPath**
+**/crs/consistenthash/deliveryservice/?deliveryServiceId=<deliveryServiceId>&requestPath=<requestPath>**
The resulting delivery service of the consistent hash for a given delivery service and request path -- used to test steering delivery services.
|
-**/crs/coveragezone/caches/?deliveryServiceId=:deliveryServiceId&cacheLocationId=:cacheLocationId**
+**/crs/coveragezone/caches/?deliveryServiceId=<deliveryServiceId>&cacheLocationId=<cacheLocationId>**
A list of caches for a given delivery service and cache location.
|
-**/crs/coveragezone/cachelocation/?ip=:ip&deliveryServiceId=:deliveryServiceId**
+**/crs/coveragezone/cachelocation/?ip=<ip>&deliveryServiceId=<deliveryServiceId>**
The resulting cache location for a given client IP and delivery service.
|
-**/crs/deepcoveragezone/cachelocation/?ip=:ip&deliveryServiceId=:deliveryServiceId**
+**/crs/deepcoveragezone/cachelocation/?ip=<ip>&deliveryServiceId=<deliveryServiceId>**
The resulting cache location using deep coverage zone file (deep caching) for a given client IP and delivery service.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/98cf8d9a/docs/master/api/index.html
----------------------------------------------------------------------
diff --git a/docs/master/api/index.html b/docs/master/api/index.html
index 8b93c64..205c819 100644
--- a/docs/master/api/index.html
+++ b/docs/master/api/index.html
@@ -209,6 +209,7 @@
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_api.html#response-structure">Response Structure</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_api.html#using-api-endpoints">Using API Endpoints</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_api.html#api-errors">API Errors</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_ops_api.html#trafficops-native-client-libraries">TrafficOps Native Client Libraries</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="routes.html">API Routes</a></li>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/98cf8d9a/docs/master/api/traffic_ops_api.html
----------------------------------------------------------------------
diff --git a/docs/master/api/traffic_ops_api.html b/docs/master/api/traffic_ops_api.html
index 09ae269..3742ba2 100644
--- a/docs/master/api/traffic_ops_api.html
+++ b/docs/master/api/traffic_ops_api.html
@@ -100,7 +100,6 @@
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
@@ -134,7 +133,6 @@
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_server.html">Traffic Server</a></li>
</ul>
</li>
</ul>
@@ -144,6 +142,7 @@
<li class="toctree-l2"><a class="reference internal" href="routes.html">API Routes</a></li>
<li class="toctree-l2"><a class="reference internal" href="v11/index.html">API 1.1 Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
@@ -401,6 +400,10 @@
</dd>
</dl>
</div>
+<div class="section" id="trafficops-native-client-libraries">
+<h2>TrafficOps Native Client Libraries<a class="headerlink" href="#trafficops-native-client-libraries" title="Permalink to this headline">¶</a></h2>
+<p>TrafficOps client libraries are available in both Golang and Python. You can read more about them at <a class="reference external" href="https://github.com/apache/incubator-trafficcontrol/tree/master/traffic_control/clients">https://github.com/apache/incubator-trafficcontrol/tree/master/traffic_control/clients</a></p>
+</div>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/98cf8d9a/docs/master/development/traffic_router.html
----------------------------------------------------------------------
diff --git a/docs/master/development/traffic_router.html b/docs/master/development/traffic_router.html
index 2e33a5a..261043c 100644
--- a/docs/master/development/traffic_router.html
+++ b/docs/master/development/traffic_router.html
@@ -100,7 +100,6 @@
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
@@ -132,10 +131,18 @@
<li class="toctree-l2"><a class="reference internal" href="traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Router</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/98cf8d9a/docs/master/development/traffic_router/traffic_router_api.html
----------------------------------------------------------------------
diff --git a/docs/master/development/traffic_router/traffic_router_api.html b/docs/master/development/traffic_router/traffic_router_api.html
index 0d3f832..050a11a 100644
--- a/docs/master/development/traffic_router/traffic_router_api.html
+++ b/docs/master/development/traffic_router/traffic_router_api.html
@@ -40,7 +40,7 @@
<link rel="search" title="Search" href="../../search.html"/>
<link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
<link rel="up" title="Traffic Router" href="../traffic_router.html"/>
- <link rel="next" title="Traffic Monitor" href="../traffic_monitor.html"/>
+ <link rel="next" title="Traffic Monitor Golang" href="../traffic_monitor.html"/>
<link rel="prev" title="Traffic Router" href="../traffic_router.html"/>
@@ -100,7 +100,6 @@
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
@@ -132,10 +131,18 @@
<li class="toctree-l2"><a class="reference internal" href="../traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="../traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
@@ -189,7 +196,7 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="../traffic_monitor.html" class="btn btn-neutral float-right" title="Traffic Monitor">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="../traffic_monitor.html" class="btn btn-neutral float-right" title="Traffic Monitor Golang">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="../traffic_router.html" class="btn btn-neutral" title="Traffic Router"><span class="fa fa-arrow-circle-left"></span> Previous</a>
@@ -205,7 +212,7 @@
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>/crs/stats/ip/:ipaddress</strong></p>
+<p><strong>/crs/stats/ip/<ipaddress></strong></p>
<p>Geolocation information for an IPv4 or IPv6 address.</p>
<div class="line-block">
<div class="line"><br /></div>
@@ -220,42 +227,42 @@
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>/crs/locations/:location/caches</strong></p>
+<p><strong>/crs/locations/<location>/caches</strong></p>
<p>A list of caches for this cache group only.</p>
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>/crs/consistenthash/cache/coveragezone/?ip=:ip&deliveryServiceId=:deliveryServiceId&requestPath=:requestPath</strong></p>
+<p><strong>/crs/consistenthash/cache/coveragezone/?ip=<ip>&deliveryServiceId=<deliveryServiceId>&requestPath=<requestPath></strong></p>
<p>The resulting cache of the consistent hash using coverage zone file for a given client IP, delivery service, and request path.</p>
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>/crs/consistenthash/cache/deep/coveragezone/?ip=:ip&deliveryServiceId=:deliveryServiceId&requestPath=:requestPath</strong></p>
+<p><strong>/crs/consistenthash/cache/deep/coveragezone/?ip=<ip>&deliveryServiceId=<deliveryServiceId>&requestPath=<requestPath></strong></p>
<p>The resulting cache of the consistent hash using deep coverage zone file (deep caching) for a given client IP, delivery service, and request path.</p>
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>/crs/consistenthash/cache/geolocation/?ip=:ip&deliveryServiceId=:deliveryServiceId&requestPath=:requestPath</strong></p>
+<p><strong>/crs/consistenthash/cache/geolocation/?ip=<ip>&deliveryServiceId=<deliveryServiceId>&requestPath=<requestPath></strong></p>
<p>The resulting cache of the consistent hash using geolocation for a given client IP, delivery service, and request path.</p>
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>/crs/consistenthash/deliveryservice/?deliveryServiceId=:deliveryServiceId&requestPath=:requestPath</strong></p>
+<p><strong>/crs/consistenthash/deliveryservice/?deliveryServiceId=<deliveryServiceId>&requestPath=<requestPath></strong></p>
<p>The resulting delivery service of the consistent hash for a given delivery service and request path – used to test steering delivery services.</p>
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>/crs/coveragezone/caches/?deliveryServiceId=:deliveryServiceId&cacheLocationId=:cacheLocationId</strong></p>
+<p><strong>/crs/coveragezone/caches/?deliveryServiceId=<deliveryServiceId>&cacheLocationId=<cacheLocationId></strong></p>
<p>A list of caches for a given delivery service and cache location.</p>
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>/crs/coveragezone/cachelocation/?ip=:ip&deliveryServiceId=:deliveryServiceId</strong></p>
+<p><strong>/crs/coveragezone/cachelocation/?ip=<ip>&deliveryServiceId=<deliveryServiceId></strong></p>
<p>The resulting cache location for a given client IP and delivery service.</p>
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>/crs/deepcoveragezone/cachelocation/?ip=:ip&deliveryServiceId=:deliveryServiceId</strong></p>
+<p><strong>/crs/deepcoveragezone/cachelocation/?ip=<ip>&deliveryServiceId=<deliveryServiceId></strong></p>
<p>The resulting cache location using deep coverage zone file (deep caching) for a given client IP and delivery service.</p>
</div>
@@ -265,7 +272,7 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="../traffic_monitor.html" class="btn btn-neutral float-right" title="Traffic Monitor">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="../traffic_monitor.html" class="btn btn-neutral float-right" title="Traffic Monitor Golang">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="../traffic_router.html" class="btn btn-neutral" title="Traffic Router"><span class="fa fa-arrow-circle-left"></span> Previous</a>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/98cf8d9a/docs/master/index.html
----------------------------------------------------------------------
diff --git a/docs/master/index.html b/docs/master/index.html
index 1616150..5d9b8ce 100644
--- a/docs/master/index.html
+++ b/docs/master/index.html
@@ -450,6 +450,7 @@
<li class="toctree-l3"><a class="reference internal" href="api/traffic_ops_api.html#response-structure">Response Structure</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/traffic_ops_api.html#using-api-endpoints">Using API Endpoints</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/traffic_ops_api.html#api-errors">API Errors</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/traffic_ops_api.html#trafficops-native-client-libraries">TrafficOps Native Client Libraries</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/routes.html">API Routes</a></li>