Merge pull request #153 from lightninglabs/prod-docker-file

docker+GitHub: add production Dockerfile and build automatically on tag push

Author: Roasbeef

.github/workflows/docker.yml

@@ -0,0 +1,45 @@
+name: Docker image build
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+
+defaults:
+  run:
+    shell: bash
+
+env:
+  DOCKER_REPO: lightninglabs
+  DOCKER_IMAGE: lightning-terminal
+
+jobs:
+  main:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v1
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v1
+
+      - name: Login to DockerHub
+        uses: docker/login-action@v1
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_API_KEY }}
+
+      - name: Set env
+        run: echo "RELEASE_VERSION=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV
+
+      - name: Build and push
+        id: docker_build
+        uses: docker/build-push-action@v2
+        with:
+          push: true
+          tags: "${{ env.DOCKER_REPO }}/${{ env.DOCKER_IMAGE }}:${{ env.RELEASE_VERSION }}"
+          build-args: checkout=${{ env.RELEASE_VERSION }}
+
+      - name: Image digest
+        run: echo ${{ steps.docker_build.outputs.digest }}

Dockerfile

@@ -1,17 +1,24 @@
 FROM golang:1.15.5-alpine as builder
 
-# Copy in the local repository to build from.
-COPY . /go/src/github.com/lightninglabs/lightning-terminal
-
 # Force Go to use the cgo based DNS resolver. This is required to ensure DNS
 # queries required to connect to linked containers succeed.
 ENV GODEBUG netdns=cgo
 
+# Pass a tag, branch or a commit using build-arg. This allows a docker image to
+# be built from a specified Git state. The default image will use the Git tip of
+# master by default.
+ARG checkout="master"
+
 # Explicitly turn on the use of modules (until this becomes the default).
 ENV GO111MODULE on
 
 ENV NODE_VERSION=v12.17.0
 
+# We need some additional proto files with google annotations, the version
+# should match what's in lnd's scripts/install_travis_proto.sh
+ENV PROTOC_VERSION=3.4.0
+ENV PROTOC_URL="https://github.com/protocolbuffers/protobuf/releases/download/v${PROTOC_VERSION}/protoc-${PROTOC_VERSION}-linux-x86_64.zip"
+
 # Install dependencies and install/build lightning-terminal.
 RUN apk add --no-cache --update alpine-sdk \
     git \
@@ -21,18 +28,21 @@ RUN apk add --no-cache --update alpine-sdk \
     binutils \
     tar \
     protobuf-dev \
+    zip \
+&& curl -sfSLO ${PROTOC_URL} \
+&& unzip protoc-${PROTOC_VERSION}-linux-x86_64.zip -d /usr/local \
+&& rm /usr/local/bin/protoc /usr/local/readme.txt \
 && touch ~/.bashrc \
 && curl -sfSLO https://unofficial-builds.nodejs.org/download/release/${NODE_VERSION}/node-${NODE_VERSION}-linux-x64-musl.tar.xz \
 && tar -xf node-${NODE_VERSION}-linux-x64-musl.tar.xz -C /usr --strip 1 \
 && rm node-${NODE_VERSION}-linux-x64-musl.tar.xz \
 && curl -o- -L https://yarnpkg.com/install.sh | bash \
 && . ~/.bashrc \
-&&  cd /go/src/github.com/lightninglabs/lightning-terminal \
-&&  make install \
-&& go install -v -trimpath github.com/lightningnetwork/lnd/cmd/lncli \
-&& go install -v -trimpath github.com/lightninglabs/faraday/cmd/frcli \
-&& go install -v -trimpath github.com/lightninglabs/loop/cmd/loop \
-&& go install -v -trimpath github.com/lightninglabs/pool/cmd/pool
+&& git clone https://github.com/lightninglabs/lightning-terminal /go/src/github.com/lightninglabs/lightning-terminal \
+&& cd /go/src/github.com/lightninglabs/lightning-terminal \
+&& git checkout $checkout \
+&& make install \
+&& make go-install-cli
 
 # Start a new, final image to reduce size.
 FROM alpine as final

Makefile

@@ -112,6 +112,13 @@ go-install:
 	@$(call print, "Installing lightning-terminal.")
 	$(GOINSTALL) -tags="$(LND_RELEASE_TAGS)" -ldflags "$(LDFLAGS)" $(PKG)/cmd/litd
 
+go-install-cli:
+	@$(call print, "Installing all CLI binaries.")
+	$(GOINSTALL) -trimpath -tags="$(LND_RELEASE_TAGS)" -ldflags "$(LDFLAGS)" github.com/lightningnetwork/lnd/cmd/lncli
+	$(GOINSTALL) -trimpath -ldflags "$(LDFLAGS)" github.com/lightninglabs/loop/cmd/loop
+	$(GOINSTALL) -trimpath github.com/lightninglabs/faraday/cmd/frcli
+	$(GOINSTALL) -trimpath github.com/lightninglabs/pool/cmd/pool
+
 app-build: yarn-install
 	@$(call print, "Building production app.")
 	cd app; yarn build

dev.Dockerfile

@@ -0,0 +1,57 @@
+FROM golang:1.15.5-alpine as builder
+
+# Copy in the local repository to build from.
+COPY . /go/src/github.com/lightninglabs/lightning-terminal
+
+# Force Go to use the cgo based DNS resolver. This is required to ensure DNS
+# queries required to connect to linked containers succeed.
+ENV GODEBUG netdns=cgo
+
+# Explicitly turn on the use of modules (until this becomes the default).
+ENV GO111MODULE on
+
+ENV NODE_VERSION=v12.17.0
+
+# Install dependencies and install/build lightning-terminal.
+RUN apk add --no-cache --update alpine-sdk \
+    git \
+    make \
+    curl \
+    bash \
+    binutils \
+    tar \
+    protobuf-dev \
+&& touch ~/.bashrc \
+&& curl -sfSLO https://unofficial-builds.nodejs.org/download/release/${NODE_VERSION}/node-${NODE_VERSION}-linux-x64-musl.tar.xz \
+&& tar -xf node-${NODE_VERSION}-linux-x64-musl.tar.xz -C /usr --strip 1 \
+&& rm node-${NODE_VERSION}-linux-x64-musl.tar.xz \
+&& curl -o- -L https://yarnpkg.com/install.sh | bash \
+&& . ~/.bashrc \
+&& cd /go/src/github.com/lightninglabs/lightning-terminal \
+&& make install \
+&& make go-install-cli
+
+# Start a new, final image to reduce size.
+FROM alpine as final
+
+# Define a root volume for data persistence.
+VOLUME /root/.lnd
+
+# Expose lightning-terminal and lnd ports (server, rpc).
+EXPOSE 8443 10009 9735
+
+# Copy the binaries and entrypoint from the builder image.
+COPY --from=builder /go/bin/litd /bin/
+COPY --from=builder /go/bin/lncli /bin/
+COPY --from=builder /go/bin/frcli /bin/
+COPY --from=builder /go/bin/loop /bin/
+COPY --from=builder /go/bin/pool /bin/
+
+# Add bash.
+RUN apk add --no-cache \
+    bash \
+    jq \
+    ca-certificates
+
+# Specify the start command and entrypoint as the lightning-terminal daemon.
+ENTRYPOINT ["litd"]

doc/compile.md

@@ -6,7 +6,7 @@ installed on your machine.
 | Dependency                                          | Description                                                                                                                                                                          |
 | --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
 | [golang](https://golang.org/doc/install)            | LiT's backend web server is written in Go. The minimum version supported is Go v1.13.                                                                                                |
-| [protoc](https://grpc.io/docs/protoc-installation/) | Required to compile LND & Loop gRPC proto files at build time.                                                                                                                        |
+| [protoc 3.4.0](https://github.com/lightningnetwork/lnd/tree/master/lnrpc#generate-protobuf-definitions) | Required to compile LND & Loop gRPC proto files at build time. Must be installed according to step 1 of the linked guide.  |
 | [nodejs](https://nodejs.org/en/download/)           | LiT's frontend is written in TypeScript and built on top of the React JS web framework. To bundle the assets into Javascript & CSS compatible with web browsers, NodeJS is required. |
 | [yarn](https://classic.yarnpkg.com/en/docs/install) | A popular package manager for NodeJS application dependencies.                                                                                                                        |
 
@@ -26,3 +26,44 @@ need to download those binaries from the
 [loop](https://github.com/lightninglabs/loop/releases),
 [pool](https://github.com/lightninglabs/pool/releases), and
 [faraday](https://github.com/lightninglabs/faraday/releases) repos manually.
+
+## Building a docker image
+
+There are two flavors of Dockerfiles available:
+ - `Dockerfile`: Used for production builds. Checks out the source code from
+   GitHub during build. The build argument `--build-arg checkout=v0.x.x-alpha`
+   can be used to specify what git tag or commit to check out before building.
+ - `dev.Dockerfile` Used for development or testing builds. Uses the local code
+   when building and allows local changes to be tested more easily.
+
+### Building a development docker image
+
+Follow the instructions of the [previous chapter](#compile-from-source-code) to
+install all necessary dependencies.
+
+Then, instead of `make install` run the following commands:
+
+```shell script
+$ docker build -f dev.Dockerfile -t my-lit-dev-image .
+```
+
+If successful, you can then run the docker image with:
+
+```shell script
+$ docker run -p 8443:8443 --rm --name litd my-lit-dev-image \
+  --httpslisten=0.0.0.0:8443 \
+  ... (your configuration flags here)
+```
+
+See the [execution section in the main README](../README.md#execution) to find
+out what configuration flags to use.
+
+### Building a production docker image
+
+To create a production build, you need to specify the git tag to create the
+image from. All local files will be ignored, everything is cloned and built from
+GitHub so you don't need to install any dependencies:
+
+```shell script
+$ docker build -t lightninglabs/lightning-terminal --build-arg checkout=v0.3.2-alpha .
+```