This repository was archived by the owner on Nov 24, 2025. It is now read-only.
Repository navigation
Expand file tree
/
Copy pathDockerfile
More file actions
370 lines (329 loc) · 13.2 KB
/
Copy pathDockerfile
File metadata and controls
370 lines (329 loc) · 13.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
# syntax = docker/dockerfile:1
# INSTRUCTIONS
#
# Build local context (chainweb-node repo):
#
# ```sh
# docker buildx build .
# ```
#
# Build remote context from github:
#
# ```
# docker buildx build --build-arg BUILDKIT_CONTEXT_KEEP_GIT_DIR=1 https://github.com/kadena-io/chainweb-node.git#master
# ```
#
# Setting `BUILDKIT_CONTEXT_KEEP_GIT_DIR=1` is optional but enables some
# additional sanity checks.
#
# Skipping tests:
#
# ```sh
# docker buildx build --target=chainweb-node .
# ```
#
# Usefull target values are:
#
# - chainweb-node, image with only chainweb-node
# - chainweb-applications, image with all executables from the repository
# - chainweb-node-tested (default), just chainweb-node, runs tests during build
#
# Troubleshooting:
#
# If the build is failing because of unavailable disk space, try pruning the
# build cache with
#
# ```sh
# docker buildx prune --all
# ```
# ############################################################################ #
# Parameters
# ############################################################################ #
# changing the ubuntu version will most likely break the build. In order to
# support this we would have to define dedicated runtime images and build
# images.
ARG UBUNTU_VERSION=22.04
ARG GHC_VERSION=9.10.1
ARG PROJECT_NAME=chainweb
# ############################################################################ #
# Chainweb Application Runtime Image
# ############################################################################ #
FROM ubuntu:${UBUNTU_VERSION} AS chainweb-runtime
ARG GHC_VERSION
ARG UBUNTU_VERSION
ARG TARGETPLATFORM
ARG DEBIAN_FRONTEND=noninteractive
RUN <<EOF
apt-get update -y
apt-get install -yqq \
--no-install-recommends \
ca-certificates \
libbz2-1.0 \
libffi8 \
libgmp10 \
liblz4-1 \
libncurses5 \
libsnappy1v5 \
libssl3 \
libtinfo5 \
locales \
zlib1g \
libgflags2.2
if [ "${TARGETPLATFORM}" = "linux/arm64" ] ; then
apt-get install -yqq \
--no-install-recommends \
llvm-12 \
libnuma1
fi
rm -rf /var/lib/apt/lists/*
locale-gen en_US.UTF-8
update-locale LC_ALL=en_US.UTF-8 LANG=en_US.UTF-8
EOF
ENV LANG=en_US.UTF-8
WORKDIR /chainweb
LABEL com.chainweb.docker.image.compiler="ghc-${GHC_VERSION}"
LABEL com.chainweb.docker.image.os="ubuntu-${UBUNTU_VERSION}"
# ############################################################################ #
# Chainweb Build Image
# ############################################################################ #
FROM chainweb-runtime AS chainweb-build
RUN <<EOF
echo "BUILDPLATFORM: $BUILDPLATFORM"
echo "TARGETPLATFORM: $TARGETPLATFORM"
EOF
ARG GHC_VERSION
ARG TARGETPLATFORM
ARG DEBIAN_FRONTEND=noninteractive
RUN <<EOF
apt-get update -y
apt-get install -yqq \
--no-install-recommends \
binutils \
build-essential \
ca-certificates \
curl \
git \
libbz2-dev \
libclang-dev \
libffi-dev \
libgflags-dev \
libgmp-dev \
liblz4-dev \
libncurses-dev \
libsnappy-dev \
libssl-dev \
libzstd-dev \
neovim \
pkg-config \
zlib1g-dev
if [ ${TARGETPLATFORM} = "linux/arm64" ] ; then
echo plat: ${TARGETPLATFORM}
apt-get install -yqq \
--no-install-recommends \
libnuma-dev
fi
EOF
# Install Haskell toolchain
ENV CABAL_DIR=/root/.cabal
ENV PATH=/root/.local/bin:/root/.ghcup/bin:$PATH
ENV BOOTSTRAP_HASKELL_NONINTERACTIVE=1
ENV BOOTSTRAP_HASKELL_MINIMAL=1
ENV BOOTSTRAP_HASKELL_NO_UPGRADE=1
ENV LD_LIBRARY_PATH=/usr/lib/x86_64-linux-gnu/:$LD_LIBRARY_PATH
RUN --mount=type=cache,target=/root/.ghcup/cache,id=${TARGETPLATFORM} <<EOF
curl -sSf https://get-ghcup.haskell.org | sh
ghcup --cache install cabal latest
ghcup set cabal latest
ghcup --cache install ghc ${GHC_VERSION}
ghcup set ghc ${GHC_VERSION}
cabal --version
ghc --version
EOF
RUN --mount=type=cache,target=/root/.cabal,id=${TARGETPLATFORM} <<EOF
cabal update
EOF
# ############################################################################ #
# Builds
# ############################################################################ #
# ############################################################################ #
# Setup Context
FROM chainweb-build as chainweb-build-ctx
ARG TARGETPLATFORM
# RUN git clone --filter=tree:0 https://github.com/kadena-io/chainweb-node
# WORKDIR /chainweb/chainweb-node
COPY . .
ENV GIT_DISCOVERY_ACROSS_FILESYSTEM=1
RUN mkdir -p /tools
COPY --chmod=0755 <<EOF /tools/check-git-clean.sh
#!/bin/sh
if [ -d ".git" ] && ! [ -f "/tools/wip" ] && ! git diff --exit-code; then \
echo "Git working tree is not clean. The build changed some file that is checked into git." 1>&2 ; \
exit 1 ; \
fi
EOF
RUN sh /tools/check-git-clean.sh || touch /tools/wip
# ############################################################################ #
# Build Dependencies
FROM chainweb-build-ctx as chainweb-build-dependencies
ARG TARGETPLATFORM
ARG PROJECT_NAME
ENV GIT_DISCOVERY_ACROSS_FILESYSTEM=1
RUN --mount=type=cache,target=/root/.cabal,id=${TARGETPLATFORM} \
--mount=type=cache,target=./dist-newstyle,id=${PROJECT_NAME}-${TARGETPLATFORM},sharing=locked \
[ -f cabal.project.freeze ] || cabal --enable-tests --enable-benchmarks freeze
RUN --mount=type=cache,target=/root/.cabal,id=${TARGETPLATFORM} \
--mount=type=cache,target=./dist-newstyle,id=${PROJECT_NAME}-${TARGETPLATFORM},sharing=locked \
cabal build --enable-tests --enable-benchmarks --only-download
RUN --mount=type=cache,target=/root/.cabal,id=${TARGETPLATFORM} \
--mount=type=cache,target=./dist-newstyle,id=${PROJECT_NAME}-${TARGETPLATFORM},sharing=locked \
cabal build --enable-tests --enable-benchmarks --only-dependencies
# ############################################################################ #
# Build Chainweb Library
FROM chainweb-build-dependencies AS chainweb-build-lib
ARG TARGETPLATFORM
ARG PROJECT_NAME
ENV GIT_DISCOVERY_ACROSS_FILESYSTEM=1
RUN --mount=type=cache,target=/root/.cabal,id=${TARGETPLATFORM} \
--mount=type=cache,target=./dist-newstyle,id=${PROJECT_NAME}-${TARGETPLATFORM},sharing=locked \
cabal build --enable-tests --enable-benchmarks chainweb:lib:chainweb
RUN sh /tools/check-git-clean.sh
# ############################################################################ #
# Build Chainweb Tests
FROM chainweb-build-lib AS chainweb-build-tests
ARG TARGETPLATFORM
ARG PROJECT_NAME
RUN --mount=type=cache,target=/root/.cabal,id=${TARGETPLATFORM} \
--mount=type=cache,target=./dist-newstyle,id=${PROJECT_NAME}-${TARGETPLATFORM},sharing=locked \
cabal build --enable-tests --enable-benchmarks chainweb:test:chainweb-tests
RUN sh /tools/check-git-clean.sh
RUN --mount=type=cache,target=/root/.cabal,id=${TARGETPLATFORM} \
--mount=type=cache,target=./dist-newstyle,id=${PROJECT_NAME}-${TARGETPLATFORM},sharing=locked <<EOF
mkdir -p artifacts
cp $(cabal list-bin --enable-tests --enable-benchmarks chainweb:test:chainweb-tests) artifacts/
EOF
# ############################################################################ #
# Build cwtool and run ea
FROM chainweb-build-lib AS chainweb-build-cwtool
ARG TARGETPLATFORM
ARG PROJECT_NAME
RUN --mount=type=cache,target=/root/.cabal,id=${TARGETPLATFORM} \
--mount=type=cache,target=./dist-newstyle,id=${PROJECT_NAME}-${TARGETPLATFORM},sharing=locked \
cabal build --enable-tests --enable-benchmarks chainweb:exe:cwtool
RUN sh /tools/check-git-clean.sh
RUN --mount=type=cache,target=/root/.cabal,id=${TARGETPLATFORM} \
--mount=type=cache,target=./dist-newstyle,id=${PROJECT_NAME}-${TARGETPLATFORM},sharing=locked \
cabal run --enable-tests --enable-benchmarks chainweb:exe:cwtool -- ea
RUN <<EOF
sh /tools/check-git-clean.sh ||
{ echo "Inconsistent genesis headers detected. Did you forget to run ea?" 1>&2 ; exit 1 ; }
EOF
RUN --mount=type=cache,target=/root/.cabal,id=${TARGETPLATFORM} \
--mount=type=cache,target=./dist-newstyle,id=${PROJECT_NAME}-${TARGETPLATFORM},sharing=locked <<EOF
mkdir -p artifacts
cp $(cabal list-bin --enable-tests --enable-benchmarks chainweb:exe:cwtool) artifacts/
EOF
# ############################################################################ #
# Build benchmarks
FROM chainweb-build-lib AS chainweb-build-bench
ARG TARGETPLATFORM
ARG PROJECT_NAME
RUN --mount=type=cache,target=/root/.cabal,id=${TARGETPLATFORM} \
--mount=type=cache,target=./dist-newstyle,id=${PROJECT_NAME}-${TARGETPLATFORM},sharing=locked \
cabal build --enable-tests --enable-benchmarks chainweb:bench:bench
RUN sh /tools/check-git-clean.sh
RUN --mount=type=cache,target=/root/.cabal,id=${TARGETPLATFORM} \
--mount=type=cache,target=./dist-newstyle,id=chainweb-${TARGETPLATFORM},sharing=locked <<EOF
mkdir -p artifacts
cp $(cabal list-bin --enable-tests --enable-benchmarks chainweb:bench:bench) artifacts/
EOF
# ############################################################################ #
# Build Chainweb Node Application
FROM chainweb-build-lib AS chainweb-build-node
ARG TARGETPLATFORM
ARG PROJECT_NAME
RUN --mount=type=cache,target=/root/.cabal,id=${TARGETPLATFORM} \
--mount=type=cache,target=./dist-newstyle,id=${PROJECT_NAME}-${TARGETPLATFORM},sharing=locked \
cabal build --enable-tests --enable-benchmarks chainweb-node:exe:chainweb-node
RUN sh /tools/check-git-clean.sh
RUN --mount=type=cache,target=/root/.cabal,id=${TARGETPLATFORM} \
--mount=type=cache,target=./dist-newstyle,id=${PROJECT_NAME}-${TARGETPLATFORM},sharing=locked <<EOF
mkdir -p artifacts
cp $(cabal list-bin --enable-tests --enable-benchmarks chainweb-node:exe:chainweb-node) artifacts/
EOF
# ############################################################################ #
# Run Tests and Benchmarks
# ############################################################################ #
# ############################################################################ #
# Run Chainweb Tests
FROM chainweb-runtime AS chainweb-run-tests
COPY --from=chainweb-build-tests /chainweb/artifacts/chainweb-tests .
COPY --from=chainweb-build-tests /chainweb/test/pact test/pact
COPY --from=chainweb-build-tests /chainweb/pact pact
RUN <<EOF
ulimit -n 10000
./chainweb-tests --hide-successes --results-json test-results.json -p '!/chainweb216Test/'
EOF
# ############################################################################ #
# Run slow tests
FROM chainweb-runtime AS chainweb-run-slowtests
COPY --from=chainweb-build-cwtool /chainweb/artifacts/cwtool .
RUN <<EOF
ulimit -n 10000
./cwtool slow-tests
EOF
# ############################################################################ #
# Run benchmarks
FROM chainweb-runtime AS chainweb-run-bench
COPY --from=chainweb-build-bench /chainweb/artifacts/bench .
RUN <<EOF
ulimit -n 10000
./bench
EOF
# ############################################################################ #
# Applications
# ############################################################################ #
# ############################################################################ #
# Chainweb-node Application
FROM chainweb-runtime AS chainweb-node
ENV PATH=/chainweb:$PATH
COPY --from=chainweb-build-node /chainweb/artifacts/chainweb-node .
COPY --from=chainweb-build-node /chainweb/LICENSE .
COPY --from=chainweb-build-node /chainweb/README.md .
COPY --from=chainweb-build-node /chainweb/CHANGELOG.md .
COPY --from=chainweb-build-node /chainweb/chainweb.cabal .
COPY --from=chainweb-build-node /chainweb/cabal.project .
COPY --from=chainweb-build-node /chainweb/cabal.project.freeze .
STOPSIGNAL SIGTERM
HEALTHCHECK CMD \
[ $(ulimit -Sn) -gt 65535 ] \
&& exec 3<>/dev/tcp/localhost/1848 \
&& printf "GET /health-check HTTP/1.1\r\nhost: http://localhost:1848\r\nConnection: close\r\n\r\n" >&3 \
&& grep -q "200 OK" <&3 \
|| exit 1
ENTRYPOINT ["/chainweb/chainweb-node"]
# ############################################################################ #
# All binaries (for testing and debugging)
FROM chainweb-node AS chainweb-applications
COPY --from=chainweb-build-bench /chainweb/artifacts/bench .
COPY --from=chainweb-build-cwtool /chainweb/artifacts/cwtool .
COPY --from=chainweb-build-tests /chainweb/artifacts/chainweb-tests .
COPY --from=chainweb-build-tests /chainweb/test/pact test/pact
COPY --from=chainweb-build-tests /chainweb/pact pact
# ############################################################################ #
# Tested Chainweb-node Application
FROM chainweb-node AS chainweb-node-tested
# Phony dependencies on tests
COPY --from=chainweb-build-cwtool /etc/hostname /tmp/run-ea
COPY --from=chainweb-run-tests /etc/hostname /tmp/run-tests
COPY --from=chainweb-run-slowtests /etc/hostname /tmp/run-slowtests
COPY --from=chainweb-run-bench /etc/hostname /tmp/run-bench
RUN rm -f /tmp/run-tests /tmp/run-ea /tmp/run-slowtests /tmp/run-bench
# ############################################################################ #
# (Optional) Initialize and Validate Database
# ############################################################################ #
# FROM CHAINWEB_BUILD AS CHAINWEB_INITIALIZE_DB
#
# TODO
# - Create image that only rocksdb database to volume, so that it can be
# done during the build?
# - Just start the node on it?