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

Improve Docker documentation #376

Merged
merged 1 commit into from
Dec 20, 2016
Merged

Improve Docker documentation #376

merged 1 commit into from
Dec 20, 2016

Conversation

discordianfish
Copy link
Member

This adds bind-mounts and ignore flags to Docker example and explains
why it's best run uncontainerized.

--net="host" \
quay.io/prometheus/node-exporter \
-collector.procfs /host/proc \
-collector.sysfs /host/proc \

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/host/sys

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ops, thanks - fixed. Copied it without checking from the issue.

You can deploy this exporter using the [prom/node-exporter](https://registry.hub.docker.com/u/prom/node-exporter/) Docker image.

For example:
It's not recommended to deploy the node-exporter as Docker container because it
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

node_exporter

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed!


For example:
It's not recommended to deploy the node-exporter as Docker container because it
requires access to the host system. If you need to run it on Docker, you can
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe "designed to monitor the host system"

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@SuperQ I went for a more technical description. Why do you think 'designed to monitor' is better than 'requires access to'? I imaging if we use the former, people might say: "well, designed for - but I still want to run it in Docker and Prometheus peepz don't allow it"

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe to make it overly clear, mention both aspects. :)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense. Like this?

This adds bind-mounts and ignore flags to Docker example and explains
why it's best run uncontainerized.
@discordianfish
Copy link
Member Author

@SuperQ Good to merge?

@SuperQ SuperQ merged commit 481392d into master Dec 20, 2016
@SuperQ SuperQ deleted the fish-update-docker-readme branch December 20, 2016 17:36
@SuperQ SuperQ mentioned this pull request Jan 15, 2017
tamcore pushed a commit to gitgrave/node_exporter that referenced this pull request Oct 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants