Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation for docker usage #1855

Open
DrPyser opened this issue Apr 23, 2019 · 5 comments · May be fixed by #1865
Open

Documentation for docker usage #1855

DrPyser opened this issue Apr 23, 2019 · 5 comments · May be fixed by #1865

Comments

@DrPyser
Copy link

DrPyser commented Apr 23, 2019

It seems the docker image(https://quay.io/repository/prometheus/alertmanager) is lacking necessary documentation, such as internal ports to map, environment variables that can be used for configuration, etc.

Thanks!

@mxinden
Copy link
Member

mxinden commented Apr 26, 2019

Thanks for the pointer @DrPyser. My suggestion would be to not sync the readme, but instead link to the Github one.

I don't have access to Quay. As far as I know @simonpasquier does? Would you mind removing the description and linking to https://github.com/prometheus/alertmanager/blob/master/README.md? What do you all think?

@simonpasquier
Copy link
Member

I've updated the quay.io page. @DrPyser if you've got ideas to improve the README file, feel free to send a PR.

@mxinden
Copy link
Member

mxinden commented Apr 26, 2019

Thanks @simonpasquier!

@DrPyser
Copy link
Author

DrPyser commented Apr 29, 2019

My suggestion would be to add information on things that one should know to use the image, like

  • which environment variables can be used to configure the container
  • which paths can/should be mapped to volumes for data persistence or configuration
  • which ports are exposed(listened to) by the container process
  • what command the container runs by default, and how that command can be modified/overridden.

Some of that information can be directly found in the Dockerfile, some might benefit from a better knowledge of the alertmanager command and intentions behind the Dockerfile.

@DrPyser
Copy link
Author

DrPyser commented Apr 29, 2019

#1865

@DrPyser DrPyser linked a pull request Apr 29, 2019 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants