@itentialopensource/adapter-amazon_route53 0.3.8 → 0.4.0

package/BROKER.md

@@ -22,18 +22,25 @@ Below is an example of how you may set up the properties for this call.
   {
     "path": "/{org}/get/devices",
     "method": "GET",
+    "pagination": {
+      "offsetVar": "",
+      "limitVar": "",
+      "incrementBy": "limit",
+      "requestLocation": "query"
+    },
     "query": {},
     "body": {},
     "headers": {},
     "handleFailure": "ignore",
+    "responseDataKey": "",
     "requestFields": {
       "org": "555"
     },
     "responseFields": {
-      "name": "host",
-      "ostype": "os",
+      "name": "{hostField}",
+      "ostype": "{osField}",
       "ostypePrefix": "system-",
-      "ipaddress": "attributes.ipaddr",
+      "ipaddress": "{attributes.ipaddr}",
       "port": "443"
     }
   },
@@ -44,16 +51,17 @@ Below is an example of how you may set up the properties for this call.
     "body": {},
     "headers": {},
     "handleFailure": "ignore",
+    "responseDataKey": "",
     "requestFields": {
       "org": "777"
     },
     "responseFields": {
-      "name": "host",
-      "ostype": "os",
+      "name": "{hostField}",
+      "ostype": "{osField}",
       "ostypePrefix": "system-",
-      "ipaddress": "attributes.ipaddr",
+      "ipaddress": "{attributes.ipaddr}",
       "port": "443",
-      "myorg": "org"
+      "myorg": "{orgField}"
     }
   }
 ]
@@ -88,12 +96,13 @@ Below is an example of how you may set up the properties for this call.
     "headers": {},
     "handleFailure": "ignore",
     "statusValue": "online",
+    "responseDataKey": "",
     "requestFields": {
-      "org": "myorg",
-      "id": "name"
+      "org": "{myorg}",
+      "id": "{name}"
     },
     "responseFields": {
-      "status": "status"
+      "status": "{status}"
     }
   }
 ]
@@ -129,9 +138,10 @@ Below is an example of how you may set up the properties for this call.
     "body": {},
     "headers": {},
     "handleFailure": "ignore",
+    "responseDataKey": "",
     "requestFields": {
-      "org": "myorg",
-      "id": "name"
+      "org": "{myorg}",
+      "id": "{name}"
     }
     "responseFields": {}
   },
@@ -142,8 +152,9 @@ Below is an example of how you may set up the properties for this call.
     "body": {},
     "headers": {},
     "handleFailure": "ignore",
+    "responseDataKey": "",
     "requestFields": {
-      "org": "myorg"
+      "org": "{myorg}"
     }
     "responseFields": {}
   }
@@ -178,17 +189,18 @@ Below is an example of how you may set up the properties for this call.
     "body": {},
     "headers": {},
     "handleFailure": "ignore",
+    "responseDataKey": "",
     "requestFields": {
-      "org": "myorg",
-      "id": "name"
+      "org": "{myorg}",
+      "id": "{name}"
     },
     "responseFields": {
-      "name": "host",
-      "ostype": "os",
+      "name": "{hostField}",
+      "ostype": "{osField}",
       "ostypePrefix": "system-",
-      "ipaddress": "attributes.ipaddr",
+      "ipaddress": "{attributes.ipaddr}",
       "port": "443",
-      "myorg": "org"
+      "myorg": "{orgField}"
     }
   }
 ]

package/CALLS.md

@@ -19,7 +19,7 @@ These are adapter methods that IAP or you might use. There are some other method
   </tr>
   <tr>
     <td style="padding:15px">healthCheck(callback)</td>
-    <td style="padding:15px">This call ensures that the adapter can communicate with Adapter for ServiceNow. The actual call that is used is defined in the adapter properties and .system entities action.json file.</td>
+    <td style="padding:15px">This call ensures that the adapter can communicate with Adapter for Amazon Route 53. The actual call that is used is defined in the adapter properties and .system entities action.json file.</td>
     <td style="padding:15px">No</td>
   </tr>
   <tr>
@@ -29,7 +29,7 @@ These are adapter methods that IAP or you might use. There are some other method
   </tr>
   <tr>
     <td style="padding:15px">encryptProperty(property, technique, callback)</td>
-    <td style="padding:15px">This call will take the provided property and technique, and return the property encrypted with the technique. This allows the property to be used in the adapterProps section for the credential password so that the password does not have to be in clear text. The adapter will decrypt the property as needed for communications with Adapter for ServiceNow.</td>
+    <td style="padding:15px">This call will take the provided property and technique, and return the property encrypted with the technique. This allows the property to be used in the adapterProps section for the credential password so that the password does not have to be in clear text. The adapter will decrypt the property as needed for communications with Adapter for Amazon Route 53.</td>
     <td style="padding:15px">No</td>
   </tr>
   <tr>

package/CHANGELOG.md

@@ -1,4 +1,20 @@
 
+## 0.4.0 [07-08-2024]
+
+* Minor/2024 auto migration
+
+See merge request itentialopensource/adapters/cloud/adapter-amazon_route53!16
+
+---
+
+## 0.3.9 [03-28-2024]
+
+* Changes made at 2024.03.28_13:14PM
+
+See merge request itentialopensource/adapters/cloud/adapter-amazon_route53!15
+
+---
+
 ## 0.3.8 [03-21-2024]
 
 * Changes made at 2024.03.21_13:49PM

package/PROPERTIES.md

@@ -97,6 +97,7 @@ This section defines **all** the properties that are available for the adapter,
         }
       },
       "devicebroker": {
+        "enabled": false,
         "getDevice": [
           {
             "path": "/call/to/get/device/details",
@@ -580,6 +581,10 @@ The device broker section defines the properties used integrate Amazon_route53 t
     <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Property</span></th>
     <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
   </tr>
+  <tr>
+    <td style="padding:15px">enabled</td>
+    <td style="padding:15px">Whether or not the device broker calls have been mapped.</td>
+  </tr>
   <tr>
     <td style="padding:15px">getDevice</td>
     <td style="padding:15px">The array of calls used to get device details for the broker</td>

package/README.md

@@ -4,29 +4,49 @@
 
 Some of the page links in this document and links to other GitLab files do not work in Confluence however, the information is available in other sections of the Confluence material.
 
-- [Overview](./SUMMARY.md)
-- [Versioning](#versioning)
-- [Supported IAP Versions](#supported-iap-versions)
-- [Getting Started](#getting-started)
-  - [Helpful Background Information](#helpful-background-information)
-  - [Prerequisites](#prerequisites)
-  - [How to Install](#how-to-install)
-  - [Testing](#testing)
-- [Configuration](./PROPERTIES.md)
-- [Using this Adapter](./CALLS.md)
+- [Specific to this Adapter](#specific-to-this-adapter)
   - [Authentication](./AUTH.md)
-- [Additional Information](#additional-information)
-  - [Enhancements](./ENHANCE.md)
-  - [Contributing](./CONTRIBUTING.md)
-  - [Helpful Links](#helpful-links)
-  - [Node Scripts](#node-scripts)
-- [Troubleshoot](./TROUBLESHOOT.md)
-- [License and Maintainers](#license-and-maintainers)
-- [Product License](#product-license)
+  - [Sample Properties](./sampleProperties.json)
+  - [Available Calls](./CALLS.md)
+  - [Swagger](./report/adapter-openapi.json)
+- [Generic Adapter Information](#generic-adapter-information)
+  - [Overview](./SUMMARY.md)
+  - [Versioning](#versioning)
+  - [Supported IAP Versions](#supported-iap-versions)
+  - [Getting Started](#getting-started)
+    - [Helpful Background Information](#helpful-background-information)
+    - [Prerequisites](#prerequisites)
+    - [How to Install](#how-to-install)
+    - [Testing](#testing)
+  - [Configuration](./PROPERTIES.md)
+  - [Additional Information](#additional-information)
+    - [Enhancements](./ENHANCE.md)
+    - [Contributing](./CONTRIBUTING.md)
+    - [Helpful Links](#helpful-links)
+    - [Node Scripts](#node-scripts)
+  - [Troubleshoot](./TROUBLESHOOT.md)
+  - [License and Maintainers](#license-and-maintainers)
+  - [Product License](#product-license)
+
+
+## Specific to this Adapter
 
-## [Overview](./SUMMARY.md)
+### [Authentication](./AUTH.md)
+
+### [Sample Properties](./sampleProperties.json)
+
+<a href="./sampleProperties.json" target="_blank">Sample Properties</a> 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.
+
+### [Available Calls](./CALLS.md)
+
+### [Swagger](./report/adapter-openapi.json)
+
+
+## Generic Adapter Information
 
-## Versioning
+### [Overview](./SUMMARY.md)
+
+### Versioning
 
 Itential Product and opensource adapters utilize SemVer for versioning. The current version of the adapter can be found in the `package.json` file or viewed in the IAP GUI on the System page. All Itential opensource adapters can be found in the <a href="https://gitlab.com/itentialopensource/adapters" target="_blank">Itential OpenSource Repository</a>.
 
@@ -34,7 +54,7 @@ Any release prior to 1.0.0 is a pre-release. Initial builds of adapters are gene
 
 Release notes can be viewed in CHANGELOG.md.
 
-## Supported IAP Versions
+### Supported IAP Versions
 
 Itential Product adapters are built for particular versions of IAP and packaged with the versions they work with. 
 
@@ -42,11 +62,11 @@ Itential opensource adapter as well as custom adapters built with the Itential A
 
 Many of the scripts that come with all adapters built using the Itential Adapter Builder do have some dependencies on IAP or the IAP database schema and so it is possible these scripts could stop working in different versions of IAP. If you notify Itential of any issues, the Adapter Team will attempt to fix the scripts for newer releases of IAP.
 
-## Getting Started
+### Getting Started
 
 These instructions will help you get a copy of the project on your local machine for development and testing. Reading this section is also helpful for deployments as it provides you with pertinent information on prerequisites and properties.
 
-### Helpful Background Information
+#### Helpful Background Information
 
 There is <a href="https://docs.itential.com/opensource/docs/adapters" target="_blank">Adapter documentation available on the Itential Documentation Site</a>. This documentation includes information and examples that are helpful for:
 
@@ -67,7 +87,7 @@ Troubleshooting an Adapter
 Others will be added over time.
 Want to build a new adapter? Use the <a href="https://adapters.itential.io" target="_blank">Itential Adapter Builder</a>
 
-### Prerequisites
+#### Prerequisites
 
 The following is a list of required packages for installation on the system the adapter will run on:
 
@@ -154,7 +174,7 @@ eslint-plugin-json
 testdouble
 ```
 
-### How to Install
+#### How to Install
 
 1. Set up the name space location in your IAP node_modules.
 
@@ -167,8 +187,8 @@ if the @itentialopensource directory does not exist, create it:
 2. Clone/unzip/tar the adapter into your IAP environment.
 
 ```bash
-cd \@itentialopensource
-git clone git@gitlab.com:\@itentialopensource/adapters/adapter-amazon_route53
+cd @itentialopensource
+git clone git@gitlab.com:@itentialopensource/adapters/adapter-amazon_route53
 or
 unzip adapter-amazon_route53.zip
 or
@@ -196,30 +216,11 @@ systemctl restart pronghorn
 
 7. Change the adapter service instance configuration (host, port, credentials, etc) in IAP Admin Essentials GUI
 
-
-For an easier install of the adapter use npm run adapter:install, it will install the adapter in IAP. Please note that it can be dependent on where the adapter is installed and on the version of IAP so it is subject to fail. If using this, you can replace step 3-5 above with these:
-
-3. Install adapter dependencies and check the adapter.
-
-```bash
-cd adapter-amazon_route53
-npm run adapter:install
-```
-
-4. Restart IAP
-
-```bash
-systemctl restart pronghorn
-```
-
-5. Change the adapter service instance configuration (host, port, credentials, etc) in IAP Admin Essentials GUI
-
-
-### Testing
+#### Testing
 
 Mocha is generally used to test all Itential Opensource Adapters. There are unit tests as well as integration tests performed. Integration tests can generally be run as standalone using mock data and running the adapter in stub mode, or as integrated. When running integrated, every effort is made to prevent environmental failures, however there is still a possibility.
 
-#### Unit Testing
+##### Unit Testing
 
 Unit Testing includes testing basic adapter functionality as well as error conditions that are triggered in the adapter prior to any integration. There are two ways to run unit tests. The prefered method is to use the testRunner script; however, both methods are provided here.
 
@@ -232,7 +233,7 @@ npm run test:baseunit
 
 To add new unit tests, edit the `test/unit/adapterTestUnit.js` file. The tests that are already in this file should provide guidance for adding additional tests.
 
-#### Integration Testing - Standalone
+##### Integration Testing - Standalone
 
 Standalone Integration Testing requires mock data to be provided with the entities. If this data is not provided, standalone integration testing will fail. When the adapter is set to run in stub mode (setting the stub property to true), the adapter will run through its code up to the point of making the request. It will then retrieve the mock data and return that as if it had received that data as the response from Amazon_route53. It will then translate the data so that the adapter can return the expected response to the rest of the Itential software. Standalone is the default integration test.
 
@@ -247,7 +248,7 @@ npm run test:integration
 
 To add new integration tests, edit the `test/integration/adapterTestIntegration.js` file. The tests that are already in this file should provide guidance for adding additional tests.
 
-#### Integration Testing
+##### Integration Testing
 
 Integration Testing requires connectivity to Amazon_route53. By using the testRunner script it prevents you from having to edit the integration test. It also resets the integration test after the test is complete so that credentials are not saved in the file.
 
@@ -263,23 +264,19 @@ Test should also be written to clean up after themselves. However, it is importa
 
 > **Reminder**: Do not check in code with actual credentials to systems.
 
-## [Configuration](./PROPERTIES.md)
-
-## [Using this Adapter](./CALLS.md)
-
-### [Authentication](./AUTH.md)
+### [Configuration](./PROPERTIES.md)
 
-## Additional Information
+### Additional Information
 
-### [Enhancements](./ENHANCE.md)
+#### [Enhancements](./ENHANCE.md)
 
-### [Contributing](./CONTRIBUTING.md)
+#### [Contributing](./CONTRIBUTING.md)
 
-### Helpful Links
+#### Helpful Links
 
 <a href="https://docs.itential.com/opensource/docs/adapters" target="_blank">Adapter Technical Resources</a>
 
-### Node Scripts
+#### Node Scripts
 
 There are several node scripts that now accompany the adapter. These scripts are provided to make several activities easier. Many of these scripts can have issues with different versions of IAP as they have dependencies on IAP and Mongo. If you have issues with the scripts please report them to the Itential Adapter Team. Each of these scripts are described below.
 
@@ -331,9 +328,9 @@ There are several node scripts that now accompany the adapter. These scripts are
 </table>
 <br>
 
-## [Troubleshoot](./TROUBLESHOOT.md)
+### [Troubleshoot](./TROUBLESHOOT.md)
 
-## License and Maintainers
+### License and Maintainers
 
 ```text
 Itential Product Adapters are maintained by the Itential Product Team.
@@ -341,6 +338,6 @@ Itential OpenSource Adapters are maintained by the Itential Adapter Team and the
 Custom Adapters are maintained by other sources.
 ```
 
-## Product License
+### Product License
 
 [Apache 2.0](./LICENSE)

package/SYSTEMINFO.md

@@ -7,7 +7,7 @@ Product: Route53
 Product Page: https://aws.amazon.com/route53/
 
 ## Introduction
-We classify AWS Route53 into the Cloud domain as Route53 provides Cloud Services.
+We classify AWS Route53 into the Cloud domain as Route53 provides capabilities in managing and orchestrating domain name system sercices within cloud environments.
 
 "Route53 offers Domain Name Services (DNS)" 
 "Route53 allows for customizing Domain Name Services to improve application availability" 
@@ -16,6 +16,9 @@ We classify AWS Route53 into the Cloud domain as Route53 provides Cloud Services
 The AWS route53 adapter from Itential is used to integrate the Itential Automation Platform (IAP) with AWS Route53. With this adapter you have the ability to perform operations such as:
 
 - Configure and Manage DNS. 
+- Get, or Create Traffic Policy
+- Get, Create, or Delete Hosted Zone
+- List Hosted Zones
 
 ## Additional Product Documentation
 The [API documents for AWS Route53](https://docs.aws.amazon.com/Route53/latest/APIReference/Welcome.html)

package/TAB1.md

@@ -0,0 +1,13 @@
+# Overview 
+
+This adapter is used to integrate the Itential Automation Platform (IAP) with the Amazon_route53 System. The API that was used to build the adapter for Amazon_route53 is usually available in the report directory of this adapter. The adapter utilizes the Amazon_route53 API to provide the integrations that are deemed pertinent to IAP. The ReadMe file is intended to provide information on this adapter it is generated from various other Markdown files.
+
+## Details 
+The AWS route53 adapter from Itential is used to integrate the Itential Automation Platform (IAP) with AWS Route53. With this adapter you have the ability to perform operations such as:
+
+- Configure and Manage DNS. 
+- Get, or Create Traffic Policy
+- Get, Create, or Delete Hosted Zone
+- List Hosted Zones
+
+For further technical details on how to install and use this adapter, please click the Technical Documentation tab. 

package/TAB2.md

@@ -0,0 +1,369 @@
+# Amazon Route53
+
+## 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 Amazon Route53 adapter with AWS 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>. 
+
+#### AWS Authentication
+The Amazon Route53 adapter requires AWS Authentication it does not utilize any of the autnetication methods provided by the adapter library as a result, the auth_method should be set to no_authentication. The adapter utilizes AWS signature 4 authentication. There are 3 flavors of doing this. 
+
+The first way is using a "service" account and its AWS keys to authentication as that account. In this case, you will get the aws_access_key, aws_secret_key, and aws_session_token from AWS and configure them into the adapter service instance as shown below.
+
+The second way is using AWS STS. this still requires a "service" account and its AWS keys to authentication as that account. In this case, you will get the aws_access_key, aws_secret_key, and aws_session_token from AWS and configure them into the adapter service instance as shown below. In addition, you will provide STS paramaters in the workflow tasks that tell the adapter the role you want used on the particular call.
+
+The third authentication method is to use an IAM role. With this method, you do not need any authentication keys as the adapter will utilize an "internal" AWS call to get the things that it needs for authentication. Since the adapter needs to make the call to this "internal" AWS IP address, the IAP server needs to be where it has access to that address or you will not be able to use this method.
+
+If you change authentication methods, you should change this section accordingly and merge it back into the adapter repository.
+
+#### AWS Signature 4 Service Account Authentication
+The Amazon Route53 adapter requires AWS Signature 4 Authentication. If you change authentication methods, you should change this section accordingly and merge it back into the adapter repository.
+
+This authentication is done in the adapter itself and not in the adapter libraries. This is why the auth_method is set to "no_authentication".
+
+STEPS  
+1. Ensure you have access to a Amazon Route53 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": "aws_authentication",
+  "aws_access_key": "aws_access_key",
+  "aws_secret_key": "aws_secret_key",
+  "aws_session_token": "aws_session_token"
+}
+```
+you can leave all of the other properties in the authentication section, they will not be used for Amazon Route53 authentication.
+4. Restart the adapter. If your properties were set correctly, the adapter should go online. 
+
+#### AWS Security Token Service
+The Amazon Route53 adapter also supports AWS Security Token Service (STS) Authentication. For using this authentication, you need to use the calls in the Adapter that have the STSRole suffix on them and pass the STS information into the method.
+
+#### AWS IAM Role
+The Amazon Route53 adapter also supports AWS IAM Role Authentication. For using this authentication, you need to use the calls in the Adapter that have the STSRole suffix on them and pass the RoleName into the method.
+
+#### AMAZON STEPS FOR IAM ROLE
+Increase number of hops if running IAP inside of docker on EC2 instance
+```bash
+aws sso login --profile aws-bota-1
+<export aws keys for CLI access>
+
+aws ec2 modify-instance-metadata-options  --instance-id i-0e150236026b7c45d  --http-put-response-hop-limit 3 --http-endpoint enabled --region us-east-1
+```
+
+Create a new role and attach to it policies:
+- go to your EC2 instance, select it
+- Actions->Security->Modify IAM Role
+- Click 'Create New IAM Role'
+- Create a role:
+```text
+Trusted entity type: AWS service
+Use Case: EC2
+```
+
+Add policies to the role
+- AmazonEC2FullAccess (Provides full access to Amazon EC2 via the AWS Management Console.)
+- AmazonRoute53FullAccess (Provides full access to all Amazon Route 53 via the AWS Management Console.)
+
+Save the role
+
+Go back to your EC2 instance and Actions->Security->Modify IAM Role, associate newly created role with your EC2 instance
+
+#### Troubleshooting
+- Make sure you copied over the correct access key, secret key and session 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.
+- For IAM, you can run this on the IAP server to verify you are getting to the "internal" AWS Server
+```bash
+TOKEN=`curl -v -X PUT "http://169.254.169.254/latest/api/token" -H "X-aws-ec2-metadata-token-ttl-seconds: 21600"` && curl -v -H "X-aws-ec2-metadata-token: $TOKEN" -v http://169.254.169.254/latest/meta-data/iam/security-credentials/<rolename>
+```
+### 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": "localhost",
+    "region": "us-east-1",
+    "port": 443,
+    "choosepath": "",
+    "base_path": "/",
+    "version": "2013-04-01",
+    "service": "route53",
+    "cache_location": "none",
+    "encode_pathvars": true,
+    "encode_queryvars": true,
+    "save_metric": false,
+    "stub": true,
+    "protocol": "https",
+    "authentication": {
+      "auth_method": "aws_authentication",
+      "username": "username",
+      "password": "password",
+      "token": "token",
+      "token_timeout": 600000,
+      "token_cache": "local",
+      "invalid_token_error": 401,
+      "auth_field": "header.headers.Authorization",
+      "auth_field_format": "Basic {b64}{username}:{password}{/b64}",
+      "auth_logging": false,
+      "client_id": "",
+      "client_secret": "",
+      "grant_type": "",
+      "sensitive": [],
+      "sso": {
+        "protocol": "",
+        "host": "",
+        "port": 0
+      },
+      "multiStepAuthCalls": [
+        {
+          "name": "",
+          "requestFields": {},
+          "responseFields": {},
+          "successfullResponseCode": 200
+        }
+      ],
+      "aws_access_key": "aws_access_key",
+      "aws_secret_key": "aws_secret_key",
+      "aws_session_token": "aws_session_token",
+      "aws_iam_role": ""
+    },
+    "healthcheck": {
+      "type": "startup",
+      "frequency": 60000,
+      "query_object": {},
+      "addlHeaders": {}
+    },
+    "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": {},
+        "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/cloud/adapter-amazon_route53/-/blob/master/report/adapter-openapi.json) 
+
+## [Generic Adapter Information](https://gitlab.com/itentialopensource/adapters/cloud/adapter-amazon_route53/-/blob/master/README.md) 
+

package/metadata.json

@@ -44,13 +44,24 @@
     "isDeprecated": false
   },
   "brokerSince": "",
+  "authMethods": [
+    {
+      "type": "AWS Auth",
+      "primary": true
+    }
+  ],
   "documentation": {
     "storeLink": "",
     "npmLink": "https://www.npmjs.com/package/@itentialopensource/adapter-amazon_route53",
-    "repoLink": "https://gitlab.com/itentialopensource/adapters/cloud/adapter-amazon_route53",
+    "repoLink": "https://gitlab.com/itentialopensource/adapters/adapter-amazon_route53",
     "docLink": "https://docs.itential.com/opensource/docs/amazon-route53",
     "demoLinks": [],
-    "trainingLinks": [],
+    "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",

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@itentialopensource/adapter-amazon_route53",
-  "version": "0.3.8",
+  "version": "0.4.0",
   "description": "This adapter integrates with system described as: Amazon Route53.",
   "main": "adapter.js",
   "systemName": "Amazon AWS Route53",
   "wizardVersion": "2.44.7",
-  "engineVersion": "1.67.10",
+  "engineVersion": "1.67.20",
   "adapterType": "http",
   "scripts": {
     "artifactize": "npm i && node utils/packModificationScript.js",
@@ -16,7 +16,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/*",
     "adapter:patches2bundled": "node utils/patches2bundledDeps.js",
     "test": "npm run test:baseunit && npm run test:unit && npm run test:integration",
     "adapter:install": "npm i && node utils/tbScript.js install",
@@ -46,20 +45,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/cloud/adapter-amazon_route53.git"
+    "url": "git@gitlab.com:itentialopensource/adapters/adapter-amazon_route53.git"
   },
   "author": "Itential",
-  "homepage": "https://gitlab.com/itentialopensource/adapters/cloud/adapter-amazon_route53#readme",
+  "homepage": "https://gitlab.com/itentialopensource/adapters/adapter-amazon_route53#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",
@@ -67,7 +66,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

@@ -985,6 +985,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.3.2",
-  "configLines": 9893,
+  "version": "0.3.9",
+  "configLines": 9898,
   "scriptLines": 1783,
   "codeLines": 9292,
-  "testLines": 6945,
+  "testLines": 6944,
   "testCases": 354,
-  "totalCodeLines": 18020,
+  "totalCodeLines": 18019,
   "wfTasks": 153
 }

package/report/updateReport1717535007617.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": 83
+    },
+    {
+      "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": 3584
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of unit tests",
+      "value": 209
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of lines of code in integration tests",
+      "value": 2108
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of integration tests",
+      "value": 73
+    },
+    {
+      "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": 7145
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Tests",
+      "value": 282
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Files",
+      "value": 6
+    }
+  ]
+}

package/sampleProperties.json

@@ -122,30 +122,32 @@
       }
     },
     "devicebroker": {
+      "enabled": false,
       "getDevice": [
         {
-          "path": "/get/devices/{id}",
+          "path": "/not/mapped",
           "method": "GET",
           "query": {},
           "body": {},
           "headers": {},
           "handleFailure": "ignore",
           "requestFields": {
-            "id": "name"
+            "insample": "{port}"
           },
           "responseDatakey": "",
           "responseFields": {
-            "name": "host",
-            "ostype": "os",
-            "ostypePrefix": "system-",
-            "ipaddress": "attributes.ipaddr",
-            "port": "443"
+            "name": "{this}{||}{that}",
+            "ostype": "{osfield}",
+            "ostypePrefix": "meraki-",
+            "port": "{port}",
+            "ipaddress": "{ip_addr}",
+            "serial" : "{serial}"
           }
         }
       ],
       "getDevicesFiltered": [
         {
-          "path": "/get/devices",
+          "path": "/not/mapped",
           "method": "GET",
           "pagination": {
             "offsetVar": "",
@@ -160,42 +162,44 @@
           "requestFields": {},
           "responseDatakey": "",
           "responseFields": {
-            "name": "host",
-            "ostype": "os",
-            "ostypePrefix": "system-",
-            "ipaddress": "attributes.ipaddr",
-            "port": "443"
+            "name": "{this}{||}{that}",
+            "ostype": "{osfield}",
+            "ostypePrefix": "meraki-",
+            "port": "{port}",
+            "ipaddress": "{ip_addr}",
+            "serial" : "{serial}",
+            "id": "{myid}"
           }
         }
       ],
       "isAlive": [
         {
-          "path": "/get/devices/{id}/status",
+          "path": "/not/mapped/{devID}",
           "method": "GET",
           "query": {},
           "body": {},
           "headers": {},
           "handleFailure": "ignore",
           "requestFields": {
-            "id": "name"
+            "devID": "{id}"
           },
           "responseDatakey": "",
           "responseFields": {
-            "status": "status",
-            "statusValue": "online"
+            "status": "return2xx",
+            "statusValue": "AD.200"
           }
         }
       ],
       "getConfig": [
         {
-          "path": "/get/devices/{id}/configPart1",
+          "path": "/not/mapped/{devID}",
           "method": "GET",
           "query": {},
           "body": {},
           "headers": {},
           "handleFailure": "ignore",
           "requestFields": {
-            "id": "name"
+            "devID": "{id}"
           },
           "responseDatakey": "",
           "responseFields": {}
@@ -203,7 +207,7 @@
       ],
       "getCount": [
         {
-          "path": "/get/devices",
+          "path": "/not/mapped",
           "method": "GET",
           "query": {},
           "body": {},
@@ -219,15 +223,15 @@
       "enabled": false,
       "entities": [
         {
-          "entityType": "",
-          "frequency": 1440,
+          "entityType": "device",
+          "frequency": 3600,
           "flushOnFail": false,
-          "limit": 1000,
+          "limit": 10000,
           "retryAttempts": 5,
           "sort": true,
           "populate": [
             {
-              "path": "",
+              "path": "/not/mapped",
               "method": "GET",
               "pagination": {
                 "offsetVar": "",
@@ -241,7 +245,15 @@
               "handleFailure": "ignore",
               "requestFields": {},
               "responseDatakey": "",
-              "responseFields": {}
+              "responseFields": {
+                "name": "{this}{||}{that}",
+                "ostype": "{osfield}",
+                "ostypePrefix": "meraki-",
+                "port": "{port}",
+                "ipaddress": "{ip_addr}",
+                "serial" : "{serial}",
+                "id": "{myid}"
+              }
             }
           ],
           "cachedTasks": [

package/test/integration/adapterTestIntegration.js

@@ -46,6 +46,7 @@ samProps.ssl.accept_invalid_cert = false;
 if (samProps.request.attempt_timeout < 30000) {
   samProps.request.attempt_timeout = 30000;
 }
+samProps.devicebroker.enabled = true;
 const attemptTimeout = samProps.request.attempt_timeout;
 const { stub } = samProps;
 

package/test/unit/adapterTestUnit.js

@@ -284,7 +284,6 @@ describe('[unit] Amazon_route53 Adapter Test', () => {
           assert.equal('mocha test/unit/adapterBaseTestUnit.js --LOG=error', packageDotJson.scripts['test:baseunit']);
           assert.equal('mocha test/unit/adapterTestUnit.js --LOG=error', packageDotJson.scripts['test:unit']);
           assert.equal('mocha test/integration/adapterTestIntegration.js --LOG=error', packageDotJson.scripts['test:integration']);
-          assert.equal('nyc --reporter html --reporter text mocha --reporter dot test/*', packageDotJson.scripts['test:cover']);
           assert.equal('npm run test:baseunit && npm run test:unit && npm run test:integration', packageDotJson.scripts.test);
           assert.equal('npm publish --registry=https://registry.npmjs.org --access=public', packageDotJson.scripts.deploy);
           assert.equal('npm run deploy', packageDotJson.scripts.build);
@@ -316,12 +315,11 @@ describe('[unit] Amazon_route53 Adapter Test', () => {
           assert.notEqual(null, packageDotJson.dependencies);
           assert.notEqual('', packageDotJson.dependencies);
           assert.equal('^8.12.0', packageDotJson.dependencies.ajv);
-          assert.equal('^1.6.7', packageDotJson.dependencies.axios);
+          assert.equal('^1.6.8', packageDotJson.dependencies.axios);
           assert.equal('^11.0.0', packageDotJson.dependencies.commander);
           assert.equal('^11.1.1', packageDotJson.dependencies['fs-extra']);
           assert.equal('^10.3.0', packageDotJson.dependencies.mocha);
           assert.equal('^2.0.1', packageDotJson.dependencies['mocha-param']);
-          assert.equal('^15.1.0', packageDotJson.dependencies.nyc);
           assert.equal('^0.4.4', packageDotJson.dependencies.ping);
           assert.equal('^1.4.10', packageDotJson.dependencies['readline-sync']);
           assert.equal('^7.5.3', packageDotJson.dependencies.semver);
@@ -563,7 +561,7 @@ describe('[unit] Amazon_route53 Adapter Test', () => {
           log.error(`Adapter Exception: ${error}`);
           done(error);
         }
-      });
+      }).timeout(attemptTimeout);
     });
 
     describe('propertiesSchema.json', () => {