Added documentation on docker usage #1865
Conversation
| @@ -50,6 +50,32 @@ You can also build just one of the binaries in this repo by passing a name to th | |||
| $ make build BINARIES=amtool | |||
| ``` | |||
|
|
|||
| ## Docker | |||
|
|
|||
| <!--- example of complete docker run command to run a container ---> | |||
There was a problem hiding this comment.
How about linking to the Procfile of this repository, as it gives a user a full setup on their local machine.
There was a problem hiding this comment.
There was a problem hiding this comment.
I'm talking about an actual invokation of docker run ..., using volumes(-v) and port(-p) mapping as appropriate, then the command arguments. The Procfile contains example invokations of the alertmanager binary, but it will look different when using docker run, so it can be confusing to people less familiar with docker and unix.
README.md
Outdated
| These paths can also be mapped to volumes: | ||
| * `/etc/alertmanager/alertmanager.yml`: default configuration file path | ||
|
|
||
| ### Environment variables |
There was a problem hiding this comment.
I am not aware of any. Configuration is limited to the config file and the command line flags.
There was a problem hiding this comment.
Same for me. I'd remove this section.
removed space Co-Authored-By: DrPyser <schok53@gmail.com>
|
other than the DCO, is there anything preventing this PR from being merged? |
README.md
Outdated
|
|
||
| ### Ports | ||
|
|
||
| * `9093`: main api port |
README.md
Outdated
| @@ -50,6 +50,33 @@ You can also build just one of the binaries in this repo by passing a name to th | |||
| $ make build BINARIES=amtool | |||
| ``` | |||
|
|
|||
| ## Docker | |||
There was a problem hiding this comment.
Maybe "Container image" rather than "Docker ™️"?
| <!--- example of complete docker run command to run a container ---> | ||
| <!--- example of a docker-compose.yml service snippet ---> | ||
|
|
||
| ### Ports |
README.md
Outdated
| These paths can also be mapped to volumes: | ||
| * `/etc/alertmanager/alertmanager.yml`: default configuration file path | ||
|
|
||
| ### Environment variables |
There was a problem hiding this comment.
Same for me. I'd remove this section.
|
|
||
| <!--- Add documentation here ---> | ||
|
|
||
| ### Command and entrypoint |
| ### Command and entrypoint | ||
| The container entrypoint is the [`alertmanager` command](https://prometheus.io/docs/alerting/configuration/)<!---More complete documentation of the command would be useful here--->. | ||
|
|
||
| The default docker command passed to the entrypoint is `--config.file=/etc/alertmanager/alertmanager.yml --storage.path=/alertmanager`. Specifying the docker command(using `docker run quay.io/prometheus/alertmanager $COMMAND`) thus override those default arguments. |
There was a problem hiding this comment.
Regarding this paragraph, I'm not sure we want to get into this level of details as 1) the arguments may change over time and 2) it is more a matter of the container runtime.
There was a problem hiding this comment.
Fair enough, we could link to a documentation page for the binary.
|
A lost afternoon and some Googling lead me here. I had been trying to mount the configuration for alertmanager via a volume, and the Dockerfile shown on Docker Hub (https://hub.docker.com/r/prom/alertmanager/dockerfile) shows the config file location used by alertmanager as Will the changes noted in this ticket also update the Dockerfile shown on Docker Hub? |
|
@bploetz the inaccuracy on Docker Hub has already been reported but we need someone from Docker Hub to clean up things (see docker/hub-feedback#1847). |
|
the issue on docker hub does not prevent this project to get a proper readme on github documenting the docker image. |
Closes #1855 .
This is an invitation to add more documentation related to docker usage.
A new
Dockersection is added to the readme, with subsections for describing exposed ports, volumes, environment variables and commands.I only added the information I could gather from reading the dockerfile(https://github.com/prometheus/alertmanager/blob/master/Dockerfile). I invite contributors, members and people with better knowledge and experience on this software to help add relevant information relative to usage of the docker image.