Mongo vendor logo

Vendor

Mongo

Product

Mongo DB

Method

REST

Category

Data Storage

Project Type

Adapter

View Repository
Adapter

Adapter for Integration to Mongo

Overview

This adapter is used to integrate the Itential Automation Platform (IAP) with the DBMongo System. The API that was used to build the adapter for DBMongo is usually available in the report directory of this adapter. The adapter utilizes the DBMongo 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 MongoDB adapter from Itential is used to integrate the Itential Automation Platform (IAP) with MongoDB. With this adapter you have the ability to perform operations with MongoDB on items such as:

  • Storage of Information
  • Retrieval of Information

For further technical details on how to install and use this adapter, please click the Technical Documentation tab.

MongoDB

Table of Contents

Specific Adapter Information

Authentication

This document will go through the steps for authenticating the Mongo DB adapter with. Properly configuring the properties for an adapter in IAP is critical for getting the adapter online. You can read more about adapter authentication HERE.

Database Library Authentication

The Mongo DB adapter requires Database Library Authentication. If you change authentication methods, you should change this section accordingly and merge it back into the adapter repository.

STEPS

  1. Ensure you have access to an Adapter for Mongo DB 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 a cluster set up. Tweak the properties as needed for your set up.
     "properties": {
   "db": "<databaseName>",
   "host": "host1:27017,host2:27017,host3",
   "port": 27017,
   "createUuid": true,
   "databaseConnection": "connect on startup",
   "credentials": {
     "dbAuth": true,
     "dbAuthSource": "admin",
     "passwd": "<password>",
     "user": "<username>"
   },
   "ssl": {
     "enabled": true,
     "sslValidate": true,
     "sslCA": "/home/dirA/dirB/myCAFile.cert",
     "acceptInvalidCerts": true,
     "checkServerIdentity": true
   },
   "replSet": {
     "enabled": true,
     "replicaSet": "replicaSet=rs1"
   }
 }
  4. Restart the adapter. If your properties were set correctly, the adapter should go online.

Troubleshooting

  • Make sure you copied over the correct username and password.
  • Turn on debug level logs for the adapter in IAP Admin Essentials.
  • Investigate the logs
  • 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.

    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.

  "properties": {
    "db": "mydatabase",
    "host": "host",
    "port": 27017,
    "databaseConnection": "connect on startup",
    "createUuid": true,
    "convertObjectId": false,
    "credentials": {
      "dbAuth": false,
      "dbAuthSource": "admin",
      "user": "myuser",
      "passwd": "mypassword"
    },
    "ssl": {
      "enabled": false,
      "sslValidate": true,
      "acceptInvalidCerts": false,
      "sslCA": "",
      "checkServerIdentity": false
    },
    "replSet": {
      "enabled": false,
      "replicaSet": ""
    },
    "healthcheck": {
      "enabled": "startup"
    }
  }

Swagger

Note: The content for this section may be missing as its corresponding .json file is unavailable. This sections will be updated once adapter-openapi.json file is added.

Generic Adapter Information