@itentialopensource/adapter-adtran_mosaic_devicemanager 0.1.1 → 0.3.0

package/README.md

@@ -2,34 +2,37 @@
 
 ## Table of Contents
 
-* [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)
-* [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)
+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)
+  - [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)
 
 ## [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 [Itential OpenSource Repository](https://gitlab.com/itentialopensource/adapters).
+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>.
 
 Any release prior to 1.0.0 is a pre-release. Initial builds of adapters are generally set up as pre-releases as there is often work that needs to be done to configure the adapter and make sure the authentication process to AdtranMosaicDeviceManager works appropriately.
 
-Release notes can be viewed in CHANGELOG.md or in the [Customer Knowledge Base](https://itential.atlassian.net/servicedesk/customer/portals) for Itential adapters.
+Release notes can be viewed in CHANGELOG.md.
 
 ## Supported IAP Versions
 
@@ -45,21 +48,24 @@ These instructions will help you get a copy of the project on your local machine
 
 ### Helpful Background Information
 
-There is adapter documentation available on the Itential Developer Site [HERE](https://www.itential.com/automation-platform/integrations/adapters-resources/). This documentation includes information and examples that are helpful for:
+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:
 
 ```text
 Authentication
-Properties
+IAP Service Instance Configuration
 Code Files
-Action Files
-Schema Files
-Mock Data Files
+Endpoint Configuration (Action & Schema)
+Mock Data
+Adapter Generic Methods
+Headers
+Security
 Linting and Testing
-Troubleshooting
+Build an Adapter
+Troubleshooting an Adapter
 ```
 
 Others will be added over time.
-Want to build a new adapter? Use the Itential Adapter Builder [HERE](https://adapters.itential.io)
+Want to build a new adapter? Use the <a href="https://adapters.itential.io" target="_blank">Itential Adapter Builder</a>
 
 ### Prerequisites
 
@@ -73,22 +79,69 @@ Git
 
 The following list of packages are required for Itential opensource adapters or custom adapters that have been built utilizing the Itential Adapter Builder. You can install these packages by running npm install inside the adapter directory.
 
-| Package | Description |
-| ------- | ------- |
-| @itentialopensource/adapter-utils | Runtime library classes for all adapters;  includes request handling, connection, authentication throttling, and translation. |
-| ajv | Required for validation of adapter properties to integrate with AdtranMosaicDeviceManager. |
-| axios | Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality. |
-| commander | Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality. |
-| fs-extra | Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality. |
-| mocha | Testing library that is utilized by some of the node scripts that are included with the adapter. |
-| mocha-param | Testing library that is utilized by some of the node scripts that are included with the adapter. |
-| mongodb | Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality. |
-  
-| network-diagnostics | Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality. |
-| nyc | Testing coverage library that is utilized by some of the node scripts that are included with the adapter. |
-| readline-sync | Utilized by the node script that comes with the adapter;  helps to test unit and integration functionality. |
-| semver | Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality. |
-| winston | Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality. |
+<table border="1" class="bordered-table">
+  <tr>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Package</span></th>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
+  </tr>
+  <tr>
+    <td style="padding:15px">@itentialopensource/adapter-utils</td>
+    <td style="padding:15px">Runtime library classes for all adapters;  includes request handling, connection, authentication throttling, and translation.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">ajv</td>
+    <td style="padding:15px">Required for validation of adapter properties to integrate with AdtranMosaicDeviceManager.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">axios</td>
+    <td style="padding:15px">Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">commander</td>
+    <td style="padding:15px">Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">dns-lookup-promise</td>
+    <td style="padding:15px">Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">fs-extra</td>
+    <td style="padding:15px">Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">mocha</td>
+    <td style="padding:15px">Testing library that is utilized by some of the node scripts that are included with the adapter.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">mocha-param</td>
+    <td style="padding:15px">Testing library that is utilized by some of the node scripts that are included with the adapter.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">mongodb</td>
+    <td style="padding:15px">Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">nyc</td>
+    <td style="padding:15px">Testing coverage library that is utilized by some of the node scripts that are included with the adapter.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">ping</td>
+    <td style="padding:15px">Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">readline-sync</td>
+    <td style="padding:15px">Utilized by the node script that comes with the adapter;  helps to test unit and integration functionality.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">semver</td>
+    <td style="padding:15px">Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">winston</td>
+    <td style="padding:15px">Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.</td>
+  </tr>
+</table>
+<br>
 
 If you are developing and testing a custom adapter, or have testing capabilities on an Itential opensource adapter, you will need to install these packages as well.
 
@@ -98,7 +151,6 @@ eslint
 eslint-config-airbnb-base
 eslint-plugin-import
 eslint-plugin-json
-package-json-validator
 testdouble
 ```
 
@@ -127,7 +179,9 @@ tar -xvf adapter-adtran_mosaic_devicemanager.tar
 
 ```bash
 cd adapter-adtran_mosaic_devicemanager
-npm run adapter:install
+npm install
+npm run lint:errors
+npm run test
 ```
 
 4. Restart IAP
@@ -136,17 +190,20 @@ npm run adapter:install
 systemctl restart pronghorn
 ```
 
-5. Change the adapter service instance configuration (host, port, credentials, etc) in IAP Admin Essentials GUI
+5. Create an adapter service instance configuration in IAP Admin Essentials GUI
+
+6. Copy the properties from the sampleProperties.json and paste them into the service instance configuration in the inner/second properties field.
+
+7. Change the adapter service instance configuration (host, port, credentials, etc) in IAP Admin Essentials GUI
 
-npm run adapter:install can be dependent on where the adapter is installed and on the version of IAP so it is subject to fail. If this happens you can replace step 3-5 above with these:
+
+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-adtran_mosaic_devicemanager
-npm run install
-npm run lint:errors
-npm run test
+npm run adapter:install
 ```
 
 4. Restart IAP
@@ -155,11 +212,8 @@ npm run test
 systemctl restart pronghorn
 ```
 
-5. Create an adapter service instance configuration in IAP Admin Essentials GUI
-
-6. Copy the properties from the sampleProperties.json and paste them into the service instance configuration in the inner/second properties field.
+5. Change the adapter service instance configuration (host, port, credentials, etc) in IAP Admin Essentials GUI
 
-7. Change the adapter service instance configuration (host, port, credentials, etc) in IAP Admin Essentials GUI
 
 ### Testing
 
@@ -223,24 +277,59 @@ Test should also be written to clean up after themselves. However, it is importa
 
 ### Helpful Links
 
-[Adapter Technical Resources](https://www.itential.com/automation-platform/integrations/adapters-resources/)
+<a href="https://docs.itential.com/opensource/docs/adapters" target="_blank">Adapter Technical Resources</a>
 
 ### 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.
 
-| Run | Description |
-| ------- | ------- |
-| npm run adapter:install | Provides an easier way to install the adapter.|
-| npm run adapter:checkMigrate | Checks whether your adapter can and should be migrated to the latest foundation.|
-| npm run adapter:findPath | Can be used to see if the adapter supports a particular API call.|
-| npm run adapter:migrate | Provides an easier way to migrate your adapter after you download the migration zip from Itential DevSite|
-| npm run adapter:update | Provides an easier way to update your adapter after you download the migration zip from Itential DevSite|
-| npm run adapter:revert | Allows you to revert after a migration or update if it resulted in issues.|
-| npm run troubleshoot | Provides a way to troubleshoot the adapter - runs connectivity, healthcheck and basic get.|
-| npm run connectivity | Provides a connectivity check to the AdtranMosaicDeviceManager system.|
-| npm run healthcheck | Checks whether the configured healthcheck call works to AdtranMosaicDeviceManager.|
-| npm run basicget | Checks whether the basic get calls works to AdtranMosaicDeviceManager.|
+<table border="1" class="bordered-table">
+  <tr>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Run</span></th>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
+  </tr>
+  <tr>
+    <td style="padding:15px">npm run adapter:install</td>
+    <td style="padding:15px">Provides an easier way to install the adapter.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">npm run adapter:checkMigrate</td>
+    <td style="padding:15px">Checks whether your adapter can and should be migrated to the latest foundation.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">npm run adapter:findPath</td>
+    <td style="padding:15px">Can be used to see if the adapter supports a particular API call.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">npm run adapter:migrate</td>
+    <td style="padding:15px">Provides an easier way to update your adapter after you download the migration zip from Itential DevSite.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">npm run adapter:update</td>
+    <td style="padding:15px">Provides an easier way to update your adapter after you download the update zip from Itential DevSite.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">npm run adapter:revert</td>
+    <td style="padding:15px">Allows you to revert after a migration or update if it resulted in issues.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">npm run troubleshoot</td>
+    <td style="padding:15px">Provides a way to troubleshoot the adapter - runs connectivity, healthcheck and basic get.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">npm run connectivity</td>
+    <td style="padding:15px">Provides a connectivity check to the AdtranMosaicDeviceManager system.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">npm run healthcheck</td>
+    <td style="padding:15px">Checks whether the configured healthcheck call works to AdtranMosaicDeviceManager.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">npm run basicget</td>
+    <td style="padding:15px">Checks whether the basic get calls works to AdtranMosaicDeviceManager.</td>
+  </tr>
+</table>
+<br>
 
 ## [Troubleshoot](./TROUBLESHOOT.md)
 

package/SUMMARY.md

@@ -1,9 +1,9 @@
 ## Overview
 
-This adapter is used to integrate the Itential Automation Platform (IAP) with the AdtranMosaicDeviceManager System. The API for AdtranMosaicDeviceManager is available at [HERE](). The adapter utilizes the AdtranMosaicDeviceManager 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.
+This adapter is used to integrate the Itential Automation Platform (IAP) with the AdtranMosaicDeviceManager System. The API that was used to build the adapter for AdtranMosaicDeviceManager is usually available in the report directory of this adapter. The adapter utilizes the AdtranMosaicDeviceManager 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.
 
 >**Note**: It is possible that some integrations will be supported through the AdtranMosaicDeviceManager adapter while other integrations will not. If you need additional API calls, you can use the Update capabilities provided by the Adapter Builder or request Itential to add them if the Adapter is an Itential opensourced adapter.
 
-Itential provides information on all of its product adapters in the Customer Knowledge Base. Information in the [Customer Knowledge Base](https://itential.atlassian.net/servicedesk/customer/portals) is consistently maintained and goes through documentation reviews. As a result, it should be the first place to go for information.
+Itential provides information on all of its product adapters in the Customer Knowledge Base. Information in the <a href="https://itential.atlassian.net/servicedesk/customer/portals" target="_blank">Customer Knowledge Base</a> is consistently maintained and goes through documentation reviews. As a result, it should be the first place to go for information.
 
 For opensourced and custom built adapters, the ReadMe is a starting point to understand what you have built, provide the information for you to be able to update the adapter, and assist you with deploying the adapter into IAP.

package/SYSTEMINFO.md

@@ -0,0 +1,11 @@
+# Adtran Mosaic Device Manager
+
+Vendor: Adtran Mosaic Device Manager
+Homepage: https://Adtran Mosaic Device Manager.com/
+
+Product: Adtran Mosaic Device Manager
+Product Page: https://Adtran Mosaic Device Manager.com/
+
+## Introduction
+
+## Additional Product Documentation

package/TROUBLESHOOT.md

@@ -1,8 +1,8 @@
 ## Troubleshoot
 
-Run `npm run troubleshoot` to start the interactive troubleshooting process. The command allows user to verify and update connection, authentication as well as healthcheck configuration. After that it will test these properties by sending HTTP request to the endpoint. If the tests pass, it will persist these changes into IAP.
+Run `npm run troubleshoot` to start the interactive troubleshooting process. The command allows you to verify and update connection, authentication as well as healthcheck configuration. After that it will test these properties by sending HTTP request to the endpoint. If the tests pass, it will persist these changes into IAP.
 
-User also have the option to run individual command to perform specific test
+You also have the option to run individual commands to perform specific test:
 
 - `npm run healthcheck` will perform a healthcheck request of with current setting.
 - `npm run basicget` will perform some non-parameter GET request with current setting.
@@ -27,6 +27,7 @@ Go into the Itential Platform GUI and verify/update the properties
 ```text
 ping the ip address of AdtranMosaicDeviceManager server
 try telnet to the ip address port of AdtranMosaicDeviceManager
+execute a curl command to the other system
 ```
 
 4. Verify the credentials provided for AdtranMosaicDeviceManager.
@@ -43,4 +44,4 @@ Go into the Itential Platform GUI and verify/update the properties
 
 ### Functional Issues
 
-Adapter logs are located in `/var/log/pronghorn`. In older releases of the Itential Platform, there is a `pronghorn.log` file which contains logs for all of the Itential Platform. In newer versions, adapters are logging into their own files.
+Adapter logs are located in `/var/log/pronghorn`. In older releases of the Itential Platform, there is a `pronghorn.log` file which contains logs for all of the Itential Platform. In newer versions, adapters can be configured to log into their own files.