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

Added Cache Groups overview section #4154

Merged
mitchell852 merged 2 commits into from
Dec 11, 2019
Merged

Added Cache Groups overview section #4154

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fd6f410
Added Cache Groups overview section
ocket8888 Dec 3, 2019
734f9bc
Fixed DEEP_CZ description
ocket8888 Dec 11, 2019
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
16 changes: 8 additions & 8 deletions docs/source/admin/traffic_portal/usingtrafficportal.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ A table showing the results of the periodic :ref:`to-check-ext` that are run. Th

:Profile: :ref:`profile-name` of the :term:`Profile` applied to the Edge-tier or Mid-tier :term:`cache server`, or the special name "ALL" indicating that this row is a group of all :term:`cache servers` within a single :term:`Cache Group`
:Host: 'ALL' for entries grouped by :term:`Cache Group`, or the hostname of a particular :term:`cache server`
:Cache Group: Name of the :term:`Cache Group` to which this server belongs, or the name of the :term:`Cache Group` that is grouped for entries grouped by :term:`Cache Group`, or the special name "ALL" indicating that this row is an aggregate across all :term:`Cache Groups`
:Cache Group: :ref:`Name of the Cache Group <cache-group-name>` to which this server belongs, or the name of the :term:`Cache Group` that is grouped for entries grouped by :term:`Cache Group`, or the special name "ALL" indicating that this row is an aggregate across all :term:`Cache Groups`
:Healthy: True/False as determined by Traffic Monitor

.. seealso:: :ref:`health-proto`
Expand Down Expand Up @@ -362,7 +362,7 @@ A configurable table of all servers (of all kinds) across all :term:`Delivery Se

Use the `Select Columns` menu to select the server columns to view and search. Columns can also be rearranged using drag-and-drop. Available server columns include:

:Cache Group: [Visible by default] The name of the :term:`Cache Group` to which this server belongs
:Cache Group: [Visible by default] The :ref:`Name of the Cache Group <cache-group-name>` to which this server belongs
:CDN: [Visible by default] The name of the CDN to which the server belongs
:Domain: [Visible by default] The domain part of the server's :abbr:`FQDN (Fully Qualified Domain Name)`
:Host: [Visible by default] The (short) hostname of the server
Expand Down Expand Up @@ -437,7 +437,7 @@ A table of all :term:`origins`. These are automatically created for the :term:`o
.. note:: If this field appears blank in the table, it means that a default was chosen for the :term:`origin` based on its Protocol - ``80`` for "http", ``443`` for "https".

:Coordinate: The name of the geographic coordinate pair that defines the physical location of this :term:`origin server`. :term:`Origins` created for :term:`Delivery Services` automatically will **not** have associated Coordinates. This can be rectified on the details pages for said :term:`origins`
:Cachegroup: The name of the :term:`Cache Group` to which this :term:`origin` belongs, if any.
:Cachegroup: The :ref:`Name of the Cache Group <cache-group-name>` to which this :term:`origin` belongs, if any.
:Profile: The :ref:`profile-name` of a :term:`Profile` used by this :term:`origin`.

:term:`Origin` management includes the ability to (where applicable):
Expand Down Expand Up @@ -537,11 +537,11 @@ Cache Groups
------------
This page is a table of :term:`Cache Groups`, each entry of which has the following fields:

:Name: The full name of this :term:`Cache Group`
:Short Name: A shorter, more human-friendly name for this :term:`Cache Group`
:Type: The :term:`Type` of this :term:`Cache Group`
:Latitude: A geographic latitude assigned to this :term:`Cache Group`
:Longitude: A geographic longitude assigned to this :term:`Cache Group`
:Name: The full :ref:`Name of this Cache Group <cache-group-name>`
:Short Name: This :ref:`Cache Group's Short Name <cache-group-short-name>`
:Type: This :ref:`Cache Group's Type <cache-group-type>`
:Latitude: This :ref:`Cache Group's Latitude <cache-group-latitude>`
:Longitude: This :ref:`Cache Group's Longitude <cache-group-longitude>`

:term:`Cache Group` management includes the ability to (where applicable):

Expand Down
95 changes: 56 additions & 39 deletions docs/source/api/asns.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,24 +19,28 @@
********
``asns``
********
.. seealso:: `The Autonomous System Wikipedia page <https://en.wikipedia.org/wiki/Autonomous_system_%28Internet%29>` for an explanation of what an ASN actually is.
.. seealso:: `The Autonomous System Wikipedia page <https://en.wikipedia.org/wiki/Autonomous_system_%28Internet%29>`_ for an explanation of what an :abbr:`ASN (Autonomous System Number)` actually is.

``GET``
=======
List all Autonomous System Numbers (ASNs).
List all :abbr:`ASNs (Autonomous System Numbers)`.

:Auth. Required: Yes
:Roles Required: None
:Response Type: Array

.. versionchanged:: 1.2
Previously was an object with only one key ("asns") that contained the response array. This has been flattened so that the response is the actual array.

Request Structure
-----------------
.. table:: Request Query Parameters

+------------+----------+-----------------------------------------------------------------------------------------------------+
| Parameter | Required | Description |
+============+==========+=====================================================================================================+
| cachegroup | no | An integral, unique identifier for a :term:`Cache Group` - only ANSs for this :term:`Cache Group` |
| | | will be returned. |
| cachegroup | no | The :ref:`cache-group-id` of a :term:`Cache Group` - only :abbr:`ASNs (Autonomous System Numbers)` |
| | | for this :term:`Cache Group` will be returned. |
+------------+----------+-----------------------------------------------------------------------------------------------------+
| orderby | no | Choose the ordering of the results - must be the name of one of the fields of the objects in the |
| | | ``response`` array |
Expand All @@ -53,16 +57,23 @@ Request Structure
| | | effect. ``limit`` must be defined to make use of ``page``. |
+------------+----------+-----------------------------------------------------------------------------------------------------+

.. code-block:: http
:caption: Request Example

GET /api/1.4/asns HTTP/1.1
User-Agent: python-requests/2.22.0
Accept-Encoding: gzip, deflate
Accept: */*
Connection: keep-alive
Cookie: mojolicious=...

Response Structure
------------------
:lastUpdated: The Time / Date this server entry was last updated in ISO format
:id: An integer which uniquely identifies the ASN
:asn: Autonomous System Numbers per APNIC for identifying a service provider
:cachegroup: Related Cache Group name
:cachegroupId: Related Cache Group ID

.. versionchanged:: 1.2
Used to contain the array in the ``response.asns`` object, changed so that ``response`` is an actual array
:asn: An :abbr:`ASN (Autonomous System Number)` as specified by IANA for identifying a service provider
:cachegroup: A string that is the :ref:`cache-group-name` of the :term:`Cache Group` that is associated with this :abbr:`ASN (Autonomous System Number)`
:cachegroupId: An integer that is the :ref:`cache-group-id` of the :term:`Cache Group` that is associated with this :abbr:`ASN (Autonomous System Number)`
:id: An integral, unique identifier for this association between an :abbr:`ASN (Autonomous System Number)` and a :term:`Cache Group`
:lastUpdated: The time and date this server entry was last updated in an ISO-like format

.. code-block:: http
:caption: Response Example
Expand All @@ -72,60 +83,64 @@ Response Structure
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
Access-Control-Allow-Origin: *
Content-Encoding: gzip
Content-Type: application/json
Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
Whole-Content-Sha512: 2zeWYI/dGyCzi0ZUWXuuycLFPyL9M5nDJchC7nJMQPW3cwXTaTwf0qI3mP3G1ArZlJTk/ju6/jbUVCNcVIXX1Q==
Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 02 Dec 2019 22:51:14 GMT; Max-Age=3600; HttpOnly
Whole-Content-Sha512: F2NmDbTpXqrIQDX7IBKH9+1drtTL4XedSfJv6klMgLEZwbLCkddIXuSLpmgVCID6kTVqy3fTKjZS3U+HJ3YUEQ==
X-Server-Name: traffic_ops_golang/
Date: Thu, 01 Nov 2018 18:56:38 GMT
Content-Length: 129
Date: Mon, 02 Dec 2019 21:51:14 GMT
Content-Length: 128

{ "response": [
{
"asn": 1,
"cachegroup": "TRAFFIC_ANALYTICS",
"cachegroupId": 1,
"id": 1,
"lastUpdated": "2018-11-01 18:55:39+00"
"lastUpdated": "2019-12-02 21:49:08+00"
}
]}



``POST``
========
Creates a new Autonomous System Number (ASN).
Creates a new :abbr:`ASN (Autonomous System Number)`.

:Auth. Required: Yes
:Roles Required: "admin" or "operations"
:Response Type: Object

Request Structure
-----------------
:asn: The value of the new ASN
:cachegroupId: The integral, unique identifier of a Cache Group to which this ASN will be assigned
:cachegroup: An optional field which, if present, specifies the name of a Cache Group to which this ASN will be assigned
:asn: The value of the new :abbr:`ASN (Autonomous System Number)`
:cachegroup: An optional field which, if present, is a string that specifies the :ref:`cache-group-name` of a :term:`Cache Group` to which this :abbr:`ASN (Autonomous System Number)` will be assigned

.. note:: While this endpoint accepts the ``cachegroup`` field, sending this in the request payload has no effect except that the response will (erroneously) name the Cache Group to which the ASN was assigned. Any subsequent requests will reveal that, in fact, the Cache Group name is set by the ``cachegroupId`` field.
.. note:: While this endpoint accepts the ``cachegroup`` field, sending this in the request payload has no effect except that the response will (erroneously) name the :term:`Cache Group` to which the :abbr:`ASN (Autonomous System Number)` was assigned. Any subsequent requests will reveal that, in fact, the :term:`Cache Group` is set entirely by the ``cachegroupId`` field, and so the actual :ref:`cache-group-name` may differ from what was in the request.

:cachegroupId: An integer that is the :ref:`cache-group-id` of a :term:`Cache Group` to which this :abbr:`ASN (Autonomous System Number)` will be assigned

.. code-block:: http
:caption: Request Example

POST /api/1.1/asns HTTP/1.1
Host: trafficops.infra.ciab.test
User-Agent: curl/7.47.0
POST /api/1.4/asns HTTP/1.1
User-Agent: python-requests/2.22.0
Accept-Encoding: gzip, deflate
Accept: */*
Connection: keep-alive
Cookie: mojolicious=...
Content-Length: 60
Content-Type: application/x-www-form-urlencoded
Content-Length: 29

{"asn": 1, "cachegroupId": 1}


Response Structure
------------------
:lastUpdated: The Time / Date this server entry was last updated in ISO format
:id: An integer which uniquely identifies the ASN
:asn: Autonomous System Numbers per APNIC for identifying a service provider
:cachegroup: Related Cache Group name
:cachegroupId: Related Cache Group ID
:asn: An :abbr:`ASN (Autonomous System Number)` as specified by IANA for identifying a service provider
:cachegroup: A string that is the :ref:`cache-group-name` of the :term:`Cache Group` that is associated with this :abbr:`ASN (Autonomous System Number)`
:cachegroupId: An integer that is the :ref:`cache-group-id` of the :term:`Cache Group` that is associated with this :abbr:`ASN (Autonomous System Number)`
:id: An integral, unique identifier for this association between an :abbr:`ASN (Autonomous System Number)` and a :term:`Cache Group`
:lastUpdated: The time and date this server entry was last updated in an ISO-like format

.. code-block:: http
:caption: Response Example
Expand All @@ -135,12 +150,13 @@ Response Structure
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
Access-Control-Allow-Origin: *
Content-Encoding: gzip
Content-Type: application/json
Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
Whole-Content-Sha512: DnM8HexH7LFkVNH8UYFe6uBQ445Ic8lRLDlOSDIuo4gjokMafxh5Ebr+CsSixNt//OxP0hoWZ+DKymSC5Hdi9Q==
Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 02 Dec 2019 22:49:08 GMT; Max-Age=3600; HttpOnly
Whole-Content-Sha512: mx8b2GTYojz4QtMxXCMoQyZogCB504vs0yv6WGly4dwM81W3XiejWNuUwchRBYYi8QHaWsMZ3DaiGGfQi/8Giw==
X-Server-Name: traffic_ops_golang/
Date: Thu, 01 Nov 2018 18:57:08 GMT
Content-Length: 175
Date: Mon, 02 Dec 2019 21:49:08 GMT
Content-Length: 150

{ "alerts": [
{
Expand All @@ -150,8 +166,9 @@ Response Structure
],
"response": {
"asn": 1,
"cachegroup": "TRAFFIC_ANALYTICS",
"cachegroup": null,
"cachegroupId": 1,
"id": 2,
"lastUpdated": "2018-11-01 18:57:08+00"
"id": 1,
"lastUpdated": "2019-12-02 21:49:08+00"
}}

Loading