a few nits

Signed-off-by: see-quick <maros.orsak159@gmail.com>
This commit is contained in:
see-quick 2025-09-17 14:42:05 +02:00
parent 3c7ac2fb3a
commit cdc4e86e11
1 changed files with 8 additions and 8 deletions

View File

@ -67,7 +67,7 @@ debugpy_port=5678
usage() { usage() {
local exit_status="${1}" local exit_status="${1}"
cat <<EOF cat <<EOF
ducker-ak: a tool for running Apache Kafka tests inside container images. ducker-ak: a tool for running Apache Kafka tests inside Docker images.
Supports Docker and Podman container runtimes. Auto-detects available runtime Supports Docker and Podman container runtimes. Auto-detects available runtime
or can be overridden with CONTAINER_RUNTIME environment variable. or can be overridden with CONTAINER_RUNTIME environment variable.
@ -77,10 +77,10 @@ Usage: ${script_path} [command] [options]
help|-h|--help help|-h|--help
Display this help message Display this help message
up [-n|--num-nodes NUM_NODES] [-f|--force] [container-image] up [-n|--num-nodes NUM_NODES] [-f|--force] [docker-image]
[-C|--custom-ducktape DIR] [-e|--expose-ports ports] [-j|--jdk JDK_VERSION] [--ipv6] [-C|--custom-ducktape DIR] [-e|--expose-ports ports] [-j|--jdk JDK_VERSION] [--ipv6]
Bring up a cluster with the specified amount of nodes (defaults to ${default_num_nodes}). Bring up a cluster with the specified amount of nodes (defaults to ${default_num_nodes}).
The container image name defaults to ${default_image_name}. If --force is specified, we will The Docker image name defaults to ${default_image_name}. If --force is specified, we will
attempt to bring up an image even some parameters are not valid. attempt to bring up an image even some parameters are not valid.
If --custom-ducktape is specified, we will install the provided custom If --custom-ducktape is specified, we will install the provided custom
@ -95,7 +95,7 @@ up [-n|--num-nodes NUM_NODES] [-f|--force] [container-image]
If -j|--jdk is specified, you can customize the OpenJDK base image used for building If -j|--jdk is specified, you can customize the OpenJDK base image used for building
the ducker container. Defaults to ${default_jdk}. Example: -j openjdk:17-bullseye the ducker container. Defaults to ${default_jdk}. Example: -j openjdk:17-bullseye
If --ipv6 is specified, we will create a container network with IPv6 enabled. If --ipv6 is specified, we will create a Docker network with IPv6 enabled.
Note that port 5678 will be automatically exposed for ducker01 node and will be mapped to 5678 Note that port 5678 will be automatically exposed for ducker01 node and will be mapped to 5678
on your local machine to enable debugging in VS Code. on your local machine to enable debugging in VS Code.
@ -121,12 +121,12 @@ ssh [node-name|user-name@node-name] [command]
down [-q|--quiet] [-f|--force] down [-q|--quiet] [-f|--force]
Tear down all the currently active ducker-ak nodes. If --quiet is specified, Tear down all the currently active ducker-ak nodes. If --quiet is specified,
only error messages are printed. If --force or -f is specified, "container rm -f" only error messages are printed. If --force or -f is specified, "docker rm -f"
will be used to remove the nodes, which kills currently running ducker-ak test. will be used to remove the nodes, which kills currently running ducker-ak test.
purge [--f|--force] purge [--f|--force]
Purge container images created by ducker-ak. This will free disk space. Purge Docker images created by ducker-ak. This will free disk space.
If --force is set, we run 'container rmi -f'. If --force is set, we run 'docker rmi -f'.
EOF EOF
exit "${exit_status}" exit "${exit_status}"
} }
@ -325,7 +325,7 @@ docker_run() {
expose_ports="${expose_ports} -p ${port_mapping}:${port_mapping}" expose_ports="${expose_ports} -p ${port_mapping}:${port_mapping}"
fi fi
# Invoke container run. We need privileged mode to be able to run iptables # Invoke docker-run. We need privileged mode to be able to run iptables
# and mount FUSE filesystems inside the container. We also need it to # and mount FUSE filesystems inside the container. We also need it to
# run iptables inside the container. # run iptables inside the container.
local memory_swappiness_option="" local memory_swappiness_option=""