Skip to content
This repository was archived by the owner on Aug 23, 2023. It is now read-only.

Refactor docker docs a bit #1047

Merged
merged 2 commits into from
Sep 14, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -55,6 +55,7 @@ Otherwise data loss of current chunks will be incurred. See [operations guide](

* [Overview](https://github.com/grafana/metrictank/blob/master/docs/overview.md)
* [Quick start using docker](https://github.com/grafana/metrictank/blob/master/docs/quick-start-docker.md)
([other docker stacks](docs/docker.md))
* [Installation guides](https://github.com/grafana/metrictank/blob/master/docs/installation.md)
* [Configuration](https://github.com/grafana/metrictank/blob/master/docs/config.md)
* [Memory server](https://github.com/grafana/metrictank/blob/master/docs/memory-server.md)
4 changes: 2 additions & 2 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -44,6 +44,6 @@ see the [Makefile](../Makefile) for more targets

# Documentation

* [docs](../docs) for users and operators
* [devdocs](../devdocs) for MT developers
* [docs](../docs) for users, operators and basic development instructions
* [devdocs](../devdocs) in-depth implementation details for developers

4 changes: 4 additions & 0 deletions devdocs/docker.md → docs/docker.md
Original file line number Diff line number Diff line change
@@ -17,6 +17,8 @@ plain, basic environment.
uses metrictank docker image (with baked in binaries and configs), statsdaemon.
Comes with 1 dashboard: the metrictank dashboard

[see our quickstart guide](https://github.com/grafana/metrictank/blob/master/docs/quick-start-docker.md)

### docker-dev

Similar to docker-standard, but custom metrictank build is loaded, custom configs from scripts/config
@@ -45,6 +47,8 @@ Similar to docker-dev-custom-cfg-kafka
* uses a cluster of 4 MT's (with 2x replication)
* separate graphite monitoring server

[see our docker-cluster quickstart guide](https://github.com/grafana/metrictank/blob/master/docs/quick-start-docker-cluster.md)

### docker-chaos

Similar to docker-cluster but used for chaos testing
6 changes: 5 additions & 1 deletion docs/quick-start-docker-cluster.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Quick start for docker-cluster

The metrictank repository holds various stack configurations. See [docker](docker.md) for more info.
If you're not familiar with Grafana dashboarding and datasources, you should first follow
[our standard quickstart guide](https://github.com/grafana/metrictank/blob/master/docs/quick-start-docker.md) which goes further in depth on that.

The docker-cluster image is similar to docker-standard, but with the following changes and features:

* Cluster of 4 metrictanks (with 2x replication)
@@ -114,4 +118,4 @@ To clean up all data so you can start fresh, run this after you stopped the stac
```
docker rm -v $(docker ps -a -q -f status=exited)
```
This will remove the stopped containers and their data volumes.
This will remove the stopped containers and their data volumes.
2 changes: 1 addition & 1 deletion docs/quick-start-docker.md
Original file line number Diff line number Diff line change
@@ -171,4 +171,4 @@ This will remove the stopped containers and their data volumes.

## Other docker stacks

The metrictank repository holds other stack configurations as well (for clustering, benchmarking, etc). See [devdocs/docker](../devdocs/docker.md) for more info.
The metrictank repository holds other stack configurations as well (for clustering, benchmarking, etc). See [docker](docker.md) for more info.