[DOCS-13805] [Atlas] Clarify meaning of nodeType:READ_ONLY Created: 31/Jul/20  Updated: 29/Oct/23  Resolved: 05/Oct/20

Status: Closed
Project: Documentation
Component/s: Atlas
Affects Version/s: None
Fix Version/s: None

Type: Improvement Priority: Major - P3
Reporter: James Kovacs Assignee: Jeffrey Allen
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Related
Participants:
Days since reply: 3 years, 18 weeks, 2 days ago
Epic Link: DOCSP-2982
Story Points: 2

 Description   

Description

In Replica Set Tag Descriptions, we describe nodeType as having possible values of ELECTABLE, READ_ONLY, and ANALYTICS. We should describe what each of these types means explicitly. Notably that nodeType:READ_ONLY means a non-electable, read-only node as configured in the Atlas UI.

Why is there confusion? My initial thought when I saw these node types is that an Analytics node is used for analytics and therefore would have the nodeType:ANALYTICS applied to it. This is correct. An Analytics node cannot be written to (because it is not the primary nor can it ever be primary) and therefore should also have nodeType:READ_ONLY applied to it. This is incorrect. By this line of reasoning, I had also expected electable secondaries to also be marked with nodeType:READ_ONLY. Thinking it through, it doesn't make sense for Atlas to reconfigure tag sets based on election outcomes, but without knowing the inner workings of tag sets, it doesn't seem unreasonable at first glance for electable secondaries to be tagged with nodeType:READ_ONLY.

In summary we should explicitly call out the following:

nodeType:ELECTABLE means an "electable node for high availability" as configured in the Atlas UI.
nodeType:READ_ONLY means a "read-only node for optimal local reads" as configured in the Atlas UI.
nodeType:ANALYTICS means an "analytics node for workload isolation" as configured in the Atlas UI.

Scope of changes

Impact to Other Docs

MVP (Work and Date)

Resources (Scope or Design Docs, Invision, etc.)



 Comments   
Comment by Jeffrey Allen [ 05/Oct/20 ]

Thanks james.kovacs, we have a separate docs ticket for that update, DOCSP-12435, which is currently scheduled for this week's sprint. I'm going to close this issue and we will handle the OPERATIONAL tag updates in the other ticket.

Comment by Jeffrey Allen [ 30/Sep/20 ]

Hi james.kovacs thanks for filing this ticket. I just requested your review on a pull request which provides some clarification to the node types. Please see https://github.com/10gen/cloud-docs/pull/1870.

Thanks!

Generated at Thu Feb 08 08:08:46 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.