Update Dockerfiles to reference executable via ENTRYPOINT by zdicesare · Pull Request #815 · jaegertracing/jaeger

zdicesare · 2018-05-13T03:53:05Z

In all Dockerfiles, reference the executable in ENTRYPOINT to allow
consumers to override default parameters without needing to specify
the executable path. Standard defaults move to ENTRYPOINT too for the same reason.

Signed-off-by: Zachary DiCesare zachary.v.dicesare@gmail.com

Which problem is this PR solving?

Resolves Allow running containers without overriding command line #802

Short description of the changes

In all Dockerfiles, reference the executable path and standard default arguments in ENTRYPOINT
to allow consumers to override defaults without needing to specify them again.
Move hotrod default argument to CMD

coveralls · 2018-05-13T04:02:41Z

Coverage remained the same at 100.0% when pulling 864d66b on zdicesare:feature/dockerfile-entrypoint into a4706c0 on jaegertracing:master.

yurishkuro · 2018-05-13T17:45:45Z

build shows errors like this

jaeger-collector_1      | Error: unknown command "/go/bin/collector-linux" for "jaeger-collector"

zdicesare · 2018-05-14T00:47:33Z

Hey, sorry about that, I'm still looking into the cause.

zdicesare · 2018-05-14T18:10:10Z

This is ready for review. I'll add a PR to the documentation repository as well

vprithvi · 2018-05-14T22:01:41Z

cmd/query/Dockerfile

 ADD jaeger-ui-build /go/jaeger-ui/
-CMD ["/go/bin/query-linux", "--query.static-files=/go/jaeger-ui/"]
+ENTRYPOINT ["/go/bin/query-linux"]
+CMD ["--query.static-files=/go/jaeger-ui/"]


The dockerfile docs state that ENTRYPOINT may be used with arguments, as such ENTRYPOINT ["top", "-b"].

I'm not clear on what advantage the combination for ENTRYPOINT to set the command and CMD to set defaults gives us. Could you elaborate?

To answer my own question: It seems that we need to use the --entrypoint option to override the entry point while anything after the image in the docker command overrides cmd

I was discussing with @yurishkuro about this, and agree with him in that moving "--query.static-files=/go/jaeger-ui" as an argument to the ENTRYPOINT command is better.

This is because overriding CMD in docker run overrides all the command parameters forcing users to pass in "--query.static-files=/go/jaeger-ui/".

By putting this in the ENTRYPOINT, other overrides become easier, and people may still override the static file location by using the -d option

That sounds reasonable to me, however in the case that a user did override query.static-files, the resulting command would look like:

/go/bin/query-linux --query.static-files=/go/jaeger-ui/ --query.static-files=/my/desired/path

which seems a little weird at first glance, but it works because flags sets the last value it encounters. Are we ok relying on this?

Also, it seems like the same change would make sense for the defaults in cmd/standalone/Dockerfile.

I'm very new to the Jaeger repo, so thank you for the patience here!

vprithvi · 2018-05-14T22:10:01Z

lgtm, will merge when the documentation PR is up

- In all Dockerfiles, reference the executable in ENTRYPOINT to allow consumers to override default parameters without needing to specify the executable path. - Common default arguments in the query and standalone Dockerfiles also move to ENTRYPOINT - Move hotrod default argument to CMD Signed-off-by: Zachary DiCesare <zachary.v.dicesare@gmail.com>

zdicesare · 2018-05-15T01:12:57Z

Updated this PR w/ feedback, but want to make sure we're ok with the new usage

Documentation PR at jaegertracing/documentation#74

yurishkuro · 2018-05-15T03:18:57Z

/go/bin/query-linux --query.static-files=/go/jaeger-ui/ --query.static-files=/my/desired/path

That's just how it would look internally, right? Don't think it matters as long as it works. Eventually we should fix #609 and not require this option to begin with.

jpkrohling

Note that this is a breaking change and will affect everyone overriding the default flags.

This should also be coordinated with changes on:

https://github.com/jaegertracing/jaeger-kubernetes
https://github.com/jaegertracing/jaeger-openshift
https://github.com/kubernetes/charts/tree/master/incubator/jaeger

jpkrohling · 2018-05-15T08:13:22Z

cmd/standalone/Dockerfile

 COPY ./cmd/standalone/sampling_strategies.json /go/src/config/

-CMD ["/go/bin/standalone-linux","--query.static-files=/go/src/jaeger-ui-build/build/","--sampling.strategies-file=/go/src/config/sampling_strategies.json"]
+ENTRYPOINT ["/go/bin/standalone-linux", "--query.static-files=/go/src/jaeger-ui-build/build/", "--sampling.strategies-file=/go/src/config/sampling_strategies.json"]


While I think the static files would "never" change for the Docker image (or would they?), the strategies file are most likely to change in some scenarios. As it's easier to override a config file than a flag on an entrypoint directive, it would be best to use a configuration file instead of passing values via flags, like:

COPY ./cmd/standalone/standalone.yaml /go/src/config/ ENTRYPOINT ["/go/bin/standalone-linux", "--config-file=/go/src/config/standalone.yaml"]

./cmd/standalone/standalone.yaml doesn't exist yet, but could look like this:

query: static-files: /go/jaeger-ui/ sampling: strategies-file: /go/src/config/sampling_strategies.json

The other Dockerfiles should also follow the same pattern.

And finally, I would personally prefer /conf/ instead of /go/src/config/, and /bin/ instead of /go/bin/, unless there's a specific reason to keep go in the path name.

cc @yurishkuro, @pavolloffay

I don't have a strong opinion on directories.

I have noticed that some images put binaries into /bin or /usr/share and configuration into /etc so in our case /etc/jaeger

Those images are probably following the LSB (Linux Standard Base), which is a standard for this kind of thing on the Linux world. I'd be OK with that, if we do indeed place the config files at /etc/jaeger/standalone.yaml instead of /etc/jaeger.yaml.

I meant /etc/jaeger as a dir for whatever configuration we need.

But as I said I don't have a strong opinion. I am not sure what benefits putting binaries into /bin has as we use from scratch. One way or another following standard Linux conventions is not a bad thing :).

If there are no options that need to be passed, then there's no reason to have a config file.

If there are CLI options to be passed (as is the case for the current state of this PR), then it's easier for a consumer to override a config file than override the entrypoint directive.

I may be a step behind you here- but doesn't the consumer overriding a config file via an argument to the container require a volume mount? In that case it seems easier to override the entrypoint with additional command line arguments.

The embedding of UI assets is done in #918. Once it's merged I suggest we change this one to

ENTRYPOINT ["/go/bin/standalone-linux"] CMD ["--sampling.strategies-file=/go/src/config/sampling_strategies.json"]

I now see the value of using the config as the lowest priority default value, but I propose we leave it for another PR, as it won't be such a breaking change as this PR.

Or rather:

ENTRYPOINT ["/go/bin/standalone-linux"] CMD ["--sampling.strategies-file=/etc/jaeger/sampling_strategies.json"]

https://github.com/jaegertracing/jaeger/pull/918/files#diff-da47d3e14c88bf43b29700d0fa2b7a27R22

@jkandasa scenarios to test:

Override the CMD with a custom option (--log-level, for instance)

Override the /etc/jaeger/sampling_strategies.json file

zdicesare · 2018-05-15T23:39:05Z

Additional PRs at:
jaegertracing/jaeger-openshift#81
jaegertracing/jaeger-kubernetes#87

Command line params to the jaeger containers in https://github.com/kubernetes/charts/tree/master/incubator/jaeger are all empty, and I did not see any references to the executables in that repo but definitely could use a confirmation on that.

jpkrohling · 2018-05-16T08:58:48Z

Command line params to the jaeger containers in https://github.com/kubernetes/charts/tree/master/incubator/jaeger are all empty

It would then need only a version bump, to make use of the new feature.

but definitely could use a confirmation on that.

Also looks empty to me, but the best person to confirm would be @dvonthenen

davidvonthenen · 2018-05-16T15:27:37Z

@jpkrohling @zdicesare Yup, command line params are empty. All configuration is done via ENV variables. A bump in the version should take care of it.

jpkrohling · 2018-07-09T09:43:46Z

cmd/query/Dockerfile

 COPY query-linux /go/bin/
 ADD jaeger-ui-build /go/jaeger-ui/
-CMD ["/go/bin/query-linux", "--query.static-files=/go/jaeger-ui/"]
+ENTRYPOINT ["/go/bin/query-linux", "--query.static-files=/go/jaeger-ui/"]


After #918, the --query.static-files option is optional and the assets are embedded into the binary, so, remove this from the entrypoint.

jpkrohling · 2018-07-09T09:45:24Z

crossdock/docker-compose.yml

    jaeger-query:
 #    override to disable static files
-        command: ["/go/bin/query-linux", "--query.static-files=", "--cassandra.keyspace=jaeger_v1_dc1", "--cassandra.servers=cassandra"]
+        command: ["--query.static-files=", "--cassandra.keyspace=jaeger_v1_dc1", "--cassandra.servers=cassandra"]


The first option can be removed

codecov · 2018-07-09T20:21:02Z

Codecov Report

Merging #815 into master will not change coverage.
The diff coverage is n/a.

@@          Coverage Diff          @@
##           master   #815   +/-   ##
=====================================
  Coverage     100%   100%           
=====================================
  Files         126    126           
  Lines        6070   6070           
=====================================
  Hits         6070   6070

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5bbdeeb...38500a5. Read the comment docs.

zdicesare · 2018-07-09T20:29:54Z

Thank you for updating this @yurishkuro, I can work on updating the other PRs with new images when this is out, including creating a version bump PR in https://github.com/kubernetes/charts/tree/master/incubator/jaeger

yurishkuro

🎉

zdicesare requested review from black-adder, pavolloffay, vprithvi and yurishkuro as code owners May 13, 2018 03:53

zdicesare force-pushed the feature/dockerfile-entrypoint branch from e6f3657 to 39a93ce Compare May 14, 2018 01:27

vprithvi reviewed May 14, 2018

View reviewed changes

vprithvi approved these changes May 14, 2018

View reviewed changes

zdicesare force-pushed the feature/dockerfile-entrypoint branch from 39a93ce to 864d66b Compare May 15, 2018 00:51

zdicesare mentioned this pull request May 15, 2018

Update docker examples for new run syntax jaegertracing/documentation#74

Merged

jpkrohling reviewed May 15, 2018

View reviewed changes

This was referenced May 15, 2018

Remove executable as an argument to containers jaegertracing/jaeger-kubernetes#87

Merged

Remove executable as an argument to containers jaegertracing/jaeger-openshift#81

Merged

This was referenced Jul 9, 2018

Version 1.6 countdown #919

Closed

Package static assets inside the query-service binary #918

Merged

jpkrohling reviewed Jul 9, 2018

View reviewed changes

Merge branch 'master' into feature/dockerfile-entrypoint

38500a5

ghost assigned yurishkuro Jul 9, 2018

ghost added the review label Jul 9, 2018

yurishkuro approved these changes Jul 9, 2018

View reviewed changes

yurishkuro merged commit 48bbbae into jaegertracing:master Jul 9, 2018

ghost removed the review label Jul 9, 2018

isaachier mentioned this pull request Aug 29, 2018

Crossdock and Travis are buggy #1028

Closed

Conversation

zdicesare commented May 13, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Which problem is this PR solving?

Short description of the changes

Uh oh!

coveralls commented May 13, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

yurishkuro commented May 13, 2018

Uh oh!

zdicesare commented May 14, 2018

Uh oh!

zdicesare commented May 14, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vprithvi commented May 14, 2018

Uh oh!

zdicesare commented May 15, 2018

Uh oh!

yurishkuro commented May 15, 2018

Uh oh!

jpkrohling left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zdicesare commented May 15, 2018

Uh oh!

jpkrohling commented May 16, 2018

Uh oh!

davidvonthenen commented May 16, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Jul 9, 2018

Codecov Report

Uh oh!

zdicesare commented Jul 9, 2018

Uh oh!

yurishkuro left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

zdicesare commented May 13, 2018 •

edited

Loading

coveralls commented May 13, 2018 •

edited

Loading