Fix documentation for single node walkthrough #795
Conversation
Codecov Report
@@ Coverage Diff @@
## master #795 +/- ##
==========================================
- Coverage 78.11% 78.05% -0.06%
==========================================
Files 364 364
Lines 31052 31058 +6
==========================================
- Hits 24255 24243 -12
- Misses 5180 5190 +10
- Partials 1617 1625 +8
Continue to review full report at Codecov.
|
docs/integrations/prometheus.md
Outdated
| @@ -36,6 +73,13 @@ Now start the process up: | |||
| m3coordinator -f <config-name.yml> | |||
| ``` | |||
|
|
|||
| Or use the docker container: | |||
There was a problem hiding this comment.
Sure thing.
| @@ -310,7 +321,7 @@ func defaultedPlacementInitRequest( | |||
| replicationFactor = 1 | |||
| instances = []*placementpb.Instance{ | |||
| &placementpb.Instance{ | |||
| Id: "localhost", | |||
| Id: "m3db_local", | |||
There was a problem hiding this comment.
Worth pulling this out into configs and/or explicitly mentioning that this is a 'reserved id' or something similar?
There was a problem hiding this comment.
Sure thing, done.
docs/how_to/cluster_hard_way.md
Outdated
| @@ -1,7 +1,8 @@ | |||
| # M3DB Cluster Deployment, Manually (The Hard Way) | |||
|
|
|||
| ## Introduction | |||
| This document lists the manual steps involved in deploying a M3DB cluster. In practice, you wouldn’t be doing this by hand, you’d be automating it using Terraform or Kubernetes. If you’re interested in how you could do so, we have some other guides you might be interested under the How-To section on https://m3db.github.io/m3db/. | |||
|
|
|||
| This document lists the manual steps involved in deploying a M3DB cluster. In practice, you wouldn’t be doing this by hand, you’d be automating it using Terraform or Kubernetes. If you’re interested in how you could do so, we have some other guides you might be interested under the How-To section. | |||
There was a problem hiding this comment.
Might read better as:
This document lists the manual steps involved in deploying a M3DB cluster. In practice, you'd be automating this using Terraform or Kubernetes rather than doing this by hand; guides for doing so are available under the How-To section.
There was a problem hiding this comment.
Sure thing, thanks.
docs/how_to/single_node.md
Outdated
| @@ -159,3 +119,7 @@ curl -sSf -X POST http://localhost:9003/query -d '{ | |||
| "exhaustive": true | |||
| } | |||
| ``` | |||
|
|
|||
| ## Use integrations | |||
There was a problem hiding this comment.
Integrations might be a better header than Use integrations
There was a problem hiding this comment.
Sure thing, done.
docs/how_to/single_node.md
Outdated
|
|
||
| ## Use integrations | ||
|
|
||
| Checkout the integrations documentation to integrate with our software, such as [Prometheus as a long term storage remote read/write endpoint](../integrations/prometheus.md). |
There was a problem hiding this comment.
Maybe just this?
[Prometheus as a long term storage remote read/write endpoint](../integrations/prometheus.md)
There was a problem hiding this comment.
Sure thing, done.
docs/integrations/prometheus.md
Outdated
| ... | ||
| Start by downloading the [config template](https://github.com/m3db/m3db/blob/master/src/coordinator/config/m3coordinator-cluster-template.yml). Update the `namespaces` and the `client` section for a new cluster to match your cluster's configuration. | ||
|
|
||
| At the very least you'll need to specify the name of your namespace that you setup, the retention that it has. You can leave the metrics type as `unaggregated` since it's required by default to have a cluster that receives all Prometheus metrics unaggregated. In the future you might also want to aggregate and downsample metrics for longer retention, and you can come back and update the config once you've setup those clusters. |
There was a problem hiding this comment.
The first line of this and the next line can be combined into something like You'll need to specify the static IPs or hostnames of your M3DB seed nodes, and the name and retention values of the namespace you set up.
There was a problem hiding this comment.
Sure thing, done.
No description provided.