Manage Deployments

On this page

Connect a Deployment to Charts

Access Deployment Settings
Enable Organization-Wide Sharing for a Deployment
Deployment Read Preference

On the Data Sources page, an Atlas Project Owner can:

Connect a deployment to Atlas Charts.
Disconnect a deployment from Atlas Charts.
Modify deployment settings.

To manage data source settings, see Manage Data Sources.

Connect a Deployment to Charts

Note

Charts connects to all deployments and data sources in your project by default.

You can connect a deployment to Charts to access the data for the collections within the deployment in Charts.

To connect a deployment to Charts:

Go to the Data Sources page.

Click Data sources under the Deployments heading in the sidebar.

The Data Sources page displays.

In the Deployment dropdown, select the deployment that contains your data source.

Deployments in Atlas Charts reference Atlas deployments that contain valid Charts data sources, including:

All clusters and serverless instances in your Atlas project for which you have the Project Data Access Read Only role or higher.
All federated database instances in your project, including Online Archives.

After you select a deployment, the following information displays:

Field	Description
Deployment Name	Human-readable label that identifies the deployment in Atlas.
Deployment Connection Status	Label that indicates whether you connected the deployment to Atlas Charts.
Type	Label that identifies the deployment as a replica set, serverless instance, or federated database instance.
Status	Label that indicates the current operating condition of the deployment.
Version	Label that indicates the MongoDB version on which the deployment runs. Charts doesn't display Version for federated database instances.
Region	Label that indicates the cloud provider and region where MongoDB provisions the deployment. Charts doesn't display Region for serverless instances.
Tier	Label that indicates the Atlas cluster tier for the deployment. Charts doesn't display Tier for federated database instances and serverless instances.

Check the connection status and connect the deployment.

If the deployment connection status is Connected, the deployment is already connected to Charts. The Data Access section displays all of the collections within the selected Atlas deployment.

If the deployment connection status is Disconnected:

Click the connect icon next to the deployment connection status.
Click Reconnect on the modal that appears.

The deployment connects and the Data Access section displays all of the databases for the selected Atlas deployment.

Disconnect a Deployment from Charts

Disconnect a deployment to disconnect all data sources within the deployment from Charts.

If you disconnect a deployment, you can reconnect it later to resume rendering charts that use the deployment's data sources.

To disconnect a deployment:

Go to the Data Sources page.

Click Data sources under the Deployments heading in the sidebar.

The Data Sources page displays.

In the Deployment dropdown, select the deployment that contains your data source.

Deployments in Atlas Charts reference Atlas deployments that contain valid Charts data sources, including:

All clusters and serverless instances in your Atlas project for which you have the Project Data Access Read Only role or higher.
All federated database instances in your project, including Online Archives.

After you select a deployment, the following information displays:

Field	Description
Deployment Name	Human-readable label that identifies the deployment in Atlas.
Deployment Connection Status	Label that indicates whether you connected the deployment to Atlas Charts.
Type	Label that identifies the deployment as a replica set, serverless instance, or federated database instance.
Status	Label that indicates the current operating condition of the deployment.
Version	Label that indicates the MongoDB version on which the deployment runs. Charts doesn't display Version for federated database instances.
Region	Label that indicates the cloud provider and region where MongoDB provisions the deployment. Charts doesn't display Region for serverless instances.
Tier	Label that indicates the Atlas cluster tier for the deployment. Charts doesn't display Tier for federated database instances and serverless instances.

Check the connection status and disconnect the deployment.

If the deployment connection status is Disconnected, the deployment is already disconnected from Charts.

If the deployment connection status is Connected:

Click the disconnect icon next to the deployment connection status. The Disconnect Deployment modal appears.
Click Check for connected charts to learn whether any charts use the deployment's collections as a data source.
Click Disconnect.

The deployment disconnects from Charts.

Access Deployment Settings

To manage a deployment in Charts:

Go to the Data Sources page.

Click Data sources under the Deployments heading in the sidebar.

The Data Sources page displays.

In the Deployment dropdown, select the deployment that contains your data source.

Deployments in Atlas Charts reference Atlas deployments that contain valid Charts data sources, including:

All clusters and serverless instances in your Atlas project for which you have the Project Data Access Read Only role or higher.
All federated database instances in your project, including Online Archives.

After you select a deployment, the following information displays:

Field	Description
Deployment Name	Human-readable label that identifies the deployment in Atlas.
Deployment Connection Status	Label that indicates whether you connected the deployment to Atlas Charts.
Type	Label that identifies the deployment as a replica set, serverless instance, or federated database instance.
Status	Label that indicates the current operating condition of the deployment.
Version	Label that indicates the MongoDB version on which the deployment runs. Charts doesn't display Version for federated database instances.
Region	Label that indicates the cloud provider and region where MongoDB provisions the deployment. Charts doesn't display Region for serverless instances.
Tier	Label that indicates the Atlas cluster tier for the deployment. Charts doesn't display Tier for federated database instances and serverless instances.

Check the connection status and connect the deployment.

If the deployment connection status is Connected, the deployment is already connected to Charts. The Data Access section displays all of the collections within the selected Atlas deployment.

If the deployment connection status is Disconnected:

Click the connect icon next to the deployment connection status.
Click Reconnect on the modal that appears.

The deployment connects and the Data Access section displays all of the databases for the selected Atlas deployment.

You can manage the following deployment settings.

Enable Organization-Wide Sharing for a Deployment

Organization-wide sharing grants users in your organization, including users who are not members of your project, permission to view data in a deployment that is used for dashboards shared with your organization.

You can enable organization-wide sharing for an entire deployment or for a specific data source.

Considerations

Check that you can access the Atlas UI for the organization that contains your Atlas project.
If your organization's owners enable IP access list for the Atlas UI for an organization, this restricts access to the Atlas UI only to those users whose IP addresses are included in the organization's IP access list. If you don't have access to an organization, Atlas Charts displays a banner at the top of the page notifying you of the restriction. Contact your organization's owners so that they can include your IP address in the access list for the Atlas UI for this organization. This restriction doesn't apply to embedded charts applications and to the public dashboard.
If you enable organization-wide sharing for a deployment, it applies to all existing data sources and to any new data source you add to that deployment in the future.

To enable organization-wide sharing for a deployment:

Go to the Data Sources page.

Click Data sources under the Deployments heading in the sidebar.

The Data Sources page displays.

In the Deployment dropdown, select the deployment that contains your data source.

Deployments in Atlas Charts reference Atlas deployments that contain valid Charts data sources, including:

All clusters and serverless instances in your Atlas project for which you have the Project Data Access Read Only role or higher.
All federated database instances in your project, including Online Archives.

After you select a deployment, the following information displays:

Field	Description
Deployment Name	Human-readable label that identifies the deployment in Atlas.
Deployment Connection Status	Label that indicates whether you connected the deployment to Atlas Charts.
Type	Label that identifies the deployment as a replica set, serverless instance, or federated database instance.
Status	Label that indicates the current operating condition of the deployment.
Version	Label that indicates the MongoDB version on which the deployment runs. Charts doesn't display Version for federated database instances.
Region	Label that indicates the cloud provider and region where MongoDB provisions the deployment. Charts doesn't display Region for serverless instances.
Tier	Label that indicates the Atlas cluster tier for the deployment. Charts doesn't display Tier for federated database instances and serverless instances.

Turn on organization-wide sharing.

In the Organization subsection of the Data Access section, toggle All users in the organization can view data in this data source to ON.

Deployment Read Preference

Each deployment has a read preference, which determines the replica set member that the data source reads data from.

By default, a newly-added Atlas cluster has a read preference of Secondary, which means that it reads from a secondary node within the Atlas cluster. You can change the read preference of a cluster using the Read preference dropdown.

You can't change the read preference of a federated database instance. Federated database instances have a read preference of Nearest by default, which means that they read from the replica set member whose network latency falls within the acceptable latency window. To learn more, see Read Preference Modes.

The Read preference dropdown contains the following read preference options for clusters:

Read Preference	Description
Primary	Reads from the primary node within the cluster. To learn more, see Read Preference Modes.
Secondary	Reads from the secondary node within the cluster. To learn more, see Read Preference Modes.
Nearest	Reads from the replica set member whose network latency falls within the acceptable latency window. To learn more, see Read Preference Modes.
Analytics Node	Reads from an analytics node.

Back

Manage Data Sources

Create & Manage Charts Views