linkedin / linkedin/Burrow

Dockerfile expects burrow to already be built

Open
#321 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
4k
Forks
818
Avg merge
1h 14m
Merged PRs (30d)
1

Description

The Dockerfile seems to expect you to provide the burrow binary, which seems to go against common expectations of portability for a Dockerfile. I could be wrong, but am curious as to why this decision was made? Why not just have the Dockerfile install burrow? If you want to use the iron + binary tactic for size purposes, I would provide both options out of the box.

In the Dockerfile:
```
ADD burrow /app/
```

In addition, the `docker-compose.yml` file mounts the `docker-config` directory to `/etc/burrow`, but the Dockerfile expects you to do that manually. Wouldn't it make more sense to have the `Dockerfile` simply require that you mount your config directory to `/etc/burrow`?

Also, it expects the binary to be lowercase, but it gets installed as uppercase.

For example:
```
FROM golang:alpine3.7
MAINTAINER LinkedIn Burrow "https://github.com/linkedin/Burrow"

RUN apk update
RUN apk add git

RUN go get github.com/linkedin/Burrow
WORKDIR src/github.com/linkedin/Burrow
RUN go install

RUN mkdir /app
WORKDIR /app
RUN mv /go/bin/Burrow ./burrow

CMD ["/app/burrow", "--config-dir", "/etc/burrow"]

```

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Inspect Dockerfile and docker-compose.yml first, focusing on the ADD burrow step, the binary name, and the /etc/burrow configuration mount. Compare the requested build and configuration behavior with the current files; done means the documented Docker workflow no longer requires an externally built binary and handles configuration consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, docker-compose, go
Domain
devops, infrastructure
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.