Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion tez-dist/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@
<configuration>
<executable>/bin/bash</executable>
<arguments>
<argument>${project.basedir}/src/docker/tez-am/build-am-docker.sh</argument>
<argument>${project.basedir}/src/docker/build.sh</argument>
<argument>-tez ${project.version}</argument>
<argument>-repo apache</argument>
</arguments>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,25 +47,24 @@ RUN set -ex; \

# Set necessary environment variables
ENV TEZ_HOME=/opt/tez \
TEZ_CONF_DIR=/opt/tez/conf

ENV TEZ_CLIENT_VERSION=$TEZ_VERSION
TEZ_CONF_DIR=/opt/tez/conf \
TEZ_CLIENT_VERSION=$TEZ_VERSION

ENV PATH=$TEZ_HOME/bin:$PATH

COPY --from=env --chown=tez /opt/tez $TEZ_HOME

RUN mkdir -p $TEZ_CONF_DIR && chown tez:tez $TEZ_CONF_DIR

COPY --chown=tez am-entrypoint.sh /
COPY --chown=tez entrypoint.sh am-entrypoint.sh child-entrypoint.sh /
COPY --chown=tez conf $TEZ_CONF_DIR

# Create Extension Point Directory
RUN mkdir -p /opt/tez/plugins && chown tez:tez /opt/tez/plugins && chmod 755 /opt/tez/plugins

RUN chmod +x /am-entrypoint.sh
RUN chmod +x /entrypoint.sh /am-entrypoint.sh /child-entrypoint.sh

USER tez
WORKDIR $TEZ_HOME

ENTRYPOINT ["/am-entrypoint.sh"]
ENTRYPOINT ["/entrypoint.sh"]
196 changes: 196 additions & 0 deletions tez-dist/src/docker/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,196 @@
<!--
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.
-->

# Apache Tez Docker

This directory contains a unified Docker implementation for running TezAM
and TezChild process from a single container image. Based on
`TEZ_COMPONENT` environment variable the entrypoint is dynamically selected

1. Building the docker image:

```bash
mvn clean install -DskipTests -Pdocker
```

Alternatively, you can build it explicitly via the provided script:

```bash
./tez-dist/src/docker/build.sh -tez <version> -repo apache
```

2. Local Zookeeper Setup (Standalone):

If you are running the AM container use the official Docker
image (Refer to docker-compose.yml):

```bash
docker pull zookeeper:3.8.4

docker run -d \
--name zookeeper-server \
-p 2181:2181 \
-p 8080:8080 \
-e ZOO_MY_ID=1 \
zookeeper:3.8.4
```

3. Running the Tez containers explicitly:

**Running the Tez AM:**

```bash
export TEZ_VERSION=1.0.0-SNAPSHOT

docker run --rm \
-p 10001:10001 \
--env-file tez-dist/src/docker/am.env \
--name tez-am \
--hostname localhost \
apache/tez:$TEZ_VERSION
```

* `TEZ_VERSION` corresponds to the Maven `${project.version}`.
Set this environment variable in your shell before running the commands.

* Expose ports using the `-p` flag based on the
`tez.am.client.am.port-range` property in `tez-site.xml`.

* The `--hostname` flag configures the container's hostname, allowing
services on the host (e.g., macOS) to connect to it.

* Ensure the `--env-file` flag is included, or at a minimum, pass
`-e TEZ_FRAMEWORK_MODE=STANDALONE_ZOOKEEPER` and `-e TEZ_COMPONENT=AM`
to the `docker run` command.

**Running the Tez Child:**

The child container requires specific arguments (`<am-host> <am-port>
<container-id> <token-id> <attempt-number>`) to connect back to the
Application Master.

Assuming your AM is running on `localhost` port `10001`, and the AM
assigned the container ID `container_1703023223000_0001_01_000001`:

```bash
docker run --rm \
--network host \
--env-file tez-dist/src/docker/child.env \
--name tez-child \
--hostname localhost \
apache/tez:1.0.0-SNAPSHOT \
localhost 10001 container_1703023223000_0001_01_000001 dummy_token_abc 1
```

4. Debugging the Tez containers:
Uncomment the `JAVA_TOOL_OPTIONS` in `am.env` (or `child.env` for
port 5006) and expose the debug port using `-p` flag:

```bash
docker run --rm \
-p 10001:10001 -p 5005:5005 \
--env-file tez-dist/src/docker/am.env \
--name tez-am \
--hostname localhost \
apache/tez:$TEZ_VERSION
```

5. To override the tez-site.xml in docker image use:

* Set the `TEZ_CUSTOM_CONF_DIR` environment variable in `am.env` /
`child.env` or via the `docker run` command (e.g.,
`/opt/tez/custom-conf`).

```bash
export TEZ_SITE_PATH=$(pwd)/tez-dist/src/docker/conf/tez-site.xml

docker run --rm \
-p 10001:10001 \
--env-file tez-dist/src/docker/am.env \
-v "$TEZ_SITE_PATH:/opt/tez/custom-conf/tez-site.xml" \
--name tez-am \
--hostname localhost \
apache/tez:$TEZ_VERSION
```

6. To add plugin jars in docker image use:

* The plugin directory path inside the Docker container is fixed at
`/opt/tez/plugins`.

```bash
docker run --rm \
-p 10001:10001 \
--env-file tez-dist/src/docker/am.env \
-v "/path/to/your/local/plugins:/opt/tez/plugins" \
--name tez-am \
--hostname localhost \
apache/tez:$TEZ_VERSION
```

7. Using Docker Compose (Local Testing Cluster):

The provided `docker-compose.yml` offers a complete, minimal Hadoop
ecosystem to test Tez in a distributed manner locally without setting
up a real cluster.

**Services Included:**

* **namenode & datanode:** A minimal Apache Hadoop HDFS cluster
(lean image)

* **zookeeper:** Required by the Tez AM for standalone session
discovery

* **tez-am:** It automatically waits for Zookeeper and HDFS to
be healthy before starting up.

* **tez-child:** TBD

**To start the full cluster:**

```bash
docker-compose -f tez-dist/src/docker/docker-compose.yml up -d
```

**To monitor the Application Master logs:**

```bash
docker-compose -f tez-dist/src/docker/docker-compose.yml logs -f tez-am
```

**To shut down the cluster and clean up volumes (HDFS/Zookeeper data):**

```bash
docker-compose -f tez-dist/src/docker/docker-compose.yml down -v
```

8. To mount custom plugins or JARs required by Tez AM (e.g., for split
generation — typically the hive-exec jar, but in general, any UDFs or
dependencies previously managed via YARN localization:

* Create a directory `tez-plugins` and add all required jars.

* Uncomment the following lines in docker compose under the `tez-am`
and `tez-child` services to mount this directory as a volume to
`/opt/tez/plugins` in the docker container.

```yaml
volumes:
- ./tez-plugins:/opt/tez/plugins
```
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@

set -xeou pipefail

################################################
# 1. Mocking DAGAppMaster#main() env variables #
################################################
#############################################
# Mocking DAGAppMaster#main() env variables #
#############################################

: "${USER:="tez"}"
: "${LOCAL_DIRS:="/tmp"}"
Expand Down Expand Up @@ -70,12 +70,6 @@ CLASSPATH="${CLASSPATH}:${TEZ_HOME}/*:${TEZ_HOME}/lib/*"
#############
# Execution #
#############
TEZ_DAG_JAR=$(find "$TEZ_HOME" -maxdepth 1 -name "tez-dag-*.jar" ! -name "*-tests.jar" | head -n 1)

if [ -z "$TEZ_DAG_JAR" ]; then
echo "Error: Could not find tez-dag-*.jar in $TEZ_HOME"
exit 1
fi

echo "--> Starting DAGAppMaster..."

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@

USER=tez
LOG_DIRS=/opt/tez/logs
TEZ_COMPONENT=AM
TEZ_FRAMEWORK_MODE=STANDALONE_ZOOKEEPER
TEZ_CUSTOM_CONF_DIR=/opt/tez/custom-conf
# TEZ_AM_HEAP_OPTS configures the maximum heap size (Xmx) for the Tez AM.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ REPO=
usage() {
cat <<EOF 1>&2
Usage: $0 [-h] [-tez <Tez version>] [-repo <Docker repo>]
Build the Apache Tez AM Docker image
Build the Apache Tez (AM and CHILD) Docker image
-help Display help
-tez Build image with the specified Tez version
-repo Docker repository
Expand Down Expand Up @@ -59,8 +59,8 @@ SCRIPT_DIR=$(
pwd
)

DIST_DIR=${DIST_DIR:-"$SCRIPT_DIR/../../.."}
PROJECT_ROOT=${PROJECT_ROOT:-"$SCRIPT_DIR/../../../.."}
DIST_DIR=${DIST_DIR:-"$SCRIPT_DIR/../../"}
PROJECT_ROOT=${PROJECT_ROOT:-"$SCRIPT_DIR/../../../"}

REPO=${REPO:-apache}
WORK_DIR="$(mktemp -d)"
Expand All @@ -86,17 +86,19 @@ fi
# -------------------------------------------------------------------------
# BUILD CONTEXT PREPARATION
# -------------------------------------------------------------------------
cp -R "$SCRIPT_DIR/conf" "$WORK_DIR/" 2>/dev/null || mkdir -p "$WORK_DIR/conf"
cp -R "$SCRIPT_DIR/conf" "$WORK_DIR/"
cp "$SCRIPT_DIR/entrypoint.sh" "$WORK_DIR/"
cp "$SCRIPT_DIR/am-entrypoint.sh" "$WORK_DIR/"
cp "$SCRIPT_DIR/Dockerfile.am" "$WORK_DIR/"
cp "$SCRIPT_DIR/child-entrypoint.sh" "$WORK_DIR/"
cp "$SCRIPT_DIR/Dockerfile" "$WORK_DIR/"

echo "Building Docker image..."
docker build \
"$WORK_DIR" \
-f "$WORK_DIR/Dockerfile.am" \
-t "$REPO/tez-am:$TEZ_VERSION" \
-f "$WORK_DIR/Dockerfile" \
-t "$REPO/tez:$TEZ_VERSION" \
--build-arg "BUILD_ENV=unarchive" \
--build-arg "TEZ_VERSION=$TEZ_VERSION"

rm -r "${WORK_DIR}"
echo "Docker image $REPO/tez-am:$TEZ_VERSION built successfully."
echo "Docker image $REPO/tez:$TEZ_VERSION built successfully."
Loading