diff --git a/docs-beta/content/overview/_index.md b/docs-beta/content/about_m3/_index.md similarity index 80% rename from docs-beta/content/overview/_index.md rename to docs-beta/content/about_m3/_index.md index e57aae4b8d..fd48bf221d 100644 --- a/docs-beta/content/overview/_index.md +++ b/docs-beta/content/about_m3/_index.md @@ -1,5 +1,5 @@ +++ -title = "Overview" +title = "About the project" date = 2020-04-01T19:43:46-04:00 weight = 1 chapter = true diff --git a/docs-beta/content/about_m3/contributing.md b/docs-beta/content/about_m3/contributing.md new file mode 100644 index 0000000000..609df3a10e --- /dev/null +++ b/docs-beta/content/about_m3/contributing.md @@ -0,0 +1,6 @@ +--- +title: "Contributing" +date: 2020-04-21T20:45:23-04:00 +draft: true +--- + diff --git a/docs-beta/content/about_m3/glossary.md b/docs-beta/content/about_m3/glossary.md new file mode 100644 index 0000000000..ff081ce944 --- /dev/null +++ b/docs-beta/content/about_m3/glossary.md @@ -0,0 +1,6 @@ +--- +title: "Glossary" +date: 2020-04-21T20:45:40-04:00 +draft: true +--- + diff --git a/docs-beta/content/about_m3/release_notes.md b/docs-beta/content/about_m3/release_notes.md new file mode 100644 index 0000000000..93bf0a4a86 --- /dev/null +++ b/docs-beta/content/about_m3/release_notes.md @@ -0,0 +1,6 @@ +--- +title: "Release_notes" +date: 2020-04-21T20:45:33-04:00 +draft: true +--- + diff --git a/docs-beta/content/contact/_index.md b/docs-beta/content/contact/_index.md index 4251b5a13c..ddeb69224c 100644 --- a/docs-beta/content/contact/_index.md +++ b/docs-beta/content/contact/_index.md @@ -1,12 +1,12 @@ +++ title = "Contact" date = 2020-04-01T20:23:37-04:00 -weight = 7 +weight = 9 chapter = true -pre = "7. " +pre = "9. " +++ -### Section 7 +### Section 9 # Contact Us diff --git a/docs-beta/content/faq/_index.md b/docs-beta/content/faq/_index.md deleted file mode 100644 index ad86bb931d..0000000000 --- a/docs-beta/content/faq/_index.md +++ /dev/null @@ -1,18 +0,0 @@ -+++ -title = "FAQ's" -date = 2020-04-01T20:22:51-04:00 -weight = 8 -chapter = true -pre = "8. " -+++ - -### Section 8 - -# FAQ's - - -1. How do I ....? - -2. - -3. \ No newline at end of file diff --git a/docs-beta/content/getting_started/aggregator.md b/docs-beta/content/getting_started/aggregator.md deleted file mode 100644 index 408133effa..0000000000 --- a/docs-beta/content/getting_started/aggregator.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: "Aggregator" -date: 2020-03-30T18:34:12-04:00 -draft: true ---- - -##Aggregator \ No newline at end of file diff --git a/docs-beta/content/getting_started/coordinator.md b/docs-beta/content/getting_started/coordinator.md deleted file mode 100644 index fc3e930eef..0000000000 --- a/docs-beta/content/getting_started/coordinator.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: "Coordinator" -date: 2020-03-30T18:33:59-04:00 -draft: true ---- - -Coordinator \ No newline at end of file diff --git a/docs-beta/content/getting_started/docker.md b/docs-beta/content/getting_started/docker.md new file mode 100644 index 0000000000..2ce1f044dc --- /dev/null +++ b/docs-beta/content/getting_started/docker.md @@ -0,0 +1,6 @@ +--- +title: "Docker" +date: 2020-04-21T20:47:48-04:00 +draft: true +--- + diff --git a/docs-beta/content/getting_started/kube.md b/docs-beta/content/getting_started/kube.md new file mode 100644 index 0000000000..89b7b852d6 --- /dev/null +++ b/docs-beta/content/getting_started/kube.md @@ -0,0 +1,6 @@ +--- +title: "Kube" +date: 2020-04-21T20:47:43-04:00 +draft: true +--- + diff --git a/docs-beta/content/getting_started/m3_binary.md b/docs-beta/content/getting_started/m3_binary.md new file mode 100644 index 0000000000..7c14749b89 --- /dev/null +++ b/docs-beta/content/getting_started/m3_binary.md @@ -0,0 +1,6 @@ +--- +title: "M3_binary" +date: 2020-04-21T20:47:36-04:00 +draft: true +--- + diff --git a/docs-beta/content/getting_started/multi_node_deployment.md b/docs-beta/content/getting_started/multi_node_deployment.md deleted file mode 100644 index af73a53e2a..0000000000 --- a/docs-beta/content/getting_started/multi_node_deployment.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: "Multi Node Deployment" -date: 2020-03-30T18:33:53-04:00 -draft: true ---- - -Multi node \ No newline at end of file diff --git a/docs-beta/content/getting_started/query.md b/docs-beta/content/getting_started/query.md deleted file mode 100644 index 8e9d5bc3e3..0000000000 --- a/docs-beta/content/getting_started/query.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: "Query" -date: 2020-03-30T18:34:06-04:00 -draft: true ---- - -Query \ No newline at end of file diff --git a/docs-beta/content/getting_started/single_node_deployment.md b/docs-beta/content/getting_started/single_node_deployment.md deleted file mode 100644 index b1c5b94e3f..0000000000 --- a/docs-beta/content/getting_started/single_node_deployment.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -title: "Single Node Deployment" -date: 2020-03-30T18:33:46-04:00 -draft: true ---- - -### M3DB Single Node Deployment - -Deploying a single-node cluster is a great way to experiment with M3DB and get a feel for what it -has to offer. Our Docker image by default configures a single M3DB instance as one binary -containing: - -- An M3DB storage instance (`m3dbnode`) for timeseries storage. This includes an embedded tag-based - metrics index, as well as as an embedded etcd server for storing the above mentioned cluster - topology and runtime configuration. -- A "coordinator" instance (`m3coordinator`) for writing and querying tagged metrics, as well as - managing cluster topology and runtime configuration. - -To begin, first start up a Docker container with port `7201` (used to manage the cluster topology), port `7203` which is where Prometheus scrapes metrics produced by `M3DB` and `M3Coordinator`, and port `9003` (used to read and write metrics) exposed. We recommend you create a persistent data -directory on your host for durability: - -``` -docker pull quay.io/m3db/m3dbnode:latest -docker run -p 7201:7201 -p 7203:7203 -p 9003:9003 --name m3db -v $(pwd)/m3db_data:/var/lib/m3db quay.io/m3db/m3dbnode:latest -``` - -**Note:** For the single node case, we use this [sample config file](https://github.com/m3db/m3/blob/master/src/dbnode/config/m3dbnode-local-etcd.yml). If you inspect the file, you'll see that all the configuration is namespaced by `coordinator` or `db`. That's because this setup runs `M3DB` and `M3Coordinator` as one application. While this is convenient for testing and development, you'll want to run clustered `M3DB` with a separate `M3Coordinator` in production. You can read more about that [here.](cluster_hard_way.md). - -Next, create an initial namespace for your metrics in the database using the cURL below. Keep in mind that the provided `namespaceName` must match the namespace in the `local` section of the `M3Coordinator` YAML configuration, and if you choose to [add any additional namespaces](../operational_guide/namespace_configuration.md) you'll need to add them to the `local` section of `M3Coordinator`'s YAML config as well. - -```json -curl -X POST http://localhost:7201/api/v1/database/create -d '{ - "type": "local", - "namespaceName": "default", - "retentionTime": "12h" -}' -``` - -**Note**: The `api/v1/database/create` endpoint is abstraction over two concepts in M3DB called [placements](../operational_guide/placement.md) and [namespaces](../operational_guide/namespace_configuration.md). If a placement doesn't exist, it will create one based on the `type` argument, otherwise if the placement already exists, it just creates the specified namespace. For now it's enough to just understand that it creates M3DB namespaces (tables), but if you're going to run a clustered M3 setup in production, make sure you familiarize yourself with the links above. - -Placement initialization may take a minute or two and you can check on the status of this by running the following: - -``` -curl http://localhost:7201/api/v1/placement | jq . -``` - -Once all of the shards become `AVAILABLE`, you should see your node complete bootstrapping! Don't worry if you see warnings or errors related to a local cache file, such as `[W] could not load cache from file -/var/lib/m3kv/m3db_embedded.json`. Those are expected for a local instance and in general any -warn-level errors (prefixed with `[W]`) should not block bootstrapping. - -``` -02:28:30.008072[I] updating database namespaces [{adds [default]} {updates []} {removals []}] -02:28:30.270681[I] node tchannelthrift: listening on 0.0.0.0:9000 -02:28:30.271909[I] cluster tchannelthrift: listening on 0.0.0.0:9001 -02:28:30.519468[I] node httpjson: listening on 0.0.0.0:9002 -02:28:30.520061[I] cluster httpjson: listening on 0.0.0.0:9003 -02:28:30.520652[I] bootstrap finished [{namespace metrics} {duration 55.4µs}] -02:28:30.520909[I] bootstrapped -``` - -The node also self-hosts its OpenAPI docs, outlining available endpoints. You can access this by -going to `localhost:7201/api/v1/openapi` in your browser. - -![OpenAPI Doc](redoc_screenshot.png) - -Now you can experiment with writing tagged metrics: -```json -curl -sS -X POST http://localhost:9003/writetagged -d '{ - "namespace": "default", - "id": "foo", - "tags": [ - { - "name": "__name__", - "value": "user_login" - }, - { - "name": "city", - "value": "new_york" - }, - { - "name": "endpoint", - "value": "/request" - } - ], - "datapoint": { - "timestamp": '"$(date "+%s")"', - "value": 42.123456789 - } -} -' -``` - -**Note:** In the above example we include the tag `__name__`. This is because `__name__` is a -reserved tag in Prometheus and will make querying the metric much easier. For example, if you have -[M3Query](query.md) setup as a Prometheus datasource in Grafana, you can then query for the metric -using the following PromQL query: - -``` -user_login{city="new_york",endpoint="/request"} -``` - -And reading the metrics you've written using the M3DB `/query` endpoint: -```json -curl -sS -X POST http://localhost:9003/query -d '{ - "namespace": "default", - "query": { - "regexp": { - "field": "city", - "regexp": ".*" - } - }, - "rangeStart": 0, - "rangeEnd": '"$(date "+%s")"' -}' | jq . - -{ - "results": [ - { - "id": "foo", - "tags": [ - { - "name": "__name__", - "value": "user_login" - }, - { - "name": "city", - "value": "new_york" - }, - { - "name": "endpoint", - "value": "/request" - } - ], - "datapoints": [ - { - "timestamp": 1527039389, - "value": 42.123456789 - } - ] - } - ], - "exhaustive": true -} -``` - -Now that you've got the M3 stack up and running, take a look at the rest of our documentation to see how you can integrate with [Prometheus](../integrations/prometheus.md) and [Graphite](../integrations/graphite.md) diff --git a/docs-beta/content/how_to_guides/aggregation/installation.md b/docs-beta/content/how_to_guides/aggregation/installation.md new file mode 100644 index 0000000000..2911380c65 --- /dev/null +++ b/docs-beta/content/how_to_guides/aggregation/installation.md @@ -0,0 +1,6 @@ +--- +title: "Installation" +date: 2020-04-21T20:54:54-04:00 +draft: true +--- + diff --git a/docs-beta/content/how_to_guides/aggregation/namespace.md b/docs-beta/content/how_to_guides/aggregation/namespace.md new file mode 100644 index 0000000000..5d831efe54 --- /dev/null +++ b/docs-beta/content/how_to_guides/aggregation/namespace.md @@ -0,0 +1,6 @@ +--- +title: "Namespace" +date: 2020-04-21T20:55:04-04:00 +draft: true +--- + diff --git a/docs-beta/content/how_to_guides/aggregation/r2_rules.md b/docs-beta/content/how_to_guides/aggregation/r2_rules.md deleted file mode 100644 index 8e283b9ae8..0000000000 --- a/docs-beta/content/how_to_guides/aggregation/r2_rules.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: "R2 Rules" -date: 2020-04-02T12:36:33-04:00 -draft: true ---- - -Guide for how to aggregate metrics using R2 Rules. \ No newline at end of file diff --git a/docs-beta/content/how_to_guides/aggregation/rules_policies.md b/docs-beta/content/how_to_guides/aggregation/rules_policies.md new file mode 100644 index 0000000000..a386d888b4 --- /dev/null +++ b/docs-beta/content/how_to_guides/aggregation/rules_policies.md @@ -0,0 +1,6 @@ +--- +title: "Setting policies and rules" +date: 2020-04-02T12:36:33-04:00 +draft: true +--- + diff --git a/docs-beta/content/how_to_guides/grafana.md b/docs-beta/content/how_to_guides/grafana.md new file mode 100644 index 0000000000..cd49b3c001 --- /dev/null +++ b/docs-beta/content/how_to_guides/grafana.md @@ -0,0 +1,6 @@ +--- +title: "Grafana" +date: 2020-04-21T20:53:35-04:00 +draft: true +--- + diff --git a/docs-beta/content/how_to_guides/sending_metrics/graphite.md b/docs-beta/content/how_to_guides/graphite.md similarity index 54% rename from docs-beta/content/how_to_guides/sending_metrics/graphite.md rename to docs-beta/content/how_to_guides/graphite.md index 10f8912890..7907c45605 100644 --- a/docs-beta/content/how_to_guides/sending_metrics/graphite.md +++ b/docs-beta/content/how_to_guides/graphite.md @@ -1,6 +1,6 @@ --- title: "Graphite" -date: 2020-04-02T12:37:26-04:00 +date: 2020-04-21T20:52:20-04:00 draft: true --- diff --git a/docs-beta/content/how_to_guides/monitoring_m3.md b/docs-beta/content/how_to_guides/monitoring_m3.md new file mode 100644 index 0000000000..0cb3481d4d --- /dev/null +++ b/docs-beta/content/how_to_guides/monitoring_m3.md @@ -0,0 +1,6 @@ +--- +title: "Monitoring_m3" +date: 2020-04-21T20:49:29-04:00 +draft: true +--- + diff --git a/docs-beta/content/how_to_guides/monitoring_m3/_index.md b/docs-beta/content/how_to_guides/monitoring_m3/_index.md new file mode 100644 index 0000000000..b77984f37f --- /dev/null +++ b/docs-beta/content/how_to_guides/monitoring_m3/_index.md @@ -0,0 +1,6 @@ +--- +title: "Monitoring_m3" +date: 2020-04-21T20:56:58-04:00 +draft: true +--- + diff --git a/docs-beta/content/how_to_guides/monitoring_m3/alerts.md b/docs-beta/content/how_to_guides/monitoring_m3/alerts.md new file mode 100644 index 0000000000..f621820083 --- /dev/null +++ b/docs-beta/content/how_to_guides/monitoring_m3/alerts.md @@ -0,0 +1,6 @@ +--- +title: "Alerts" +date: 2020-04-21T20:56:27-04:00 +draft: true +--- + diff --git a/docs-beta/content/how_to_guides/monitoring_m3/metrics.md b/docs-beta/content/how_to_guides/monitoring_m3/metrics.md new file mode 100644 index 0000000000..9ac42b158e --- /dev/null +++ b/docs-beta/content/how_to_guides/monitoring_m3/metrics.md @@ -0,0 +1,6 @@ +--- +title: "Metrics" +date: 2020-04-21T20:56:34-04:00 +draft: true +--- + diff --git a/docs-beta/content/how_to_guides/monitoring_m3/tracing.md b/docs-beta/content/how_to_guides/monitoring_m3/tracing.md new file mode 100644 index 0000000000..b7c0c307eb --- /dev/null +++ b/docs-beta/content/how_to_guides/monitoring_m3/tracing.md @@ -0,0 +1,6 @@ +--- +title: "Tracing" +date: 2020-04-21T20:56:40-04:00 +draft: true +--- + diff --git a/docs-beta/content/how_to_guides/other/_index.md b/docs-beta/content/how_to_guides/other/_index.md new file mode 100644 index 0000000000..b1d874b66c --- /dev/null +++ b/docs-beta/content/how_to_guides/other/_index.md @@ -0,0 +1,6 @@ +--- +title: "Other" +date: 2020-04-21T20:53:05-04:00 +draft: true +--- + diff --git a/docs-beta/content/how_to_guides/other/sql.md b/docs-beta/content/how_to_guides/other/sql.md new file mode 100644 index 0000000000..bc3c796e16 --- /dev/null +++ b/docs-beta/content/how_to_guides/other/sql.md @@ -0,0 +1,6 @@ +--- +title: "Sql" +date: 2020-04-21T20:50:09-04:00 +draft: true +--- + diff --git a/docs-beta/content/how_to_guides/other/tsdb.md b/docs-beta/content/how_to_guides/other/tsdb.md new file mode 100644 index 0000000000..7855911a27 --- /dev/null +++ b/docs-beta/content/how_to_guides/other/tsdb.md @@ -0,0 +1,6 @@ +--- +title: "Tsdb" +date: 2020-04-21T20:50:45-04:00 +draft: true +--- + diff --git a/docs-beta/content/how_to_guides/other/upgrading.md b/docs-beta/content/how_to_guides/other/upgrading.md new file mode 100644 index 0000000000..65e31bd309 --- /dev/null +++ b/docs-beta/content/how_to_guides/other/upgrading.md @@ -0,0 +1,6 @@ +--- +title: "Upgrading" +date: 2020-04-21T20:50:39-04:00 +draft: true +--- + diff --git a/docs-beta/content/how_to_guides/sending_metrics/prometheus.md b/docs-beta/content/how_to_guides/prometheus.md similarity index 56% rename from docs-beta/content/how_to_guides/sending_metrics/prometheus.md rename to docs-beta/content/how_to_guides/prometheus.md index 23290c71bb..16b8421e65 100644 --- a/docs-beta/content/how_to_guides/sending_metrics/prometheus.md +++ b/docs-beta/content/how_to_guides/prometheus.md @@ -1,6 +1,6 @@ --- title: "Prometheus" -date: 2020-04-02T12:37:22-04:00 +date: 2020-04-21T20:48:58-04:00 draft: true --- diff --git a/docs-beta/content/how_to_guides/querying/_index.md b/docs-beta/content/how_to_guides/querying/_index.md deleted file mode 100644 index 09857c7971..0000000000 --- a/docs-beta/content/how_to_guides/querying/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: "Querying" -date: 2020-04-02T12:36:50-04:00 -draft: true ---- - -How to guides for querying metrics using Prometheus and Graphite. diff --git a/docs-beta/content/how_to_guides/querying/graphite.md b/docs-beta/content/how_to_guides/querying/graphite.md deleted file mode 100644 index 6acd807c8c..0000000000 --- a/docs-beta/content/how_to_guides/querying/graphite.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: "Graphite" -date: 2020-04-02T12:36:57-04:00 -draft: true ---- - diff --git a/docs-beta/content/how_to_guides/querying/prometheus.md b/docs-beta/content/how_to_guides/querying/prometheus.md deleted file mode 100644 index 237d95af3c..0000000000 --- a/docs-beta/content/how_to_guides/querying/prometheus.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: "Prometheus" -date: 2020-04-02T12:37:03-04:00 -draft: true ---- - diff --git a/docs-beta/content/how_to_guides/sending_metrics/_index.md b/docs-beta/content/how_to_guides/sending_metrics/_index.md deleted file mode 100644 index 003cb244c2..0000000000 --- a/docs-beta/content/how_to_guides/sending_metrics/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: "Sending Metrics" -date: 2020-04-02T12:37:16-04:00 -draft: true ---- - -How to guide for sending metrics using Prometheus and Graphite. diff --git a/docs-beta/content/intro_m3/overview.md b/docs-beta/content/intro_m3/overview.md new file mode 100644 index 0000000000..e0c54cf7f6 --- /dev/null +++ b/docs-beta/content/intro_m3/overview.md @@ -0,0 +1,13 @@ ++++ +title = "Overview" +date = 2020-04-21T20:44:20-04:00 +weight = 5 +chapter = true +pre = "X. " ++++ + +### Chapter X + +# Some Chapter title + +Lorem Ipsum. \ No newline at end of file diff --git a/docs-beta/content/m3db/_index.md b/docs-beta/content/m3db/_index.md deleted file mode 100644 index 6e1f0adaaa..0000000000 --- a/docs-beta/content/m3db/_index.md +++ /dev/null @@ -1,11 +0,0 @@ -+++ -title = "M3DB" -date = 2020-04-01T19:44:54-04:00 -weight = 5 -chapter = true -pre = "5. " -+++ - -### Section 5 - -# M3DB Overview \ No newline at end of file diff --git a/docs-beta/content/m3db/configuration_guide.md b/docs-beta/content/m3db/configuration_guide.md deleted file mode 100644 index d40d17fd44..0000000000 --- a/docs-beta/content/m3db/configuration_guide.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: "Configuration Guide" -date: 2020-04-01T19:46:32-04:00 -draft: true ---- - diff --git a/docs-beta/content/m3db/overview.md b/docs-beta/content/m3db/overview.md deleted file mode 100644 index fa195dc0a0..0000000000 --- a/docs-beta/content/m3db/overview.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: "Overview" -date: 2020-04-01T19:45:17-04:00 -draft: true ---- - diff --git a/docs-beta/content/m3db/roadmap.md b/docs-beta/content/m3db/roadmap.md deleted file mode 100644 index 540b1e5d53..0000000000 --- a/docs-beta/content/m3db/roadmap.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: "Product Roadmap" -date: 2020-04-01T19:45:32-04:00 -draft: true ---- - diff --git a/docs-beta/content/media/_index.md b/docs-beta/content/media/_index.md index fb674ed581..f38b50d3c8 100644 --- a/docs-beta/content/media/_index.md +++ b/docs-beta/content/media/_index.md @@ -1,12 +1,12 @@ +++ title = "Media" date = 2020-04-01T20:23:23-04:00 -weight = 9 +weight = 11 chapter = true -pre = "9. " +pre = "11. " +++ -### Section 9 +### Section 11 # Media Coverage diff --git a/docs-beta/content/operational_guides/_index.md b/docs-beta/content/operational_guides/_index.md index e70b541536..a0c7407b8a 100644 --- a/docs-beta/content/operational_guides/_index.md +++ b/docs-beta/content/operational_guides/_index.md @@ -1,12 +1,13 @@ +++ -title = "Operational Guides" -date = 2020-04-01T20:07:20-04:00 -weight = 4 +title = "Operational_guides" +date = 2020-04-21T20:57:48-04:00 +weight = 5 chapter = true -pre = "4. " +pre = "X. " +++ -### Section 4 +### Chapter X -# Operational Guides +# Some Chapter title +Lorem Ipsum. \ No newline at end of file diff --git a/docs-beta/content/operational_guides/docker_kernel_configuration.md b/docs-beta/content/operational_guides/docker_kernel_configuration.md deleted file mode 100644 index 4c01df211e..0000000000 --- a/docs-beta/content/operational_guides/docker_kernel_configuration.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: "Docker Kernel Configuration" -date: 2020-04-01T20:19:26-04:00 -draft: true ---- - diff --git a/docs-beta/content/operational_guides/etcd.md b/docs-beta/content/operational_guides/etcd.md deleted file mode 100644 index 3046dc890f..0000000000 --- a/docs-beta/content/operational_guides/etcd.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -title: "Etcd" -date: 2020-04-01T20:19:32-04:00 -draft: true ---- - -The M3 stack leverages `etcd` as a distributed key-value storage to: - -1. Update cluster configuration in realtime -2. Manage placements for our distributed / sharded tiers like M3DB and M3Aggregator -3. Perform leader-election in M3Aggregator - -and much more! - -## Overview - -`M3DB` ships with support for running embedded `etcd` (called `seed nodes`), and while this is convenient for testing and development, we don't recommend running with this setup in production. - -Both `M3` and `etcd` are complex distributed systems, and trying to operate both within the same binary is challenging and dangerous for production workloads. - -Instead, we recommend running an external `etcd` cluster that is isolated from the `M3` stack so that performing operations like node adds, removes, and replaces are easier. - -While M3 relies on `etcd` to provide strong consistency, the perations we use it for are all low-throughput so you should be able to operate a very low maintenance `etcd` cluster. [A 3-node setup for high availability](https://github.com/etcd-io/etcd/blob/v3.3.11/Documentation/faq.md#what-is-failure-tolerance) should be more than sufficient for most workloads. - -## Configuring an External etcd Cluster - -### M3DB - -Most of our documentation demonstrates how to run `M3DB` with embedded etcd nodes. Once you're ready to switch to an external `etcd` cluster, all you need to do is modify the `M3DB` config to remove the `seedNodes` field entirely and then change the `endpoints` under `etcdClusters` to point to your external `etcd` nodes instead of the `M3DB` seed nodes. - -For example this portion of the config - -```yaml -config: - service: - env: default_env - zone: embedded - service: m3db - cacheDir: /var/lib/m3kv - etcdClusters: - - zone: embedded - endpoints: - - http://m3db_seed1:2379 - - http://m3db_seed2:2379 - - http://m3db_seed3:2379 - seedNodes: - initialCluster: - - hostID: m3db_seed1 - endpoint: http://m3db_seed1:2380 - - hostID: m3db_seed2 - endpoint: http://m3db_seed2:2380 - - hostID: m3db_seed3 - endpoint: http://m3db_seed3:2380 -``` - -would become - -```yaml -config: - service: - env: default_env - zone: embedded - service: m3db - cacheDir: /var/lib/m3kv - etcdClusters: - - zone: embedded - endpoints: - - http://external_etcd1:2379 - - http://external_etcd2:2379 - - http://external_etcd3:2379 -``` - -**Note**: `M3DB` placements and namespaces are stored in `etcd` so if you want to switch to an external `etcd` cluster you'll need to recreate all your placements and namespaces. You can do this manually or use `etcdctl`'s [Mirror Maker](https://github.com/etcd-io/etcd/blob/v3.3.11/etcdctl/doc/mirror_maker.md) functionality. - -### M3Coordinator - -`M3Coordinator` does not run embedded `etcd`, so configuring it to use an external `etcd` cluster is simple. Just replace the `endpoints` under `etcdClusters` in the YAML config to point to your external `etcd` nodes instead of the `M3DB` seed nodes. See the `M3DB` example above for a detailed before/after comparison of the YAML config. - -## etcd Operations - -### Embedded etcd - -If you're running `M3DB seed nodes` with embedded `etcd` (which we do not recommend for production workloads) and need to perform a node add/replace/remove then follow our [placement configuration guide](./placement_configuration.md) and pay special attention to follow the special instructions for `seed nodes`. - -### External etcd - -Just follow the instructions in the [etcd docs.](https://github.com/etcd-io/etcd/tree/master/Documentation) \ No newline at end of file diff --git a/docs-beta/content/operational_guides/managing_aggregator.md b/docs-beta/content/operational_guides/managing_aggregator.md new file mode 100644 index 0000000000..dd8ac89117 --- /dev/null +++ b/docs-beta/content/operational_guides/managing_aggregator.md @@ -0,0 +1,6 @@ +--- +title: "Managing_aggregator" +date: 2020-04-21T20:59:23-04:00 +draft: true +--- + diff --git a/docs-beta/content/operational_guides/managing_m3db.md b/docs-beta/content/operational_guides/managing_m3db.md new file mode 100644 index 0000000000..8213ceadbd --- /dev/null +++ b/docs-beta/content/operational_guides/managing_m3db.md @@ -0,0 +1,6 @@ +--- +title: "Managing_m3db" +date: 2020-04-21T20:58:30-04:00 +draft: true +--- + diff --git a/docs-beta/content/operational_guides/managing_m3db/_index.md b/docs-beta/content/operational_guides/managing_m3db/_index.md new file mode 100644 index 0000000000..3a46e6fd95 --- /dev/null +++ b/docs-beta/content/operational_guides/managing_m3db/_index.md @@ -0,0 +1,6 @@ +--- +title: "Managing_m3db" +date: 2020-04-21T21:00:08-04:00 +draft: true +--- + diff --git a/docs-beta/content/operational_guides/managing_m3db/etcd.md b/docs-beta/content/operational_guides/managing_m3db/etcd.md new file mode 100644 index 0000000000..5b5de4bbed --- /dev/null +++ b/docs-beta/content/operational_guides/managing_m3db/etcd.md @@ -0,0 +1,6 @@ +--- +title: "Etcd" +date: 2020-04-21T20:58:58-04:00 +draft: true +--- + diff --git a/docs-beta/content/operational_guides/managing_m3db/m3db_node_mgmt.md b/docs-beta/content/operational_guides/managing_m3db/m3db_node_mgmt.md new file mode 100644 index 0000000000..f85db80647 --- /dev/null +++ b/docs-beta/content/operational_guides/managing_m3db/m3db_node_mgmt.md @@ -0,0 +1,6 @@ +--- +title: "M3db_node_mgmt" +date: 2020-04-21T20:58:41-04:00 +draft: true +--- + diff --git a/docs-beta/content/operational_guides/managing_m3db/namespace_mgmt.md b/docs-beta/content/operational_guides/managing_m3db/namespace_mgmt.md new file mode 100644 index 0000000000..aaad933496 --- /dev/null +++ b/docs-beta/content/operational_guides/managing_m3db/namespace_mgmt.md @@ -0,0 +1,6 @@ +--- +title: "Namespace_mgmt" +date: 2020-04-21T20:58:51-04:00 +draft: true +--- + diff --git a/docs-beta/content/operational_guides/managing_query.md b/docs-beta/content/operational_guides/managing_query.md new file mode 100644 index 0000000000..a221ef0299 --- /dev/null +++ b/docs-beta/content/operational_guides/managing_query.md @@ -0,0 +1,6 @@ +--- +title: "Managing_query" +date: 2020-04-21T20:59:17-04:00 +draft: true +--- + diff --git a/docs-beta/content/operational_guides/namespace_configuration.md b/docs-beta/content/operational_guides/namespace_configuration.md deleted file mode 100644 index f36aee6a67..0000000000 --- a/docs-beta/content/operational_guides/namespace_configuration.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: "Namespace Configuration" -date: 2020-04-01T20:19:04-04:00 -draft: true ---- - diff --git a/docs-beta/content/operational_guides/overview.md b/docs-beta/content/operational_guides/overview.md deleted file mode 100644 index f4b0040f0b..0000000000 --- a/docs-beta/content/operational_guides/overview.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: "Overview" -date: 2020-04-01T20:17:50-04:00 -draft: true ---- - diff --git a/docs-beta/content/operational_guides/placement_topology.md b/docs-beta/content/operational_guides/placement_topology.md deleted file mode 100644 index b774c32a2f..0000000000 --- a/docs-beta/content/operational_guides/placement_topology.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: "Placement Topology" -date: 2020-04-01T20:18:44-04:00 -draft: true ---- - diff --git a/docs-beta/content/operational_guides/placement_topology_configuration.md b/docs-beta/content/operational_guides/placement_topology_configuration.md deleted file mode 100644 index 01e06a7ee0..0000000000 --- a/docs-beta/content/operational_guides/placement_topology_configuration.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: "Placement & topology Configuration" -date: 2020-04-01T20:18:52-04:00 -draft: true ---- - diff --git a/docs-beta/content/operational_guides/replication_and_deployment_in_zones.md b/docs-beta/content/operational_guides/replication_and_deployment_in_zones.md deleted file mode 100644 index 165063bfa8..0000000000 --- a/docs-beta/content/operational_guides/replication_and_deployment_in_zones.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: "Replication and Deployment in Zones" -date: 2020-04-01T20:18:08-04:00 -draft: true ---- - diff --git a/docs-beta/content/operational_guides/tuning_availability_consistency_durability.md b/docs-beta/content/operational_guides/tuning_availability_consistency_durability.md deleted file mode 100644 index c2483e4aba..0000000000 --- a/docs-beta/content/operational_guides/tuning_availability_consistency_durability.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: "Tuning availability, consistency, and durability" -date: 2020-04-01T20:18:31-04:00 -draft: true ---- - diff --git a/docs-beta/content/overview/architecture.md b/docs-beta/content/overview/architecture.md deleted file mode 100644 index d773503b94..0000000000 --- a/docs-beta/content/overview/architecture.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "Architecture" -date: 2020-03-30T18:25:12-04:00 -draft: true ---- - -## Architecture - diff --git a/docs-beta/content/overview/components.md b/docs-beta/content/overview/components.md deleted file mode 100644 index d6113664fe..0000000000 --- a/docs-beta/content/overview/components.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "Components" -date: 2020-03-30T18:27:40-04:00 -draft: true ---- - -### Components - -## M3 Coordinator - -M3 Coordinator is a service that coordinates reads and writes between upstream systems, such as Prometheus, and M3DB. It is a bridge that users can deploy to access the benefits of M3DB such as long term storage and multi-DC setup with other monitoring systems, such as Prometheus. See [this presentation](https://schd.ws/hosted_files/cloudnativeeu2017/73/Integrating%20Long-Term%20Storage%20with%20Prometheus%20-%20CloudNativeCon%20Berlin%2C%20March%2030%2C%202017.pdf) for more on long term storage in Prometheus. - -## M3DB - -M3DB is a distributed time series database that provides scalable storage and a reverse index of time series. It is optimized as a cost effective and reliable realtime and long term retention metrics store and index. For more details, see the [M3DB documentation](../m3db/). - -## M3 Query - -M3 Query is a service that houses a distributed query engine for querying both realtime and historical metrics, supporting several different query languages. It is designed to support both low latency realtime queries and queries that can take longer to execute, aggregating over much larger datasets, for analytical use cases. For more details, see the [query engine documentation](../query_engine/). - -## M3 Aggregator - -M3 Aggregator is a service that runs as a dedicated metrics aggregator and provides stream based downsampling, based on dynamic rules stored in etcd. It uses leader election and aggregation window tracking, leveraging etcd to manage this state, to reliably emit at-least-once aggregations for downsampled metrics to long term storage. This provides cost effective and reliable downsampling & roll up of metrics. These features also reside in the M3 Coordinator, however the dedicated aggregator is sharded and replicated, whereas the M3 Coordinator is not and requires care to deploy and run in a highly available way. There is work remaining to make the aggregator more accessible to users without requiring them to write their own compatible producer and consumer. \ No newline at end of file diff --git a/docs-beta/content/overview/motivation.md b/docs-beta/content/overview/motivation.md deleted file mode 100644 index 644a92c4f1..0000000000 --- a/docs-beta/content/overview/motivation.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "Motivation" -date: 2020-03-30T18:27:48-04:00 -draft: true ---- - -## Motivation - -We decided to open source the M3 platform as a scalable remote storage backend for Prometheus and Graphite so that others may attempt to reuse our work and avoid building yet another scalable metrics platform. As documentation for Prometheus states, it is limited by single nodes in its scalability and durability. The M3 platform aims to provide a turnkey, scalable, and configurable multi-tenant store for Prometheus, Graphite and other standard metrics schemas. \ No newline at end of file diff --git a/docs-beta/content/quickstart/_index.md b/docs-beta/content/quickstart/_index.md new file mode 100644 index 0000000000..6d8e667d9b --- /dev/null +++ b/docs-beta/content/quickstart/_index.md @@ -0,0 +1,13 @@ ++++ +title = "Quickstart" +date = 2020-04-21T20:46:17-04:00 +weight = 5 +chapter = true +pre = "X. " ++++ + +### Chapter X + +# Some Chapter title + +Lorem Ipsum. \ No newline at end of file diff --git a/docs-beta/content/reference_docs/_index.md b/docs-beta/content/reference_docs/_index.md new file mode 100644 index 0000000000..28de5d6f7c --- /dev/null +++ b/docs-beta/content/reference_docs/_index.md @@ -0,0 +1,13 @@ ++++ +title = "Reference_docs" +date = 2020-04-21T21:00:26-04:00 +weight = 5 +chapter = true +pre = "X. " ++++ + +### Chapter X + +# Some Chapter title + +Lorem Ipsum. \ No newline at end of file diff --git a/docs-beta/content/reference_docs/apis.md b/docs-beta/content/reference_docs/apis.md new file mode 100644 index 0000000000..c5b967fc65 --- /dev/null +++ b/docs-beta/content/reference_docs/apis.md @@ -0,0 +1,6 @@ +--- +title: "Apis" +date: 2020-04-21T21:02:36-04:00 +draft: true +--- + diff --git a/docs-beta/content/m3db/architecture.md b/docs-beta/content/reference_docs/architecture.md similarity index 57% rename from docs-beta/content/m3db/architecture.md rename to docs-beta/content/reference_docs/architecture.md index d28711d8e1..4e5b8c1784 100644 --- a/docs-beta/content/m3db/architecture.md +++ b/docs-beta/content/reference_docs/architecture.md @@ -1,6 +1,6 @@ --- title: "Architecture" -date: 2020-04-01T19:45:24-04:00 +date: 2020-04-21T21:00:49-04:00 draft: true --- diff --git a/docs-beta/content/reference_docs/architecture/_index.md b/docs-beta/content/reference_docs/architecture/_index.md new file mode 100644 index 0000000000..b4466e7a88 --- /dev/null +++ b/docs-beta/content/reference_docs/architecture/_index.md @@ -0,0 +1,6 @@ +--- +title: "Architecture" +date: 2020-04-21T21:04:11-04:00 +draft: true +--- + diff --git a/docs-beta/content/reference_docs/architecture/aggregator.md b/docs-beta/content/reference_docs/architecture/aggregator.md new file mode 100644 index 0000000000..79b4964f9b --- /dev/null +++ b/docs-beta/content/reference_docs/architecture/aggregator.md @@ -0,0 +1,6 @@ +--- +title: "Aggregator" +date: 2020-04-21T21:01:14-04:00 +draft: true +--- + diff --git a/docs-beta/content/reference_docs/architecture/coordinator.md b/docs-beta/content/reference_docs/architecture/coordinator.md new file mode 100644 index 0000000000..1a30f14174 --- /dev/null +++ b/docs-beta/content/reference_docs/architecture/coordinator.md @@ -0,0 +1,6 @@ +--- +title: "Coordinator" +date: 2020-04-21T21:01:05-04:00 +draft: true +--- + diff --git a/docs-beta/content/reference_docs/architecture/m3db.md b/docs-beta/content/reference_docs/architecture/m3db.md new file mode 100644 index 0000000000..72ff137cc6 --- /dev/null +++ b/docs-beta/content/reference_docs/architecture/m3db.md @@ -0,0 +1,6 @@ +--- +title: "M3db" +date: 2020-04-21T21:00:55-04:00 +draft: true +--- + diff --git a/docs-beta/content/reference_docs/architecture/query.md b/docs-beta/content/reference_docs/architecture/query.md new file mode 100644 index 0000000000..6f0986412a --- /dev/null +++ b/docs-beta/content/reference_docs/architecture/query.md @@ -0,0 +1,6 @@ +--- +title: "Query" +date: 2020-04-21T21:00:59-04:00 +draft: true +--- + diff --git a/docs-beta/content/reference_docs/configurations.md b/docs-beta/content/reference_docs/configurations.md new file mode 100644 index 0000000000..584c9ba11f --- /dev/null +++ b/docs-beta/content/reference_docs/configurations.md @@ -0,0 +1,6 @@ +--- +title: "Configurations" +date: 2020-04-21T21:01:23-04:00 +draft: true +--- + diff --git a/docs-beta/content/reference_docs/configurations/_index.md b/docs-beta/content/reference_docs/configurations/_index.md new file mode 100644 index 0000000000..092b2329a0 --- /dev/null +++ b/docs-beta/content/reference_docs/configurations/_index.md @@ -0,0 +1,6 @@ +--- +title: "Configurations" +date: 2020-04-21T21:03:58-04:00 +draft: true +--- + diff --git a/docs-beta/content/reference_docs/configurations/annotated_config.md b/docs-beta/content/reference_docs/configurations/annotated_config.md new file mode 100644 index 0000000000..a926b5d1be --- /dev/null +++ b/docs-beta/content/reference_docs/configurations/annotated_config.md @@ -0,0 +1,6 @@ +--- +title: "Annotated_config" +date: 2020-04-21T21:01:32-04:00 +draft: true +--- + diff --git a/docs-beta/content/reference_docs/configurations/availability.md b/docs-beta/content/reference_docs/configurations/availability.md new file mode 100644 index 0000000000..db16ded93b --- /dev/null +++ b/docs-beta/content/reference_docs/configurations/availability.md @@ -0,0 +1,6 @@ +--- +title: "Availability" +date: 2020-04-21T21:02:08-04:00 +draft: true +--- + diff --git a/docs-beta/content/operational_guides/bootstrapping.md b/docs-beta/content/reference_docs/configurations/bootstrapping.md similarity index 57% rename from docs-beta/content/operational_guides/bootstrapping.md rename to docs-beta/content/reference_docs/configurations/bootstrapping.md index e824b26240..94edbea6af 100644 --- a/docs-beta/content/operational_guides/bootstrapping.md +++ b/docs-beta/content/reference_docs/configurations/bootstrapping.md @@ -1,6 +1,6 @@ --- title: "Bootstrapping" -date: 2020-04-01T20:19:12-04:00 +date: 2020-04-21T21:02:17-04:00 draft: true --- diff --git a/docs-beta/content/reference_docs/configurations/namespace_config.md b/docs-beta/content/reference_docs/configurations/namespace_config.md new file mode 100644 index 0000000000..4f0cc01c02 --- /dev/null +++ b/docs-beta/content/reference_docs/configurations/namespace_config.md @@ -0,0 +1,6 @@ +--- +title: "Namespace_config" +date: 2020-04-21T21:01:40-04:00 +draft: true +--- + diff --git a/docs-beta/content/reference_docs/configurations/replication.md b/docs-beta/content/reference_docs/configurations/replication.md new file mode 100644 index 0000000000..e987e5e4b3 --- /dev/null +++ b/docs-beta/content/reference_docs/configurations/replication.md @@ -0,0 +1,6 @@ +--- +title: "Replication" +date: 2020-04-21T21:01:57-04:00 +draft: true +--- + diff --git a/docs-beta/content/reference_docs/configurations/topology_config.md b/docs-beta/content/reference_docs/configurations/topology_config.md new file mode 100644 index 0000000000..b84cd8e7fe --- /dev/null +++ b/docs-beta/content/reference_docs/configurations/topology_config.md @@ -0,0 +1,6 @@ +--- +title: "Topology_config" +date: 2020-04-21T21:01:48-04:00 +draft: true +--- + diff --git a/docs-beta/content/reference_docs/operator.md b/docs-beta/content/reference_docs/operator.md new file mode 100644 index 0000000000..b3c231870d --- /dev/null +++ b/docs-beta/content/reference_docs/operator.md @@ -0,0 +1,6 @@ +--- +title: "Operator" +date: 2020-04-21T21:02:41-04:00 +draft: true +--- + diff --git a/docs-beta/content/troubleshooting/_index.md b/docs-beta/content/troubleshooting/_index.md index 3984a0ab6e..17d3d650eb 100644 --- a/docs-beta/content/troubleshooting/_index.md +++ b/docs-beta/content/troubleshooting/_index.md @@ -1,11 +1,11 @@ +++ title = "Troubleshooting" date = 2020-04-01T20:23:10-04:00 -weight = 10 +weight = 12 chapter = true -pre = "10. " +pre = "12. " +++ -### Section 10 +### Section 12 # Troubleshooting \ No newline at end of file diff --git a/docs-beta/content/troubleshooting/error_msgs.md b/docs-beta/content/troubleshooting/error_msgs.md new file mode 100644 index 0000000000..658d359888 --- /dev/null +++ b/docs-beta/content/troubleshooting/error_msgs.md @@ -0,0 +1,6 @@ +--- +title: "Error_msgs" +date: 2020-04-21T21:04:36-04:00 +draft: true +--- + diff --git a/docs-beta/content/troubleshooting/faqs.md b/docs-beta/content/troubleshooting/faqs.md new file mode 100644 index 0000000000..57c1b372a8 --- /dev/null +++ b/docs-beta/content/troubleshooting/faqs.md @@ -0,0 +1,6 @@ +--- +title: "Faqs" +date: 2020-04-21T21:04:28-04:00 +draft: true +--- + diff --git a/docs-beta/content/troubleshooting/file_issue.md b/docs-beta/content/troubleshooting/file_issue.md new file mode 100644 index 0000000000..8018842d2c --- /dev/null +++ b/docs-beta/content/troubleshooting/file_issue.md @@ -0,0 +1,6 @@ +--- +title: "File_issue" +date: 2020-04-21T21:04:51-04:00 +draft: true +--- + diff --git a/docs-beta/content/troubleshooting/resources.md b/docs-beta/content/troubleshooting/resources.md new file mode 100644 index 0000000000..3e1fe12491 --- /dev/null +++ b/docs-beta/content/troubleshooting/resources.md @@ -0,0 +1,6 @@ +--- +title: "Resources" +date: 2020-04-21T21:04:43-04:00 +draft: true +--- + diff --git a/docs-beta/content/versions/_index.md b/docs-beta/content/versions/_index.md new file mode 100644 index 0000000000..2961d7b986 --- /dev/null +++ b/docs-beta/content/versions/_index.md @@ -0,0 +1,13 @@ ++++ +title = "Versions" +date = 2020-04-21T21:05:08-04:00 +weight = 5 +chapter = true +pre = "X. " ++++ + +### Chapter X + +# Some Chapter title + +Lorem Ipsum. \ No newline at end of file