You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficcontrol.apache.org by el...@apache.org on 2018/10/05 19:54:33 UTC
[trafficcontrol] 03/05: Update Cachegroup API docs for
localizationMethods
This is an automated email from the ASF dual-hosted git repository.
elsloo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/trafficcontrol.git
commit 8c2a2f51bf0f984483e33f88be6525e38594b387
Author: Rawlin Peters <ra...@comcast.com>
AuthorDate: Tue Aug 14 14:20:38 2018 -0600
Update Cachegroup API docs for localizationMethods
---
CHANGELOG.md | 1 +
docs/source/api/v12/cachegroup.rst | 89 ++++++++++++++++++++++++++++----------
2 files changed, 66 insertions(+), 24 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 7ae2606..9f4ffdd 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -18,6 +18,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
- Cachegroup-Coordinate Refactor: The Cachegroup API now creates/updates a Coordinate entity on Cachegroup creates/updates, and the `latitude` and `longitude` columns in the `cachegroup` table have been replaced with `coordinate` (a foreign key to Coordinate). Coordinates created from Cachegroups are given the name `from_cachegroup_\<cachegroup name\>`.
- Geolocation-based Client Steering: two new steering target types are available to use for `CLIENT_STEERING` delivery services: `STEERING_GEO_ORDER` and `STEERING_GEO_WEIGHT`. When targets of these types have an Origin with a Coordinate, Traffic Router will order and prioritize them based upon the shortest total distance from client -> edge -> origin. Co-located targets are grouped together and can be weighted or ordered within the same location using `STEERING_GEO_WEIGHT` or `STEERING_ [...]
- Tenancy is now the default behavior in Traffic Ops. All database entries that reference a tenant now have a default of the root tenant. This eliminates the need for the `use_tenancy` global parameter and will allow for code to be simplified as a result. If all user and delivery services reference the root tenant, then there will be no difference from having `use_tenancy` set to 0.
+- Cachegroup Localization Methods: The Cachegroup API now supports an optional `localizationMethods` field which specifies the localization methods allowed for that cachegroup (currently 'DEEP_CZ', 'CZ', and 'GEO'). By default if this field is null/empty, all localization methods are enabled. After Traffic Router has localized a client, it will only route that client to cachegroups that have enabled the localization method used. For example, this can be used to prevent GEO-localized traf [...]
- Traffic Monitor Client Update: Traffic Monitor is updated to use the Traffic Ops v13 client.
- Removed previously deprecated `traffic_monitor_java`
- Added `infrastructure/cdn-in-a-box` for Apachecon 2018 demonstration
diff --git a/docs/source/api/v12/cachegroup.rst b/docs/source/api/v12/cachegroup.rst
index 2c6d8f9..aba7f4d 100644
--- a/docs/source/api/v12/cachegroup.rst
+++ b/docs/source/api/v12/cachegroup.rst
@@ -60,6 +60,8 @@ Cache Group
+-----------------------------------+--------+--------------------------------------------------------------------------+
| ``secondaryParentCachegroupName`` | string | Secondary parent cachegroup name. |
+-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``localizationMethods`` | array | Array of enabled localization methods (as strings) |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
| ``shortName`` | string | Abbreviation of the Cache Group Name |
+-----------------------------------+--------+--------------------------------------------------------------------------+
| ``typeId`` | string | Unique identifier for the 'Type' of Cache Group entry |
@@ -86,6 +88,11 @@ Cache Group
"shortName": "dcchi",
"typeName": "MID_LOC",
"typeId": "4",
+ "localizationMethods": [
+ "DEEP_CZ",
+ "CZ",
+ "GEO"
+ ],
"fallbackToClosest":true
},
{
@@ -101,6 +108,7 @@ Cache Group
"shortName": "dcchi",
"typeName": "MID_LOC",
"typeId": "4",
+ "localizationMethods": null,
"fallbackToClosest":false
}
],
@@ -166,6 +174,8 @@ Cache Group
+-----------------------------------+--------+--------------------------------------------------------------------------+
| ``secondaryParentCachegroupName`` | string | Secondary parent cachegroup name. |
+-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``localizationMethods`` | array | Array of enabled localization methods (as strings) |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
| ``shortName`` | string | Abbreviation of the Cache Group Name |
+-----------------------------------+--------+--------------------------------------------------------------------------+
| ``typeId`` | string | Unique identifier for the 'Type' of Cache Group entry |
@@ -189,6 +199,11 @@ Cache Group
"parentCachegroupName": null,
"secondaryParentCachegroupId": null,
"secondaryParentCachegroupName": null,
+ "localizationMethods": [
+ "DEEP_CZ",
+ "CZ",
+ "GEO"
+ ],
"shortName": "dcchi",
"typeName": "MID_LOC",
"typeId": "4",
@@ -453,6 +468,8 @@ Cache Group
+---------------------------------+----------+-------------------------------------------------------------------+
| ``secondaryParentCachegroup`` | no | Name of Secondary Parent Cache Group entry. |
+---------------------------------+----------+-------------------------------------------------------------------+
+ | ``localizationMethods`` | no | Array of enabled localization methods (as strings) |
+ +---------------------------------+----------+-------------------------------------------------------------------+
| ``typeId`` | yes | The type of Cache Group entry, "EDGE_LOC", "MID_LOC" or "ORG_LOC" |
+---------------------------------+----------+-------------------------------------------------------------------+
| ``fallbackToClosest`` | no | Behaviour on configured fallbacks failure, true / false |
@@ -466,6 +483,10 @@ Cache Group
"latitude": 12,
"longitude": 45,
"parentCachegroup": "cache_group_mid",
+ "localizationMethods": [
+ "CZ",
+ "GEO"
+ ],
"typeId": 6,
"fallbackToClosest":true
}
@@ -493,6 +514,8 @@ Cache Group
+------------------------------------+--------+-------------------------------------------------------------------+
| ``secondaryParentCachegroupId`` | string | id of Secondary Parent Cache Group entry. |
+------------------------------------+--------+-------------------------------------------------------------------+
+ | ``localizationMethods`` | array | Array of enabled localization methods (as strings) |
+ +------------------------------------+--------+-------------------------------------------------------------------+
| ``typeName`` | string | The type of Cache Group entry, "EDGE_LOC", "MID_LOC" or "ORG_LOC" |
+------------------------------------+--------+-------------------------------------------------------------------+
| ``fallbackToClosest`` | bool | Behaviour during non-availability/failure of configured fallbacks |
@@ -516,18 +539,22 @@ Cache Group
}
],
"response": {
- 'longitude' : '45',
- 'lastUpdated' : '2016-01-25 13:55:30',
- 'shortName' : 'cg_edge',
- 'name' : 'cache_group_edge',
- 'parentCachegroup' : 'cache_group_mid',
- 'secondaryParentCachegroup' : null,
- 'latitude' : '12',
- 'typeName' : 'EDGE_LOC',
- 'id' : '104',
- 'parentCachegroupId' : '103',
- 'secondaryParentCachegroupId' : null,
- 'fallbackToClosest':true
+ "longitude" : "45",
+ "lastUpdated" : "2016-01-25 13:55:30",
+ "shortName" : "cg_edge",
+ "name" : "cache_group_edge",
+ "parentCachegroup" : "cache_group_mid",
+ "secondaryParentCachegroup" : null,
+ "latitude" : "12",
+ "localizationMethods": [
+ "CZ",
+ "GEO"
+ ],
+ "typeName" : "EDGE_LOC",
+ "id" : "104",
+ "parentCachegroupId" : "103",
+ "secondaryParentCachegroupId" : null,
+ "fallbackToClosest":true
}
}
@@ -566,6 +593,8 @@ Cache Group
+---------------------------------+----------+-------------------------------------------------------------------+
| ``secondaryParentCachegroup`` | no | Name of Secondary Parent Cache Group entry. |
+---------------------------------+----------+-------------------------------------------------------------------+
+ | ``localizationMethods`` | no | Array of enabled localization methods (as strings) |
+ +---------------------------------+----------+-------------------------------------------------------------------+
| ``typeName`` | yes | The type of Cache Group entry, "EDGE_LOC", "MID_LOC" or "ORG_LOC" |
+---------------------------------+----------+-------------------------------------------------------------------+
| ``fallbackToClosest`` | no | Behaviour on configured fallbacks failure, true / false |
@@ -580,6 +609,11 @@ Cache Group
"longitude": 45,
"parentCachegroup": "cache_group_mid",
"typeName": "EDGE_LOC",
+ "localizationMethods": [
+ "DEEP_CZ",
+ "CZ",
+ "GEO"
+ ],
"fallbackToClosest":true
}
@@ -606,6 +640,8 @@ Cache Group
+------------------------------------+--------+-------------------------------------------------------------------+
| ``secondaryParentCachegroupId`` | string | id of Secondary Parent Cache Group entry. |
+------------------------------------+--------+-------------------------------------------------------------------+
+ | ``localizationMethods`` | array | Array of enabled localization methods (as strings) |
+ +------------------------------------+--------+-------------------------------------------------------------------+
| ``typeName`` | string | The type of Cache Group entry, "EDGE_LOC", "MID_LOC" or "ORG_LOC" |
+------------------------------------+--------+-------------------------------------------------------------------+
| ``fallbackToClosest`` | bool | Behaviour during non-availability/failure of configured fallbacks |
@@ -629,18 +665,23 @@ Cache Group
}
],
"response": {
- 'longitude' : '45',
- 'lastUpdated' : '2016-01-25 13:55:30',
- 'shortName' : 'cg_edge',
- 'name' : 'cache_group_edge',
- 'parentCachegroup' : 'cache_group_mid',
- 'secondaryParentCachegroup' : null,
- 'latitude' : '12',
- 'typeName' : 'EDGE_LOC',
- 'id' : '104',
- 'parentCachegroupId' : '103',
- 'secondaryParentCachegroupId' : null,
- 'fallbackToClosest':true
+ "longitude" : "45",
+ "lastUpdated" : "2016-01-25 13:55:30",
+ "shortName" : "cg_edge",
+ "name" : "cache_group_edge",
+ "parentCachegroup" : "cache_group_mid",
+ "secondaryParentCachegroup" : null,
+ "localizationMethods": [
+ "DEEP_CZ",
+ "CZ",
+ "GEO"
+ ],
+ "latitude" : "12",
+ "typeName" : "EDGE_LOC",
+ "id" : "104",
+ "parentCachegroupId" : "103",
+ "secondaryParentCachegroupId" : null,
+ "fallbackToClosest":true
}
}