You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficcontrol.apache.org by mi...@apache.org on 2016/11/01 21:45:09 UTC
[45/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/_sources/development/traffic_ops_api/v12/server.txt
----------------------------------------------------------------------
diff --git a/docs/1.7.0/_sources/development/traffic_ops_api/v12/server.txt b/docs/1.7.0/_sources/development/traffic_ops_api/v12/server.txt
index 4e308fb..316f126 100644
--- a/docs/1.7.0/_sources/development/traffic_ops_api/v12/server.txt
+++ b/docs/1.7.0/_sources/development/traffic_ops_api/v12/server.txt
@@ -24,7 +24,7 @@ Server
/api/1.2/servers
++++++++++++++++
-**GET /api/1.2/servers.json**
+**GET /api/1.2/servers**
Retrieves properties of CDN servers.
@@ -34,12 +34,172 @@ Server
**Request Query Parameters**
+ +--------------------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +====================+==========+=============================================+
+ | ``dsId`` | no | Used to filter servers by delivery service. |
+ +--------------------+----------+---------------------------------------------+
+ | ``status`` | no | Used to filter servers by status. |
+ +--------------------+----------+---------------------------------------------+
+ | ``type`` | no | Used to filter servers by type. |
+ +--------------------+----------+---------------------------------------------+
+ | ``profileId`` | no | Used to filter servers by profile. |
+ +--------------------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================+========+============================================================================================================+
+ | ``cachegroup`` | string | The cache group name (see :ref:`to-api-v11-cachegroup`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cachegroupId`` | string | The cache group id. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | string | Id of the CDN to which the server belongs to. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cdnName`` | string | Name of the CDN to which the server belongs to. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``domainName`` | string | The domain name part of the FQDN of the cache. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``guid`` | string | An identifier used to uniquely identify the server. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``hostName`` | string | The host name part of the cache. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``httpsPort`` | string | The HTTPS port on which the main application listens (443 in most cases). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``id`` | string | The server id (database row number). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpAddress`` | string | The IPv4 address of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpGateway`` | string | The IPv4 gateway address of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpNetmask`` | string | The IPv4 netmask of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloPassword`` | string | The password of the of the lights-out-management user (displays as ****** unless you are an 'admin' user). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloUsername`` | string | The user name for lights-out-management. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``interfaceMtu`` | string | The Maximum Transmission Unit (MTU) to configure for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``interfaceName`` | string | The network interface name used for serving traffic. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ip6Address`` | string | The IPv6 address/netmask for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ip6Gateway`` | string | The IPv6 gateway for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipAddress`` | string | The IPv4 address for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipGateway`` | string | The IPv4 gateway for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipNetmask`` | string | The IPv4 netmask for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time and Date for the last update for this server. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpAddress`` | string | The IPv4 address of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpGateway`` | string | The IPv4 gateway of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpNetmask`` | string | The IPv4 netmask of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``offlineReason`` | string | A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``physLocation`` | string | The physical location name (see :ref:`to-api-v11-phys-loc`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``physLocationId`` | string | The physical location id (see :ref:`to-api-v11-phys-loc`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profile`` | string | The assigned profile name (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profileDesc`` | string | The assigned profile description (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profileId`` | string | The assigned profile Id (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``rack`` | string | A string indicating rack location. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``routerHostName`` | string | The human readable name of the router. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``routerPortName`` | string | The human readable name of the router port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``status`` | string | The Status string (See :ref:`to-api-v11-status`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``statusId`` | string | The Status id (See :ref:`to-api-v11-status`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``tcpPort`` | string | The default TCP port on which the main application listens (80 for a cache in most cases). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``type`` | string | The name of the type of this server (see :ref:`to-api-v11-type`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``typeId`` | string | The id of the type of this server (see :ref:`to-api-v11-type`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``updPending`` | bool | |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "cachegroup": "us-il-chicago",
+ "cachegroupId": "3",
+ "cdnId": "3",
+ "cdnName": "CDN-1",
+ "domainName": "chi.kabletown.net",
+ "guid": null,
+ "hostName": "atsec-chi-00",
+ "id": "19",
+ "iloIpAddress": "172.16.2.6",
+ "iloIpGateway": "172.16.2.1",
+ "iloIpNetmask": "255.255.255.0",
+ "iloPassword": "********",
+ "iloUsername": "",
+ "interfaceMtu": "9000",
+ "interfaceName": "bond0",
+ "ip6Address": "2033:D0D0:3300::2:2/64",
+ "ip6Gateway": "2033:D0D0:3300::2:1",
+ "ipAddress": "10.10.2.2",
+ "ipGateway": "10.10.2.1",
+ "ipNetmask": "255.255.255.0",
+ "lastUpdated": "2015-03-08 15:57:32",
+ "mgmtIpAddress": "",
+ "mgmtIpGateway": "",
+ "mgmtIpNetmask": "",
+ "offlineReason": "N/A",
+ "physLocation": "plocation-chi-1",
+ "physLocationId": "9",
+ "profile": "EDGE1_CDN1_421_SSL",
+ "profileDesc": "EDGE1_CDN1_421_SSL profile",
+ "profileId": "12",
+ "rack": "RR 119.02",
+ "routerHostName": "rtr-chi.kabletown.net",
+ "routerPortName": "2",
+ "status": "ONLINE",
+ "statusId": "6",
+ "tcpPort": "80",
+ "httpsPort": "443",
+ "type": "EDGE",
+ "typeId": "3",
+ "updPending": false
+ },
+ {
+ ... more server data
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.2/servers/:id**
+
+ Retrieves properties of a CDN server by server ID.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+-----------+----------+---------------------------------------------+
| Name | Required | Description |
+===========+==========+=============================================+
- | ``dsId`` | no | Used to filter servers by delivery service. |
- +-----------+----------+---------------------------------------------+
- | ``type`` | no | Used to filter servers by type. |
+ | ``id`` | yes | Server id. |
+-----------+----------+---------------------------------------------+
**Response Properties**
@@ -47,12 +207,22 @@ Server
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+====================+========+============================================================================================================+
- | ``cachegroup`` | string | The cache group name (see :ref:`to-api-v12-cachegroup`). |
+ | ``cachegroup`` | string | The cache group name (see :ref:`to-api-v11-cachegroup`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cachegroupId`` | string | The cache group id. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | string | Id of the CDN to which the server belongs to. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cdnName`` | string | Name of the CDN to which the server belongs to. |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``domainName`` | string | The domain name part of the FQDN of the cache. |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``guid`` | string | An identifier used to uniquely identify the server. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``hostName`` | string | The host name part of the cache. |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``httpsPort`` | string | The HTTPS port on which the main application listens (443 in most cases). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``id`` | string | The server id (database row number). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``iloIpAddress`` | string | The IPv4 address of the lights-out-management port. |
@@ -87,9 +257,17 @@ Server
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``mgmtIpNetmask`` | string | The IPv4 netmask of the management port (optional). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``physLocation`` | string | The physical location name (see :ref:`to-api-v12-phys-loc`). |
+ | ``offlineReason`` | string | A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``physLocation`` | string | The physical location name (see :ref:`to-api-v11-phys-loc`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``physLocationId`` | string | The physical location id (see :ref:`to-api-v11-phys-loc`). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``profile`` | string | The assigned profile name (see :ref:`to-api-v12-profile`). |
+ | ``profile`` | string | The assigned profile name (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profileDesc`` | string | The assigned profile description (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profileId`` | string | The assigned profile Id (see :ref:`to-api-v11-profile`). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``rack`` | string | A string indicating rack location. |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
@@ -97,17 +275,17 @@ Server
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``routerPortName`` | string | The human readable name of the router port. |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``status`` | string | The Status string (See :ref:`to-api-v12-status`). |
+ | ``status`` | string | The Status string (See :ref:`to-api-v11-status`). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``tcpPort`` | string | The default TCP port on which the main application listens (80 for a cache in most cases). |
+ | ``statusId`` | string | The Status id (See :ref:`to-api-v11-status`). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``httpsPort`` | string | The default HTTPS port on which the main application listens (443 for a cache in most cases). |
+ | ``tcpPort`` | string | The default TCP port on which the main application listens (80 for a cache in most cases). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``type`` | string | The name of the type of this server (see :ref:`to-api-v12-type`). |
+ | ``type`` | string | The name of the type of this server (see :ref:`to-api-v11-type`). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``xmppId`` | string | Deprecated. |
+ | ``typeId`` | string | The id of the type of this server (see :ref:`to-api-v11-type`). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``xmppPasswd`` | string | Deprecated. |
+ | ``updPending`` | bool | |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
**Response Example** ::
@@ -116,7 +294,11 @@ Server
"response": [
{
"cachegroup": "us-il-chicago",
+ "cachegroupId": "3",
+ "cdnId": "3",
+ "cdnName": "CDN-1",
"domainName": "chi.kabletown.net",
+ "guid": null,
"hostName": "atsec-chi-00",
"id": "19",
"iloIpAddress": "172.16.2.6",
@@ -135,27 +317,30 @@ Server
"mgmtIpAddress": "",
"mgmtIpGateway": "",
"mgmtIpNetmask": "",
+ "offlineReason": "N/A",
"physLocation": "plocation-chi-1",
+ "physLocationId": "9",
"profile": "EDGE1_CDN1_421_SSL",
+ "profileDesc": "EDGE1_CDN1_421_SSL profile",
+ "profileId": "12",
"rack": "RR 119.02",
"routerHostName": "rtr-chi.kabletown.net",
"routerPortName": "2",
"status": "ONLINE",
+ "statusId": "6",
"tcpPort": "80",
"httpsPort": "443",
"type": "EDGE",
- "xmppId": "atsec-chi-00-dummyxmpp",
- "xmppPasswd": "**********"
- },
- {
- ... more server data
+ "typeId": "3",
+ "updPending": false
}
]
}
|
-**GET /api/1.2/servers/summary.json**
+
+**GET /api/1.2/servers/summary**
Retrieves a count of CDN servers by type.
@@ -201,7 +386,7 @@ Server
|
-**GET /api/1.2/servers/hostname/:name/details.json**
+**GET /api/1.2/servers/hostname/:name/details**
Retrieves the details of a server.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/_sources/development/traffic_ops_api/v12/status.txt
----------------------------------------------------------------------
diff --git a/docs/1.7.0/_sources/development/traffic_ops_api/v12/status.txt b/docs/1.7.0/_sources/development/traffic_ops_api/v12/status.txt
index 401f088..e374527 100644
--- a/docs/1.7.0/_sources/development/traffic_ops_api/v12/status.txt
+++ b/docs/1.7.0/_sources/development/traffic_ops_api/v12/status.txt
@@ -24,9 +24,9 @@ Status
/api/1.2/statuses
+++++++++++++++++
-**GET /api/1.2/statuses.json**
+**GET /api/1.2/statuses**
- Retrieves a list of the server status codes available. May be useful when the status is retrieved from other APIs as a number and not a string.
+ Retrieves a list of the server status codes available.
Authentication Required: Yes
@@ -37,51 +37,92 @@ Status
+-----------------+--------+--------------------------------------------------------------------------------+
| Parameter | Type | Description |
+=================+========+================================================================================+
- | ``lastUpdated`` | string | The Time / Date this server entry was last updated |
+ | ``id`` | string | The id with which Traffic Ops stores this status, and references it internally |
+-----------------+--------+--------------------------------------------------------------------------------+
| ``name`` | string | The string equivalent of the status |
+-----------------+--------+--------------------------------------------------------------------------------+
- | ``id`` | string | The id with which Traffic Ops stores this status, and references it internally |
- +-----------------+--------+--------------------------------------------------------------------------------+
| ``description`` | string | A short description of the status |
+-----------------+--------+--------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time / Date this server entry was last updated |
+ +-----------------+--------+--------------------------------------------------------------------------------+
**Response Example** ::
{
"response": [
{
- "description": "Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches",
"id": "4",
"name": "ADMIN_DOWN",
+ "description": "Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches",
"lastUpdated": "2013-02-13 16:34:29"
},
{
- "lastUpdated": "2013-02-13 16:34:29",
- "name": "CCR_IGNORE",
"id": "5",
- "description": "Edge: 12M will not include caches in this state in CCR config files. Mid: N\/A for now"
+ "name": "CCR_IGNORE",
+ "description": "Edge: 12M will not include caches in this state in CCR config files. Mid: N\/A for now",
+ "lastUpdated": "2013-02-13 16:34:29"
},
{
- "description": "Edge: Puts server in CCR config file in this state, but CCR will never route traffic to it. Mid: Server will not be included in parent.config files for its edge caches",
"id": "1",
- "lastUpdated": "2013-02-13 16:34:29",
- "name": "OFFLINE"
+ "name": "OFFLINE",
+ "description": "Edge: Puts server in CCR config file in this state, but CCR will never route traffic to it. Mid: Server will not be included in parent.config files for its edge caches",
+ "lastUpdated": "2013-02-13 16:34:29"
},
{
"id": "2",
+ "name": "ONLINE",
"description": "Edge: Puts server in CCR config file in this state, and CCR will always route traffic to it. Mid: Server will be included in parent.config files for its edges",
- "lastUpdated": "2013-02-13 16:34:29",
- "name": "ONLINE"
+ "lastUpdated": "2013-02-13 16:34:29"
},
{
"id": "3",
- "description": "Edge: Puts server in CCR config file in this state, and CCR will adhere to the health protocol. Mid: N\/A for now",
"name": "REPORTED",
+ "description": "Edge: Puts server in CCR config file in this state, and CCR will adhere to the health protocol. Mid: N\/A for now",
"lastUpdated": "2013-02-13 16:34:29"
}
- ],
+ ]
}
-|
+**GET /api/1.2/statuses/:id**
+
+ Retrieves a server status by ID.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | Status id. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+================================================================================+
+ | ``id`` | string | The id with which Traffic Ops stores this status, and references it internally |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | ``name`` | string | The string equivalent of the status |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | ``description`` | string | A short description of the status |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time / Date this server entry was last updated |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "4",
+ "name": "ADMIN_DOWN",
+ "description": "Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches",
+ "lastUpdated": "2013-02-13 16:34:29"
+ }
+ ]
+ }
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/_sources/development/traffic_ops_api/v12/type.txt
----------------------------------------------------------------------
diff --git a/docs/1.7.0/_sources/development/traffic_ops_api/v12/type.txt b/docs/1.7.0/_sources/development/traffic_ops_api/v12/type.txt
index 90c2eeb..4238fc7 100644
--- a/docs/1.7.0/_sources/development/traffic_ops_api/v12/type.txt
+++ b/docs/1.7.0/_sources/development/traffic_ops_api/v12/type.txt
@@ -24,45 +24,54 @@ Types
/api/1.2/types
++++++++++++++
-**GET /api/1.2/types.json**
+**GET /api/1.1/types**
Authentication Required: Yes
- Role(s) Required: Yes
+ Role(s) Required: None
+
+ **Request Query Parameters**
+
+ +----------------+----------+----------------------------------------------------+
+ | Name | Required | Description |
+ +================+==========+====================================================+
+ | ``useInTable`` | no | Filter types by the table in which they apply |
+ +----------------+----------+----------------------------------------------------+
**Response Properties**
+----------------------+--------+------------------------------------------------+
| Parameter | Type | Description |
+======================+========+================================================+
- |``lastUpdated`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``useInTable`` | string | |
+ |``id`` | string | |
+----------------------+--------+------------------------------------------------+
|``name`` | string | |
+----------------------+--------+------------------------------------------------+
- |``id`` | string | |
- +----------------------+--------+------------------------------------------------+
|``description`` | string | |
+----------------------+--------+------------------------------------------------+
+ |``useInTable`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
**Response Example** ::
{
"response": [
{
- "lastUpdated": "2013-10-23 15:28:31",
- "useInTable": "staticdnsentry",
- "name": "AAAA_RECORD",
"id": "22",
- "description": "Static DNS AAAA entry"
+ "name": "AAAA_RECORD",
+ "description": "Static DNS AAAA entry",
+ "useInTable": "staticdnsentry",
+ "lastUpdated": "2013-10-23 15:28:31"
}
- ],
+ ]
}
+
|
-**GET /api/1.2/types/trimmed.json**
+**GET /api/1.1/types/trimmed**
Authentication Required: Yes
@@ -95,4 +104,49 @@ Types
],
}
+**GET /api/1.1/types/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +----------------+----------+----------------------------------------------------+
+ | Name | Required | Description |
+ +================+==========+====================================================+
+ | ``id`` | yes | Type ID. |
+ +----------------+----------+----------------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``description`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``useInTable`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "22",
+ "name": "AAAA_RECORD",
+ "description": "Static DNS AAAA entry",
+ "useInTable": "staticdnsentry",
+ "lastUpdated": "2013-10-23 15:28:31"
+ }
+ ]
+ }
+
+
|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/_sources/development/traffic_ops_api/v12/user.txt
----------------------------------------------------------------------
diff --git a/docs/1.7.0/_sources/development/traffic_ops_api/v12/user.txt b/docs/1.7.0/_sources/development/traffic_ops_api/v12/user.txt
index 8292a6b..e81292a 100644
--- a/docs/1.7.0/_sources/development/traffic_ops_api/v12/user.txt
+++ b/docs/1.7.0/_sources/development/traffic_ops_api/v12/user.txt
@@ -24,7 +24,7 @@ Users
/api/1.2/users
++++++++++++++
-**GET /api/1.2/users.json**
+**GET /api/1.2/users**
Retrieves all users.
@@ -32,82 +32,184 @@ Users
Role(s) Required: None
- **Request Query Parameters**
+ **Response Properties**
- +-----------------+----------+---------------------------------------------------+
- | Name | Required | Description |
- +=================+==========+===================================================+
- | username | no | The user you want to retrieve information for. |
- +-----------------+----------+---------------------------------------------------+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``addressLine1`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``addressLine2`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``city`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``company`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``country`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``email`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``fullName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``gid`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | hash | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``newUser`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``phoneNumber`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``postalCode`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``publicSshKey`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``registrationSent`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``role`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``roleName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``stateOrProvince`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``uid`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``username`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "addressLine1": "",
+ "addressLine2": "",
+ "city": "",
+ "company": "",
+ "country": "",
+ "email": "email1@email.com",
+ "fullName": "Tom Simpson",
+ "gid": "0",
+ "id": "53",
+ "lastUpdated": "2016-01-26 10:22:07",
+ "newUser": true,
+ "phoneNumber": "",
+ "postalCode": "",
+ "publicSshKey": "xxx",
+ "registrationSent": true,
+ "role": "6",
+ "rolename": "admin",
+ "stateOrProvince": "",
+ "uid": "0",
+ "username": "tsimpson"
+ },
+ {
+ ... more users
+ },
+ ]
+ }
+
+|
+
+
+**GET /api/1.2/users/:id**
+
+ Retrieves user by ID.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | User id. |
+ +-----------+----------+---------------------------------------------+
**Response Properties**
- +----------------------+---------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+=========+================================================+
- |``email`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``city`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``id`` | hash | |
- +----------------------+---------+------------------------------------------------+
- |``phoneNumber`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``company`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``country`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``fullName`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``localUser`` | boolean | |
- +----------------------+---------+------------------------------------------------+
- |``uid`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``username`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``rolename`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``newUser`` | boolean | |
- +----------------------+---------+------------------------------------------------+
- |``addressLine2`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``role`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``addressLine1`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``postalCode`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``gid`` | string | |
- +----------------------+---------+------------------------------------------------+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``addressLine1`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``addressLine2`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``city`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``company`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``country`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``email`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``fullName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``gid`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | hash | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``newUser`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``phoneNumber`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``postalCode`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``publicSshKey`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``registrationSent`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``role`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``roleName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``stateOrProvince`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``uid`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``username`` | string | |
+ +----------------------+--------+------------------------------------------------+
**Response Example** ::
-
- [
- {
- "email": "email@email.com",
- "city": "",
- "id": "54",
- "phoneNumber": "",
- "company": "",
- "country": "",
- "fullName": "Bob Simpson",
- "localUser": false,
- "uid": "0",
- "stateOrProvince": "",
- "username": "bsimpson",
- "rolename": "portal",
- "newUser": true,
- "addressLine2": "",
- "role": "6",
- "addressLine1": "",
- "postalCode": "",
- "gid": "0"
- }
- ]
+ {
+ "response": [
+ {
+ "addressLine1": "",
+ "addressLine2": "",
+ "city": "",
+ "company": "",
+ "country": "",
+ "email": "email1@email.com",
+ "fullName": "Tom Simpson",
+ "gid": "0",
+ "id": "53",
+ "lastUpdated": "2016-01-26 10:22:07",
+ "newUser": true,
+ "phoneNumber": "",
+ "postalCode": "",
+ "publicSshKey": "xxx",
+ "registrationSent": true,
+ "role": "6",
+ "rolename": "admin",
+ "stateOrProvince": "",
+ "uid": "0",
+ "username": "tsimpson"
+ },
+ {
+ ... more users
+ },
+ ]
+ }
|
+
**GET /api/1.2/user/current.json**
Retrieves the profile for the authenticated user.
@@ -365,7 +467,7 @@ Users
Invalidating content on the CDN is sometimes necessary when the origin was mis-configured and something is cached in the CDN that needs to be removed. Given the size of a typical Traffic Control CDN and the amount of content that can be cached in it, removing the content from all the caches may take a long time. To speed up content invalidation, Traffic Ops will not try to remove the content from the caches, but it makes the content inaccessible using the *regex_revalidate* ATS plugin. This forces a *revalidation* of the content, rather than a new get.
-.. Note:: This method forces a HTTP *revalidation* of the content, and not a new *GET* - the origin needs to support revalidation according to the HTTP/1.1 specification, and send a ``200 OK`` or ``304 Not Modified`` as applicable.
+.. Note:: This method forces a HTTP *revalidation* of the content, and not a new *GET* - the origin needs to support revalidation according to the HTTP/1.2 specification, and send a ``200 OK`` or ``304 Not Modified`` as applicable.
Authentication Required: Yes
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/_sources/development/traffic_stats.txt
----------------------------------------------------------------------
diff --git a/docs/1.7.0/_sources/development/traffic_stats.txt b/docs/1.7.0/_sources/development/traffic_stats.txt
index 186f13a..4c78bec 100644
--- a/docs/1.7.0/_sources/development/traffic_stats.txt
+++ b/docs/1.7.0/_sources/development/traffic_stats.txt
@@ -1,18 +1,18 @@
-..
+..
.. Copyright 2015 Comcast Cable Communications Management, LLC
-..
+..
.. Licensed under the Apache License, Version 2.0 (the "License");
.. you may not use this file except in compliance with the License.
.. You may obtain a copy of the License at
-..
+..
.. http://www.apache.org/licenses/LICENSE-2.0
-..
+..
.. Unless required by applicable law or agreed to in writing, software
.. distributed under the License is distributed on an "AS IS" BASIS,
.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
.. See the License for the specific language governing permissions and
.. limitations under the License.
-..
+..
Traffic Stats
*************
@@ -25,20 +25,21 @@ Software Requirements
=====================
To work on Traffic Stats you need a \*nix (MacOS and Linux are most commonly used) environment that has the following installed:
- * `Go 1.5.x or above <https://golang.org/doc/install>`_
+ * `Go 1.7.x or above <https://golang.org/doc/install>`_
* Access to a working instance of Traffic Ops
* Access to a working instance of Traffic Monitor
- * `InfluxDb version 0.10.0 or greater <https://influxdb.com/download/index.html>`_
+ * `InfluxDb version 1.0.0 or greater <https://influxdb.com/download/index.html>`_
Traffic Stats Project Tree Overview
=====================================
* **traffic_control/traffic_stats** - contains Go source files and Files used to create the Traffic Stats rpm.
* **traffic_control/traffic_stats/grafana/** - contains a javascript file which is installed on the grafana server. This allows Traffic Ops to create custom dashboards for Delivery Services, Caches, etc.
+ * **traffic_control/traffic_stats/influxdb_tools/** - contains one tool to create the databases and retention policies needed by Traffic Stats as well as continuous queries to downsample data; contains another tool to sync downsampled data between influxdb instances. This is is helpful if you have multiple instances and they get out of sync with data.
-Go Formatting Conventions
+Go Formatting Conventions
============================
-In general `Go fmt <https://golang.org/cmd/gofmt/>`_ is the standard for formatting go code.
+In general `Go fmt <https://golang.org/cmd/gofmt/>`_ is the standard for formatting go code. It is also recommended to use `Go lint <https://github.com/golang/lint>`_.
Installing The Developer Environment
====================================
@@ -54,6 +55,5 @@ To install the Traffic Ops Developer environment:
Test Cases
==========
- Currently there are not automated tests for Traffic Stats :(.
- We hope to remedy this problem very soon!
+ Currently there are no automated tests for Traffic Stats :( but pull requests are always welcome to fix this problem!
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/_sources/overview/traffic_stats.txt
----------------------------------------------------------------------
diff --git a/docs/1.7.0/_sources/overview/traffic_stats.txt b/docs/1.7.0/_sources/overview/traffic_stats.txt
index 7468166..874b10d 100644
--- a/docs/1.7.0/_sources/overview/traffic_stats.txt
+++ b/docs/1.7.0/_sources/overview/traffic_stats.txt
@@ -1,18 +1,18 @@
-..
+..
.. Copyright 2015 Comcast Cable Communications Management, LLC
-..
+..
.. Licensed under the Apache License, Version 2.0 (the "License");
.. you may not use this file except in compliance with the License.
.. You may obtain a copy of the License at
-..
+..
.. http://www.apache.org/licenses/LICENSE-2.0
-..
+..
.. Unless required by applicable law or agreed to in writing, software
.. distributed under the License is distributed on an "AS IS" BASIS,
.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
.. See the License for the specific language governing permissions and
.. limitations under the License.
-..
+..
.. _reference-label-tc-ts:
.. |arrow| image:: fwda.png
@@ -20,14 +20,14 @@
Traffic Stats
=============
-Traffic Stats is a program written in `Golang <http://golang.org>`_ that is used to acquire and store statistics about CDNs controlled by Traffic Control. Traffic Stats mines metrics from Traffic Monitor's JSON APIs and stores the data in `InfluxDb <http://influxdb.com>`_. Data is typically stored in InfluxDb on a short-term basis (30 days or less) and is used to drive graphs created by `Grafana <http://grafana.org>`_ which are linked from Traffic Ops as well as provide data exposed through the Traffic Ops API. Traffic Stats performs two functions: first it gathers stat data for Edge Caches and Delivery Services at a configurable interval (10 second default) from the Traffic Monitor API's and stores the data in InfluxDb; second it summarizes all of the stats once a day (around midnight UTC) and creates a daily rollup containing the Max Gbps served and the Total Bytes served.
+Traffic Stats is a program written in `Golang <http://golang.org>`_ that is used to acquire and store statistics about CDNs controlled by Traffic Control. Traffic Stats mines metrics from Traffic Monitor's JSON APIs and stores the data in `InfluxDb <http://influxdb.com>`_. Data is typically stored in InfluxDb on a short-term basis (30 days or less). The data from InfluxDb is then used to drive graphs created by `Grafana <http://grafana.org>`_ - which are linked to from Traffic Ops - as well as provide data exposed through the Traffic Ops API. Traffic Stats performs two functions: first it gathers stat data for Edge Caches and Delivery Services at a configurable interval (10 second default) from the Traffic Monitor API's and stores the data in InfluxDb; second it summarizes all of the stats once a day (around midnight UTC) and creates a daily rollup containing the Max Gbps served and the Total Bytes served.
Stat data is stored in three different databases:
- cache_stats: The cache_stats database is used to store data gathered from edge caches. The `measurements <https://influxdb.com/docs/v0.9/concepts/glossary.html#measurement>`_ stored by cache are: bandwidth, maxKbps, and client_connections (ats.proxy.process.http.current_client_connections). Cache Data is stored with `tags <https://influxdb.com/docs/v0.9/concepts/glossary.html#tag>`_ for hostname, cachegroup, and CDN. Data can be queried using tags.
- - deliveryservice_stats: The deliveryservice_stats database is used to store data for delivery services. The measurements stored by delivery service are: kbps, status_4xx, status_5xx, tps_2xx, tps_3xx, tps_4xx, tps_5xx, and tps_total. Delivery Service stats are stored with tags for cachegroup, CDN, and Deliveryservice xml_id.
+ - deliveryservice_stats: The deliveryservice_stats database is used to store data for delivery services. The measurements stored by delivery service are: kbps, status_4xx, status_5xx, tps_2xx, tps_3xx, tps_4xx, tps_5xx, and tps_total. Delivery Service stats are stored with tags for cachegroup, CDN, and Deliveryservice xml_id.
- daily_stats: The daily_stats database is used to store summary data for daily activities. The stats that are currently summarized are Max Bandwidth and Bytes Served and they are stored by CDN.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/_static/basic.css
----------------------------------------------------------------------
diff --git a/docs/1.7.0/_static/basic.css b/docs/1.7.0/_static/basic.css
index 9fa77d8..2b513f0 100644
--- a/docs/1.7.0/_static/basic.css
+++ b/docs/1.7.0/_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/91716725/docs/1.7.0/_static/doctools.js
----------------------------------------------------------------------
diff --git a/docs/1.7.0/_static/doctools.js b/docs/1.7.0/_static/doctools.js
index c7bfe76..8163495 100644
--- a/docs/1.7.0/_static/doctools.js
+++ b/docs/1.7.0/_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/91716725/docs/1.7.0/_static/pygments.css
----------------------------------------------------------------------
diff --git a/docs/1.7.0/_static/pygments.css b/docs/1.7.0/_static/pygments.css
index 57eadc0..8213e90 100644
--- a/docs/1.7.0/_static/pygments.css
+++ b/docs/1.7.0/_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/91716725/docs/1.7.0/_static/searchtools.js
----------------------------------------------------------------------
diff --git a/docs/1.7.0/_static/searchtools.js b/docs/1.7.0/_static/searchtools.js
index 0e794fd..066857c 100644
--- a/docs/1.7.0/_static/searchtools.js
+++ b/docs/1.7.0/_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/91716725/docs/1.7.0/_static/websupport.js
----------------------------------------------------------------------
diff --git a/docs/1.7.0/_static/websupport.js b/docs/1.7.0/_static/websupport.js
index 28d65db..98e7f40 100644
--- a/docs/1.7.0/_static/websupport.js
+++ b/docs/1.7.0/_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/91716725/docs/1.7.0/admin/index.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/admin/index.html b/docs/1.7.0/admin/index.html
index 29592cc..511c279 100644
--- a/docs/1.7.0/admin/index.html
+++ b/docs/1.7.0/admin/index.html
@@ -100,7 +100,7 @@
</li>
</ul>
<ul class="current">
-<li class="toctree-l1 current"><a class="current reference internal" href="">Administrator’s Guide</a><ul>
+<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>
@@ -300,12 +300,19 @@
<li class="toctree-l3"><a class="reference internal" href="traffic_router.html#id3">Configuration</a></li>
</ul>
</li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_router.html#https-for-http-type-delivery-services">HTTPS for Http Type Delivery Services</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="traffic_router.html#protocol-options">Protocol Options</a></li>
+<li class="toctree-l3"><a class="reference internal" href="traffic_router.html#certificate-retrieval">Certificate Retrieval</a></li>
+<li class="toctree-l3"><a class="reference internal" href="traffic_router.html#certificate-chain-ordering">Certificate Chain Ordering</a></li>
+<li class="toctree-l3"><a class="reference internal" href="traffic_router.html#suggested-way-of-setting-up-an-https-delivery-service">Suggested Way of Setting up an HTTPS Delivery Service</a></li>
+</ul>
+</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="traffic_stats.html">Traffic Stats Administration</a><ul>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html#installation">Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html#configuration">Configuration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html#id1">InfluxDb Tools</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html#id2">InfluxDb Tools</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="traffic_server.html">Traffic Server Administration</a><ul>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/admin/quick_howto/dnssec.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/admin/quick_howto/dnssec.html b/docs/1.7.0/admin/quick_howto/dnssec.html
index d359f38..c5c25f2 100644
--- a/docs/1.7.0/admin/quick_howto/dnssec.html
+++ b/docs/1.7.0/admin/quick_howto/dnssec.html
@@ -199,7 +199,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 +213,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>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/admin/quick_howto/federations.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/admin/quick_howto/federations.html b/docs/1.7.0/admin/quick_howto/federations.html
index 241305c..2fb7c80 100644
--- a/docs/1.7.0/admin/quick_howto/federations.html
+++ b/docs/1.7.0/admin/quick_howto/federations.html
@@ -200,24 +200,24 @@
</div></blockquote>
</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/federation01.png"><img alt="../../_images/federation01.png" class="align-center" src="../../_images/federation01.png" /></a>
+<a class="reference internal image-reference" href="../../_images/federation01.png"><img alt="../../_images/federation01.png" class="align-center" src="../../_images/federation01.png" style="width: 804.0px; height: 690.0px;" /></a>
<ol class="arabic simple" start="2">
<li>As a user with admin priveleges, create a Federation Mapping by going to Delivery Services -> Federations and then clicking ‘Add Federation Mapping’</li>
<li>Choose the Delivery Service for the federation to be mapped to and assign it to the Federation User; click Add.</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/federation02.png"><img alt="../../_images/federation02.png" class="align-center" src="../../_images/federation02.png" /></a>
+<a class="reference internal image-reference" href="../../_images/federation02.png"><img alt="../../_images/federation02.png" class="align-center" src="../../_images/federation02.png" style="width: 766.0px; height: 494.0px;" /></a>
<ol class="arabic" start="4">
<li><p class="first">After the Federation is added, Traffic Ops will display the Federation.</p>
<p>Changes can be made at this time or the Federation can be deleted. Notice that no resolvers have been added to the fedeation yet. This can only be done by the federation user created in step 1.</p>
<p>If no further action is necessary, the Close button will close the window and display the list of all Federations.</p>
</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/federation03.png"><img alt="../../_images/federation03.png" class="align-center" src="../../_images/federation03.png" /></a>
+<a class="reference internal image-reference" href="../../_images/federation03.png"><img alt="../../_images/federation03.png" class="align-center" src="../../_images/federation03.png" style="width: 806.0px; height: 886.0px;" /></a>
<p><strong>The Federation user can now add resolvers to the Federation Mapping in Traffic Ops.</strong></p>
<ol class="arabic" start="5">
<li><p class="first">The federation user logs to traffic ops and stores the mojolicious cookie. The mojolicious cookie can be obtained manually using the debug tools on a web browser or via curl.</p>
<p>Example:</p>
-<div class="highlight-python"><div class="highlight"><pre>$ curl -i -XPOST "http://localhost:3000/api/1.1/user/login" -H "Content-Type: application/json" -d '{ "u": "federation_user1", "p": "password" }'
+<div class="highlight-default"><div class="highlight"><pre><span></span>$ curl -i -XPOST "http://localhost:3000/api/1.1/user/login" -H "Content-Type: application/json" -d '{ "u": "federation_user1", "p": "password" }'
HTTP/1.1 200 OK
Date: Wed, 02 Dec 2015 21:12:06 GMT
@@ -239,7 +239,7 @@ Access-Control-Allow-Origin: http://localhost:8080
<li><p class="first">The federation user sends a request to Traffic Ops to add IPV4 and/or IPV6 resolvers</p>
<blockquote>
<div><p>Example:</p>
-<div class="highlight-python"><div class="highlight"><pre>$ curl -ki -H "Cookie: mojolicious=eyJleHBpcmVzIjoxNDQ5MTA1MTI2LCJhdXRoX2RhdGEiOiJmZWRlcmF0aW9uX3VzZXIxIn0---06b4f870d809d82a91433e92eae8320875c3e8b0;" -XPUT 'http://localhost:3000/api/1.2/federations' -d '
+<div class="highlight-default"><div class="highlight"><pre><span></span>$ curl -ki -H "Cookie: mojolicious=eyJleHBpcmVzIjoxNDQ5MTA1MTI2LCJhdXRoX2RhdGEiOiJmZWRlcmF0aW9uX3VzZXIxIn0---06b4f870d809d82a91433e92eae8320875c3e8b0;" -XPUT 'http://localhost:3000/api/1.2/federations' -d '
{"federations": [
{ "deliveryService": "images-c1",
"mappings":
@@ -271,12 +271,12 @@ Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
<li><p class="first">The resolvers added by the federation user will now visible in Traffic Ops.</p>
</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/federation04.png"><img alt="../../_images/federation04.png" class="align-center" src="../../_images/federation04.png" /></a>
+<a class="reference internal image-reference" href="../../_images/federation04.png"><img alt="../../_images/federation04.png" class="align-center" src="../../_images/federation04.png" style="width: 802.0px; height: 875.0px;" /></a>
<ol class="arabic" start="8">
<li><p class="first">Any requests made from a client that resolves to one of the federation resolvers will now be given a CNAME from Traffic Router.</p>
<blockquote>
<div><p>Example:</p>
-<div class="highlight-python"><div class="highlight"><pre>$ dig @tr.kabletown.net edge.images-c1.kabletown.net
+<div class="highlight-default"><div class="highlight"><pre><span></span>$ dig @tr.kabletown.net edge.images-c1.kabletown.net
; <<>> DiG 9.7.3-RedHat-9.7.3-2.el6 <<>> @tr.kabletown.net edge.images-c1.kabletown.net
; (1 server found)
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/admin/quick_howto/index.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/admin/quick_howto/index.html b/docs/1.7.0/admin/quick_howto/index.html
index 1a6d192..3bcfa76 100644
--- a/docs/1.7.0/admin/quick_howto/index.html
+++ b/docs/1.7.0/admin/quick_howto/index.html
@@ -112,7 +112,7 @@
<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>
<li class="toctree-l2"><a class="reference internal" href="../traffic_vault.html">Traffic Vault Administration</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="">Quick How To Guides</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Quick How To Guides</a></li>
</ul>
</li>
</ul>