Clarify product environment minimum for ECH #3307
Conversation
kunisen
added
documentation
use sentence case
There was a problem hiding this comment.
Thanks @kunisen, these changes look good! I left a few minor suggestions for your consideration.
deploy-manage/deploy/elastic-cloud/ec-customize-deployment-components.md
Outdated
Show resolved
Hide resolved
deploy-manage/deploy/elastic-cloud/ec-customize-deployment-components.md
Outdated
Show resolved
Hide resolved
deploy-manage/monitor/stack-monitoring/ece-ech-stack-monitoring.md
Outdated
Show resolved
Hide resolved
|
|
||
| To ensure optimal performance and cluster stability in your production environment, we recommend adhering to the following minimum size guidelines. Deviating from these recommendations may lead to performance issues and cluster instability. For an enhanced user experience, consider planning your deployment capacity above these minimum recommendations, and adjust sizing based on your specific use case. | ||
|
|
||
| * **{{es}} nodes / instances**: For production systems, each {{es}} node / instance in your cluster should have at least 4 GB of RAM. |
There was a problem hiding this comment.
| * **{{es}} nodes / instances**: For production systems, each {{es}} node / instance in your cluster should have at least 4 GB of RAM. | |
| * **{{es}} nodes / instances**: For production systems, each {{es}} node / instance in your cluster must have at least 4 GB of RAM. |
I think must is a stronger verb to use as it relays an obligation, an absolute requirement. Should conveys an expectation and could be interpreted as a lack of obligation.
There was a problem hiding this comment.
Thanks @yetanothertw but here IMHO we'd better say "should" because there's no legal or contractual obligation...
Customer can choose whatever size including the 1GB technical minimum to use and then run into trouble. (This is by design by cloud PM team. I have talked with them in the past)
I am a bit worried if we say "must" instead of "should", it could bring some unexpected discussion about these "obligations", e.g. customer may ask "why you said 'must use' but I don't see that in my contract?", etc and then it's hard for us to explain, because it's not a hard limit. (as again, by design by cloud PM).
(Also we don't separate production use and test use into different our cloud platform. So for testing purposes, it's really ok to use smaller, e.g. 1GB instances and accept the risk like data loss.)
So @yetanothertw @emrcbrn IMHO we should still say "should" instead of "must" so that the obligation sense is not that strong, and indicates that's a recommendation from Elastic, but not mandatory.
@yetanothertw hope this is clear and please let me know if you still strongly suggest we use "must". Happy to discuss in advance.
There was a problem hiding this comment.
Thank you for explaining that, @kunisen. I thought this was a hard requirement, so was trying to be more clear about it. It makes sense to use should when conveying an expectation or recommendation (and not an obligation).
You can also say something like: **{{es}} nodes / instances**: For production systems, we recommend that each {{es}} node / instance in your cluster has at least 4 GB of RAM.
There was a problem hiding this comment.
Agreed with the minor changes suggest by @yetanothertw , LGTM otherwise. Thanks @kunisen
…ponents.md Co-authored-by: Vlada Chirmicci <vlada.chirmicci@elastic.co>
…ponents.md Co-authored-by: Vlada Chirmicci <vlada.chirmicci@elastic.co>
…g.md Co-authored-by: Vlada Chirmicci <vlada.chirmicci@elastic.co>
I accidentally committed a suggestion but as I explained in #3307 (comment), we'd better use "should" as our verbal to avoid strong obligation.
|
@yetanothertw @emrcbrn thanks both! About whether we should use "must" or "should", please let's make it a little more clear - #3307 (comment). Please let me know if you have different thoughts. I will merge it once we reach to a common agreement with above. |
|
Thank you for your patience with this, @kunisen and apologies for the confusion 💟 |
small tweak about wording per #3307 (comment)
|
Thank you again! @yetanothertw I totally get your point that from docs point of view, maybe it's best to avoid potential confusion by getting rid of "should" term, and use "we recommend" instead. Your suggestion in #3307 (comment) works perfect and TIL how to org the statement in a better way. I made a commit based on that and will merge it accordingly. Much appreciated your kind guidance again! 🙇 |
This is to address https://github.com/elastic/support-tech-lead/issues/1655 (internal ticket).
Preview - Before merge
Preview - After merge