.png?sv=2022-11-02&ss=b&srt=o&spr=https&st=2024-04-19T04%3A31%3A37Z&se=2024-04-19T04%3A41%3A37Z&sp=r&sig=hcihVR7Ia4s4mGDMG24yFTAswq3UwYyr2PpSViqyqy0%3D){kind=logo}
Gitlab File Definitions - Adapters
- 30 Jan 2023
-
DarkLight
-
PDF
Gitlab File Definitions - Adapters
- Updated on 30 Jan 2023
-
DarkLight
-
PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
The following table will define all Markdown ( md.) files provided in an adapter GitLab repository.
| File Name | Description |
|---|---|
| Auth.md | This file provides steps for authenticating the adapter and getting it online. This can often start out as a generic file but our intentions are to go in and make it accurate for the system we are integrating with. As you find changes that need to be made please create issues in the GitLab repo for the specific adapter. For more information, please reference the authentication overview. |
| BROKER.md | This file provides information on how to integrate an adapter with the IAP Device Broker. The document will provide description of the calls utlilzed by the IAP Device Broker. Integrating an adapter with the IAP Device Broker allows for "devices" to appear and be managed from the Config Manager Application in IAP. Properly configuring the properties for the adapter in IAP is critical for getting the device broker integration to work. |
| CALLS.md | This file provides a brief summary of calls the adapter makes available to the rest of the Itential platform. The calls defined include: generic adapter calls, IAP device broker calls, and adapter-specific calls. This can often start out as a generic file that lacks the specific calls. There is a tool that can be used to automatically populate the specific calls but it will only be run when the adapters are next migrated. If you need the information on specific calls please create issues in the GitLab repo for the specific adapter. |
| CHANGELOG.md | This file provides a timeline of changes made to an adapter by versioning. |
| CODE_OF_CONDUCT.md | This files provides information on Itential conduct standards to follow when contributing to a project; our pledge, our standards, our responsibilities, etc. |
| CONTRIBUTING.md | This file provides details on contributing standards, guidelines to follow, and information for submitting adapter requests. For more information, please reference the adapter contributing wiki. |
| ENHANCE.md | This file provides information on how to make the following changes to an adapter; properties, calls, authentication, integration tests, and adding a second instance to an adapter. |
| PROPERTIES.md | This file defines service instance configurations (properties) available for an adapter and detailed information about what each property is for. For more information, please reference the IAP Service Instance Configuration Articles |
| README.md | This file contains explanatory information about an adapter such as versioning, how to install, testing, etc. |
| SUMMARY. md | This file provides overview on the external system and the APIs used to build the adapter. |
| SYSTEMINFO.md | This file provides information about the external system an adapter integrates with and why you might be interested in integration with that system. Similarly with AUTH and CALLS, this should have specific information. It was originally generated from the Adapter Build process as a generic file and we are in the process of providing system specific information. |
| TROUBLESHOOT.md | This file provides information on how to resolve issues that may arise while using an adapter. |
Was this article helpful?
