Skip to content

Commit 4a6cbe1

Browse files
authored
DOCSP-5241: [Charts] As a SaaS user, I can change the read preference for an existing data source (#175)
* DOCSP-5241: [Charts] As a SaaS user, I can change the read preference for an existing data source
1 parent f0edf26 commit 4a6cbe1

File tree

2 files changed

+74
-0
lines changed

2 files changed

+74
-0
lines changed

source/data-sources.txt

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,21 @@ You will see your newly added data source listed in the
141141
:guilabel:`Data Sources` view. To learn how to manage existing
142142
data sources, see :doc:`manage-data-sources`.
143143

144+
Read Preference
145+
~~~~~~~~~~~~~~~
146+
147+
Each data source has a read preference which determines the
148+
:manual:`replica set member </core/replica-set-members>` that the
149+
data source reads data from. By default, a newly added data source
150+
has a read preference of Secondary, meaning that it reads from a
151+
secondary node within the Atlas cluster. If another data source also
152+
reads from the same Atlas cluster as the newly created data source,
153+
the newly created data source has the same read preference as the
154+
existing data source.
155+
156+
You can :ref:`change the read preference <mod-data-source-permissions>`
157+
of a data source in the :guilabel:`Data Sources` view.
158+
144159
.. class:: hidden
145160

146161
.. toctree::

source/manage-data-sources.txt

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,65 @@ modify user permissions:
106106

107107
#. Click :guilabel:`Apply Changes`.
108108

109+
.. _modify-data-source-read-preference:
110+
111+
Modify Data Source Read Preference
112+
----------------------------------
113+
114+
A data source ``Owner`` can modify the read preference of a data
115+
source. A data source's read preference determines which
116+
:manual:`replica set member </core/replica-set-members>` the data
117+
source reads data from.
118+
119+
Read preference options are:
120+
121+
- :manual:`Secondary </core/replica-set-members/#secondaries>`
122+
- :atlas:`Analytics Node </faq/#analytics-nodes-overview>`
123+
- :manual:`Nearest </reference/read-preference/#nearest>`
124+
- :manual:`Primary </core/replica-set-members/#replica-set-primary-member>`
125+
126+
If your Atlas cluster includes one or more :atlas:`analytics nodes
127+
</faq/#analytics-nodes-overview>`, they are the best choice for your
128+
data source read preference. Analytics nodes provide :manual:`workload
129+
isolation </core/workload-isolation>` and reduce strain on your
130+
cluster's data-bearing nodes.
131+
132+
.. important::
133+
134+
Not all Atlas clusters include analytics nodes, and the
135+
:guilabel:`Analytics Node` option appears in the read preference
136+
selection UI whether analytics nodes are available or not. Consult
137+
your :atlas:`cluster configuration </scale-cluster/>` and ensure
138+
that your cluster has analytics nodes available before choosing
139+
:guilabel:`Analytics Node` for your data source's read preference.
140+
141+
If you select :guilabel:`Analytics Node` for your data source's
142+
read preference when no analytics nodes are available, any charts
143+
which use the data source will produce an error the next time they
144+
read from the data source.
145+
146+
If your Atlas cluster does not have analytics nodes available, the next
147+
best choice is :guilabel:`Secondary`. Reading from a secondary node
148+
reduces strain on your primary node.
149+
150+
To modify the read preference for a data source:
151+
152+
1. From the :guilabel:`Data Sources` view, click the ellipsis
153+
(:guilabel:`...`) button on the right-hand side of the data source
154+
you want to modify.
155+
156+
#. Click :guilabel:`Edit Read Preference`.
157+
158+
#. Select your desired setting from the dropdown menu.
159+
160+
#. Click the :guilabel:`Save` button.
161+
162+
.. note::
163+
164+
After changing a data source's read preference, it takes a few minutes
165+
for the change to take effect. All data sources which read from the
166+
same Atlas cluster will use the selected read preference setting.
167+
109168
.. _charts-remove-data-source:
110169

111170
Remove a Data Source

0 commit comments

Comments
 (0)