Reworked Dockerfile for a more production oriented usage #36

qdm12 · 2019-07-01T07:58:55Z

Added .dockerignore to speed up build context and avoid rebuilding when unecessary
Specified Alpine and Go versions as build arguments
Specified Go target CPU architecture as build arguments to be able to build for ARM devices
Specified base images as build arguments to be able to build for ARM devices
Trimmed down size of final image using -a -installsuffix cgo -ldflags="-s -w" go build flags and by copying the statically built binary only to the final image
Added clear build and run instructions for the Docker container

- Added .dockerignore to speed up build context and avoid rebuilding when unecessary - Specified Alpine and Go versions as build arguments - Specified Go target CPU architecture as build arguments to be able to build for ARM devices - Specified base images as build arguments to be able to build for ARM devices - Trimmed down size of final image using `-a -installsuffix cgo -ldflags="-s -w"` go build flags and by copying the statically built binary only to the final image - Added clear build and run instructions for the Docker container

qdm12 · 2019-07-01T08:00:54Z

Hi there !

Hi ! I just added that so I can run your program without downloading the binary, especially for die hard of running everything in a Docker container... And added ARM build support too. By the way, it seems your program requires Git to function, is this expected? If not, we could manage to run it in a Scratch container as a static binary which would make it very tiny 👍

dawidd6 · 2019-07-01T08:12:23Z

Hmm, I think that needing git to function is a bug. The initial codebase was taken from lazygit and maybe something wasn't removed yet.

LGTM. Additionally you may want to add these to go build:

-ldflags \
		"-X main.commit=$(COMMIT) \
		-X main.date=$(shell date -u +%Y-%m-%d) \
		-X main.version=0.2.4 \
		-X main.buildSource=Docker"

I mean, really only version, commit and buildSource would be enough, cause specyfing date could destroy reproducible building.

qdm12 · 2019-07-01T09:17:16Z

Done, I've added Docker labels with these as well, it might turn to be useful.
By the way, the error without git is:

*errors.errorString invalid dimensions
/go/src/github.com/jesseduffield/lazydocker/vendor/github.com/jesseduffield/gocui/gui.go:164 (0x7d1339)
/go/src/github.com/jesseduffield/lazydocker/pkg/gui/layout.go:84 (0x8010e4)
/go/src/github.com/jesseduffield/lazydocker/vendor/github.com/jesseduffield/gocui/gui.go:387 (0x7d2d90)
/go/src/github.com/jesseduffield/lazydocker/vendor/github.com/jesseduffield/gocui/gui.go:504 (0x7d389e)
/go/src/github.com/jesseduffield/lazydocker/vendor/github.com/jesseduffield/gocui/gui.go:412 (0x7d2fe4)
/go/src/github.com/jesseduffield/lazydocker/pkg/gui/gui.go:309 (0x7f70f3)
/go/src/github.com/jesseduffield/lazydocker/pkg/gui/subprocess.go:20 (0x80725f)
/go/src/github.com/jesseduffield/lazydocker/pkg/app/app.go:54 (0x81a71a)
/go/src/github.com/jesseduffield/lazydocker/pkg/app/app.go:54 (0x81a70d)
/usr/local/go/src/runtime/proc.go:200 (0x42d77c)
/usr/local/go/src/runtime/asm_amd64.s:1337 (0x458541)

Also, is xdg-utils necessary? It works without for me but I wanted to check with you first.

Thanks !

EDIT: Never mind, this issue arises with git from time to time as well. Maybe it's my terminal which sucks, I'm checking now.

qdm12 · 2019-07-01T09:49:24Z

ok so it seems both git and xdg-utils are not necessary.

However, running the container directly without first starting a shell /bin/sh fails because of the error of gocui above, probably because the screen size is zero or something.

So I will update the instructions, where you need to launch the container and then enter lazydocker for the GUI to work out.

- Runs the container with `/bin/sh` initially - Invoke `lazydocker` from within the container, or gocui fails as the terminal window is invalid at launch

qdm12 · 2019-07-01T10:01:16Z

It works great on my linux host and my windows host, let me know if I should change anything !

Dockerfile

jesseduffield · 2019-07-01T10:23:23Z

Hey man thanks for making this :) Very impressive.

I left one comment, other than that this LGTM, happy to merge if @dawidd6 is happy with it

README.md

dawidd6 · 2019-07-01T12:29:25Z

There seems to be a problem with getting containers logs. It works with normal installation, but not in Docker. @jesseduffield are the logs fetched from command line Docker client?

dawidd6 · 2019-07-01T12:30:51Z

diff --git a/Dockerfile b/Dockerfile
index 351e334..0abcc0f 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -24,5 +24,6 @@ LABEL org.label-schema.schema-version="1.0.0-rc1" \
     org.label-schema.vcs-description="The lazier way to manage everything docker" \
     org.label-schema.docker.cmd="docker run -it -v /var/run/docker.sock:/var/run/docker.sock lazydocker" \
     org.label-schema.version=${VERSION}
-ENTRYPOINT [ "/bin/sh" ]
+RUN printf "resize > /dev/null\nlazydocker \$@\n" > /bin/run && chmod +x /bin/run
+ENTRYPOINT [ "sh", "/bin/run" ]
 COPY --from=builder /go/src/github.com/jesseduffield/lazydocker/lazydocker /usr/bin/lazydocker
diff --git a/README.md b/README.md
index c651f8f..0af4172 100644
--- a/README.md
+++ b/README.md
@@ -97,8 +97,6 @@ go get github.com/jesseduffield/lazydocker
     docker run -it -v /var/run/docker.sock:/var/run/docker.sock lazydocker
     ```
 
-1. Then enter `lazydocker`
-
 ## Usage
 
 Call `lazydocker` in your terminal. I personally use this a lot so I've made an alias for it like so:

@qdm12 you can apply this patch on top of your sources in reworking-dockerfile branch if you want to immediately run lazydocker instead of first interactively running sh. Would make a pull request to your fork, but... I'm lazy.

jesseduffield · 2019-07-01T12:33:07Z

@dawidd6 yes they are fetched vis the command line. Though there are various places in the app that use the docker client package to do things. Perhaps there are issues due to that?

dawidd6 · 2019-07-01T12:36:55Z

@jesseduffield heh, so now there are 2 possibilities:

Try to rewrite those calls in pure Go code.
Install docker package in container.

Obviously the second one is an instant fix, but in the long run, would be better to do the first. Though I don't really know if it's feasible, would need to dig deeper into the code.

- Git commit is passed as a build argument as explained in README.md - `.git` directory is ignored by Docker for a quicker build and smaller context - the build arg VCS_REF is used both to tag the image and the Go program

Thanks to the script: ```sh #!/bin/sh resize > /dev/null lazydocker $@ ```

Dockerfile

jesseduffield · 2019-07-02T10:16:40Z

as for the resize thing, perhaps we can something like this in app.go:

func (app *App) Run() error {
	// before we do anything, we need to check that we have some window space available
	for {
		width, _, err := terminal.GetSize(int(os.Stdin.Fd()))
		if err != nil {
			return err
		}
		if width == 0 {
			time.Sleep(time.Millisecond * 50)
		}
		break
	}

	err := app.Gui.RunWithSubprocesses()

	return err
}

I'm in the middle of a long-running migration from dep to go modules right now so I can't actually test that locally :P

- Build arguments are injected by the build hook - Badges added: number of pulls, stars and if the build is automated

codecov-io · 2019-07-02T12:07:47Z

Codecov Report

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

@@           Coverage Diff           @@
##           master      #36   +/-   ##
=======================================
  Coverage   18.06%   18.06%           
=======================================
  Files          12       12           
  Lines        1052     1052           
=======================================
  Hits          190      190           
  Misses        856      856           
  Partials        6        6

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 a51bb83...d78648c. Read the comment docs.

codecov-io · 2019-07-02T12:07:48Z

Codecov Report

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

@@           Coverage Diff           @@
##           master      #36   +/-   ##
=======================================
  Coverage   18.06%   18.06%           
=======================================
  Files          12       12           
  Lines        1052     1052           
=======================================
  Hits          190      190           
  Misses        856      856           
  Partials        6        6

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 a51bb83...7107a4c. Read the comment docs.

hooks/build

pkg/app/app.go

ibnesayeed · 2019-07-06T14:58:02Z

Actually after some thoughts, it's better to bind mount the Docker binary as its version might be different from the host, potentially causing issues.

Bind mount for the binary is not ideal unless the binary on the host is static and can work cross-OS. I have created a new ticket #109 to use the API instead of the CLI binary.

jesseduffield · 2019-07-11T13:09:27Z

I forgot where we were up to with this. If I recall correctly, it was ready to go? I think there might have been some discussion on another issue but I can't find it now

qdm12 · 2019-07-11T14:59:21Z

I need this last question resolved

Also now that you use go modules, I need to changed the go binary build stage as it should be different now. I will do that the coming 2 days.

pascalandy · 2019-07-11T17:57:53Z

I'll be glad to test if you need help :)

qdm12 · 2019-07-16T05:00:07Z

Hi all,

I tested my latest Dockerfile with the lastest master code (using modules) and it fails with:

go: finding github.com/davecgh/go-spew v1.1.1
go: finding github.com/client9/misspell v0.3.4
go: finding golang.org/x/sys v0.0.0-20180905080454-ebe1bf3edb33
go: finding github.com/onsi/ginkgo v1.6.0
go: error loading module requirements
The command '/bin/sh -c go mod download' returned a non-zero code: 1

during my go mod download stage.

The full Dockerfile is:

ARG BASE_IMAGE_BUILDER=golang
ARG ALPINE_VERSION=3.10
ARG GO_VERSION=1.12.6

FROM ${BASE_IMAGE_BUILDER}:${GO_VERSION}-alpine${ALPINE_VERSION} AS builder
ARG GOARCH=amd64
ARG GOARM
RUN apk --update -q --progress add git ca-certificates
RUN go get -u -v golang.org/x/vgo 2> /dev/null
WORKDIR /tmp/gobuild
COPY go.mod go.sum ./
RUN go mod download
COPY ./ .
RUN CGO_ENABLED=0 GOOS=linux GOARCH=${GOARCH} GOARM=${GOARM} go build -a -ldflags="-s -w \
    -X main.commit=${VCS_REF} \
    -X main.version=${VERSION} \
    -X main.buildSource=Docker"

FROM scratch
ARG BUILD_DATE
ARG VCS_REF
ARG VERSION
LABEL org.label-schema.schema-version="1.0.0-rc1" \
    maintainer="jessedduffield@gmail.com" \
    org.label-schema.build-date=$BUILD_DATE \
    org.label-schema.vcs-ref=$VCS_REF \
    org.label-schema.url="https://github.com/jesseduffield/lazydocker" \
    org.label-schema.vcs-description="The lazier way to manage everything docker" \
    org.label-schema.docker.cmd="docker run -it -v /var/run/docker.sock:/var/run/docker.sock lazydocker" \
    org.label-schema.version=${VERSION}
ENTRYPOINT [ "/lazydocker" ]
VOLUME [ "/.config/jesseduffield/lazydocker" ]
COPY --from=builder /tmp/gobuild/lazydocker /lazydocker

Any idea why is this? Thanks!

Dockerfile

dawidd6 · 2019-07-16T09:55:32Z

@qdm12

RUN go get -u -v golang.org/x/vgo 2> /dev/null

Why is this needed?

COPY go.mod go.sum ./
RUN go mod download

That's totally unnecessary. See below.

RUN CGO_ENABLED=0 GOOS=linux GOARCH=${GOARCH} GOARM=${GOARM} go build -a -ldflags="-s -w \
    -X main.commit=${VCS_REF} \
    -X main.version=${VERSION} \
    -X main.buildSource=Docker"

Just append to this -mod=vendor so vendored dependencies are used instead of downloading them.

qdm12 · 2019-07-16T11:22:45Z

It's just to make the build faster, so that dependencies are not downloaded at every build. Do you think it's possible to go mod download and use the vendor directory at the same time?

For now I'll make it a one line build as you suggested but this is quite slow for development purposes.

- Volume did not work properly as the config would be persistent but not shared across restart of the container running interactively. - Docker run instructions were therefore updated and simplified to bind mount the config directory as volume do not really work in this situation.

@ibnesayeed

As @ibnesayeed mentionned, some environment variables are actually defined even in Scratch Docker images. `PATH` contains `/bin` so there is no need to overwrite it.

dawidd6 · 2019-07-16T12:43:46Z

But you don't need to download dependencies as they are already available offline in vendor/ and I don't know how can that slow down the build.

qdm12 · 2019-07-16T13:36:01Z

Hi, that's great then, less work for me 😄 It would be eventually interesting to get rid of the vendor directory and have only git commit references in the go.mod file, or am I missing something out? Thanks.

dawidd6 · 2019-07-16T13:43:57Z

@jesseduffield likes vendoring, cause it makes it easier to quickly make changes to dependencies and see the results. Plus also with vendoring it is enough to just clone one repo and then build, while without vendoring there is also a need to download dependencies from different sources before building.

So, in conclusion, I think that vendoring will stay here for a while.

dawidd6 · 2019-07-16T16:58:41Z

I just tried the newest iteration of Dockerfile and it seems like logs, stats, attaching and other stuff handled by docker CLI binary are still not working. I tried using alpine image instead of the scratch one, as I thought it could be an issue with PATH, but it wasn't the case. Dunno really what to do with that.

qdm12 · 2019-07-16T17:55:41Z

I had my CPU stats working on my side. I'll try attaching to containers as well. Are you sure you are trying the last Dockerfile with the current master branch?

dawidd6 · 2019-07-16T18:36:03Z

Yep, i just merged this branch from your fork with latest upstream master and I don't get those stats.

qdm12 · 2019-07-21T12:31:16Z

Hi all, sorry for the long delay.

I get the stats, config and Top. Screenshot below:

But I don't get the logs. What are your thoughts on this? I cannot figure out why it does not work.

dawidd6 · 2019-07-21T13:23:06Z

Me neither. I get the same result.

I'd suggest merging this PR already as it is very outdated comparing to current master (go modules) and open another PR for fixing remaining issues.

qdm12 · 2019-07-21T13:30:30Z

Yes I wanted to suggest the same thing but didn't want to be rude.

It will still be much better than the current Dockerfile implementation. And, as you pointed out, it'll be easier to develop from a new branch as copying back and forth between repositories (one with modules, one without) isn't great.

dawidd6 · 2019-07-21T13:41:57Z

It is done. Please open another PR.

tmardesen-greatamerica · 2020-05-29T13:47:48Z

I am using the latest Go installation, and I do not have Top or Stats working (This is installed on windows server 2019), what is the work around? To use the dockerfile for Lazydocker?

qdm12 added 2 commits July 1, 2019 11:51

Added Docker labels and Go commit, version and buildSource

ceb8cfc

Fixed Docker regarding no size window with gocui

330131b

- Runs the container with `/bin/sh` initially - Invoke `lazydocker` from within the container, or gocui fails as the terminal window is invalid at launch

jesseduffield reviewed Jul 1, 2019

View reviewed changes

Dockerfile Outdated Show resolved Hide resolved

dawidd6 reviewed Jul 1, 2019

View reviewed changes

README.md Outdated Show resolved Hide resolved

dawidd6 reviewed Jul 1, 2019

View reviewed changes

README.md Outdated Show resolved Hide resolved

qdm12 added 3 commits July 1, 2019 15:37

Git commit reference mechanism changed

fd70aaa

- Git commit is passed as a build argument as explained in README.md - `.git` directory is ignored by Docker for a quicker build and smaller context - the build arg VCS_REF is used both to tag the image and the Go program

Fixed docker build typo (both URL and PATH)

580936c

Lazydocker can be ran directly as entrypoint

c89e396

Thanks to the script: ```sh #!/bin/sh resize > /dev/null lazydocker $@ ```

jesseduffield reviewed Jul 2, 2019

View reviewed changes

Dockerfile Outdated Show resolved Hide resolved

qdm12 added 2 commits July 2, 2019 13:57

VERSION and VCS_REF build arguments are unset by default

18d34d5

Added Docker automated build hook and readme badges for Docker

d78648c

- Build arguments are injected by the build hook - Badges added: number of pulls, stars and if the build is automated

dawidd6 reviewed Jul 2, 2019

View reviewed changes

hooks/build Show resolved Hide resolved

qdm12 added 2 commits July 2, 2019 20:08

Resolved screen size issue, final Docker image uses Scratch

20f4ad8

Detailed development Docker build in readme with all build args

767488a

golangcibot reviewed Jul 2, 2019

View reviewed changes

pkg/app/app.go Outdated Show resolved Hide resolved

Fixed bad loop for checking terminal size

d404716

Removed terminal space check (gocui got fixed)

88896e9

dawidd6 mentioned this pull request Jul 11, 2019

Can we run lazydocker in a container? #123

Closed

qdm12 added 3 commits July 15, 2019 22:02

Simplified docker run readme thanks to default volume

dec1466

Added Docker CLI binary to final image

98697c5

All binaries are in /bin directory.

dedafb3

ibnesayeed reviewed Jul 16, 2019

View reviewed changes

Dockerfile Outdated Show resolved Hide resolved

ibnesayeed reviewed Jul 16, 2019

View reviewed changes

Dockerfile Outdated Show resolved Hide resolved

Dockerfile Outdated Show resolved Hide resolved

qdm12 added 4 commits July 16, 2019 05:00

Uses modules for Docker build

84320dd

Switched to opencontainers.org labels for Docker image

80fdf31

Removed PATH variable definition in Dockerfile

25e8775

As @ibnesayeed mentionned, some environment variables are actually defined even in Scratch Docker images. `PATH` contains `/bin` so there is no need to overwrite it.

dawidd6 merged commit 25e8775 into jesseduffield:master Jul 21, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Reworked Dockerfile for a more production oriented usage #36

Reworked Dockerfile for a more production oriented usage #36

qdm12 commented Jul 1, 2019

qdm12 commented Jul 1, 2019

dawidd6 commented Jul 1, 2019

qdm12 commented Jul 1, 2019 •

edited

Loading

qdm12 commented Jul 1, 2019

qdm12 commented Jul 1, 2019

jesseduffield commented Jul 1, 2019

dawidd6 commented Jul 1, 2019

dawidd6 commented Jul 1, 2019 •

edited

Loading

jesseduffield commented Jul 1, 2019

dawidd6 commented Jul 1, 2019

jesseduffield commented Jul 2, 2019

codecov-io commented Jul 2, 2019

codecov-io commented Jul 2, 2019 •

edited

Loading

ibnesayeed commented Jul 6, 2019

jesseduffield commented Jul 11, 2019

qdm12 commented Jul 11, 2019

pascalandy commented Jul 11, 2019

qdm12 commented Jul 16, 2019

dawidd6 commented Jul 16, 2019 •

edited

Loading

qdm12 commented Jul 16, 2019

dawidd6 commented Jul 16, 2019 •

edited

Loading

qdm12 commented Jul 16, 2019

dawidd6 commented Jul 16, 2019

dawidd6 commented Jul 16, 2019

qdm12 commented Jul 16, 2019

dawidd6 commented Jul 16, 2019

qdm12 commented Jul 21, 2019

dawidd6 commented Jul 21, 2019

qdm12 commented Jul 21, 2019

dawidd6 commented Jul 21, 2019

tmardesen-greatamerica commented May 29, 2020

Reworked Dockerfile for a more production oriented usage #36

Reworked Dockerfile for a more production oriented usage #36

Conversation

qdm12 commented Jul 1, 2019

qdm12 commented Jul 1, 2019

dawidd6 commented Jul 1, 2019

qdm12 commented Jul 1, 2019 • edited Loading

qdm12 commented Jul 1, 2019

qdm12 commented Jul 1, 2019

jesseduffield commented Jul 1, 2019

dawidd6 commented Jul 1, 2019

dawidd6 commented Jul 1, 2019 • edited Loading

jesseduffield commented Jul 1, 2019

dawidd6 commented Jul 1, 2019

jesseduffield commented Jul 2, 2019

codecov-io commented Jul 2, 2019

Codecov Report

codecov-io commented Jul 2, 2019 • edited Loading

Codecov Report

ibnesayeed commented Jul 6, 2019

jesseduffield commented Jul 11, 2019

qdm12 commented Jul 11, 2019

pascalandy commented Jul 11, 2019

qdm12 commented Jul 16, 2019

dawidd6 commented Jul 16, 2019 • edited Loading

qdm12 commented Jul 16, 2019

dawidd6 commented Jul 16, 2019 • edited Loading

qdm12 commented Jul 16, 2019

dawidd6 commented Jul 16, 2019

dawidd6 commented Jul 16, 2019

qdm12 commented Jul 16, 2019

dawidd6 commented Jul 16, 2019

qdm12 commented Jul 21, 2019

dawidd6 commented Jul 21, 2019

qdm12 commented Jul 21, 2019

dawidd6 commented Jul 21, 2019

tmardesen-greatamerica commented May 29, 2020

qdm12 commented Jul 1, 2019 •

edited

Loading

dawidd6 commented Jul 1, 2019 •

edited

Loading

codecov-io commented Jul 2, 2019 •

edited

Loading

dawidd6 commented Jul 16, 2019 •

edited

Loading

dawidd6 commented Jul 16, 2019 •

edited

Loading