@itentialopensource/adapter-kentik_v5 0.3.2 → 0.3.4

package/TAB2.md

@@ -0,0 +1,336 @@
+# Kentik v5
+
+## Table of Contents 
+
+  - [Specific Adapter Information](#specific-adapter-information) 
+    - [Authentication](#authentication) 
+    - [Sample Properties](#sample-properties) 
+    - [Swagger](#swagger) 
+  - [Generic Adapter Information](#generic-adapter-information) 
+
+## Specific Adapter Information
+### Authentication
+
+This document will go through the steps for authenticating the Kentik adapter with Static Token Authentication. Properly configuring the properties for an adapter in IAP is critical for getting the adapter online. You can read more about adapter authentication <a href="https://docs.itential.com/opensource/docs/authentication" target="_blank">HERE</a>. 
+
+Companies periodically change authentication methods to provide better security. As this happens this section should be updated and contributed/merge back into the adapter repository.
+
+#### Static Token Authentication
+The Kentik adapter requires Static Token Authentication. If you change authentication methods, you should change this section accordingly and merge it back into the adapter repository.
+
+STEPS  
+1. Ensure you have access to a Kentik server and that it is running
+2. Follow the steps in the README.md to import the adapter into IAP if you have not already done so
+3. Use the properties below for the ```properties.authentication``` field
+```json
+"authentication": {
+  "auth_method": "static_token",
+  "token": "<user_api_token>",
+  "auth_field": "header.headers.X-CH-Auth-API-Token",
+  "auth_field_format": "{token}",
+  "auth_logging": false
+}
+```
+you can leave all of the other properties in the authentication section, they will not be used for static token authentication.
+
+4. Use the properties below for the ```request.global_request.addlHeaders``` field to add X-CH-Auth-Email header to the requests
+```json
+"request": {
+  "global_request": {
+    "addlHeaders": {
+      "X-CH-Auth-Email": "user@domain.suffix"
+    }
+  }
+}
+```
+5. Restart the adapter. If your properties were set correctly, the adapter should go online. 
+
+#### Troubleshooting
+- Make sure you copied over the correct token.
+- Turn on debug level logs for the adapter in IAP Admin Essentials.
+- Turn on auth_logging for the adapter in IAP Admin Essentials (adapter properties).
+- Investigate the logs - in particular:
+  - The FULL REQUEST log to make sure the proper headers are being sent with the request.
+  - The FULL BODY log to make sure the payload is accurate.
+  - The CALL RETURN log to see what the other system is telling us.
+- Credentials should be ** masked ** by the adapter so make sure you verify the username and password - including that there are erroneous spaces at the front or end.
+- Remember when you are done to turn auth_logging off as you do not want to log credentials.
+
+### Sample Properties
+
+Sample Properties can be used to help you configure the adapter in the Itential Automation Platform. You will need to update connectivity information such as the host, port, protocol and credentials.
+
+```json
+  "properties": {
+    "host": "api.kentik.com",
+    "port": 443,
+    "choosepath": "",
+    "base_path": "/api",
+    "version": "v5",
+    "cache_location": "none",
+    "encode_pathvars": true,
+    "encode_queryvars": true,
+    "save_metric": false,
+    "stub": true,
+    "protocol": "https",
+    "authentication": {
+      "auth_method": "static_token",
+      "username": "username",
+      "password": "password",
+      "token": "tokenGoesHere",
+      "token_timeout": 600000,
+      "token_cache": "local",
+      "invalid_token_error": 401,
+      "auth_field": "header.headers.X-CH-Auth-API-Token",
+      "auth_field_format": "{token}",
+      "auth_logging": false,
+      "client_id": "",
+      "client_secret": "",
+      "grant_type": "",
+      "sensitive": [],
+      "sso": {
+        "protocol": "",
+        "host": "",
+        "port": 0
+      },
+      "multiStepAuthCalls": [
+        {
+          "name": "",
+          "requestFields": {},
+          "responseFields": {},
+          "successfullResponseCode": 200
+        }
+      ],
+      "token_user_field": "username",
+      "token_password_field": "password",
+      "token_result_field": "token",
+      "token_URI_path": ""
+    },
+    "healthcheck": {
+      "type": "none",
+      "frequency": 60000,
+      "query_object": {},
+      "addlHeaders": {},
+      "protocol": "REST",
+      "URI_Path": ""
+    },
+    "throttle": {
+      "throttle_enabled": false,
+      "number_pronghorns": 1,
+      "sync_async": "sync",
+      "max_in_queue": 1000,
+      "concurrent_max": 1,
+      "expire_timeout": 0,
+      "avg_runtime": 200,
+      "priorities": [
+        {
+          "value": 0,
+          "percent": 100
+        }
+      ]
+    },
+    "request": {
+      "number_redirects": 0,
+      "number_retries": 3,
+      "limit_retry_error": [
+        0
+      ],
+      "failover_codes": [],
+      "attempt_timeout": 5000,
+      "global_request": {
+        "payload": {},
+        "uriOptions": {},
+        "addlHeaders": {
+          "X-CH-Auth-Email": "first.last@itential.com"
+        },
+        "authData": {}
+      },
+      "healthcheck_on_timeout": true,
+      "return_raw": false,
+      "archiving": false,
+      "return_request": false
+    },
+    "proxy": {
+      "enabled": false,
+      "host": "",
+      "port": 1,
+      "protocol": "http",
+      "username": "",
+      "password": ""
+    },
+    "ssl": {
+      "ecdhCurve": "",
+      "enabled": false,
+      "accept_invalid_cert": false,
+      "ca_file": "",
+      "key_file": "",
+      "cert_file": "",
+      "secure_protocol": "",
+      "ciphers": ""
+    },
+    "mongo": {
+      "host": "",
+      "port": 0,
+      "database": "",
+      "username": "",
+      "password": "",
+      "replSet": "",
+      "db_ssl": {
+        "enabled": false,
+        "accept_invalid_cert": false,
+        "ca_file": "",
+        "key_file": "",
+        "cert_file": ""
+      }
+    },
+    "devicebroker": {
+      "enabled": false,
+      "getDevice": [
+        {
+          "path": "/not/mapped",
+          "method": "GET",
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "ignore",
+          "requestFields": {
+            "insample": "{port}"
+          },
+          "responseDatakey": "",
+          "responseFields": {
+            "name": "{this}{||}{that}",
+            "ostype": "{osfield}",
+            "ostypePrefix": "meraki-",
+            "port": "{port}",
+            "ipaddress": "{ip_addr}",
+            "serial": "{serial}"
+          }
+        }
+      ],
+      "getDevicesFiltered": [
+        {
+          "path": "/not/mapped",
+          "method": "GET",
+          "pagination": {
+            "offsetVar": "",
+            "limitVar": "",
+            "incrementBy": "limit",
+            "requestLocation": "query"
+          },
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "ignore",
+          "requestFields": {},
+          "responseDatakey": "",
+          "responseFields": {
+            "name": "{this}{||}{that}",
+            "ostype": "{osfield}",
+            "ostypePrefix": "meraki-",
+            "port": "{port}",
+            "ipaddress": "{ip_addr}",
+            "serial": "{serial}",
+            "id": "{myid}"
+          }
+        }
+      ],
+      "isAlive": [
+        {
+          "path": "/not/mapped/{devID}",
+          "method": "GET",
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "ignore",
+          "requestFields": {
+            "devID": "{id}"
+          },
+          "responseDatakey": "",
+          "responseFields": {
+            "status": "return2xx",
+            "statusValue": "AD.200"
+          }
+        }
+      ],
+      "getConfig": [
+        {
+          "path": "/not/mapped/{devID}",
+          "method": "GET",
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "ignore",
+          "requestFields": {
+            "devID": "{id}"
+          },
+          "responseDatakey": "",
+          "responseFields": {}
+        }
+      ],
+      "getCount": [
+        {
+          "path": "/not/mapped",
+          "method": "GET",
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "ignore",
+          "requestFields": {},
+          "responseDatakey": "",
+          "responseFields": {}
+        }
+      ]
+    },
+    "cache": {
+      "enabled": false,
+      "entities": [
+        {
+          "entityType": "device",
+          "frequency": 3600,
+          "flushOnFail": false,
+          "limit": 10000,
+          "retryAttempts": 5,
+          "sort": true,
+          "populate": [
+            {
+              "path": "/not/mapped",
+              "method": "GET",
+              "pagination": {
+                "offsetVar": "",
+                "limitVar": "",
+                "incrementBy": "limit",
+                "requestLocation": "query"
+              },
+              "query": {},
+              "body": {},
+              "headers": {},
+              "handleFailure": "ignore",
+              "requestFields": {},
+              "responseDatakey": "",
+              "responseFields": {
+                "name": "{this}{||}{that}",
+                "ostype": "{osfield}",
+                "ostypePrefix": "meraki-",
+                "port": "{port}",
+                "ipaddress": "{ip_addr}",
+                "serial": "{serial}",
+                "id": "{myid}"
+              }
+            }
+          ],
+          "cachedTasks": [
+            {
+              "name": "",
+              "filterField": "",
+              "filterLoc": ""
+            }
+          ]
+        }
+      ]
+    }
+  }
+```
+### [Swagger](https://gitlab.com/itentialopensource/adapters/observability/adapter-kentik_v5/-/blob/master/report/adapter-openapi.json) 
+
+## [Generic Adapter Information](https://gitlab.com/itentialopensource/adapters/observability/adapter-kentik_v5/-/blob/master/README.md) 
+

package/compliance-report.json

@@ -0,0 +1,9 @@
+{
+  "ComplianceEntries": [
+    {
+      "name": "Compliance Summary",
+      "numInvalidProjects": 0,
+      "numValidProjects": 0
+    }
+  ]
+}

package/compliance-report.txt

@@ -0,0 +1,5 @@
+---------------------------------------------------------------------------------------------
+**** Project Compliance Summary ****
+0 project(s) are not valid
+0 project(s) are valid
+---------------------------------------------------------------------------------------------

package/metadata.json

@@ -2,7 +2,7 @@
   "name": "adapter-kentik_v5",
   "webName": "Adapter for Integration to Kentik API v5",
   "vendor": "Kentik",
-  "product": "API v5",
+  "product": "Kentik",
   "osVersion": [],
   "apiVersions": [
     "v5"
@@ -29,34 +29,80 @@
     "isDeprecated": false
   },
   "brokerSince": "",
+  "authMethods": [
+    {
+      "type": "API Key",
+      "primary": true
+    }
+  ],
   "documentation": {
     "storeLink": "",
     "npmLink": "https://www.npmjs.com/package/@itentialopensource/adapter-kentik_v5",
-    "repoLink": "https://gitlab.com/itentialopensource/adapters/observability/adapter-kentik_v5",
+    "repoLink": "https://gitlab.com/itentialopensource/adapters/adapter-kentik_v5",
     "docLink": "",
-    "demoLinks": [],
-    "trainingLinks": [],
+    "demoLinks": [
+      {
+        "title": "Itential + Kentik: Integrated Network Observability & Automation",
+        "link": "https://www.itential.com/resource/demo/itential-kentik-integrated-network-observability-automation/"
+      },
+      {
+        "title": "Itential + Kentik: Integrating Observability with Automation for Closed-Loop Remediation of Infrastructure Events",
+        "link": "https://www.itential.com/blog/company/hybrid-cloud-automation/itential-kentik-integrating-observability-with-automation-for-closed-loop-remediation-of-infrastructure-events/"
+      }
+    ],
+    "trainingLinks": [
+      {
+        "title": "Itential Academy",
+        "link": "https://www.itential.com/itential-academy/"
+      }
+    ],
     "faqLink": "https://docs.itential.com/opensource/docs/troubleshooting-an-adapter",
     "contributeLink": "https://gitlab.com/itentialopensource/adapters/contributing-guide",
     "issueLink": "https://itential.atlassian.net/servicedesk/customer/portals",
     "webLink": "https://www.itential.com/adapters/kentik-api-version-5/",
-    "vendorLink": "",
-    "productLink": "",
-    "apiLinks": []
+    "vendorLink": "https://www.kentik.com/",
+    "productLink": "https://www.kentik.com/",
+    "apiLinks": [
+      {
+        "title": "Kentik APIs",
+        "link": "https://kb.kentik.com/v0/Ab09.htm",
+        "public": true
+      }
+    ]
   },
   "assets": [],
   "relatedItems": {
     "adapters": [],
     "integrations": [],
     "ecosystemApplications": [],
-    "workflowProjects": [],
+    "workflowProjects": [
+      {
+        "name": "Kentik - REST",
+        "webName": "Kentik - Device Management",
+        "overview": "The integration of Itential and Kentik enables network teams to build automations that can immediately respond to events and alarms generated by the Kentik observability platform. In addition, Itential also offers a package of Pre-Built Automations to implement multiple use cases with the integration. The Kentik - REST Pre-Built provides automations that help Network Engineers automate common tasks performed in the Kentik platform. This Pre-Built contains multiple automations including:\n\n- Create a Device in Kentik - With this automation, users can create a device for a specific site and provide the device record as output.\n- Run Device Flow Test - With this automation, users can run a device flow test for a specific device, providing the results of the test as output.",
+        "isDependency": false,
+        "versions": [
+          "^1.0.9"
+        ],
+        "repoLink": "https://gitlab.com/itentialopensource/pre-built-automations/kentik-rest",
+        "docLink": "",
+        "webLink": "https://www.itential.com/automations/kentik-device-management/"
+      }
+    ],
     "transformationProjects": [],
-    "exampleProjects": []
-  },
-  "authMethods": [
-    {
-      "type": "API Key",
-      "primary": true
-    }
-  ]
+    "exampleProjects": [
+      {
+        "name": "Kentik - REST - Example",
+        "webName": "Kentik - Example Use Case Bundle",
+        "overview": "This contains several example use cases that are applicable when the Itential Automation Platform is integrated with the Kentik Platform. Because every environment is different, these use cases are fully functioning examples that can be modified to operate in your IT ecosystem. These workflows have been written with modularity in mind to make them easy to understand and simple to modify to suit your needs.",
+        "isDependency": false,
+        "versions": [
+          "1.1.10"
+        ],
+        "repoLink": "https://gitlab.com/itentialopensource/pre-built-automations/kentik-rest-example",
+        "docLink": "",
+        "webLink": "https://www.itential.com/automations/kentik-example-use-case-bundle/"
+      }
+    ]
+  }
 }

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@itentialopensource/adapter-kentik_v5",
-  "version": "0.3.2",
+  "version": "0.3.4",
   "description": "This adapter integrates with system described as: kentikV5Api.",
   "main": "adapter.js",
   "wizardVersion": "2.44.7",
-  "engineVersion": "1.67.14",
+  "engineVersion": "1.67.20",
   "adapterType": "http",
   "scripts": {
     "artifactize": "npm i && node utils/packModificationScript.js",
@@ -15,7 +15,6 @@
     "test:baseunit": "mocha test/unit/adapterBaseTestUnit.js --LOG=error",
     "test:unit": "mocha test/unit/adapterTestUnit.js --LOG=error",
     "test:integration": "mocha test/integration/adapterTestIntegration.js --LOG=error",
-    "test:cover": "nyc --reporter html --reporter text mocha --reporter dot test/*",
     "test": "npm run test:baseunit && npm run test:unit && npm run test:integration",
     "adapter:install": "npm i && node utils/tbScript.js install",
     "adapter:checkMigrate": "node utils/checkMigrate.js",
@@ -43,20 +42,20 @@
   ],
   "license": "Apache-2.0",
   "engines": {
-    "node": ">= 8.0.0",
+    "node": ">= 14.0.0",
     "npm": ">= 6.0.0"
   },
   "repository": {
     "type": "git",
-    "url": "git@gitlab.com:itentialopensource/adapters/observability/adapter-kentik_v5.git"
+    "url": "git@gitlab.com:itentialopensource/adapters/adapter-kentik_v5.git"
   },
   "author": "Itential",
-  "homepage": "https://gitlab.com/itentialopensource/adapters/observability/adapter-kentik_v5#readme",
+  "homepage": "https://gitlab.com/itentialopensource/adapters/adapter-kentik_v5#readme",
   "dependencies": {
-    "@itentialopensource/adapter-utils": "^5.3.8",
+    "@itentialopensource/adapter-utils": "^5.5.0",
     "acorn": "^8.10.0",
     "ajv": "^8.12.0",
-    "axios": "^1.6.7",
+    "axios": "^1.6.8",
     "commander": "^11.0.0",
     "dns-lookup-promise": "^1.0.4",
     "fs-extra": "^11.1.1",
@@ -64,7 +63,6 @@
     "mocha": "^10.3.0",
     "mocha-param": "^2.0.1",
     "mongodb": "^4.16.0",
-    "nyc": "^15.1.0",
     "ping": "^0.4.4",
     "prompts": "^2.4.2",
     "readline-sync": "^1.4.10",

package/propertiesSchema.json

@@ -945,6 +945,11 @@
     "devicebroker": {
       "type": "object",
       "properties": {
+        "enabled": {
+          "type": "boolean",
+          "description": "Whether or not the device broker calls have been mapped",
+          "default": false
+        },
         "getDevice": {
           "type": "array",
           "description": "Broker call(s) to getDevice",

package/report/adapterInfo.json

@@ -1,10 +1,10 @@
 {
-  "version": "0.2.0",
-  "configLines": 8395,
+  "version": "0.3.3",
+  "configLines": 8400,
   "scriptLines": 1783,
   "codeLines": 7198,
-  "testLines": 7378,
+  "testLines": 7377,
   "testCases": 352,
-  "totalCodeLines": 16359,
+  "totalCodeLines": 16358,
   "wfTasks": 85
 }

package/report/updateReport1719238796757.json

@@ -0,0 +1,120 @@
+{
+  "errors": [],
+  "statistics": [
+    {
+      "owner": "errorJson",
+      "description": "New adapter errors available for use",
+      "value": 0
+    },
+    {
+      "owner": "errorJson",
+      "description": "Adapter errors no longer available for use",
+      "value": 0
+    },
+    {
+      "owner": "errorJson",
+      "description": "Adapter errors that have been updated (e.g. recommendation changes)",
+      "value": 31
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of production dependencies",
+      "value": 16
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of development dependencies",
+      "value": 6
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of npm scripts",
+      "value": 21
+    },
+    {
+      "owner": "packageJson",
+      "description": "Runtime Library dependency",
+      "value": "^5.5.0"
+    },
+    {
+      "owner": "propertiesSchemaJson",
+      "description": "Adapter properties defined in the propertiesSchema file",
+      "value": 78
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the README.md",
+      "value": 344
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the SUMMARY.md",
+      "value": 9
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the PROPERTIES.md",
+      "value": 647
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the TROUBLESHOOT.md",
+      "value": 48
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the ENHANCE.md",
+      "value": 70
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the BROKER.md",
+      "value": 70
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of lines of code in unit tests",
+      "value": 3672
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of unit tests",
+      "value": 213
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of lines of code in integration tests",
+      "value": 2453
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of integration tests",
+      "value": 69
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of lines of code in adapterBase.js",
+      "value": 1453
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of static files added",
+      "value": 36
+    },
+    {
+      "owner": "Overall",
+      "description": "Total lines of Code",
+      "value": 7578
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Tests",
+      "value": 282
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Files",
+      "value": 6
+    }
+  ]
+}