[docs] Add FAQ #1927
Merged
[docs] Add FAQ #1927
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
martin-mao
reviewed
Sep 10, 2019
docs/faqs/index.md
Outdated
| @@ -1 +1,70 @@ | |||
| # FAQs | |||
|
|
|||
| - **Is there a way to disable M3DB embedded `etcd` and just use an external `etcd` cluster?** | |||
| Yes, you can definitely do that. It's all just about setting the etcd endpoints in config as etcd hosts instead of M3DB hosts. | |||
There was a problem hiding this comment.
Link to how to set up external etcd cluster perhaps?
| Refer to the [troubleshooting guide](../troubleshooting/index.md). | ||
|
|
||
| - **Do you support PromQL?** | ||
| Yes, M3Query and M3Coordinator both support PromQL. |
There was a problem hiding this comment.
Shall we mention support for Graphite too?
docs/faqs/index.md
Outdated
| Yes, M3Query and M3Coordinator both support PromQL. | ||
|
|
||
| - **Does M3DB store both data and (tag) metadata on the same node?** | ||
| Yes it stores the data as well as the tags since it has an embedded index. Make sure you have `IndexEnabled` set to `true` in your namespace configuration |
There was a problem hiding this comment.
When you say data, maybe clarify with time series datapoints?
docs/faqs/index.md
Outdated
| If you’re adding namespaces, the m3dbnode process will pickup the new namespace without a restart. | ||
|
|
||
| - **Do I need to restart M3DB if I change or delete a namespace?** | ||
| If you’re removing or modifying an existing namespace, you’ll need to restart the m3dbnode process. It is recommended to restart one node at a time and wait for a node to be completely bootstrapped before restarting another node. |
There was a problem hiding this comment.
Hmm, that can technically continue on and keep using the cluster right? Maybe change wording to complete the namespace deletion process?
docs/faqs/index.md
Outdated
| Refer to the [Aggregation section](../how_to/query) of the M3Query how-to guide. | ||
|
|
||
| - **How do I set up aggregation using a separate aggregation tier?** | ||
| <Fill this in> |
docs/faqs/index.md
Outdated
| See the `Ticking` graph on [M3DB dashboard](https://grafana.com/dashboards/8126). | ||
|
|
||
| - **How much memory utilization should I run M3DB at?** | ||
| We recommend not going above 40%. |
There was a problem hiding this comment.
Hmm, is that very aggressive? maybe 50%?
benraskin92
force-pushed
the
braskin/add_faq
branch
from
88de537 to
78e0290
Compare
Codecov Report
@@ Coverage Diff @@
## master #1927 +/- ##
=========================================
+ Coverage 59.9% 63.4% +3.4%
=========================================
Files 1085 1113 +28
Lines 102830 104790 +1960
=========================================
+ Hits 61677 66467 +4790
+ Misses 36906 34077 -2829
+ Partials 4247 4246 -1
Continue to review full report at Codecov.
|
martin-mao
approved these changes
Sep 12, 2019
docs/faqs/index.md
Outdated
| See [M3DB openhttps://m3db.io/openapi | ||
|
|
||
| - **What is the recommended way to upgrade my M3 stack?** | ||
| <Fill this in> |
There was a problem hiding this comment.
Can we change this to TBA?
docs/faqs/index.md
Outdated
| We recommend not going above 50%. | ||
|
|
||
| - **What is the recommended hardware to run on?** | ||
| <Fill this in> |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
Fixes #
Special notes for your reviewer:
Does this PR introduce a user-facing and/or backwards incompatible change?:
Does this PR require updating code package or user-facing documentation?: