http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/42d25dc5/docs/latest/_sources/development/traffic_ops_api/v12/tenant.txt ---------------------------------------------------------------------- diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/tenant.txt b/docs/latest/_sources/development/traffic_ops_api/v12/tenant.txt new file mode 100644 index 0000000..f75868e --- /dev/null +++ b/docs/latest/_sources/development/traffic_ops_api/v12/tenant.txt @@ -0,0 +1,255 @@ +.. +.. +.. Licensed under the Apache License, Version 2.0 (the "License"); +.. you may not use this file except in compliance with the License. +.. You may obtain a copy of the License at +.. +.. http://www.apache.org/licenses/LICENSE-2.0 +.. +.. Unless required by applicable law or agreed to in writing, software +.. distributed under the License is distributed on an "AS IS" BASIS, +.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +.. See the License for the specific language governing permissions and +.. limitations under the License. +.. + +.. _to-api-v12-tenant: + +Tenants +======= + +.. _to-api-v12-tenant-route: + +/api/1.2/tenants +++++++++++++++++++ + +**GET /api/1.2/tenants** + + Get all tenants. + + Authentication Required: Yes + + Role(s) Required: None + + **Response Properties** + + +----------------------+--------+-------------------------------------------------+ + | Parameter | Type | Description | + +======================+========+=================================================+ + |``id`` | int | Tenant id | + +----------------------+--------+-------------------------------------------------+ + |``name`` | string | Tenant name | + +----------------------+--------+-------------------------------------------------+ + |``active`` | bool | Active or inactive | + +----------------------+--------+-------------------------------------------------+ + |``parentId`` | int | Parent tenant ID | + +----------------------+--------+-------------------------------------------------+ + |``parentName`` | string | Parent tenant name | + +----------------------+--------+-------------------------------------------------+ + + **Response Example** :: + + { + "response": [ + { + "id": 1 + "name": "root", + "active": true, + "parentId": null, + "parentName": null, + }, + { + "id": 2 + "name": "tenant-a", + "active": true, + "parentId": 1 + "parentName": "root" + } + ] + } + +| + + +**GET /api/1.2/tenants/:id** + + Get a tenant by ID. + + Authentication Required: Yes + + Role(s) Required: None + + **Response Properties** + + +----------------------+--------+-------------------------------------------------+ + | Parameter | Type | Description | + +======================+========+=================================================+ + |``id`` | int | Tenant id | + +----------------------+--------+-------------------------------------------------+ + |``name`` | string | Tenant name | + +----------------------+--------+-------------------------------------------------+ + |``active`` | bool | Active or inactive | + +----------------------+--------+-------------------------------------------------+ + |``parentId`` | int | Parent tenant ID | + +----------------------+--------+-------------------------------------------------+ + |``parentName`` | string | Parent tenant name | + +----------------------+--------+-------------------------------------------------+ + + **Response Example** :: + + { + "response": [ + { + "id": 2 + "name": "tenant-a", + "active": true, + "parentId": 1, + "parentName": "root" + } + ] + } + +| + + +**PUT /api/1.2/tenants/:id** + + Update a tenant. + + Authentication Required: Yes + + Role(s) Required: admin or oper + + **Request Route Parameters** + + +-------------------+----------+------------------------------------------------+ + | Name | Type | Description | + +===================+==========+================================================+ + | ``id`` | int | Tenant id | + +-------------------+----------+------------------------------------------------+ + + **Request Properties** + + +-------------------+----------+--------------------------+ + | Parameter | Required | Description | + +===================+==========+==========================+ + | ``name`` | yes | The name of the tenant | + +-------------------+----------+--------------------------+ + | ``active`` | yes | True or false | + +-------------------+----------+--------------------------+ + | ``parentId`` | yes | Parent tenant | + +-------------------+----------+--------------------------+ + + **Request Example** :: + + { + "name": "my-tenant" + "active": true + "parentId": 1 + } + +| + + **Response Properties** + + +----------------------+--------+-------------------------------------------------+ + | Parameter | Type | Description | + +======================+========+=================================================+ + |``id`` | int | Tenant id | + +----------------------+--------+-------------------------------------------------+ + |``name`` | string | Tenant name | + +----------------------+--------+-------------------------------------------------+ + |``active`` | bool | Active or inactive | + +----------------------+--------+-------------------------------------------------+ + |``parentId`` | int | Parent tenant ID | + +----------------------+--------+-------------------------------------------------+ + |``parentName`` | string | Parent tenant name | + +----------------------+--------+-------------------------------------------------+ + + **Response Example** :: + + { + "response": { + "id": 2, + "name": "my-tenant", + "active": true, + "parentId": 1, + "parentName": "root", + "lastUpdated": "2014-03-18 08:57:39" + }, + "alerts": [ + { + "level": "success", + "text": "Tenant update was successful." + } + ] + } + +| + + +**POST /api/1.2/tenants** + + Create a tenant. + + Authentication Required: Yes + + Role(s) Required: admin or oper + + **Request Properties** + + +-------------------+----------+--------------------------+ + | Parameter | Required | Description | + +===================+==========+==========================+ + | ``name`` | yes | The name of the tenant | + +-------------------+----------+--------------------------+ + | ``active`` | no | Defaults to false | + +-------------------+----------+--------------------------+ + | ``parentId`` | yes | Parent tenant | + +-------------------+----------+--------------------------+ + + **Request Example** :: + + { + "name": "your-tenant" + "parentId": 2 + } + +| + + **Response Properties** + + +----------------------+--------+-------------------------------------------------+ + | Parameter | Type | Description | + +======================+========+=================================================+ + |``id`` | int | Tenant id | + +----------------------+--------+-------------------------------------------------+ + |``name`` | string | Tenant name | + +----------------------+--------+-------------------------------------------------+ + |``active`` | bool | Active or inactive | + +----------------------+--------+-------------------------------------------------+ + |``parentId`` | int | Parent tenant ID | + +----------------------+--------+-------------------------------------------------+ + |``parentName`` | string | Parent tenant name | + +----------------------+--------+-------------------------------------------------+ + + **Response Example** :: + + { + "response": { + "id": 2, + "name": "your-tenant", + "active": false, + "parentId": 2, + "parentName": "my-tenant", + "lastUpdated": "2014-03-18 08:57:39" + }, + "alerts": [ + { + "level": "success", + "text": "Tenant create was successful." + } + ] + } + +|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/42d25dc5/docs/latest/_sources/development/traffic_ops_api/v12/topology.txt ---------------------------------------------------------------------- diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/topology.txt b/docs/latest/_sources/development/traffic_ops_api/v12/topology.txt index 89444f0..9b7cf9f 100644 --- a/docs/latest/_sources/development/traffic_ops_api/v12/topology.txt +++ b/docs/latest/_sources/development/traffic_ops_api/v12/topology.txt @@ -23,11 +23,109 @@ Snapshot CRConfig /api/1.2/snapshot/{:cdn_name} +++++++++++++++++++++++++++++ +**GET /api/1.2/cdns/{:cdn_name}/snapshot** + + Retrieves the CURRENT snapshot for a CDN which doesn't necessarily represent the current state of the CDN. The contents of this snapshot are currently used by Traffic Monitor and Traffic Router. + + Authentication Required: Yes + + Role(s) Required: Admin or Operations + + **Request Route Parameters** + + +----------------+----------+---------------------------------------------+ + | Name | Required | Description | + +================+==========+=============================================+ + | ``cdn_name`` | yes | CDN name. | + +----------------+----------+---------------------------------------------+ + + **Response Properties** + + +-----------------------+--------+------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+========+==============================================================================+ + | ``config`` | hash | General CDN configuration settings. | + +-----------------------+--------+------------------------------------------------------------------------------+ + | ``contentRouters`` | hash | A list of Traffic Routers. | + +-----------------------+--------+------------------------------------------------------------------------------+ + | ``contentServers`` | hash | A list of Traffic Servers and the delivery services associated with each. | + +-----------------------+--------+------------------------------------------------------------------------------+ + | ``deliveryServices`` | hash | A list of delivery services. | + +-----------------------+--------+------------------------------------------------------------------------------+ + | ``edgeLocations`` | hash | A list of cache groups. | + +-----------------------+--------+------------------------------------------------------------------------------+ + | ``stats`` | hash | Snapshot properties. | + +-----------------------+--------+------------------------------------------------------------------------------+ + + **Response Example** :: + + { + "response": { + "config": { ... }, + "contentRouters": { ... }, + "contentServers": { ... }, + "deliveryServices": { ... }, + "edgeLocations": { ... }, + "stats": { ... }, + }, + } + +| + +**GET /api/1.2/cdns/{:cdn_name}/snapshot/new** + + Retrieves a PENDING snapshot for a CDN which represents the current state of the CDN. The contents of this snapshot are NOT currently used by Traffic Monitor and Traffic Router. Once a snapshot is performed, this snapshot will become the CURRENT snapshot and will be used by Traffic Monitor and Traffic Router. + + Authentication Required: Yes + + Role(s) Required: Admin or Operations + + **Request Route Parameters** + + +----------------+----------+---------------------------------------------+ + | Name | Required | Description | + +================+==========+=============================================+ + | ``cdn_name`` | yes | CDN name. | + +----------------+----------+---------------------------------------------+ + + **Response Properties** + + +-----------------------+--------+------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+========+==============================================================================+ + | ``config`` | hash | General CDN configuration settings. | + +-----------------------+--------+------------------------------------------------------------------------------+ + | ``contentRouters`` | hash | A list of Traffic Routers. | + +-----------------------+--------+------------------------------------------------------------------------------+ + | ``contentServers`` | hash | A list of Traffic Servers and the delivery services associated with each. | + +-----------------------+--------+------------------------------------------------------------------------------+ + | ``deliveryServices`` | hash | A list of delivery services. | + +-----------------------+--------+------------------------------------------------------------------------------+ + | ``edgeLocations`` | hash | A list of cache groups. | + +-----------------------+--------+------------------------------------------------------------------------------+ + | ``stats`` | hash | Snapshot properties. | + +-----------------------+--------+------------------------------------------------------------------------------+ + + **Response Example** :: + + { + "response": { + "config": { ... }, + "contentRouters": { ... }, + "contentServers": { ... }, + "deliveryServices": { ... }, + "edgeLocations": { ... }, + "stats": { ... }, + }, + } + +| + **PUT /api/1.2/snapshot/{:cdn_name}** Authentication Required: Yes - Role(s) Required: admin or oper + Role(s) Required: Admin or Operations **Request Route Parameters** http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/42d25dc5/docs/latest/_sources/development/traffic_ops_api/v12/user.txt ---------------------------------------------------------------------- diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/user.txt b/docs/latest/_sources/development/traffic_ops_api/v12/user.txt index b141eca..b51291f 100644 --- a/docs/latest/_sources/development/traffic_ops_api/v12/user.txt +++ b/docs/latest/_sources/development/traffic_ops_api/v12/user.txt @@ -72,6 +72,10 @@ Users +----------------------+--------+------------------------------------------------+ |``stateOrProvince`` | string | | +----------------------+--------+------------------------------------------------+ + | ``tenant`` | string | Owning tenant name | + +----------------------+--------+------------------------------------------------+ + | ``tenantId`` | int | Owning tenant ID | + +----------------------+--------+------------------------------------------------+ |``uid`` | string | | +----------------------+--------+------------------------------------------------+ |``username`` | string | | @@ -100,6 +104,8 @@ Users "role": "6", "rolename": "admin", "stateOrProvince": "", + "tenant": "root", + "tenantId": 1, "uid": "0", "username": "tsimpson" }, @@ -169,6 +175,10 @@ Users +----------------------+--------+------------------------------------------------+ |``stateOrProvince`` | string | | +----------------------+--------+------------------------------------------------+ + | ``tenant`` | string | Owning tenant name | + +----------------------+--------+------------------------------------------------+ + | ``tenantId`` | int | Owning tenant ID | + +----------------------+--------+------------------------------------------------+ |``uid`` | string | | +----------------------+--------+------------------------------------------------+ |``username`` | string | | @@ -197,6 +207,8 @@ Users "role": "6", "rolename": "admin", "stateOrProvince": "", + "tenant": "root", + "tenantId": 1, "uid": "0", "username": "tsimpson" }, @@ -208,6 +220,153 @@ Users | + +**POST /api/1.2/users** + + Create a user. + + Authentication Required: Yes + + Role(s) Required: admin or oper + + **Request Properties** + + +-------------------------+--------+----------+-------------------------------------------------+ + | Parameter | Type | Required | Description | + +=========================+========+==========+=================================================+ + |``addressLine1`` | string | no | | + +-------------------------+--------+----------+-------------------------------------------------+ + |``addressLine2`` | string | no | | + +-------------------------+--------+----------+-------------------------------------------------+ + |``city`` | string | no | | + +-------------------------+--------+----------+-------------------------------------------------+ + |``confirmLocalPassword`` | string | yes | | + +-------------------------+--------+----------+-------------------------------------------------+ + |``company`` | string | no | | + +-------------------------+--------+----------+-------------------------------------------------+ + |``country`` | string | no | | + +-------------------------+--------+----------+-------------------------------------------------+ + |``email`` | string | yes | | + +-------------------------+--------+----------+-------------------------------------------------+ + |``fullName`` | string | yes | | + +-------------------------+--------+----------+-------------------------------------------------+ + |``localPassword`` | string | yes | | + +-------------------------+--------+----------+-------------------------------------------------+ + |``newUser`` | bool | no | | + +-------------------------+--------+----------+-------------------------------------------------+ + |``phoneNumber`` | string | no | | + +-------------------------+--------+----------+-------------------------------------------------+ + |``postalCode`` | string | no | | + +-------------------------+--------+----------+-------------------------------------------------+ + |``publicSshKey`` | string | no | | + +-------------------------+--------+----------+-------------------------------------------------+ + |``role`` | int | yes | | + +-------------------------+--------+----------+-------------------------------------------------+ + |``stateOrProvince`` | string | no | | + +-------------------------+--------+----------+-------------------------------------------------+ + | ``tenantId`` | int | no | Owning tenant ID | + +-------------------------+--------+----------+-------------------------------------------------+ + |``username`` | string | yes | | + +-------------------------+--------+----------+-------------------------------------------------+ + + + **Request Example** :: + + { + "username": "tsimpson" + "tenantId": 1, + "fullName": "Tom Simpson" + "email": "ema...@email.com" + "role": 6 + "localPassword": "password" + "confirmLocalPassword": "password" + } + +| + + **Response Properties** + + +----------------------+--------+------------------------------------------------+ + | Parameter | Type | Description | + +======================+========+================================================+ + |``addressLine1`` | string | | + +----------------------+--------+------------------------------------------------+ + |``addressLine2`` | string | | + +----------------------+--------+------------------------------------------------+ + |``city`` | string | | + +----------------------+--------+------------------------------------------------+ + |``company`` | string | | + +----------------------+--------+------------------------------------------------+ + |``country`` | string | | + +----------------------+--------+------------------------------------------------+ + |``email`` | string | | + +----------------------+--------+------------------------------------------------+ + |``fullName`` | string | | + +----------------------+--------+------------------------------------------------+ + |``gid`` | int | | + +----------------------+--------+------------------------------------------------+ + |``id`` | int | | + +----------------------+--------+------------------------------------------------+ + |``lastUpdated`` | string | | + +----------------------+--------+------------------------------------------------+ + |``newUser`` | string | | + +----------------------+--------+------------------------------------------------+ + |``phoneNumber`` | string | | + +----------------------+--------+------------------------------------------------+ + |``postalCode`` | string | | + +----------------------+--------+------------------------------------------------+ + |``publicSshKey`` | string | | + +----------------------+--------+------------------------------------------------+ + |``registrationSent`` | bool | | + +----------------------+--------+------------------------------------------------+ + |``role`` | int | | + +----------------------+--------+------------------------------------------------+ + |``roleName`` | string | | + +----------------------+--------+------------------------------------------------+ + |``stateOrProvince`` | string | | + +----------------------+--------+------------------------------------------------+ + |``uid`` | int | | + +----------------------+--------+------------------------------------------------+ + | ``tenantId`` | int | Owning tenant ID | + +----------------------+--------+------------------------------------------------+ + |``username`` | string | | + +----------------------+--------+------------------------------------------------+ + + **Response Example** :: + + {"alerts": [ + { + "level":"success", + "text":"User creation was successful." + } + ], + "response: { + "addressLine1":"", + "addressLine2":"", + "city":"", + "company":"", + "country":"", + "email":"ema...@email.com", + "fullName":"Tom Simpson", + "gid":0, + "id":2, + "lastUpdated":null, + "newUser":false, + "phoneNumber":"", + "postalCode":"", + "publicSshKey":"", + "registrationSent":false, + "role":6, + "roleName":"portal", + "stateOrProvince":"", + "tenantId": 1, + "uid":0, + "username":"tsimpson", + } + } + +| + **GET /api/1.2/users/:id/deliveryservices** Retrieves all delivery services assigned to the user. See also `Using Traffic Ops - Delivery Service <http://trafficcontrol.apache.org/docs/latest/admin/traffic_ops_using.html#delivery-service>`_. @@ -352,6 +511,10 @@ Users +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ | ``sslKeyVersion`` | string | | +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ + | ``tenant`` | string | Owning tenant name | + +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ + | ``tenantId`` | int | Owning tenant ID. | + +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ | ``trRequestHeaders`` | string | | +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ | ``trResponseHeaders`` | string | | @@ -426,6 +589,8 @@ Users "remapText": null, "signed": false, "sslKeyVersion": "0", + "tenant": "root", + "tenantId": 1, "trRequestHeaders": null, "trResponseHeaders": "Access-Control-Allow-Origin: *", "type": "HTTP", @@ -440,7 +605,7 @@ Users | -**GET /api/1.2/user/current.json** +**GET /api/1.2/user/current** Retrieves the profile for the authenticated user. @@ -448,7 +613,7 @@ Users Role(s) Required: None - **Request Properties** + **Response Properties** +----------------------+---------+------------------------------------------------+ | Parameter | Type | Description | @@ -487,6 +652,10 @@ Users +----------------------+---------+------------------------------------------------+ |``postalCode`` | string | | +----------------------+---------+------------------------------------------------+ + | ``tenant`` | string | Owning tenant name | + +----------------------+---------+------------------------------------------------+ + | ``tenantId`` | int | Owning tenant ID | + +----------------------+---------+------------------------------------------------+ **Response Example** :: @@ -508,13 +677,16 @@ Users "role": "6", "addressLine1": "", "gid": "0", - "postalCode": "" + "postalCode": "", + "tenant": "root", + "tenantId": 1 + }, } | -**POST /api/1.2/user/current/update** +**PUT /api/1.2/user/current** Updates the date for the authenticated user. @@ -561,6 +733,8 @@ Users +----------------------+---------+------------------------------------------------+ |``postalCode`` | string | | +----------------------+---------+------------------------------------------------+ + | ``tenantId`` | int | Owning tenant ID | + +----------------------+---------+------------------------------------------------+ **Request Example** :: @@ -582,7 +756,10 @@ Users "role": "6", "addressLine1": "", "gid": "0", - "postalCode": "" + "postalCode": "", + "tenant": "root", + "tenantId": 1, + } } @@ -828,7 +1005,7 @@ Role(s) Required: None | -**GET /api/1.2/user/:id/deliveryservices/available.json** +**GET /api/1.2/user/:id/deliveryservices/available** Authentication Required: Yes @@ -847,10 +1024,12 @@ Role(s) Required: None +----------------------+--------+------------------------------------------------+ | Parameter | Type | Description | +======================+========+================================================+ - |``xmlId`` | string | | - +----------------------+--------+------------------------------------------------+ |``id`` | string | | +----------------------+--------+------------------------------------------------+ + |``displayName`` | string | | + +----------------------+--------+------------------------------------------------+ + |``xmlId`` | string | | + +----------------------+--------+------------------------------------------------+ **Response Example** :: @@ -858,12 +1037,14 @@ Role(s) Required: None { "response": [ { - "xmlId": "ns-img", - "id": "90" + "id": "90", + "displayName": "Foo Bar DS", + "xmlId": "foo-bar" }, { - "xmlId": "ns-img-secure", - "id": "280" + "id": "92", + "displayName": "Foo Baz DS", + "xmlId": "foo-baz" } ], } http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/42d25dc5/docs/latest/_sources/index.txt ---------------------------------------------------------------------- diff --git a/docs/latest/_sources/index.txt b/docs/latest/_sources/index.txt index 2a12096..50b604b 100644 --- a/docs/latest/_sources/index.txt +++ b/docs/latest/_sources/index.txt @@ -23,7 +23,7 @@ Traffic Control is an Open Source implementation of a Content Delivery Network. The following documentation sections are available: -CDN Basics +CDN Basics ========== A review of the basic functionality of a Content Delivery Network. @@ -53,7 +53,7 @@ How to deploy and manage a Traffic Control CDN. Developer's Guide ================== -A guide to the various internal and external APIs, and a introduction for the Traffic Control developer. +A guide to the various internal and external APIs, and an introduction for the Traffic Control developer. .. toctree:: :maxdepth: 3 http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/42d25dc5/docs/latest/_sources/overview/introduction.txt ---------------------------------------------------------------------- diff --git a/docs/latest/_sources/overview/introduction.txt b/docs/latest/_sources/overview/introduction.txt index a983820..2789b46 100644 --- a/docs/latest/_sources/overview/introduction.txt +++ b/docs/latest/_sources/overview/introduction.txt @@ -15,14 +15,35 @@ Introduction ============ -Traffic Control is a control plane for a CDN, which includes all of the components mentioned in the CDN Basics section, except for the Log File Analysis System. The caching software chosen for Traffic Control is `Apache Traffic Server <http://trafficserver.apache.org/>`_ (ATS). Although the current release only supports ATS as a cache, this may change with future releases. +Traffic Control is a caching server control plane application which is used to aggregate caching servers into a Content Delivery Network (CDN). The CDN caching software chosen for Traffic Control is `Apache Traffic Server <http://trafficserver.apache.org/>`_ (ATS). Although the current release only supports ATS as a cache, this may change with future releases. Traffic Control was first developed at Comcast for internal use and released to Open Source in April of 2015. Traffic Control moved into the Apache Incubator in August of 2016. -Traffic Control implements the blue boxes in the architecture diagram below. +Traffic Control implements the elements illustrated in green in the diagram below. .. image:: traffic_control_overview_3.png :align: center + +**Traffic Ops** + * `Traffic Ops <http://trafficcontrol.apache.org/docs/latest/overview/traffic_ops.html/>`_ is used to configure caching servers and CDN delivery services. It also contains APIs used to access CDN data. + +**Traffic Router** + * `Traffic Router <http://trafficcontrol.apache.org/docs/latest/overview/traffic_router.html/>`_ is used to route clients requests to the closest healthy cache by analyzing the health, capacity, and state of the caching servers and relative distance from each cache group to the location of the client. + +**Traffic Monitor** + * `Traffic Monitor <http://trafficcontrol.apache.org/docs/latest/overview/traffic_monitor.html/>`_ does health polling of the caching servers on a very short interval to keep track of which servers should be kept in rotation. + +**Traffic Stats** + * `Traffic Stats <http://trafficcontrol.apache.org/docs/latest/overview/traffic_stats.html/>`_ collects real time traffic statistics aggregated from each of the caching servers. This data is used by the Traffic Router to assess the available capacity of each caching server which it uses to balance traffic load and prevent overload. + +**Traffic Portal** + * `Traffic Portal <http://trafficcontrol.apache.org/docs/latest/overview/traffic_portal.html/>`_ is a web application which leverages the Traffic Ops APIs to present CDN data through a web interface. + +**Traffic Logs** + * Traffic Logs is currently under construction and is intended to aggregate Traffic Server request/response logs as well as other server logs. Logs will be parsed and indexed for search. + + In the next sections each of these components will be explained further. + http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/42d25dc5/docs/latest/_sources/overview/traffic_monitor.txt ---------------------------------------------------------------------- diff --git a/docs/latest/_sources/overview/traffic_monitor.txt b/docs/latest/_sources/overview/traffic_monitor.txt index 1a3222f..d97bddd 100644 --- a/docs/latest/_sources/overview/traffic_monitor.txt +++ b/docs/latest/_sources/overview/traffic_monitor.txt @@ -22,7 +22,7 @@ Traffic Monitor =============== -Traffic Monitor is a Java/Tomcat application that monitors the caches in a CDN for a variety of metrics. These metrics are for use in determining the overall health of a given cache and the related delivery services. A given CDN can operate a number of Traffic Monitors, from a number of geographically diverse locations, to prevent false positives caused by network problems at a given site. +Traffic Monitor is an HTTP service that monitors the caches in a CDN for a variety of metrics. These metrics are for use in determining the overall health of a given cache and the related delivery services. A given CDN can operate a number of Traffic Monitors, from a number of geographically diverse locations, to prevent false positives caused by network problems at a given site. Traffic Monitors operate independently, but use the state of other Traffic Monitors in conjunction with their own state, to provide a consistent view of CDN cache health to upstream applications such as Traffic Router. Health Protocol governs the cache and Delivery Service availability. http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/42d25dc5/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 index f9ed1bc..dd021ac 100644 --- a/docs/latest/_sources/overview/traffic_router.txt +++ b/docs/latest/_sources/overview/traffic_router.txt @@ -48,6 +48,7 @@ Traffic routing options are often configured at the Delivery Service level. * 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. | http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/42d25dc5/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 index 4928e4e..520c8be 100644 --- a/docs/latest/_sources/overview/traffic_server.txt +++ b/docs/latest/_sources/overview/traffic_server.txt @@ -45,5 +45,5 @@ All caches (and other servers) are assigned a Profile in Traffic Ops. |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. + 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/42d25dc5/docs/latest/_static/basic.css ---------------------------------------------------------------------- diff --git a/docs/latest/_static/basic.css b/docs/latest/_static/basic.css index 9fa77d8..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-2015 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ @@ -52,6 +52,8 @@ div.sphinxsidebar { width: 230px; margin-left: -100%; font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; } div.sphinxsidebar ul { @@ -83,10 +85,6 @@ div.sphinxsidebar #searchbox input[type="text"] { width: 170px; } -div.sphinxsidebar #searchbox input[type="submit"] { - width: 30px; -} - img { border: 0; max-width: 100%; @@ -187,6 +185,13 @@ div.genindex-jumpbox { /* -- general body styles --------------------------------------------------- */ +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + a.headerlink { visibility: hidden; } http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/42d25dc5/docs/latest/_static/doctools.js ---------------------------------------------------------------------- diff --git a/docs/latest/_static/doctools.js b/docs/latest/_static/doctools.js index c7bfe76..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-2015 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ @@ -124,6 +124,7 @@ var Documentation = { this.fixFirefoxAnchorBug(); this.highlightSearchWords(); this.initIndexTable(); + }, /** @@ -252,6 +253,29 @@ var Documentation = { }); var url = parts.join('/'); return path.substring(url.lastIndexOf('/') + 1, path.length - 1); + }, + + initOnKeyListeners: function() { + $(document).keyup(function(event) { + var activeElementType = document.activeElement.tagName; + // don't navigate when in search box or textarea + if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT') { + switch (event.keyCode) { + case 37: // left + var prevHref = $('link[rel="prev"]').prop('href'); + if (prevHref) { + window.location.href = prevHref; + return false; + } + case 39: // right + var nextHref = $('link[rel="next"]').prop('href'); + if (nextHref) { + window.location.href = nextHref; + return false; + } + } + } + }); } }; @@ -260,4 +284,4 @@ _ = Documentation.gettext; $(document).ready(function() { Documentation.init(); -}); +}); \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/42d25dc5/docs/latest/_static/pygments.css ---------------------------------------------------------------------- diff --git a/docs/latest/_static/pygments.css b/docs/latest/_static/pygments.css index 57eadc0..8213e90 100644 --- a/docs/latest/_static/pygments.css +++ b/docs/latest/_static/pygments.css @@ -4,8 +4,10 @@ .highlight .err { border: 1px solid #FF0000 } /* Error */ .highlight .k { color: #007020; font-weight: bold } /* Keyword */ .highlight .o { color: #666666 } /* Operator */ +.highlight .ch { color: #408090; font-style: italic } /* Comment.Hashbang */ .highlight .cm { color: #408090; font-style: italic } /* Comment.Multiline */ .highlight .cp { color: #007020 } /* Comment.Preproc */ +.highlight .cpf { color: #408090; font-style: italic } /* Comment.PreprocFile */ .highlight .c1 { color: #408090; font-style: italic } /* Comment.Single */ .highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */ .highlight .gd { color: #A00000 } /* Generic.Deleted */ http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/42d25dc5/docs/latest/_static/searchtools.js ---------------------------------------------------------------------- diff --git a/docs/latest/_static/searchtools.js b/docs/latest/_static/searchtools.js index 0e794fd..066857c 100644 --- a/docs/latest/_static/searchtools.js +++ b/docs/latest/_static/searchtools.js @@ -2,14 +2,15 @@ * searchtools.js_t * ~~~~~~~~~~~~~~~~ * - * Sphinx JavaScript utilties for the full-text search. + * Sphinx JavaScript utilities for the full-text search. * - * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ +/* Non-minified version JS is _stemmer.js if file is provided */ /** * Porter Stemmer */ @@ -373,8 +374,7 @@ var Search = { } // lookup as search terms in fulltext - results = results.concat(this.performTermsSearch(searchterms, excluded, terms, Scorer.term)) - .concat(this.performTermsSearch(searchterms, excluded, titleterms, Scorer.title)); + results = results.concat(this.performTermsSearch(searchterms, excluded, terms, titleterms)); // let the scorer override scores with a custom scoring function if (Scorer.score) { @@ -538,23 +538,47 @@ var Search = { /** * search for full-text terms in the index */ - performTermsSearch : function(searchterms, excluded, terms, score) { + performTermsSearch : function(searchterms, excluded, terms, titleterms) { var filenames = this._index.filenames; var titles = this._index.titles; - var i, j, file, files; + var i, j, file; var fileMap = {}; + var scoreMap = {}; var results = []; // perform the search on the required terms for (i = 0; i < searchterms.length; i++) { var word = searchterms[i]; + var files = []; + var _o = [ + {files: terms[word], score: Scorer.term}, + {files: titleterms[word], score: Scorer.title} + ]; + // no match but word was a required one - if ((files = terms[word]) === undefined) + if ($u.every(_o, function(o){return o.files === undefined;})) { break; - if (files.length === undefined) { - files = [files]; } + // found search word in contents + $u.each(_o, function(o) { + var _files = o.files; + if (_files === undefined) + return + + if (_files.length === undefined) + _files = [_files]; + files = files.concat(_files); + + // set score for the word in each file to Scorer.term + for (j = 0; j < _files.length; j++) { + file = _files[j]; + if (!(file in scoreMap)) + scoreMap[file] = {} + scoreMap[file][word] = o.score; + } + }); + // create the mapping for (j = 0; j < files.length; j++) { file = files[j]; @@ -576,7 +600,9 @@ var Search = { // ensure that none of the excluded terms is in the search result for (i = 0; i < excluded.length; i++) { if (terms[excluded[i]] == file || - $u.contains(terms[excluded[i]] || [], file)) { + titleterms[excluded[i]] == file || + $u.contains(terms[excluded[i]] || [], file) || + $u.contains(titleterms[excluded[i]] || [], file)) { valid = false; break; } @@ -584,6 +610,9 @@ var Search = { // if we have still a valid result we can add it to the result list if (valid) { + // select one (max) score for the file. + // for better ranking, we should calculate ranking by using words statistics like basic tf-idf... + var score = $u.max($u.map(fileMap[file], function(w){return scoreMap[file][w]})); results.push([filenames[file], titles[file], '', null, score]); } } @@ -594,7 +623,7 @@ var Search = { * helper function to return a node containing the * search summary for a given text. keywords is a list * of stemmed words, hlwords is the list of normal, unstemmed - * words. the first one is used to find the occurance, the + * words. the first one is used to find the occurrence, the * latter for highlighting it. */ makeSearchSummary : function(text, keywords, hlwords) { http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/42d25dc5/docs/latest/_static/tc_logo.png ---------------------------------------------------------------------- diff --git a/docs/latest/_static/tc_logo.png b/docs/latest/_static/tc_logo.png index 749fd7f..e30944c 100644 Binary files a/docs/latest/_static/tc_logo.png and b/docs/latest/_static/tc_logo.png differ http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/42d25dc5/docs/latest/_static/websupport.js ---------------------------------------------------------------------- diff --git a/docs/latest/_static/websupport.js b/docs/latest/_static/websupport.js index 28d65db..98e7f40 100644 --- a/docs/latest/_static/websupport.js +++ b/docs/latest/_static/websupport.js @@ -2,9 +2,9 @@ * websupport.js * ~~~~~~~~~~~~~ * - * sphinx.websupport utilties for all documentation. + * sphinx.websupport utilities for all documentation. * - * :copyright: Copyright 2007-2015 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/42d25dc5/docs/latest/admin/index.html ---------------------------------------------------------------------- diff --git a/docs/latest/admin/index.html b/docs/latest/admin/index.html index 18d4174..9e0cb26 100644 --- a/docs/latest/admin/index.html +++ b/docs/latest/admin/index.html @@ -7,7 +7,7 @@ <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> - <title>Administratorâs Guide — Traffic Control master documentation </title> + <title>Administratorâs Guide — Traffic Control 2.1-dev documentation </title> @@ -33,8 +33,8 @@ - <link rel="top" title="Traffic Control master documentation" href="../index.html"/> - <link rel="next" title="Installing Traffic Ops" href="traffic_ops_install.html"/> + <link rel="top" title="Traffic Control 2.1-dev documentation" href="../index.html"/> + <link rel="next" title="Traffic Ops - Installing" href="traffic_ops/installation.html"/> <link rel="prev" title="Traffic Vault" href="../overview/traffic_vault.html"/> @@ -100,13 +100,16 @@ </li> </ul> <ul class="current"> -<li class="toctree-l1 current"><a class="current reference internal" href="">Administrator’s Guide</a><ul> -<li class="toctree-l2"><a class="reference internal" href="traffic_ops_install.html">Installing Traffic Ops</a></li> -<li class="toctree-l2"><a class="reference internal" href="traffic_ops_config.html">Configuring Traffic Ops</a></li> -<li class="toctree-l2"><a class="reference internal" href="traffic_ops_using.html">Using Traffic Ops</a></li> -<li class="toctree-l2"><a class="reference internal" href="traffic_ops_extensions.html">Managing Traffic Ops Extensions</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#">Administrator’s Guide</a><ul> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops/installation.html">Traffic Ops - Installing</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops/configuration.html">Traffic Ops - Configuring</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops/using.html">Traffic Ops - Using</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops/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_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> <li class="toctree-l2"><a class="reference internal" href="traffic_server.html">Traffic Server Administration</a></li> @@ -117,10 +120,12 @@ </ul> <ul> <li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../development/building.html">Building Traffic Control</a></li> <li class="toctree-l2"><a class="reference internal" href="../development/traffic_ops.html">Traffic Ops</a></li> <li class="toctree-l2"><a class="reference internal" href="../development/traffic_portal.html">Traffic Portal</a></li> <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</a></li> +<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor_golang.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> @@ -158,7 +163,7 @@ <div class="rst-content"> <div role="navigation" aria-label="breadcrumbs navigation"> <ul class="wy-breadcrumbs"> - <li><a href="../index.html">Traffic Control master</a> »</li> + <li><a href="../index.html">Traffic Control 2.1-dev</a> »</li> <li>Administrator’s Guide</li> <li class="wy-breadcrumbs-aside"> @@ -172,7 +177,7 @@ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - <a href="traffic_ops_install.html" class="btn btn-neutral float-right" title="Installing Traffic Ops">Next <span class="fa fa-arrow-circle-right"></span></a> + <a href="traffic_ops/installation.html" class="btn btn-neutral float-right" title="Traffic Ops - Installing">Next <span class="fa fa-arrow-circle-right"></span></a> <a href="../overview/traffic_vault.html" class="btn btn-neutral" title="Traffic Vault"><span class="fa fa-arrow-circle-left"></span> Previous</a> @@ -188,9 +193,9 @@ <ol class="arabic simple"> <li>Traffic Ops</li> <li>Traffic Vault (Riak)</li> +<li>Traffic Monitor</li> <li>Apache Traffic Server Mid-Tier Caches</li> <li>Apache Traffic Server Edge Caches</li> -<li>Traffic Monitor</li> <li>Traffic Router</li> <li>Traffic Stats</li> <li>Traffic Portal</li> @@ -198,65 +203,83 @@ <p>Once everything is installed, you will need to configure the servers to talk to each other. You will also need Origin server(s), which the Mid-Tier Cache(s) get content from. An Origin server is simply an HTTP(S) server which serves the content you wish to cache on the CDN.</p> <div class="toctree-wrapper compound"> <ul> -<li class="toctree-l1"><a class="reference internal" href="traffic_ops_install.html">Installing Traffic Ops</a><ul> -<li class="toctree-l2"><a class="reference internal" href="traffic_ops_install.html#system-requirements">System Requirements</a></li> -<li class="toctree-l2"><a class="reference internal" href="traffic_ops_install.html#navigating-the-install">Navigating the Install</a><ul> -<li class="toctree-l3"><a class="reference internal" href="traffic_ops_install.html#upgrading-traffic-ops">Upgrading Traffic Ops</a></li> +<li class="toctree-l1"><a class="reference internal" href="traffic_ops/installation.html">Traffic Ops - Installing</a><ul> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops/installation.html#system-requirements">System Requirements</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops/installation.html#navigating-the-install">Navigating the Install</a><ul> +<li class="toctree-l3"><a class="reference internal" href="traffic_ops/installation.html#upgrading-traffic-ops">Upgrading Traffic Ops</a></li> +</ul> +</li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a><ul> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops/default_profiles.html#minimum-traffic-ops-profiles-needed">Minimum Traffic Ops Profiles needed</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops/default_profiles.html#steps-to-import-a-profile">Steps to Import a Profile</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a><ul> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops/migration_from_10_to_20.html#system-requirements">System Requirements</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops/migration_from_10_to_20.html#setup-the-traffic-ops-db-directory">Setup the traffic_ops_db directory</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops/migration_from_10_to_20.html#migration-preparation">Migration Preparation</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops/migration_from_10_to_20.html#navigating-the-database-migration">Navigating the Database Migration</a></li> </ul> </li> +<li class="toctree-l1"><a class="reference internal" href="traffic_ops/configuration.html">Traffic Ops - Configuring</a><ul> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops/configuration.html#installing-the-ssl-cert">Installing the SSL Cert</a><ul> +<li class="toctree-l3"><a class="reference internal" href="traffic_ops/configuration.html#self-signed-certificate-development">Self-signed Certificate (Development)</a></li> +<li class="toctree-l3"><a class="reference internal" href="traffic_ops/configuration.html#certificate-from-certificate-authority-production">Certificate from Certificate Authority (Production)</a></li> </ul> </li> -<li class="toctree-l1"><a class="reference internal" href="traffic_ops_config.html">Configuring Traffic Ops</a><ul> -<li class="toctree-l2"><a class="reference internal" href="traffic_ops_config.html#installing-the-ssl-cert">Installing the SSL Cert</a></li> -<li class="toctree-l2"><a class="reference internal" href="traffic_ops_config.html#content-delivery-networks">Content Delivery Networks</a></li> -<li class="toctree-l2"><a class="reference internal" href="traffic_ops_config.html#profile-parameters">Profile Parameters</a></li> -<li class="toctree-l2"><a class="reference internal" href="traffic_ops_config.html#regions-locations-and-cache-groups">Regions, Locations and Cache Groups</a></li> -<li class="toctree-l2"><a class="reference internal" href="traffic_ops_config.html#configuring-content-purge">Configuring Content Purge</a><ul> -<li class="toctree-l3"><a class="reference internal" href="traffic_ops_config.html#creating-the-centos-kickstart-file">Creating the CentOS Kickstart File</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops/configuration.html#content-delivery-networks">Content Delivery Networks</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops/configuration.html#profile-parameters">Profile Parameters</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops/configuration.html#regions-locations-and-cache-groups">Regions, Locations and Cache Groups</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops/configuration.html#configuring-content-purge">Configuring Content Purge</a><ul> +<li class="toctree-l3"><a class="reference internal" href="traffic_ops/configuration.html#creating-the-centos-kickstart-file">Creating the CentOS Kickstart File</a></li> </ul> </li> </ul> </li> -<li class="toctree-l1"><a class="reference internal" href="traffic_ops_using.html">Using Traffic Ops</a><ul> -<li class="toctree-l2"><a class="reference internal" href="traffic_ops_using.html#the-traffic-ops-menu">The Traffic Ops Menu</a></li> -<li class="toctree-l2"><a class="reference internal" href="traffic_ops_using.html#health">Health</a><ul> -<li class="toctree-l3"><a class="reference internal" href="traffic_ops_using.html#the-health-table">The Health Table</a></li> -<li class="toctree-l3"><a class="reference internal" href="traffic_ops_using.html#graph-view">Graph View</a></li> -<li class="toctree-l3"><a class="reference internal" href="traffic_ops_using.html#server-checks">Server Checks</a></li> -<li class="toctree-l3"><a class="reference internal" href="traffic_ops_using.html#daily-summary">Daily Summary</a></li> +<li class="toctree-l1"><a class="reference internal" href="traffic_ops/using.html">Traffic Ops - Using</a><ul> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops/using.html#the-traffic-ops-menu">The Traffic Ops Menu</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops/using.html#health">Health</a><ul> +<li class="toctree-l3"><a class="reference internal" href="traffic_ops/using.html#the-health-table">The Health Table</a></li> +<li class="toctree-l3"><a class="reference internal" href="traffic_ops/using.html#graph-view">Graph View</a></li> +<li class="toctree-l3"><a class="reference internal" href="traffic_ops/using.html#server-checks">Server Checks</a></li> +<li class="toctree-l3"><a class="reference internal" href="traffic_ops/using.html#daily-summary">Daily Summary</a></li> </ul> </li> -<li class="toctree-l2"><a class="reference internal" href="traffic_ops_using.html#server">Server</a><ul> -<li class="toctree-l3"><a class="reference internal" href="traffic_ops_using.html#server-types">Server Types</a></li> -<li class="toctree-l3"><a class="reference internal" href="traffic_ops_using.html#bulk-upload-server">Bulk Upload Server</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops/using.html#server">Server</a><ul> +<li class="toctree-l3"><a class="reference internal" href="traffic_ops/using.html#server-types">Server Types</a></li> +<li class="toctree-l3"><a class="reference internal" href="traffic_ops/using.html#bulk-upload-server">Bulk Upload Server</a></li> </ul> </li> -<li class="toctree-l2"><a class="reference internal" href="traffic_ops_using.html#delivery-service">Delivery Service</a><ul> -<li class="toctree-l3"><a class="reference internal" href="traffic_ops_using.html#delivery-service-types">Delivery Service Types</a></li> -<li class="toctree-l3"><a class="reference internal" href="traffic_ops_using.html#federations">Federations</a></li> -<li class="toctree-l3"><a class="reference internal" href="traffic_ops_using.html#header-rewrite-options-and-dscp">Header Rewrite Options and DSCP</a></li> -<li class="toctree-l3"><a class="reference internal" href="traffic_ops_using.html#token-based-authentication">Token Based Authentication</a></li> -<li class="toctree-l3"><a class="reference internal" href="traffic_ops_using.html#parent-selection">Parent Selection</a></li> -<li class="toctree-l3"><a class="reference internal" href="traffic_ops_using.html#multi-site-origin">Multi Site Origin</a></li> -<li class="toctree-l3"><a class="reference internal" href="traffic_ops_using.html#ccr-profile-or-traffic-router-profile">CCR Profile or Traffic Router Profile</a></li> -<li class="toctree-l3"><a class="reference internal" href="traffic_ops_using.html#delivery-service-regexp">Delivery Service Regexp</a></li> -<li class="toctree-l3"><a class="reference internal" href="traffic_ops_using.html#static-dns-entries">Static DNS Entries</a></li> -<li class="toctree-l3"><a class="reference internal" href="traffic_ops_using.html#server-assignments">Server Assignments</a></li> -<li class="toctree-l3"><a class="reference internal" href="traffic_ops_using.html#the-coverage-zone-file-and-asn-table">The Coverage Zone File and ASN Table</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops/using.html#delivery-service">Delivery Service</a><ul> +<li class="toctree-l3"><a class="reference internal" href="traffic_ops/using.html#delivery-service-types">Delivery Service Types</a></li> +<li class="toctree-l3"><a class="reference internal" href="traffic_ops/using.html#federations">Federations</a></li> +<li class="toctree-l3"><a class="reference internal" href="traffic_ops/using.html#header-rewrite-options-and-dscp">Header Rewrite Options and DSCP</a></li> +<li class="toctree-l3"><a class="reference internal" href="traffic_ops/using.html#token-based-authentication">Token Based Authentication</a></li> +<li class="toctree-l3"><a class="reference internal" href="traffic_ops/using.html#parent-selection">Parent Selection</a></li> +<li class="toctree-l3"><a class="reference internal" href="traffic_ops/using.html#qstring-handling">Qstring Handling</a></li> +<li class="toctree-l3"><a class="reference internal" href="traffic_ops/using.html#multi-site-origin">Multi Site Origin</a></li> +<li class="toctree-l3"><a class="reference internal" href="traffic_ops/using.html#traffic-router-profile">Traffic Router Profile</a></li> +<li class="toctree-l3"><a class="reference internal" href="traffic_ops/using.html#regex-remap-expression">Regex Remap Expression</a></li> +<li class="toctree-l3"><a class="reference internal" href="traffic_ops/using.html#delivery-service-regexp">Delivery Service Regexp</a></li> +<li class="toctree-l3"><a class="reference internal" href="traffic_ops/using.html#static-dns-entries">Static DNS Entries</a></li> +<li class="toctree-l3"><a class="reference internal" href="traffic_ops/using.html#server-assignments">Server Assignments</a></li> +<li class="toctree-l3"><a class="reference internal" href="traffic_ops/using.html#the-coverage-zone-file-and-asn-table">The Coverage Zone File and ASN Table</a></li> </ul> </li> -<li class="toctree-l2"><a class="reference internal" href="traffic_ops_using.html#parameters-and-profiles">Parameters and Profiles</a></li> -<li class="toctree-l2"><a class="reference internal" href="traffic_ops_using.html#tools">Tools</a><ul> -<li class="toctree-l3"><a class="reference internal" href="traffic_ops_using.html#generate-iso">Generate ISO</a></li> -<li class="toctree-l3"><a class="reference internal" href="traffic_ops_using.html#queue-updates-and-snapshot-crconfig">Queue Updates and Snapshot CRConfig</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops/using.html#parameters-and-profiles">Parameters and Profiles</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops/using.html#tools">Tools</a><ul> +<li class="toctree-l3"><a class="reference internal" href="traffic_ops/using.html#generate-iso">Generate ISO</a></li> +<li class="toctree-l3"><a class="reference internal" href="traffic_ops/using.html#queue-updates-and-snapshot-crconfig">Queue Updates and Snapshot CRConfig</a></li> </ul> </li> -<li class="toctree-l2"><a class="reference internal" href="traffic_ops_using.html#invalidate-content">Invalidate Content</a></li> -<li class="toctree-l2"><a class="reference internal" href="traffic_ops_using.html#manage-dnssec-keys">Manage DNSSEC Keys</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops/using.html#invalidate-content">Invalidate Content</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops/using.html#manage-dnssec-keys">Manage DNSSEC Keys</a></li> </ul> </li> -<li class="toctree-l1"><a class="reference internal" href="traffic_ops_extensions.html">Managing Traffic Ops Extensions</a><ul> -<li class="toctree-l2"><a class="reference internal" href="traffic_ops_extensions.html#example-cron-file">Example Cron File</a></li> +<li class="toctree-l1"><a class="reference internal" href="traffic_ops/extensions.html">Managing Traffic Ops Extensions</a><ul> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops/extensions.html#example-cron-file">Example Cron File</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="traffic_portal.html">Traffic Portal Administration</a></li> @@ -269,6 +292,15 @@ <li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html#troubleshooting-and-log-files">Troubleshooting and log files</a></li> </ul> </li> +<li class="toctree-l1"><a class="reference internal" href="traffic_monitor_golang.html">Traffic Monitor Administration</a><ul> +<li class="toctree-l2"><a class="reference internal" href="traffic_monitor_golang.html#installing-traffic-monitor">Installing Traffic Monitor</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_monitor_golang.html#configuring-traffic-monitor">Configuring Traffic Monitor</a><ul> +<li class="toctree-l3"><a class="reference internal" href="traffic_monitor_golang.html#configuration-overview">Configuration Overview</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="traffic_monitor_golang.html#troubleshooting-and-log-files">Troubleshooting and log files</a></li> +</ul> +</li> <li class="toctree-l1"><a class="reference internal" href="traffic_router.html">Traffic Router Administration</a><ul> <li class="toctree-l2"><a class="reference internal" href="traffic_router.html#installing-traffic-router">Installing Traffic Router</a></li> <li class="toctree-l2"><a class="reference internal" href="traffic_router.html#configuring-traffic-router">Configuring Traffic Router</a><ul> @@ -318,7 +350,10 @@ </li> <li class="toctree-l1"><a class="reference internal" href="traffic_server.html">Traffic Server Administration</a><ul> <li class="toctree-l2"><a class="reference internal" href="traffic_server.html#installing-traffic-server">Installing Traffic Server</a></li> -<li class="toctree-l2"><a class="reference internal" href="traffic_server.html#configuring-traffic-server">Configuring Traffic Server</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_server.html#configuring-traffic-server">Configuring Traffic Server</a><ul> +<li class="toctree-l3"><a class="reference internal" href="traffic_server.html#installing-the-ort-script">Installing the ORT script</a></li> +</ul> +</li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="traffic_vault.html">Traffic Vault Administration</a><ul> @@ -337,6 +372,7 @@ </li> <li class="toctree-l1"><a class="reference internal" href="quick_howto/index.html">Quick How To Guides</a><ul> <li class="toctree-l2"><a class="reference internal" href="quick_howto/multi_site.html">Configure Multi Site Origin</a></li> +<li class="toctree-l2"><a class="reference internal" href="quick_howto/multi_site_ats5.html">Configure Multi Site Origin (5.x)</a></li> <li class="toctree-l2"><a class="reference internal" href="quick_howto/dnssec.html">Configure DNSSEC</a></li> <li class="toctree-l2"><a class="reference internal" href="quick_howto/federations.html">Configure Federations</a></li> <li class="toctree-l2"><a class="reference internal" href="quick_howto/regionalgeo.html">Configure Regional Geo-blocking (RGB)</a></li> @@ -353,7 +389,7 @@ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - <a href="traffic_ops_install.html" class="btn btn-neutral float-right" title="Installing Traffic Ops">Next <span class="fa fa-arrow-circle-right"></span></a> + <a href="traffic_ops/installation.html" class="btn btn-neutral float-right" title="Traffic Ops - Installing">Next <span class="fa fa-arrow-circle-right"></span></a> <a href="../overview/traffic_vault.html" class="btn btn-neutral" title="Traffic Vault"><span class="fa fa-arrow-circle-left"></span> Previous</a> @@ -385,10 +421,11 @@ <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT:'../', - VERSION:'master', + VERSION:'2.1-dev', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', - HAS_SOURCE: true + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '' }; </script> <script type="text/javascript" src="../_static/jquery.js"></script> http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/42d25dc5/docs/latest/admin/quick_howto/dnssec.html ---------------------------------------------------------------------- diff --git a/docs/latest/admin/quick_howto/dnssec.html b/docs/latest/admin/quick_howto/dnssec.html index 6efa6be..65e5cf8 100644 --- a/docs/latest/admin/quick_howto/dnssec.html +++ b/docs/latest/admin/quick_howto/dnssec.html @@ -7,7 +7,7 @@ <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> - <title>Configure DNSSEC — Traffic Control master documentation </title> + <title>Configure DNSSEC — Traffic Control 2.1-dev documentation </title> @@ -33,10 +33,10 @@ - <link rel="top" title="Traffic Control master documentation" href="../../index.html"/> + <link rel="top" title="Traffic Control 2.1-dev documentation" href="../../index.html"/> <link rel="up" title="Quick How To Guides" href="index.html"/> <link rel="next" title="Configure Federations" href="federations.html"/> - <link rel="prev" title="Configure Multi Site Origin" href="multi_site.html"/> + <link rel="prev" title="Configure Multi Site Origin (5.x)" href="multi_site_ats5.html"/> <script src="_static/js/modernizr.min.js"></script> @@ -102,12 +102,15 @@ </ul> <ul class="current"> <li class="toctree-l1 current"><a class="reference internal" href="../index.html">Administrator’s Guide</a><ul class="current"> -<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_install.html">Installing Traffic Ops</a></li> -<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_config.html">Configuring Traffic Ops</a></li> -<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_using.html">Using Traffic Ops</a></li> -<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_extensions.html">Managing Traffic Ops Extensions</a></li> +<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/installation.html">Traffic Ops - Installing</a></li> +<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li> +<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li> +<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/configuration.html">Traffic Ops - Configuring</a></li> +<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/using.html">Traffic Ops - Using</a></li> +<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/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_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> <li class="toctree-l2"><a class="reference internal" href="../traffic_server.html">Traffic Server Administration</a></li> @@ -118,10 +121,12 @@ </ul> <ul> <li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li> <li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li> <li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li> <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</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor_golang.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> @@ -159,7 +164,7 @@ <div class="rst-content"> <div role="navigation" aria-label="breadcrumbs navigation"> <ul class="wy-breadcrumbs"> - <li><a href="../../index.html">Traffic Control master</a> »</li> + <li><a href="../../index.html">Traffic Control 2.1-dev</a> »</li> <li><a href="../index.html">Administrator’s Guide</a> »</li> @@ -180,7 +185,7 @@ <a href="federations.html" class="btn btn-neutral float-right" title="Configure Federations">Next <span class="fa fa-arrow-circle-right"></span></a> - <a href="multi_site.html" class="btn btn-neutral" title="Configure Multi Site Origin"><span class="fa fa-arrow-circle-left"></span> Previous</a> + <a href="multi_site_ats5.html" class="btn btn-neutral" title="Configure Multi Site Origin (5.x)"><span class="fa fa-arrow-circle-left"></span> Previous</a> </div> @@ -199,7 +204,7 @@ <ol class="arabic simple"> <li>Go to Tools->Manage DNSSEC Keys choose a CDN and click Manage DNSSEC Keys</li> </ol> -<a class="reference internal image-reference" href="../../_images/dnssec01.png"><img alt="../../_images/dnssec01.png" class="align-center" src="../../_images/dnssec01.png" /></a> +<a class="reference internal image-reference" href="../../_images/dnssec01.png"><img alt="../../_images/dnssec01.png" class="align-center" src="../../_images/dnssec01.png" style="width: 1100.0px; height: 280.0px;" /></a> <ol class="arabic" start="2"> <li><p class="first">Generate keys for a CDN by clicking Generate Keys then entering the following information:</p> <blockquote> @@ -213,20 +218,20 @@ <p>Depending upon the number of Delivery Services in the CDN, generating DNSSEC keys may take serveral seconds.</p> </li> </ol> -<a class="reference internal image-reference" href="../../_images/dnssec02.png"><img alt="../../_images/dnssec02.png" class="align-center" src="../../_images/dnssec02.png" /></a> +<a class="reference internal image-reference" href="../../_images/dnssec02.png"><img alt="../../_images/dnssec02.png" class="align-center" src="../../_images/dnssec02.png" style="width: 747.0px; height: 454.0px;" /></a> <ol class="arabic" start="3"> <li><p class="first">In order for DNSSEC to work properly, the DS Record information needs to be added to the parent zone of the CDN’s domain (e.g. If the CDN’s domain is ‘cdn.kabletown.net’ the parent zone is ‘kabletown.net’).</p> <p>If you control your parent zone you can enter this information yourself, otherwise you will need to work with your DNS team to get the DS Record added to the parent zone.</p> </li> </ol> -<a class="reference internal image-reference" href="../../_images/dnssec03.png"><img alt="../../_images/dnssec03.png" class="align-center" src="../../_images/dnssec03.png" /></a> +<a class="reference internal image-reference" href="../../_images/dnssec03.png"><img alt="../../_images/dnssec03.png" class="align-center" src="../../_images/dnssec03.png" style="width: 499.1px; height: 190.4px;" /></a> <ol class="arabic" start="4"> <li><p class="first">Once DS Record information has been added to the parent zone, DNSSEC needs to be activated for the CDN so that Traffic Router will sign responses.</p> <p>Click on Tools -> Manage DNSSEC Keys -> Choose your CDN -> On the Manage DNSSEC Keys page click the activate DNSSEC Keys button.</p> <p>This will add a ‘dnssec.enabled = “true”’ entry to CRConfig for the chosen CDN.</p> </li> </ol> -<a class="reference internal image-reference" href="../../_images/dnssec04.png"><img alt="../../_images/dnssec04.png" class="align-center" src="../../_images/dnssec04.png" /></a> +<a class="reference internal image-reference" href="../../_images/dnssec04.png"><img alt="../../_images/dnssec04.png" class="align-center" src="../../_images/dnssec04.png" style="width: 554.4px; height: 422.8px;" /></a> <ol class="arabic" start="5"> <li><p class="first">DNSSEC should now be active on your CDN and Traffic Router should be signing responses.</p> <blockquote> @@ -249,7 +254,7 @@ <a href="federations.html" class="btn btn-neutral float-right" title="Configure Federations">Next <span class="fa fa-arrow-circle-right"></span></a> - <a href="multi_site.html" class="btn btn-neutral" title="Configure Multi Site Origin"><span class="fa fa-arrow-circle-left"></span> Previous</a> + <a href="multi_site_ats5.html" class="btn btn-neutral" title="Configure Multi Site Origin (5.x)"><span class="fa fa-arrow-circle-left"></span> Previous</a> </div> @@ -278,10 +283,11 @@ <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT:'../../', - VERSION:'master', + VERSION:'2.1-dev', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', - HAS_SOURCE: true + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '' }; </script> <script type="text/javascript" src="../../_static/jquery.js"></script>
