http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/45597d7d/docs/latest/_sources/development/traffic_ops_api/v12/deliveryservice.txt ---------------------------------------------------------------------- diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/deliveryservice.txt b/docs/latest/_sources/development/traffic_ops_api/v12/deliveryservice.txt index c1100dd..6ceb1d7 100644 --- a/docs/latest/_sources/development/traffic_ops_api/v12/deliveryservice.txt +++ b/docs/latest/_sources/development/traffic_ops_api/v12/deliveryservice.txt @@ -132,8 +132,6 @@ Delivery Service +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` | +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ - | ``multiSiteOriginAlgor`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` | - +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ | ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the | | | | protocol (http:// or https://) for use in retrieving content from the origin server. | +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ @@ -199,9 +197,6 @@ Delivery Service "dnsBypassTtl": "30", "dscp": "40", "edgeHeaderRewrite": null, - "exampleURLs": [ - "http://edge.foo-ds.foo.bar.net"; - ], "geoLimit": "0", "geoLimitCountries": null, "geoLimitRedirectURL": null, @@ -230,7 +225,6 @@ Delivery Service "missLat": "41.881944", "missLong": "-87.627778", "multiSiteOrigin": false, - "multiSiteOriginAlgorithm": null, "orgServerFqdn": "http://baz.boo.net";, "originShield": null, "profileDescription": "Content Router for over-the-top", @@ -367,8 +361,6 @@ Delivery Service +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` | +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ - | ``multiSiteOriginAlgor`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` | - +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ | ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the | | | | protocol (http:// or https://) for use in retrieving content from the origin server. | +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ @@ -465,7 +457,6 @@ Delivery Service "missLat": "41.881944", "missLong": "-87.627778", "multiSiteOrigin": false, - "multiSiteOriginAlgorithm": null, "orgServerFqdn": "http://baz.boo.net";, "originShield": null, "profileDescription": "Content Router for over-the-top",
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/45597d7d/docs/latest/_sources/development/traffic_ops_api/v12/deliveryservice_regex.txt ---------------------------------------------------------------------- diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/deliveryservice_regex.txt b/docs/latest/_sources/development/traffic_ops_api/v12/deliveryservice_regex.txt new file mode 100644 index 0000000..16697ec --- /dev/null +++ b/docs/latest/_sources/development/traffic_ops_api/v12/deliveryservice_regex.txt @@ -0,0 +1,374 @@ +.. +.. +.. 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-ds-regexes: + +Delivery Service Regexes +======================== + +.. _to-api-v12-ds-regexes-route: + + +**GET /api/1.2/deliveryservices_regexes** + + Retrieves regexes for all delivery services. + + Authentication Required: Yes + + Role(s) Required: Admin or Oper + + **Response Properties** + + +------------------+--------+-------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==================+========+=========================================================================+ + | ``dsName`` | array | Delivery service name. | + +------------------+--------+-------------------------------------------------------------------------+ + | ``regexes`` | array | An array of regexes for the delivery service. | + +------------------+--------+-------------------------------------------------------------------------+ + | ``>type`` | string | The regex type. | + +------------------+--------+-------------------------------------------------------------------------+ + | ``>pattern`` | string | The regex pattern. | + +------------------+--------+-------------------------------------------------------------------------+ + | ``>setNumber`` | string | The order in which the regex is evaluated. | + +------------------+--------+-------------------------------------------------------------------------+ + + **Response Example** :: + + { + "response": [ + { + "dsName": "foo-bar", + "regexes": [ + { + "type": "HOST_REGEXP", + "pattern": ".*\.foo-bar\..*", + "setNumber": 0 + }, + { + "type": "HOST_REGEXP", + "pattern": "foo.bar.com", + "setNumber": 1 + } + ] + }, + { ... } + ] + } + +| + +**GET /api/1.2/deliveryservices/{:dsId}/regexes** + + Retrieves regexes for a specific delivery service. + + Authentication Required: Yes + + Role(s) Required: None + + **Request Route Parameters** + + +-----------+----------+---------------------------------------------+ + | Name | Required | Description | + +===========+==========+=============================================+ + | ``dsId`` | yes | Delivery service id. | + +-----------+----------+---------------------------------------------+ + + **Response Properties** + + +------------------+--------+-------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==================+========+=========================================================================+ + | ``id`` | string | Delivery service regex ID. | + +------------------+--------+-------------------------------------------------------------------------+ + | ``type`` | string | Delivery service regex type ID. | + +------------------+--------+-------------------------------------------------------------------------+ + | ``typeName`` | string | Delivery service regex type name. | + +------------------+--------+-------------------------------------------------------------------------+ + | ``pattern`` | string | Delivery service regex pattern. | + +------------------+--------+-------------------------------------------------------------------------+ + | ``setNumber`` | string | The order in which the regex is evaluated for the delivery service. | + +------------------+--------+-------------------------------------------------------------------------+ + + **Response Example** :: + + { + "response": [ + { + "id": 852, + "type": 18, + "typeName": "HOST_REGEXP", + "pattern": ".*\.foo-bar\..*", + "setNumber": 0 + }, + { + "id": 853, + "type": 18, + "typeName": "HOST_REGEXP", + "pattern": "foo.bar.com", + "setNumber": 1 + } + ] + } + +| + +**GET /api/1.2/deliveryservices/{:dsId}/regexes/{:id}** + + Retrieves a regex for a specific delivery service. + + Authentication Required: Yes + + Role(s) Required: None + + **Request Route Parameters** + + +-----------+----------+---------------------------------------------+ + | Name | Required | Description | + +===========+==========+=============================================+ + | ``dsId`` | yes | Delivery service id. | + +-----------+----------+---------------------------------------------+ + | ``id`` | yes | Delivery service regex id. | + +-----------+----------+---------------------------------------------+ + + **Response Properties** + + +------------------+--------+-------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==================+========+=========================================================================+ + | ``id`` | string | Delivery service regex ID. | + +------------------+--------+-------------------------------------------------------------------------+ + | ``type`` | string | Delivery service regex type ID. | + +------------------+--------+-------------------------------------------------------------------------+ + | ``typeName`` | string | Delivery service regex type name. | + +------------------+--------+-------------------------------------------------------------------------+ + | ``pattern`` | string | Delivery service regex pattern. | + +------------------+--------+-------------------------------------------------------------------------+ + | ``setNumber`` | string | The order in which the regex is evaluated for the delivery service. | + +------------------+--------+-------------------------------------------------------------------------+ + + **Response Example** :: + + { + "response": [ + { + "id": 852, + "type": 18, + "typeName": "HOST_REGEXP" + "pattern": ".*\.foo-bar\..*", + "setNumber": 0 + } + ] + } + +| + +**POST /api/1.2/deliveryservices/{:dsId}/regexes** + + Create a regex for a delivery service. + + Authentication Required: Yes + + Role(s) Required: Admin or Oper + + **Request Route Parameters** + + +-----------+----------+---------------------------------------------+ + | Name | Required | Description | + +===========+==========+=============================================+ + | ``dsId`` | yes | Delivery service id. | + +-----------+----------+---------------------------------------------+ + + **Request Properties** + + +---------------+----------+---------------------------------------------+ + | Parameter | Required | Description | + +===============+==========+=============================================+ + | ``pattern`` | yes | Regex pattern. | + +---------------+----------+---------------------------------------------+ + | ``type`` | yes | Regex type ID. | + +---------------+----------+---------------------------------------------+ + | ``setNumber`` | yes | Regex type ID. | + +---------------+----------+---------------------------------------------+ + + **Request Example** :: + + { + "pattern": ".*\.foo-bar\..*" + "type": 18 + "setNumber": 0 + } + +| + + **Response Properties** + + +------------------+--------+-------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==================+========+=========================================================================+ + | ``id`` | string | Delivery service regex ID. | + +------------------+--------+-------------------------------------------------------------------------+ + | ``type`` | string | Delivery service regex type ID. | + +------------------+--------+-------------------------------------------------------------------------+ + | ``typeName`` | string | Delivery service regex type name. | + +------------------+--------+-------------------------------------------------------------------------+ + | ``pattern`` | string | Delivery service regex pattern. | + +------------------+--------+-------------------------------------------------------------------------+ + | ``setNumber`` | string | The order in which the regex is evaluated for the delivery service. | + +------------------+--------+-------------------------------------------------------------------------+ + + **Response Example** :: + + { + "response":{ + "id": 852, + "type": 18, + "typeName": "HOST_REGEXP" + "pattern": ".*\.foo-bar\..*", + "setNumber": 0 + }, + "alerts":[ + { + "level": "success", + "text": "Delivery service regex creation was successful." + } + ] + } + +| + +**PUT /api/1.2/deliveryservices/{:dsId}/regexes/{:id}** + + Update a regex for a delivery service. + + Authentication Required: Yes + + Role(s) Required: Admin or Oper + + **Request Route Parameters** + + +-----------+----------+---------------------------------------------+ + | Name | Required | Description | + +===========+==========+=============================================+ + | ``dsId`` | yes | Delivery service id. | + +-----------+----------+---------------------------------------------+ + | ``id`` | yes | Delivery service regex id. | + +-----------+----------+---------------------------------------------+ + + **Request Properties** + + +---------------+----------+---------------------------------------------+ + | Parameter | Required | Description | + +===============+==========+=============================================+ + | ``pattern`` | yes | Regex pattern. | + +---------------+----------+---------------------------------------------+ + | ``type`` | yes | Regex type ID. | + +---------------+----------+---------------------------------------------+ + | ``setNumber`` | yes | Regex type ID. | + +---------------+----------+---------------------------------------------+ + + **Request Example** :: + + { + "pattern": ".*\.foo-bar\..*" + "type": 18 + "setNumber": 0 + } + +| + + **Response Properties** + + +------------------+--------+-------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==================+========+=========================================================================+ + | ``id`` | string | Delivery service regex ID. | + +------------------+--------+-------------------------------------------------------------------------+ + | ``type`` | string | Delivery service regex type ID. | + +------------------+--------+-------------------------------------------------------------------------+ + | ``typeName`` | string | Delivery service regex type name. | + +------------------+--------+-------------------------------------------------------------------------+ + | ``pattern`` | string | Delivery service regex pattern. | + +------------------+--------+-------------------------------------------------------------------------+ + | ``setNumber`` | string | The order in which the regex is evaluated for the delivery service. | + +------------------+--------+-------------------------------------------------------------------------+ + + **Response Example** :: + + { + "response":{ + "id": 852, + "type": 18, + "typeName": "HOST_REGEXP" + "pattern": ".*\.foo-bar\..*", + "setNumber": 0 + }, + "alerts":[ + { + "level": "success", + "text": "Delivery service regex update was successful." + } + ] + } + +| + +**DELETE /api/1.2/deliveryservices/{:dsId}/regexes/{:id}** + + Delete delivery service regex. + + Authentication Required: Yes + + Role(s) Required: Admin or Oper + + **Request Route Parameters** + + +-----------+----------+---------------------------------------------+ + | Name | Required | Description | + +===========+==========+=============================================+ + | ``dsId`` | yes | Delivery service id. | + +-----------+----------+---------------------------------------------+ + | ``id`` | yes | Delivery service regex id. | + +-----------+----------+---------------------------------------------+ + + **Response Properties** + + +-------------+--------+----------------------------------+ + | Parameter | Type | Description | + +=============+========+==================================+ + | ``alerts`` | array | A collection of alert messages. | + +-------------+--------+----------------------------------+ + | ``>level`` | string | Success, info, warning or error. | + +-------------+--------+----------------------------------+ + | ``>text`` | string | Alert message. | + +-------------+--------+----------------------------------+ + + **Response Example** :: + + { + "alerts": [ + { + "level": "success", + "text": "Delivery service regex delete was successful." + } + ], + } + +| + + + + http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/45597d7d/docs/latest/_sources/development/traffic_ops_api/v12/profile.txt ---------------------------------------------------------------------- diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/profile.txt b/docs/latest/_sources/development/traffic_ops_api/v12/profile.txt index bec8f9f..72e3583 100644 --- a/docs/latest/_sources/development/traffic_ops_api/v12/profile.txt +++ b/docs/latest/_sources/development/traffic_ops_api/v12/profile.txt @@ -35,7 +35,9 @@ Profiles +---------------+----------+----------------------------------------------------+ | Name | Required | Description | +===============+==========+====================================================+ - | ``param`` | no | Used to filter profiles by parameter. | + | ``param`` | no | Used to filter profiles by parameter ID. | + +---------------+----------+----------------------------------------------------+ + | ``cdn`` | no | Used to filter profiles by CDN ID. | +---------------+----------+----------------------------------------------------+ **Response Properties** @@ -43,24 +45,33 @@ Profiles +-----------------+--------+----------------------------------------------------+ | Parameter | Type | Description | +=================+========+====================================================+ - | ``lastUpdated`` | array | The Time / Date this server entry was last updated | + | ``id`` | string | Primary key | +-----------------+--------+----------------------------------------------------+ | ``name`` | string | The name for the profile | +-----------------+--------+----------------------------------------------------+ - | ``id`` | string | Primary key | - +-----------------+--------+----------------------------------------------------+ | ``description`` | string | The description for the profile | +-----------------+--------+----------------------------------------------------+ + | ``cdn`` | int | The CDN ID | + +-----------------+--------+----------------------------------------------------+ + | ``cdnName`` | string | The CDN name | + +-----------------+--------+----------------------------------------------------+ + | ``type`` | string | Profile type | + +-----------------+--------+----------------------------------------------------+ + | ``lastUpdated`` | array | The Time / Date this server entry was last updated | + +-----------------+--------+----------------------------------------------------+ **Response Example** :: { "response": [ { - "lastUpdated": "2012-10-08 19:34:45", - "name": "CCR_TOP", "id": "8", - "description": "Content Router for top.foobar.net" + "name": "EDGE_27_PROFILE", + "description": "A profile with all the Foo parameters" + "cdn": 1 + "cdnName": "cdn1" + "type": "ATS_PROFILE" + "lastUpdated": "2012-10-08 19:34:45", } ] } @@ -86,7 +97,7 @@ Profiles { "response": [ { - "name": "CCR_TOP" + "name": "EDGE_27_PROFILE" } ] } @@ -112,24 +123,33 @@ Profiles +-----------------+--------+----------------------------------------------------+ | Parameter | Type | Description | +=================+========+====================================================+ - | ``lastUpdated`` | array | The Time / Date this server entry was last updated | + | ``id`` | string | Primary key | +-----------------+--------+----------------------------------------------------+ | ``name`` | string | The name for the profile | +-----------------+--------+----------------------------------------------------+ - | ``id`` | string | Primary key | - +-----------------+--------+----------------------------------------------------+ | ``description`` | string | The description for the profile | +-----------------+--------+----------------------------------------------------+ + | ``cdn`` | int | The CDN ID | + +-----------------+--------+----------------------------------------------------+ + | ``cdnName`` | string | The CDN name | + +-----------------+--------+----------------------------------------------------+ + | ``type`` | string | Profile type | + +-----------------+--------+----------------------------------------------------+ + | ``lastUpdated`` | array | The Time / Date this server entry was last updated | + +-----------------+--------+----------------------------------------------------+ **Response Example** :: { "response": [ { - "lastUpdated": "2012-10-08 19:34:45", - "name": "CCR_TOP", "id": "8", - "description": "Content Router for top.foobar.net" + "name": "EDGE_27_PROFILE", + "description": "A profile with all the Foo parameters" + "cdn": 1 + "cdnName": "cdn1" + "type": "ATS_PROFILE" + "lastUpdated": "2012-10-08 19:34:45", } ] } @@ -138,7 +158,7 @@ Profiles **POST /api/1.2/profiles** - Create a new empty profile. + Create a new empty profile. Authentication Required: Yes @@ -146,19 +166,26 @@ Profiles **Request Properties** - +-----------------------+--------+----------------------------------------------------+ - | Parameter | Type | Description | - +=======================+========+====================================================+ - | ``name`` | string | The name of the new profile | - +-----------------------+--------+----------------------------------------------------+ - | ``description`` | string | new profile description | - +-----------------------+--------+----------------------------------------------------+ + +-----------------------+--------+----------+-----------------------------------------+ + | Parameter | Type | Required | Description | + +=======================+========+==========+=========================================+ + | ``name`` | string | yes | Profile name | + +-----------------------+--------+----------+-----------------------------------------+ + | ``description`` | string | yes | Profile description | + +-----------------------+--------+----------+-----------------------------------------+ + | ``cdn`` | int | no | CDN ID | + +-----------------------+--------+----------+-----------------------------------------+ + | ``type`` | string | yes | Profile type | + +-----------------------+--------+----------+-----------------------------------------+ + **Request Example** :: { - "name": "CCR_COPY", - "description": "CCR_COPY description", + "name": "EDGE_28_PROFILE", + "description": "EDGE_28_PROFILE description", + "cdn": 1, + "type": "ATS_PROFILE" } | @@ -168,11 +195,15 @@ Profiles +-----------------------+--------+----------------------------------------------------+ | Parameter | Type | Description | +=======================+========+====================================================+ - | ``id`` | string | Id of the new profile | + | ``id`` | string | Profile ID | +-----------------------+--------+----------------------------------------------------+ - | ``name`` | string | The name of the new profile | + | ``name`` | string | Profile name | + +-----------------------+--------+----------------------------------------------------+ + | ``description`` | string | Profile description | +-----------------------+--------+----------------------------------------------------+ - | ``description`` | string | new profile description | + | ``cdn`` | int | CDN ID | + +-----------------------+--------+----------------------------------------------------+ + | ``type`` | string | Profile type | +-----------------------+--------+----------------------------------------------------+ **Response Example** :: @@ -181,8 +212,10 @@ Profiles "response": [ { "id": "66", - "name": "CCR_COPY", - "description": "CCR_COPY description", + "name": "EDGE_28_PROFILE", + "description": "EDGE_28_PROFILE description", + "cdn": 1, + "type": "ATS_PROFILE" } ] } @@ -257,50 +290,52 @@ Profiles **Request Properties** - +-----------------+----------+---------------------------------------------------+ - | Parameter | Required | Description | - +=================+==========+===================================================+ - | ``name`` | yes | The new name for the profile. | - +-----------------+----------+---------------------------------------------------+ - | ``description`` | yes | The new description for the profile. | - +-----------------+----------+---------------------------------------------------+ + +-----------------------+--------+----------+-----------------------------------------+ + | Parameter | Type | Required | Description | + +=======================+========+==========+=========================================+ + | ``name`` | string | yes | Profile name | + +-----------------------+--------+----------+-----------------------------------------+ + | ``description`` | string | yes | Profile description | + +-----------------------+--------+----------+-----------------------------------------+ + | ``cdn`` | int | no | CDN ID | + +-----------------------+--------+----------+-----------------------------------------+ + | ``type`` | string | yes | Profile type | + +-----------------------+--------+----------+-----------------------------------------+ **Request Example** :: { - "name": "CCR_UPDATE", - "description": "CCR_UPDATE description" + "name": "EDGE_28_PROFILE", + "description": "EDGE_28_PROFILE description", + "cdn": 1, + "type": "ATS_PROFILE" } **Response Properties** - +------------------+--------+----------------------------------+ - | Parameter | Type | Description | - +==================+========+==================================+ - | ``response`` | | The updated profile info. | - +------------------+--------+----------------------------------+ - | ``>id`` | string | Profile id. | - +------------------+--------+----------------------------------+ - | ``>name`` | string | Profile name. | - +------------------+--------+----------------------------------+ - | ``>description`` | string | Profile description. | - +------------------+--------+----------------------------------+ - | ``alerts`` | array | A collection of alert messages. | - +------------------+--------+----------------------------------+ - | ``>level`` | string | success, info, warning or error. | - +------------------+--------+----------------------------------+ - | ``>text`` | string | Alert message. | - +------------------+--------+----------------------------------+ - | ``version`` | string | | - +------------------+--------+----------------------------------+ + +-----------------------+--------+----------------------------------------------------+ + | Parameter | Type | Description | + +=======================+========+====================================================+ + | ``id`` | string | Profile ID | + +-----------------------+--------+----------------------------------------------------+ + | ``name`` | string | Profile name | + +-----------------------+--------+----------------------------------------------------+ + | ``description`` | string | Profile description | + +-----------------------+--------+----------------------------------------------------+ + | ``cdn`` | int | CDN ID | + +-----------------------+--------+----------------------------------------------------+ + | ``type`` | string | Profile type | + +-----------------------+--------+----------------------------------------------------+ **Response Example** :: { "response":{ "id": "219", - "name": "CCR_UPDATE", - "description": "CCR_UPDATE description" + "name": "EDGE_28_PROFILE", + "description": "EDGE_28_PROFILE description" + "cdn": 1 + "type": "ATS_PROFILE" } "alerts":[ { http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/45597d7d/docs/latest/_sources/development/traffic_ops_api/v12/server.txt ---------------------------------------------------------------------- diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/server.txt b/docs/latest/_sources/development/traffic_ops_api/v12/server.txt index 2a08586..d49fc75 100644 --- a/docs/latest/_sources/development/traffic_ops_api/v12/server.txt +++ b/docs/latest/_sources/development/traffic_ops_api/v12/server.txt @@ -889,7 +889,7 @@ Server +----------------+----------+------------------------------------------------+ | interfaceName | yes | | +----------------+----------+------------------------------------------------+ - | ipAddress | yes | | + | ipAddress | yes | Must be unique per server profile. | +----------------+----------+------------------------------------------------+ | ipNetmask | yes | | +----------------+----------+------------------------------------------------+ @@ -913,7 +913,7 @@ Server +----------------+----------+------------------------------------------------+ | xmppPasswd | no | | +----------------+----------+------------------------------------------------+ - | ip6Address | no | | + | ip6Address | no | Must be unique per server profile. | +----------------+----------+------------------------------------------------+ | ip6Gateway | no | | +----------------+----------+------------------------------------------------+ @@ -1095,7 +1095,7 @@ Server +----------------+----------+------------------------------------------------+ | interfaceName | yes | | +----------------+----------+------------------------------------------------+ - | ipAddress | yes | | + | ipAddress | yes | Must be unique per server profile. | +----------------+----------+------------------------------------------------+ | ipNetmask | yes | | +----------------+----------+------------------------------------------------+ @@ -1119,7 +1119,7 @@ Server +----------------+----------+------------------------------------------------+ | xmppPasswd | no | | +----------------+----------+------------------------------------------------+ - | ip6Address | no | | + | ip6Address | no | Must be unique per server profile. | +----------------+----------+------------------------------------------------+ | ip6Gateway | no | | +----------------+----------+------------------------------------------------+ http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/45597d7d/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..afdcaa7 --- /dev/null +++ b/docs/latest/_sources/development/traffic_ops_api/v12/tenant.txt @@ -0,0 +1,242 @@ +.. +.. +.. 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 | + +----------------------+--------+-------------------------------------------------+ + + **Response Example** :: + + { + "response": [ + { + "id": 1 + "name": "root", + "active": true, + "parentId": null, + }, + { + "id": 2 + "name": "tenant-a", + "active": true, + "parentId": 1 + } + ] + } + +| + + +**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 | + +----------------------+--------+-------------------------------------------------+ + + **Response Example** :: + + { + "response": [ + { + "id": 2 + "name": "tenant-a", + "active": true, + "parentId": 1, + } + ] + } + +| + + +**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 | + +----------------------+--------+-------------------------------------------------+ + + **Response Example** :: + + { + "response": { + "id": 2, + "name": "my-tenant", + "active": true, + "parentId": 1, + "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 | + +----------------------+--------+-------------------------------------------------+ + + **Response Example** :: + + { + "response": { + "id": 2, + "name": "your-tenant", + "active": false, + "parentId": 2, + "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/45597d7d/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/45597d7d/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/45597d7d/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/45597d7d/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/45597d7d/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/45597d7d/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/45597d7d/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/45597d7d/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/45597d7d/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/45597d7d/docs/latest/admin/index.html ---------------------------------------------------------------------- diff --git a/docs/latest/admin/index.html b/docs/latest/admin/index.html index 18d4174..98e2001 100644 --- a/docs/latest/admin/index.html +++ b/docs/latest/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> @@ -238,7 +238,8 @@ <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#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> @@ -337,6 +338,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> http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/45597d7d/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..69775c1 100644 --- a/docs/latest/admin/quick_howto/dnssec.html +++ b/docs/latest/admin/quick_howto/dnssec.html @@ -36,7 +36,7 @@ <link rel="top" title="Traffic Control master 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> @@ -180,7 +180,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 +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> @@ -249,7 +249,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> http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/45597d7d/docs/latest/admin/quick_howto/federations.html ---------------------------------------------------------------------- diff --git a/docs/latest/admin/quick_howto/federations.html b/docs/latest/admin/quick_howto/federations.html index 76f6922..a02454a 100644 --- a/docs/latest/admin/quick_howto/federations.html +++ b/docs/latest/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/45597d7d/docs/latest/admin/quick_howto/index.html ---------------------------------------------------------------------- diff --git a/docs/latest/admin/quick_howto/index.html b/docs/latest/admin/quick_howto/index.html index bc369ed..3f44492 100644 --- a/docs/latest/admin/quick_howto/index.html +++ b/docs/latest/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> @@ -190,6 +190,7 @@ <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="multi_site.html">Configure Multi Site Origin</a></li> +<li class="toctree-l1"><a class="reference internal" href="multi_site_ats5.html">Configure Multi Site Origin (5.x)</a></li> <li class="toctree-l1"><a class="reference internal" href="dnssec.html">Configure DNSSEC</a></li> <li class="toctree-l1"><a class="reference internal" href="federations.html">Configure Federations</a></li> <li class="toctree-l1"><a class="reference internal" href="regionalgeo.html">Configure Regional Geo-blocking (RGB)</a></li>
