mirror of
https://github.com/apache/kafka.git
synced 2026-10-28 16:35:34 +08:00
Maros Orsak
2e4d25ee13
Makes the jvm image's base image overridable (`--base-image`, default unchanged), so it can be built on another JDK version or an own Alpine JRE image without forking the Dockerfile. The build fails fast with a clear message when the base image has no `java` on PATH. Checked by building on the default base (JDK 25) and on temurin:21-jre-alpine, and that a base without a JRE (alpine:3) fails at the check. The generated Docker Official Image source differs from trunk only by that check line. Reviewers: Chia-Ping Tsai <chia7712@gmail.com>, YANG-SYUAN CHOU <dino2895un@gmail.com>, Federico Valeri <fedevaleri@gmail.com>, Luke Chen <showuon@gmail.com>, liuliu <liuliugit@gmail.com>
82 lines
4.2 KiB
Python
82 lines
4.2 KiB
Python
#!/usr/bin/env python
|
|
|
|
# Licensed to the Apache Software Foundation (ASF) under one or more
|
|
# contributor license agreements. See the NOTICE file distributed with
|
|
# this work for additional information regarding copyright ownership.
|
|
# The ASF licenses this file to You under the Apache License, Version 2.0
|
|
# (the "License"); you may not use this file except in compliance with
|
|
# the License. You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
"""
|
|
Python script to prepare the hardcoded source folder for the docker official image
|
|
This script is used to prepare the source folder for the docker official image
|
|
|
|
Usage:
|
|
prepare_docker_official_image_source.py --help
|
|
Get detailed description of each option
|
|
|
|
Example command:-
|
|
prepare_docker_official_image_source.py --image-type <image_type> --kafka-version <kafka_version>
|
|
|
|
This command will build a directory with the name as <kafka_version> housing the hardcoded static Dockerfile and scripts for
|
|
the docker official image, <image_type> as image type (jvm by default), <kafka_version> for the kafka version for which the
|
|
image is being built.
|
|
"""
|
|
|
|
from datetime import date
|
|
import argparse
|
|
import os
|
|
import shutil
|
|
import re
|
|
|
|
|
|
def replace_arg_with_env(filedata, arg_name, value):
|
|
# Replace the whole line so a default like `ARG kafka_url=""` does not leak into the ENV value.
|
|
filedata, count = re.subn(rf"^ARG {re.escape(arg_name)}\b.*$", f"ENV {arg_name} {value}", filedata, flags=re.MULTILINE)
|
|
if count == 0:
|
|
raise ValueError(f"'ARG {arg_name}' not found in the Dockerfile, cannot hardcode its value")
|
|
return filedata
|
|
|
|
|
|
def remove_args_and_hardcode_values(file_path, kafka_version, kafka_url):
|
|
with open(file_path, 'r') as file:
|
|
filedata = file.read()
|
|
# Docker Official Images require literal FROM lines, so drop the ARG and inline its default.
|
|
base_image = re.search(r"^ARG base_image=(\S+)\n\n?", filedata, re.MULTILINE)
|
|
if base_image is None:
|
|
raise ValueError("'ARG base_image' not found in the Dockerfile, cannot hardcode the base image")
|
|
filedata = filedata.replace(base_image.group(0), "").replace("${base_image}", base_image.group(1))
|
|
filedata = replace_arg_with_env(filedata, "kafka_url", kafka_url)
|
|
filedata = replace_arg_with_env(filedata, "build_date", str(date.today()))
|
|
original_comment = re.compile(r"# Get kafka from https://archive.apache.org/dist/kafka and pass the url through build arguments")
|
|
updated_comment = f"# Get Kafka from https://archive.apache.org/dist/kafka, url passed as env var, for version {kafka_version}"
|
|
filedata = original_comment.sub(updated_comment, filedata)
|
|
with open(file_path, 'w') as file:
|
|
file.write(filedata)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
parser = argparse.ArgumentParser()
|
|
parser.add_argument("--image-type", "-type", choices=[
|
|
"jvm"], default="jvm", dest="image_type", help="Image type you want to build")
|
|
parser.add_argument("--kafka-version", "-v", dest="kafka_version",
|
|
help="Kafka version for which the source for docker official image is to be built")
|
|
args = parser.parse_args()
|
|
kafka_url = f"https://archive.apache.org/dist/kafka/{args.kafka_version}/kafka_2.13-{args.kafka_version}.tgz"
|
|
current_dir = os.path.dirname(os.path.realpath(__file__))
|
|
new_dir = os.path.join(current_dir, 'docker_official_images', args.kafka_version)
|
|
if os.path.exists(new_dir):
|
|
shutil.rmtree(new_dir)
|
|
os.makedirs(new_dir)
|
|
shutil.copytree(os.path.join(current_dir, args.image_type), os.path.join(new_dir, args.image_type), dirs_exist_ok=True)
|
|
shutil.copytree(os.path.join(current_dir, 'resources'), os.path.join(new_dir, args.image_type, 'resources'), dirs_exist_ok=True)
|
|
remove_args_and_hardcode_values(os.path.join(new_dir, args.image_type, 'Dockerfile'), args.kafka_version, kafka_url)
|