Skip to content
This repository was archived by the owner on Nov 24, 2025. It is now read-only.

[Issue 1907] TO API for backup edge cachegroup #2029

Merged
elsloo merged 8 commits into from
Jun 14, 2018
Merged

[Issue 1907] TO API for backup edge cachegroup #2029

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
d4b2b7d
Implements https://github.com/apache/incubator-trafficcontrol/issues/…
Vijay-1 Mar 21, 2018
14aa10b
Moved cachegroup_fallbacks.rst from development/traffic_ops_api/v12/c…
Vijay-1 May 24, 2018
efed1cf
CrConfig's backupLocation Json node generation logic in GoLang
Vijay-1 May 25, 2018
7a902f0
Addressing Rawlin's comment on; 1. Updating the document for cachegro…
Vijay-1 May 25, 2018
85a1067
Addressing Rawlin's comments:
Vijay-1 May 28, 2018
5f65244
Rawlin's comments 1. Adding cache group id for audit logs for DELETE.…
Vijay-1 May 29, 2018
1458808
Rawlins comment - parsing fallback to closest and make sure null is h…
Jun 7, 2018
4174ac1
Rawlins comment on using group by to enforce order which is not handl…
Jun 13, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
- /api/1.3/types `(GET,POST,PUT,DELETE)`
- Fair Queuing Pacing: Using the FQ Pacing Rate parameter in Delivery Services allows operators to limit the rate of individual sessions to the edge cache. This feature requires a Trafficserver RPM containing the fq_pacing experimental plugin AND setting 'fq' as the default Linux qdisc in sysctl.
- Traffic Ops rpm changed to remove world-read permission from configuration files.
- Backup Edge Cache group: If the matched group in the CZF is not available, this list of backup edge cache group configured via Traffic Ops API can be used as backup. In the event of all backup edge cache groups not available, GEO location can be optionally used as further backup. APIs detailed here [here](http://traffic-control-cdn.readthedocs.io/en/latest/development/traffic_ops_api/v12/cachegroup_fallbacks.html)

### Changed
- Reformatted this CHANGELOG file to the keep-a-changelog format
Expand Down
6 changes: 3 additions & 3 deletions docs/source/admin/traffic_router.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ Fields Always Present
+------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------+
|rloc |GeoLocation of result |Latitude and Longitude in Decimal Degrees |
+------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------+
|rdtl |Result Details Associated with unusual conditions |One of DS_NOT_FOUND, DS_NO_BYPASS, DS_BYPASS, DS_CZ_ONLY |
|rdtl |Result Details Associated with unusual conditions |One of DS_NOT_FOUND, DS_NO_BYPASS, DS_BYPASS, DS_CZ_ONLY, DS_CZ_BACKUP_CG |
+------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------+
|rerr |Message about internal Traffic Router Error |String |
+------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------+
Expand Down Expand Up @@ -266,8 +266,8 @@ Fields Always Present
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| "-" |The request was not redirected. This is usually a result of a DNS request to the Traffic Router or an explicit denial for that request. |
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+


|DS_CZ_BACKUP_CG |Traffic Router found a backup cache via fallback (cr-config's edgeLocation) / coordinates (CZF) configuration |
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+


---------------
Expand Down
35 changes: 27 additions & 8 deletions docs/source/api/v12/cachegroup.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Cache Group
/api/1.2/cachegroups
++++++++++++++++++++

**GET /api/1.1/cachegroups**
**GET /api/1.2/cachegroups**

Authentication Required: Yes

Expand Down Expand Up @@ -66,6 +66,8 @@ Cache Group
+-----------------------------------+--------+--------------------------------------------------------------------------+
| ``typeName`` | string | The name of the type of Cache Group entry |
+-----------------------------------+--------+--------------------------------------------------------------------------+
| ``fallbackToClosest`` | bool | Behaviour during non-availability/ failure of configured fallbacks |
+-----------------------------------+--------+--------------------------------------------------------------------------+

**Response Example** ::

Expand All @@ -83,7 +85,8 @@ Cache Group
"secondaryParentCachegroupName": null,
"shortName": "dcchi",
"typeName": "MID_LOC",
"typeId": "4"
"typeId": "4",
"fallbackToClosest":true
},
{
"id": "22",
Expand All @@ -97,7 +100,8 @@ Cache Group
"secondaryParentCachegroupName": null,
"shortName": "dcchi",
"typeName": "MID_LOC",
"typeId": "4"
"typeId": "4",
"fallbackToClosest":false
}
],
}
Expand Down Expand Up @@ -168,6 +172,8 @@ Cache Group
+-----------------------------------+--------+--------------------------------------------------------------------------+
| ``typeName`` | string | The name of the type of Cache Group entry |
+-----------------------------------+--------+--------------------------------------------------------------------------+
| ``fallbackToClosest`` | bool | Behaviour during non-availability/ failure of configured fallbacks |
+-----------------------------------+--------+--------------------------------------------------------------------------+

**Response Example** ::

Expand All @@ -185,7 +191,8 @@ Cache Group
"secondaryParentCachegroupName": null,
"shortName": "dcchi",
"typeName": "MID_LOC",
"typeId": "4"
"typeId": "4",
"fallbackToClosest":true
}
],
}
Expand Down Expand Up @@ -448,6 +455,8 @@ Cache Group
+---------------------------------+----------+-------------------------------------------------------------------+
| ``typeId`` | yes | The type of Cache Group entry, "EDGE_LOC", "MID_LOC" or "ORG_LOC" |
+---------------------------------+----------+-------------------------------------------------------------------+
| ``fallbackToClosest`` | no | Behaviour on configured fallbacks failure, true / false |
+---------------------------------+----------+-------------------------------------------------------------------+

**Request Example** ::

Expand All @@ -457,7 +466,8 @@ Cache Group
"latitude": 12,
"longitude": 45,
"parentCachegroup": "cache_group_mid",
"typeId": 6
"typeId": 6,
"fallbackToClosest":true
}

**Response Properties**
Expand Down Expand Up @@ -485,6 +495,8 @@ Cache Group
+------------------------------------+--------+-------------------------------------------------------------------+
| ``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 |
+------------------------------------+--------+-------------------------------------------------------------------+
| ``lastUpdated`` | string | The Time / Date this entry was last updated |
+------------------------------------+--------+-------------------------------------------------------------------+
| ``alerts`` | array | A collection of alert messages. |
Expand Down Expand Up @@ -514,7 +526,8 @@ Cache Group
'typeName' : 'EDGE_LOC',
'id' : '104',
'parentCachegroupId' : '103',
'secondaryParentCachegroupId' : null
'secondaryParentCachegroupId' : null,
'fallbackToClosest':true
}
}

Expand Down Expand Up @@ -555,6 +568,8 @@ Cache Group
+---------------------------------+----------+-------------------------------------------------------------------+
| ``typeName`` | yes | The type of Cache Group entry, "EDGE_LOC", "MID_LOC" or "ORG_LOC" |
+---------------------------------+----------+-------------------------------------------------------------------+
| ``fallbackToClosest`` | no | Behaviour on configured fallbacks failure, true / false |
+---------------------------------+----------+-------------------------------------------------------------------+

**Request Example** ::

Expand All @@ -564,7 +579,8 @@ Cache Group
"latitude": 12,
"longitude": 45,
"parentCachegroup": "cache_group_mid",
"typeName": "EDGE_LOC"
"typeName": "EDGE_LOC",
"fallbackToClosest":true
}

**Response Properties**
Expand Down Expand Up @@ -592,6 +608,8 @@ Cache Group
+------------------------------------+--------+-------------------------------------------------------------------+
| ``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 |
+------------------------------------+--------+-------------------------------------------------------------------+
| ``lastUpdated`` | string | The Time / Date this entry was last updated |
+------------------------------------+--------+-------------------------------------------------------------------+
| ``alerts`` | array | A collection of alert messages. |
Expand Down Expand Up @@ -621,7 +639,8 @@ Cache Group
'typeName' : 'EDGE_LOC',
'id' : '104',
'parentCachegroupId' : '103',
'secondaryParentCachegroupId' : null
'secondaryParentCachegroupId' : null,
'fallbackToClosest':true
}
}

Expand Down
Loading