@itentialopensource/adapter-onap_aai 0.3.1 → 0.4.0

package/SUMMARY.md

@@ -0,0 +1,9 @@
+## Overview
+
+This adapter is used to integrate the Itential Automation Platform (IAP) with the Onap_aai System. The API that was used to build the adapter for Onap_aai is usually available in the report directory of this adapter. The adapter utilizes the Onap_aai 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 Onap_aai 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 <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 @@
+# ONAP - Active and Available Inventory
+
+Vendor: ONAP - Active and Available Inventory
+Homepage: https://ONAP - Active and Available Inventory.com/
+
+Product: ONAP - Active and Available Inventory
+Product Page: https://ONAP - Active and Available Inventory.com/
+
+## Introduction
+
+## Additional Product Documentation

package/TROUBLESHOOT.md

@@ -0,0 +1,47 @@
+## Troubleshoot
+
+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.
+
+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.
+- `npm run connectivity` will perform networking diagnostics of the adatper endpoint.
+
+### Connectivity Issues
+
+1. You can run the adapter troubleshooting script which will check connectivity, run the healthcheck and run basic get calls.
+
+```bash
+npm run troubleshoot
+```
+
+2. Verify the adapter properties are set up correctly.
+
+```text
+Go into the Itential Platform GUI and verify/update the properties
+```
+
+3. Verify there is connectivity between the Itential Platform Server and Onap_aai Server.
+
+```text
+ping the ip address of Onap_aai server
+try telnet to the ip address port of Onap_aai
+execute a curl command to the other system
+```
+
+4. Verify the credentials provided for Onap_aai.
+
+```text
+login to Onap_aai using the provided credentials
+```
+
+5. Verify the API of the call utilized for Onap_aai Healthcheck.
+
+```text
+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 can be configured to log into their own files.