Deploy a BI Connector
On this page
- OAuth 2.0 authentication for programmatic access to Cloud Manager is available as a Preview feature.
- The feature and the corresponding documentation might change at any time during the Preview period. To use OAuth 2.0 authentication, create a service account to use in your requests to the Cloud Manager Public API.
The MongoDB Connector for Business Intelligence allows you to query a MongoDB database using SQL commands to aid in data analysis. It translates SQL queries from data analysis tools to MongoDB aggregation pipelines on MongoDB database.
Note
The BI Connector only allows
read-only operations
on data served in MongoDB databases. To create, update, or delete
data you must use mongosh or any appropriate driver.
Use the following procedure to deploy a new MongoDB BI Connector for Cloud Manager to manage.
Prerequisites
MongoDB BI Connector for Cloud Manager is not compatible with x.509 authentication.
BI Connector deployment is only available to users of Cloud Manager Premium. See Cloud Manager Features and Pricing for information about upgrading to Cloud Manager Premium.
To deploy MongoDB clusters, you must provision hosts to serve those clusters. Cloud Manager requires access to these hosts.
Important
If you run MongoDB Enterprise and provision your own Linux hosts, then you must manually install a set of dependencies to each server before installing MongoDB. The MongoDB manual provides the appropriate command to install the dependencies.
To learn more about the specifics for an operating system, see the following:
Note
The BI connector cannot be deployed using Cloud Manager
if the automation agent authentication mechanism is
Kerberos (GSSAPI) authentication.
Procedure
In MongoDB Cloud Manager, go to the Deployment page for your project.
If it is not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.
If it's not already displayed, select your desired project from the Projects menu in the navigation bar.
If the Deployment page is not already displayed, click Deployment in the sidebar.
The Deployment page displays.
Go to the Processes page.
Click the Processes tab for your deployment.
The Processes page displays.
Configure the BI Connector instance.
In the New BI Connector modal, configure the following settings:
Choose Server | Select the host where this new BI Connector is installed. |
Deployment Item | Select the deployment item (standalone, replica set,
or sharded cluster) to which this new BI connector
connects. |
Port to Listen On | Type the IANA port number you want to use when connecting
to this new BI Connector. The recommended port number is
3306. |
Read Preference | Select how the BI connector routes read operations to the members of a replica set. Available values include: |
Included Namespace(s) (Optional) | Type the name of a database and/or collection to limit what data the BI Connector can access. Leave this box blank to allow the BI Connector to use all namespaces on the host. Click the + add another namespace link to add another namespace to your list of included namespaces. |