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

Docker netdata documentation #4899

Closed
pgassmann opened this issue Dec 3, 2018 · 6 comments
Closed

Docker netdata documentation #4899

pgassmann opened this issue Dec 3, 2018 · 6 comments
Assignees
Labels
area/docs docker docker related issues feature request New features priority/low A 'nice to have' not critical issue
Milestone

Comments

@pgassmann
Copy link

@paulfantom Can the Information on Dockerhub be changed to show usage information for the docker image? Is this Readme added manually?

@paulfantom Can you add the information on how to specify additional parameters.

  • cli: append the desired options to the cli docker run -d [...] netdata/netdata -i 192.168.1.1.
  • docker-compose: command: '-i 192.168.1.1'

It would also be helpful to have a direct link from the docs to dockerhub. on https://docs.netdata.cloud/packaging/docker/ to https://hub.docker.com/r/netdata/netdata/

@paulfantom paulfantom self-assigned this Dec 3, 2018
@cakrit
Copy link
Contributor

cakrit commented Dec 3, 2018

The Wiki Page contains a link that is no longer valid.
The correct link is now docs.netdata.cloud docs.netdata.cloud/packaging/docker

Link fixed.

Regarding additional info in the README, please go ahead and update it. We are more than happy to get help with the documentation
@paulfantom will review the changes for accuracy.

So it's just the following that will remain:

Can the Information on Dockerhub be changed to show usage information for the docker image? Is this Readme added manually?

@paulfantom
Copy link
Contributor

Readme in docker hub is added manually and I will try to add sth to sync it via CI system with a file located at packaging/docker/README.md

@paulfantom paulfantom added this to the v1.12-rc1 milestone Dec 3, 2018
@paulfantom paulfantom added the priority/low A 'nice to have' not critical issue label Dec 3, 2018
@ktsaou
Copy link
Member

ktsaou commented Dec 3, 2018

@cakrit could you please take care of it? The README on docker hub, should docker related.

@cakrit cakrit added the feature request New features label Dec 4, 2018
@paulfantom
Copy link
Contributor

@pgassmann we are using ENTRYPOINT directive in our Dockerfile, so the way to add any parameters to netdata binary is to use CMD/command ( https://docs.docker.com/engine/reference/builder/#cmd ). We are not planning on duplicating documentation for how this method is implemented in various tools (docker cli/docker-compose/k8s manifests/other).

@cakrit
Copy link
Contributor

cakrit commented Dec 4, 2018

I spoke with @paulfantom and I will do a PR to improve the docker documentation today. The automated update will come a bit later.

cakrit added a commit that referenced this issue Dec 4, 2018
Minor improvements to docker installation readme
Bug fix to stop presenting empty links in bash modules
Related to #4899
@cakrit
Copy link
Contributor

cakrit commented Dec 4, 2018

#4914 updated the README, https://hub.docker.com/r/netdata/netdata/ is also updated.
Thank you for your feedback @pgassmann

@cakrit cakrit closed this as completed Dec 4, 2018
@cakrit cakrit modified the milestones: v1.12-rc1, v1.12-rc0 Dec 4, 2018
kiku-jw pushed a commit to kiku-jw/netdata that referenced this issue Mar 4, 2019
Minor improvements to docker installation readme
Bug fix to stop presenting empty links in bash modules
Related to netdata#4899
@ilyam8 ilyam8 added the docker docker related issues label May 30, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs docker docker related issues feature request New features priority/low A 'nice to have' not critical issue
Projects
None yet
Development

No branches or pull requests

5 participants