This is an automated email from the ASF dual-hosted git repository.
mitchell852 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/trafficcontrol.git
The following commit(s) were added to refs/heads/master by this push:
new cc3e677 Updated documentation and TP's server UI related to xmppId
(#4908)
cc3e677 is described below
commit cc3e6774c07b524d46873e8b8b32907a8d3cdf9b
Author: rimashah25 <[email protected]>
AuthorDate: Thu Jul 23 17:30:38 2020 -0600
Updated documentation and TP's server UI related to xmppId (#4908)
* Updated .rst files related to xmppId. Also added hash Id field on traffic
portal server summary page
* Updated .rst files related to xmppId-1
* Updated CHANGELOG.md
---
CHANGELOG.md | 1 +
docs/source/api/v2/servers.rst | 4 ++--
docs/source/api/v2/servers_details.rst | 2 +-
docs/source/api/v2/servers_id.rst | 2 +-
docs/source/api/v3/servers.rst | 4 ++--
docs/source/api/v3/servers_details.rst | 2 +-
docs/source/api/v3/servers_id.rst | 4 ++--
.../app/src/common/modules/table/servers/TableServersController.js | 5 +++++
8 files changed, 15 insertions(+), 9 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index c082a6b..236d0ae 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -26,6 +26,7 @@ The format is based on [Keep a
Changelog](http://keepachangelog.com/en/1.0.0/).
- Astats csv support - astats will now respond to `Accept: text/csv` and
return a csv formatted stats list
- Updated /deliveryservices/{{ID}}/servers to use multiple interfaces in API v3
- Updated /deliveryservices/{{ID}}/servers/eligible to use multiple interfaces
in API v3
+- Added the ability to view Hash ID field (aka xmppID) on Traffic Portals'
server summary page
### Fixed
- Fixed #2156 - Renaming a host in TC, does not impact xmpp_id and thereby
hashid [Related github
issue](https://github.com/apache/trafficcontrol/issues/2156)
diff --git a/docs/source/api/v2/servers.rst b/docs/source/api/v2/servers.rst
index d62b402..eadf3b6 100644
--- a/docs/source/api/v2/servers.rst
+++ b/docs/source/api/v2/servers.rst
@@ -125,7 +125,7 @@ Response Structure
:type: The name of the :term:`Type` of this server
:typeId: The integral, unique identifier of the 'type' of this server
:updPending: A boolean value which, if ``true``, indicates that the server has
updates of some kind pending, typically to be acted upon by Traffic Ops ORT
-:xmppId: An identifier to be used in XMPP communications with the server -
in nearly all cases this will be the same as ``hostName``
+:xmppId: A system-generated UUID used to generate a server hashId for use
in Traffic Router's consistent hashing algorithm. This value is set when a
server is created and cannot be changed afterwards.
:xmppPasswd: The password used in XMPP communications with the server
.. code-block:: http
@@ -349,7 +349,7 @@ Response Structure
:type: The name of the 'type' of this server
:typeId: The integral, unique identifier of the 'type' of this server
:updPending: A boolean value which, if ``true``, indicates that the server has
updates of some kind pending, typically to be acted upon by Traffic Ops ORT
-:xmppId: An identifier to be used in XMPP communications with the server -
in nearly all cases this will be the same as ``hostName``
+:xmppId: A system-generated UUID used to generate a server hashId for use
in Traffic Router's consistent hashing algorithm. This value is set when a
server is created and cannot be changed afterwards.
:xmppPasswd: The password used in XMPP communications with the server
.. code-block:: http
diff --git a/docs/source/api/v2/servers_details.rst
b/docs/source/api/v2/servers_details.rst
index 95c0828..0d99b72 100644
--- a/docs/source/api/v2/servers_details.rst
+++ b/docs/source/api/v2/servers_details.rst
@@ -99,7 +99,7 @@ Response Structure
.. note:: This is typically thought of as synonymous with
"HTTP port", as the port specified by ``httpsPort`` may also be used for
incoming TCP connections.
:type: The name of the 'type' of this server
- :xmppId: An identifier to be used in XMPP communications
with the server - in nearly all cases this will be the same as ``hostName``
+ :xmppId: A system-generated UUID used to generate a
server hashId for use in Traffic Router's consistent hashing algorithm. This
value is set when a server is created and cannot be changed afterwards.
:xmppPasswd: The password used in XMPP communications with
the server
:size: The page number - if pagination was requested in the query
parameters, else ``0`` to indicate no pagination - of the results represented
by the ``response`` array. This is named "size" for legacy reasons
diff --git a/docs/source/api/v2/servers_id.rst
b/docs/source/api/v2/servers_id.rst
index 0aee4ba..92da230 100644
--- a/docs/source/api/v2/servers_id.rst
+++ b/docs/source/api/v2/servers_id.rst
@@ -78,7 +78,7 @@ Request Structure
:typeId: The integral, unique identifier of the 'type' of this server
:updPending: A boolean value which, if ``true``, indicates that the server has
updates of some kind pending, typically to be acted upon by Traffic Ops ORT
-:xmppId: An optional identifier to be used in XMPP communications with the
server - in nearly all cases this should be the same as ``hostName``
+:xmppId: A system-generated UUID used to generate a server hashId for use
in Traffic Router's consistent hashing algorithm. This value is set when a
server is created and cannot be changed afterwards.
:xmppPasswd: An optional password used in XMPP communications with the server
.. code-block:: http
diff --git a/docs/source/api/v3/servers.rst b/docs/source/api/v3/servers.rst
index dca6b49..27c9996 100644
--- a/docs/source/api/v3/servers.rst
+++ b/docs/source/api/v3/servers.rst
@@ -144,7 +144,7 @@ Response Structure
:type: The name of the :term:`Type` of this server
:typeId: The integral, unique identifier of the 'type' of this server
:updPending: A boolean value which, if ``true``, indicates that the server has
updates of some kind pending, typically to be acted upon by Traffic Ops ORT
-:xmppId: An identifier to be used in XMPP communications with the server -
in nearly all cases this will be the same as ``hostName``
+:xmppId: A system-generated UUID used to generate a server hashId for use
in Traffic Router's consistent hashing algorithm. This value is set when a
server is created and cannot be changed afterwards.
:xmppPasswd: The password used in XMPP communications with the server
.. code-block:: http
@@ -429,7 +429,7 @@ Response Structure
:type: The name of the 'type' of this server
:typeId: The integral, unique identifier of the 'type' of this server
:updPending: A boolean value which, if ``true``, indicates that the server has
updates of some kind pending, typically to be acted upon by Traffic Ops ORT
-:xmppId: An identifier to be used in XMPP communications with the server -
in nearly all cases this will be the same as ``hostName``
+:xmppId: A system-generated UUID used to generate a server hashId for use
in Traffic Router's consistent hashing algorithm. This value is set when a
server is created and cannot be changed afterwards.
:xmppPasswd: The password used in XMPP communications with the server
.. code-block:: http
diff --git a/docs/source/api/v3/servers_details.rst
b/docs/source/api/v3/servers_details.rst
index 3613cbb..c8e44d1 100644
--- a/docs/source/api/v3/servers_details.rst
+++ b/docs/source/api/v3/servers_details.rst
@@ -108,7 +108,7 @@ Response Structure
.. note:: This is typically thought of as synonymous with
"HTTP port", as the port specified by ``httpsPort`` may also be used for
incoming TCP connections.
:type: The name of the 'type' of this server
- :xmppId: An identifier to be used in XMPP communications
with the server - in nearly all cases this will be the same as ``hostName``
+ :xmppId: A system-generated UUID used to generate a
server hashId for use in Traffic Router's consistent hashing algorithm. This
value is set when a server is created and cannot be changed afterwards.
:xmppPasswd: The password used in XMPP communications with
the server
:size: The page number - if pagination was requested in the query
parameters, else ``0`` to indicate no pagination - of the results represented
by the ``response`` array. This is named "size" for legacy reasons
diff --git a/docs/source/api/v3/servers_id.rst
b/docs/source/api/v3/servers_id.rst
index 9e564e4..be6fa07 100644
--- a/docs/source/api/v3/servers_id.rst
+++ b/docs/source/api/v3/servers_id.rst
@@ -236,7 +236,7 @@ Response Structure
:type: The name of the 'type' of this server
:typeId: The integral, unique identifier of the 'type' of this server
:updPending: A boolean value which, if ``true``, indicates that the server has
updates of some kind pending, typically to be acted upon by Traffic Ops ORT
-:xmppId: An identifier to be used in XMPP communications with the server -
in nearly all cases this will be the same as ``hostName``
+:xmppId: A system-generated UUID used to generate a server hashId for use
in Traffic Router's consistent hashing algorithm. This value is set when a
server is created and cannot be changed afterwards.
:xmppPasswd: The password used in XMPP communications with the server
.. code-block:: http
@@ -426,7 +426,7 @@ Response Structure
:type: The name of the :term:`Type` of this server
:typeId: The integral, unique identifier of the 'type' of this server
:updPending: A boolean value which, if ``true``, indicates that the server had
updates of some kind pending, typically to be acted upon by Traffic Ops
:term:`ORT`
-:xmppId: An identifier to be used in XMPP communications with the server -
in nearly all cases this will be the same as ``hostName``
+:xmppId: A system-generated UUID used to generate a server hashId for use
in Traffic Router's consistent hashing algorithm. This value is set when a
server is created and cannot be changed afterwards.
:xmppPasswd: The password used in XMPP communications with the server
.. code-block:: http
diff --git
a/traffic_portal/app/src/common/modules/table/servers/TableServersController.js
b/traffic_portal/app/src/common/modules/table/servers/TableServersController.js
index 1ddc42c..bc5154e 100644
---
a/traffic_portal/app/src/common/modules/table/servers/TableServersController.js
+++
b/traffic_portal/app/src/common/modules/table/servers/TableServersController.js
@@ -94,6 +94,11 @@ var TableServersController = function(servers, $scope,
$state, $uibModal, $windo
filter: "agNumberColumnFilter"
},
{
+ headerName: "Hash ID",
+ field: "xmppId",
+ hide: false
+ },
+ {
headerName: "ID",
field: "id",
hide: true,
