Skip to content

Commit 655e808

Browse files
breskebybreskeby
committed
Address review feedback on es default docker image
This addresses feedback we got for our default image at docker-library/official-images#18692 This also introduces separate docker source files to make maintaining those easier.
1 parent 21ff72b commit 655e808

File tree

4 files changed

+189
-12
lines changed

4 files changed

+189
-12
lines changed

‎build-tools-internal/src/main/java/org/elasticsearch/gradle/internal/DockerBase.java‎

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,36 +14,45 @@
1414
*/
1515
public enum DockerBase {
1616
// "latest" here is intentional, since the image name specifies "9"
17-
DEFAULT("redhat/ubi9-minimal:latest", "", "microdnf"),
17+
DEFAULT("redhat/ubi9-minimal:latest", "", "microdnf", "Dockerfile.default"),
1818

1919
// The Iron Bank base image is UBI (albeit hardened), but we are required to parameterize the Docker build
20-
IRON_BANK("${BASE_REGISTRY}/${BASE_IMAGE}:${BASE_TAG}", "-ironbank", "yum"),
20+
IRON_BANK("${BASE_REGISTRY}/${BASE_IMAGE}:${BASE_TAG}", "-ironbank", "yum", "Dockerfile"),
2121

2222
// Chainguard based wolfi image with latest jdk
2323
// This is usually updated via renovatebot
2424
// spotless:off
25-
WOLFI("docker.elastic.co/wolfi/chainguard-base:latest@sha256:29150cd940cc7f69407d978d5a19c86f4d9e67cf44e4d6ded787a497e8f27c9a",
25+
WOLFI(
26+
"docker.elastic.co/wolfi/chainguard-base:latest@sha256:29150cd940cc7f69407d978d5a19c86f4d9e67cf44e4d6ded787a497e8f27c9a",
2627
"-wolfi",
27-
"apk"
28+
"apk",
29+
"Dockerfile"
30+
),
31+
FIPS(
32+
"docker.elastic.co/wolfi/chainguard-base-fips:sha256-ebfc3f1d7dba992231747a2e05ad1b859843e81b5e676ad342859d7cf9e425a7@sha256:ebfc3f1d7dba992231747a2e05ad1b859843e81b5e676ad342859d7cf9e425a7",
33+
"-fips",
34+
"apk",
35+
"Dockerfile"
2836
),
29-
FIPS("docker.elastic.co/wolfi/chainguard-base-fips:sha256-ebfc3f1d7dba992231747a2e05ad1b859843e81b5e676ad342859d7cf9e425a7@sha256:ebfc3f1d7dba992231747a2e05ad1b859843e81b5e676ad342859d7cf9e425a7", "-fips", "apk"),
3037
// spotless:on
3138
// Based on WOLFI above, with more extras. We don't set a base image because
3239
// we programmatically extend from the wolfi image.
33-
CLOUD_ESS(null, "-cloud-ess", "apk");
40+
CLOUD_ESS(null, "-cloud-ess", "apk", "Dockerfile.cloud-ess"),;
3441

3542
private final String image;
3643
private final String suffix;
3744
private final String packageManager;
45+
private final String dockerfile;
3846

3947
DockerBase(String image, String suffix) {
40-
this(image, suffix, "apt-get");
48+
this(image, suffix, "apt-get", "dockerfile");
4149
}
4250

43-
DockerBase(String image, String suffix, String packageManager) {
51+
DockerBase(String image, String suffix, String packageManager, String dockerfile) {
4452
this.image = image;
4553
this.suffix = suffix;
4654
this.packageManager = packageManager;
55+
this.dockerfile = dockerfile;
4756
}
4857

4958
public String getImage() {
@@ -57,4 +66,8 @@ public String getSuffix() {
5766
public String getPackageManager() {
5867
return packageManager;
5968
}
69+
70+
public String getDockerfile() {
71+
return dockerfile;
72+
}
6073
}

‎distribution/docker/build.gradle‎

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -201,9 +201,10 @@ ext.dockerBuildContext = { Architecture architecture, DockerBase base ->
201201
from projectDir.resolve("src/docker/config")
202202
}
203203
}
204-
from(projectDir.resolve("src/docker/Dockerfile")) {
204+
from(projectDir.resolve("src/docker/${base.dockerfile}")) {
205205
expand(varExpansions)
206206
filter SquashNewlinesFilter
207+
rename ~/Dockerfile\..+$/, 'Dockerfile'
207208
}
208209
}
209210
}
@@ -360,8 +361,7 @@ void addTransformDockerContextTask(Architecture architecture, DockerBase base) {
360361
String distributionFolderName = "elasticsearch-${VersionProperties.elasticsearch}"
361362

362363
from(tarTree("${project.buildDir}/distributions/${archiveName}.tar.gz")) {
363-
364-
if (base != DockerBase.IRON_BANK) {
364+
if (base != DockerBase.IRON_BANK && base != DockerBase.DEFAULT) {
365365
// iron bank always needs a COPY with the tarball file path
366366
eachFile { FileCopyDetails details ->
367367
if (details.name.equals("Dockerfile")) {
@@ -372,6 +372,17 @@ void addTransformDockerContextTask(Architecture architecture, DockerBase base) {
372372
}
373373
}
374374
}
375+
if (base == DockerBase.DEFAULT) {
376+
// iron bank always needs a COPY with the tarball file path
377+
eachFile { FileCopyDetails details ->
378+
if (details.name.equals("Dockerfile")) {
379+
filter { String contents ->
380+
return contents.replaceAll('^RUN *.*artifacts-no-kpi.*$', "COPY $distributionFolderName .")
381+
.replaceAll('^RUN tar -zxf /tmp/elasticsearch.tar.gz --strip-components=1 &&', "RUN ")
382+
}
383+
}
384+
}
385+
}
375386
}
376387
into "${project.buildDir}/docker-context/${archiveName}"
377388

‎distribution/docker/src/docker/Dockerfile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -287,7 +287,7 @@ LABEL name="Elasticsearch" \\
287287
description="You know, for search."
288288
<% } %>
289289

290-
RUN mkdir /licenses && cp LICENSE.txt /licenses/LICENSE
290+
RUN mkdir /licenses && ln LICENSE.txt /licenses/LICENSE
291291
<% if (docker_base == 'iron_bank') { %>
292292
COPY LICENSE /licenses/LICENSE.addendum
293293
<% } %>

‎distribution/docker/src/docker/Dockerfile.default‎

Lines changed: 153 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
1+
<% /*
2+
This file is passed through Groovy's SimpleTemplateEngine, so dollars and backslashes
3+
have to be escaped in order for them to appear in the final Dockerfile. You
4+
can also comment out blocks, like this one. See:
5+
6+
https://docs.groovy-lang.org/latest/html/api/groovy/text/SimpleTemplateEngine.html
7+
8+
We use control-flow tags in this file to conditionally render the content. The
9+
layout/presentation here has been adjusted so that it looks reasonable when rendered,
10+
at the slight expense of how it looks here.
11+
12+
Note that this file is also filtered to squash together newlines, so we can
13+
add as many newlines here as necessary to improve legibility.
14+
*/ %>
15+
16+
17+
################################################################################
18+
# Build stage 1 `builder`:
19+
# Extract Elasticsearch artifact
20+
################################################################################
21+
22+
FROM ${base_image} AS builder
23+
24+
RUN microdnf install -y findutils tar gzip
25+
26+
# `tini` is a tiny but valid init for containers. This is used to cleanly
27+
# control how ES and any child processes are shut down.
28+
#
29+
# The tini GitHub page gives instructions for verifying the binary using
30+
# gpg, but the keyservers are slow to return the key and this can fail the
31+
# build. Instead, we check the binary against the published checksum.
32+
RUN set -eux ; \\
33+
tini_bin="" ; \\
34+
arch="\$(rpm --query --queryformat='%{ARCH}' rpm)"; \
35+
case "\$(arch)" in \\
36+
aarch64) tini_bin='tini-arm64' ;; \\
37+
x86_64) tini_bin='tini-amd64' ;; \\
38+
*) echo >&2 ; echo >&2 "Unsupported architecture \$arch" ; echo >&2 ; exit 1 ;; \\
39+
esac ; \\
40+
curl -f --retry 10 -S -L -O https://github.com/krallin/tini/releases/download/v0.19.0/\${tini_bin} ; \\
41+
curl -f --retry 10 -S -L -O https://github.com/krallin/tini/releases/download/v0.19.0/\${tini_bin}.sha256sum ; \\
42+
sha256sum -c \${tini_bin}.sha256sum ; \\
43+
rm \${tini_bin}.sha256sum ; \\
44+
mv \${tini_bin} /bin/tini ; \\
45+
chmod 0555 /bin/tini
46+
47+
WORKDIR /usr/share/elasticsearch
48+
RUN arch="\$(rpm --query --queryformat='%{ARCH}' rpm)" && curl -f --retry 10 -S -L --output /tmp/elasticsearch.tar.gz https://artifacts-no-kpi.elastic.co/downloads/elasticsearch/elasticsearch-${version}-linux-\$(arch).tar.gz
49+
RUN tar -zxf /tmp/elasticsearch.tar.gz --strip-components=1 && \\
50+
# Configure the distribution for Docker
51+
sed -i -e 's/ES_DISTRIBUTION_TYPE=tar/ES_DISTRIBUTION_TYPE=docker/' bin/elasticsearch-env && \\
52+
# Create required directory
53+
mkdir data && \\
54+
# Reset permissions on all directories
55+
find . -type d -exec chmod 0555 {} + && \\
56+
# Reset permissions on all files
57+
find . -type f -exec chmod 0444 {} + && \\
58+
# Make CLI tools executable
59+
chmod 0555 bin/* jdk/bin/* jdk/lib/jspawnhelper modules/x-pack-ml/platform/linux-*/bin/* && \\
60+
# Make some directories writable. `bin` must be writable because
61+
# plugins can install their own CLI utilities.
62+
chmod 0775 bin config config/jvm.options.d data logs plugins && \\
63+
# Make some files writable
64+
find config -type f -exec chmod 0664 {} + && \\
65+
# Tighten up permissions on the ES home dir (the permissions of the contents are handled below)
66+
chmod 0775 . && \\
67+
# You can't install plugins that include configuration when running as `elasticsearch` and the `config`
68+
# dir is owned by `root`, because the installed tries to manipulate the permissions on the plugin's
69+
# config directory.
70+
chown 1000:1000 bin config config/jvm.options.d data logs plugins
71+
72+
# The distribution includes a `config` directory, no need to create it
73+
COPY config/elasticsearch.yml config/log4j2.properties config/
74+
75+
76+
################################################################################
77+
# Build stage 2 (the actual Elasticsearch image):
78+
#
79+
# Copy elasticsearch from stage 1
80+
# Add entrypoint
81+
################################################################################
82+
83+
FROM ${base_image}
84+
85+
RUN microdnf install --setopt=tsflags=nodocs -y \\
86+
nc shadow-utils zip unzip findutils procps-ng && \\
87+
microdnf clean all
88+
89+
RUN groupadd -g 1000 elasticsearch && \\
90+
adduser -u 1000 -g 1000 -G 0 -d /usr/share/elasticsearch elasticsearch && \\
91+
chown -R 0:0 /usr/share/elasticsearch
92+
93+
ENV ELASTIC_CONTAINER=true
94+
95+
COPY --from=builder /bin/tini /bin/tini
96+
97+
WORKDIR /usr/share/elasticsearch
98+
99+
COPY --from=builder /usr/share/elasticsearch .
100+
101+
# Replace OpenJDK's built-in CA certificate keystore with the one from the OS
102+
# vendor. The latter is superior in several ways.
103+
# REF: https://github.com/elastic/elasticsearch-docker/issues/171
104+
RUN ln -sf /etc/pki/ca-trust/extracted/java/cacerts jdk/lib/security/cacerts
105+
106+
ENV PATH=/usr/share/elasticsearch/bin:\$PATH
107+
ENV SHELL=/bin/bash
108+
COPY bin/docker-entrypoint.sh /usr/local/bin/docker-entrypoint.sh
109+
COPY --chmod=0555 bin/docker-entrypoint.sh /usr/local/bin/docker-entrypoint.sh
110+
111+
EXPOSE 9200 9300
112+
113+
LABEL org.label-schema.build-date="${build_date}" \\
114+
org.label-schema.license="${license}" \\
115+
org.label-schema.name="Elasticsearch" \\
116+
org.label-schema.schema-version="1.0" \\
117+
org.label-schema.url="https://www.elastic.co/products/elasticsearch" \\
118+
org.label-schema.usage="https://www.elastic.co/guide/en/elasticsearch/reference/index.html" \\
119+
org.label-schema.vcs-ref="${git_revision}" \\
120+
org.label-schema.vcs-url="https://github.com/elastic/elasticsearch" \\
121+
org.label-schema.vendor="Elastic" \\
122+
org.label-schema.version="${version}" \\
123+
org.opencontainers.image.created="${build_date}" \\
124+
org.opencontainers.image.documentation="https://www.elastic.co/guide/en/elasticsearch/reference/index.html" \\
125+
org.opencontainers.image.licenses="${license}" \\
126+
org.opencontainers.image.revision="${git_revision}" \\
127+
org.opencontainers.image.source="https://github.com/elastic/elasticsearch" \\
128+
org.opencontainers.image.title="Elasticsearch" \\
129+
org.opencontainers.image.url="https://www.elastic.co/products/elasticsearch" \\
130+
org.opencontainers.image.vendor="Elastic" \\
131+
org.opencontainers.image.version="${version}"
132+
133+
LABEL name="Elasticsearch" \\
134+
maintainer="[email protected]" \\
135+
vendor="Elastic" \\
136+
version="${version}" \\
137+
release="1" \\
138+
summary="Elasticsearch" \\
139+
description="You know, for search."
140+
141+
RUN mkdir /licenses && ln LICENSE.txt /licenses/LICENSE
142+
143+
# Our actual entrypoint is `tini`, a minimal but functional init program. It
144+
# calls the entrypoint we provide, while correctly forwarding signals.
145+
ENTRYPOINT ["/bin/tini", "--", "/usr/local/bin/docker-entrypoint.sh"]
146+
# Dummy overridable parameter parsed by entrypoint
147+
CMD ["eswrapper"]
148+
149+
USER 1000:0
150+
151+
################################################################################
152+
# End of multi-stage Dockerfile
153+
################################################################################

0 commit comments

Comments
 (0)