docker_maxtext_jax_stable_stack_image_upload.sh

#!/bin/bash

# Copyright 2024 Google LLC
#
# Licensed 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
#
#      https://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.


# This script uses a pre-built JAX stable stack Docker image as the BASEIMAGE. This image includes pinned versions of JAX and other core and utility libraries, all of which have been thoroughly tested together.
# It then copies the local source code into the image and uploads it to Google Container Registry (GCR).
# This allows the image to be used for development within GCR.

# Each time you update the base image via a "bash docker_maxtext_jax_stable_stack_image_upload.sh", there will be a slow upload process
# (minutes). However, if you are simply changing local code and not updating dependencies, uploading just takes a few seconds.

# Example command:
# bash docker_maxtext_jax_stable_stack_image_upload.sh PROJECT_ID=sample_project BASEIMAGE=us-docker.pkg.dev/sample-project/jax-stable-stack/tpu:jax0.4.30-rev1 CLOUD_IMAGE_NAME=maxtext-jax-stable-stack IMAGE_TAG=latest MAXTEXT_REQUIREMENTS_FILE=requirements_with_jax_stable_stack.txt

set -e

# Set environment variables
for ARGUMENT in "$@"; do
    IFS='=' read -r KEY VALUE <<< "$ARGUMENT"
    export "$KEY"="$VALUE"
    echo "$KEY"="$VALUE"
done

if [[ ! -v BASEIMAGE ]]; then
  echo "Erroring out because BASEIMAGE is unset, please set it!"
  exit 1
fi

if [[ ! -v PROJECT_ID ]]; then
  echo "Erroring out because PROJECT is unset, please set it!"
  exit 1
fi

if [[ ! -v CLOUD_IMAGE_NAME ]]; then
  echo "Erroring out because CLOUD_IMAGE_NAME is unset, please set it!"
  exit 1
fi

if [[ ! -v IMAGE_TAG ]]; then
  echo "Erroring out because IMAGE_TAG is unset, please set it!"
  exit 1
fi

if [[ ! -v MAXTEXT_REQUIREMENTS_FILE ]]; then
  echo "Erroring out because MAXTEXT_REQUIREMENTS_FILE is unset, please set it!"
  exit 1
fi

# Default: Don't delete local image
DELETE_LOCAL_IMAGE="${DELETE_LOCAL_IMAGE:-false}"

gcloud auth configure-docker us-docker.pkg.dev --quiet

COMMIT_HASH=$(git rev-parse --short HEAD)

echo "Building JAX Stable Stack MaxText at commit hash ${COMMIT_HASH} . . ."  

IMAGE_DATE=$(date +%Y-%m-%d)

FULL_IMAGE_TAG=${IMAGE_TAG}-${IMAGE_DATE}

docker build --no-cache \
  --build-arg JAX_STABLE_STACK_BASEIMAGE=${BASEIMAGE} \
  --build-arg COMMIT_HASH=${COMMIT_HASH} \
  --build-arg MAXTEXT_REQUIREMENTS_FILE=${MAXTEXT_REQUIREMENTS_FILE} \
  --network=host \
  -t us-docker.pkg.dev/${PROJECT_ID}/${CLOUD_IMAGE_NAME}/tpu:${FULL_IMAGE_TAG} \
  -f ./maxtext_jax_stable_stack_tpu.Dockerfile .

docker push us-docker.pkg.dev/${PROJECT_ID}/${CLOUD_IMAGE_NAME}/tpu:${FULL_IMAGE_TAG}

echo "All done, check out your artifacts at: us-docker.pkg.dev/${PROJECT_ID}/${CLOUD_IMAGE_NAME}/tpu:${FULL_IMAGE_TAG}"

if [ "$DELETE_LOCAL_IMAGE" == "true" ]; then
  docker rmi us-docker.pkg.dev/${PROJECT_ID}/${CLOUD_IMAGE_NAME}/tpu:${FULL_IMAGE_TAG}
  echo "Local image deleted."
fi