@itentialopensource/adapter-netbox 0.6.3 → 0.7.1

package/CHANGELOG.md

@@ -1,4 +1,28 @@
 
+## 0.7.1 [03-07-2022]
+
+* fix graphql with sendGetBody
+
+See merge request itentialopensource/adapters/inventory/adapter-netbox!14
+
+---
+
+## 0.7.0 [02-14-2022]
+
+* migration and added a call for graphql
+
+See merge request itentialopensource/adapters/inventory/adapter-netbox!13
+
+---
+
+## 0.6.4 [07-13-2021]
+
+* Updates healthcheck endpoint to use /api/status ADAPT-758
+
+See merge request itentialopensource/adapters/inventory/adapter-netbox!12
+
+---
+
 ## 0.6.3 [03-17-2021]
 
 * fix descriptions and summaries

package/README.md

@@ -125,7 +125,8 @@ This section defines **all** the properties that are available for the adapter,
       },
       "healthcheck": {
         "type": "startup",
-        "frequency": 300000
+        "frequency": 300000,
+        "query_object": {}
       },
       "request": {
         "number_redirects": 0,
@@ -250,6 +251,7 @@ The healthcheck properties defines the API that runs the healthcheck to tell the
 | ------- | ------- |
 | type | Required. The type of health check to run. |
 | frequency | Required if intermittent. Defines how often the health check should run. Measured in milliseconds. Default is 300000.|
+| query_object | Query parameters to be added to the adapter healthcheck call.|
 
 ### Request Properties
 
@@ -398,7 +400,7 @@ There are several node scripts that now accompany the adapter. These scripts are
 | 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 Netbox system.|
 | npm run healthcheck | Checks whether the configured healthcheck call works to Netbox.|
-| npm run basicget | Checks whether the cbasic get calls works to Netbox.|
+| npm run basicget | Checks whether the basic get calls works to Netbox.|
 
 ## Installing an Itential Product Adapter
 
@@ -412,21 +414,21 @@ if the @itentialopensource directory does not exist, create it:
    mkdir @itentialopensource
 ```
 
-1. Clone the adapter into your IAP environment.
+2. Clone the adapter into your IAP environment.
 
 ```bash
 cd \@itentialopensource
 git clone git@gitlab.com:\@itentialopensource/adapters/adapter-netbox
 ```
 
-1. Run the adapter install script.
+3. Run the adapter install script.
 
 ```bash
 cd adapter-netbox
 npm run adapter:install
 ```
 
-1. Restart IAP
+4. Restart IAP
 
 ```bash
 systemctl restart pronghorn
@@ -446,7 +448,7 @@ Depending on where your code is located, this process is different.
 Adapter should be placed into: /opt/pronghorn/current/node_modules/\@itentialopensource
 ```
 
-1. Follow Steps 3-4 (above) to install an Itential adapter to load your properties, dependencies and restart IAP.
+2. Follow Steps 3-4 (above) to install an Itential adapter to load your properties, dependencies and restart IAP.
 
 ## Using this Adapter
 
@@ -494,7 +496,7 @@ The `verifyCapability` call verifies the adapter can perform the provided action
 verifyCapability(entityType, actionType, entityId, callback)
 ```
 
-The `updateEntityCache` call will update the entity cache. 
+The `updateEntityCache` call will update the entity cache.
 ```js
 updateEntityCache()
 ```
@@ -548,6 +550,77 @@ getQueue(callback)
 
 Specific adapter calls are built based on the API of the Netbox. The Adapter Builder creates the proper method comments for generating JS-DOC for the adapter. This is the best way to get information on the calls.
 
+
+## Extending/Enhancing the Adapter
+
+### Adding a Second Instance of an Adapter
+
+You can add a second instance of this adapter without adding new code on the file system. To do this go into the IAP Admin Essentials and add a new service config for this adapter. The two instances of the adapter should have unique ids. In addition, they should point to different instances of the other system. For example, they should be configured to talk to different hosts.
+
+### Adding Adapter Calls
+
+There are multiple ways to add calls to an existing adapter.
+
+The easiest way would be to use the Adapter Builder update process. This process takes in a Swagger or OpenAPI document, allows you to select the calls you want to add and then generates a zip file that can be used to update the adapter. Once you have the zip file simple put it in the adapter direcctory and execute `npm run adapter:update`.
+
+```bash
+mv updatePackage.zip adapter-netbox
+cd adapter-netbox
+npm run adapter:update
+```
+
+If you do not have a Swagger or OpenAPI document, you can use a Postman Collection and convert that to an OpenAPI document using APIMatic and then follow the first process.
+
+If you want to manually update the adapter that can also be done the key thing is to make sure you update all of the right files. Within the entities directory you will find 1 or more entities. You can create a new entity or add to an existing entity. Each entity has an action.json file, any new call will need to be put in the action.json file. It will also need to be added to the enum for the ph_request_type in the appropriate schema files. Once this configuration is complete you will need to add the call to the adapter.js file and in order to make it available as a workflow task in IAP, it should also be added to the pronghorn.json file. You can optionally add it to the unit and integration test files. There is more information on how to work on each of these files in the Adapter Technical Resources on Dev Site [HERE](https://developer.itential.io/adapters-resources/)
+
+```text
+Files to update
+* entities/<entity>/action.json: add an action
+* entities/<entity>/schema.json (or the schema defined on the action): add action to the enum for ph_request_type
+* adapter.js: add the new method and make sure it calls the proper entity and action
+* pronghorn.json: add the new method
+* test/unit/adapterTestUnit.js (optional but best practice): add unit test(s) - function is there, any required parameters error when not passed in
+* test/integration/adapterTestIntegration.js (optional but best practice): add integration test
+```
+
+### Adding Adapter Properties
+
+While changing adapter properties is done in the service instance configuration section of IAP, adding properties has to be done in the adapter. To add a property you should edit the propertiesSchema.json with the proper information for the property. In addition, you should modify the sampleProperties to have the new property in it.
+
+```text
+Files to update
+* propertiesSchema.json: add the new property and how it is defined
+* sampleProperties: add the new property with a default value
+* test/unit/adapterTestUnit.js (optional but best practice): add the property to the global properties
+* test/integration/adapterTestIntegration.js (optional but best practice): add the property to the global properties
+```
+
+### Changing Adapter Authentication
+
+Often an adapter is built before knowing the authentication and authentication process can also change over time. The adapter supports many different kinds of authentication but it does require configuration. Some forms of authentication can be defined entirely with the adapter properties but others require configuration.
+
+```text
+Files to update
+* entities/<entity>/action.json: change the getToken action as needed
+* entities/<entity>/schemaTokenReq.json: add input parameters (external name is name in other system)
+* entities/<entity>/schemaTokenResp.json: add response parameters (external name is name in other system)
+* propertiesSchema.json: add any new property and how it is defined
+* sampleProperties: add any new property with a default value
+* test/unit/adapterTestUnit.js (optional but best practice): add the property to the global properties
+* test/integration/adapterTestIntegration.js (optional but best practice): add the property to the global properties
+```
+
+### Enhancing Adapter Integration Tests
+
+The adapter integration tests are written to be able to test in either stub (standalone) mode or integrated to the other system. However, if integrating to the other system, you may need to provide better data than what the adapter provides by default as that data is likely to fail for create and update. To provide better data, edit the adapter integration test file. Make sure you do not remove the marker and keep custom code below the marker so you do not impact future migrations. Once the edits are complete, run the integration test as it instructs you to above. When you run integrated to the other system, you can also save mockdata for future use by changing the isSaveMockData flag to true.
+
+```text
+Files to update
+* test/integration/adapterTestIntegration.js: add better data for the create and update calls so that they will not fail.
+```
+
+As mentioned previously, for most of these changes as well as other possible changes, there is more information on how to work on an adapter in the Adapter Technical Resources on Dev Site [HERE](https://developer.itential.io/adapters-resources/)
+
 ## Troubleshooting the Adapter
 
 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.
@@ -566,26 +639,26 @@ User also have the option to run individual command to perform specific test
 npm run troubleshoot
 ```
 
-1. Verify the adapter properties are set up correctly.
+2. Verify the adapter properties are set up correctly.
 
 ```text
 Go into the Itential Platform GUI and verify/update the properties
 ```
 
-1. Verify there is connectivity between the Itential Platform Server and Netbox Server.
+3. Verify there is connectivity between the Itential Platform Server and Netbox Server.
 
 ```text
 ping the ip address of Netbox server
 try telnet to the ip address port of Netbox
 ```
 
-1. Verify the credentials provided for Netbox.
+4. Verify the credentials provided for Netbox.
 
 ```text
 login to Netbox using the provided credentials
 ```
 
-1. Verify the API of the call utilized for Netbox Healthcheck.
+5. Verify the API of the call utilized for Netbox Healthcheck.
 
 ```text
 Go into the Itential Platform GUI and verify/update the properties