build.sh 10.2 KB
Newer Older
1
#!/bin/bash -e
Neelay Shah's avatar
Neelay Shah committed
2
# SPDX-FileCopyrightText: Copyright (c) 2024-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
3
# SPDX-License-Identifier: Apache-2.0
4
5
6
7
8
9
10
11
12
13
14
15
#
# 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
#
# 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.
16

17

18
19
20
TAG=
RUN_PREFIX=
PLATFORM=linux/amd64
21
22
23
24

# Get short commit hash
commit_id=$(git rev-parse --short HEAD)

25
26
# if COMMIT_ID matches a TAG use that
current_tag=$(git describe --tags --exact-match 2>/dev/null | sed 's/^v//') || true
27

28
29
# Get latest TAG and add COMMIT_ID for dev
latest_tag=$(git describe --tags --abbrev=0 $(git rev-list --tags --max-count=1 main) | sed 's/^v//') || true
30
31
32
33
if [[ -z ${latest_tag} ]]; then
    latest_tag="0.0.1"
    echo "No git release tag found, setting to unknown version: ${latest_tag}"
fi
34

35
36
37
38
# Use tag if available, otherwise use latest_tag.dev.commit_id
VERSION=v${current_tag:-$latest_tag.dev.$commit_id}

PYTHON_PACKAGE_VERSION=${current_tag:-$latest_tag.dev+$commit_id}
39
40
41
42
43
44

# Frameworks
#
# Each framework has a corresponding base image.  Additional
# dependencies are specified in the /container/deps folder and
# installed within framework specific sections of the Dockerfile.
45

46
declare -A FRAMEWORKS=(["VLLM"]=1 ["TENSORRTLLM"]=2 ["NONE"]=3)
47
DEFAULT_FRAMEWORK=VLLM
48
49
50
51
52
53

SOURCE_DIR=$(dirname "$(readlink -f "$0")")
DOCKERFILE=${SOURCE_DIR}/Dockerfile
BUILD_CONTEXT=$(dirname "$(readlink -f "$SOURCE_DIR")")

# Base Images
54
TENSORRTLLM_BASE_VERSION=25.01
55
# FIXME: Need a public image for public consumption
56
57
58
TENSORRTLLM_BASE_IMAGE="gitlab-master.nvidia.com:5005/dl/dgx/tritonserver/tensorrt-llm/amd64"
TENSORRTLLM_BASE_IMAGE_TAG=krish-fix-trtllm-build.23766174
TENSORRTLLM_PIP_WHEEL_PATH=""
59

60
61
VLLM_BASE_IMAGE="nvcr.io/nvidia/cuda-dl-base"
VLLM_BASE_IMAGE_TAG="25.01-cuda12.8-devel-ubuntu24.04"
62

63
64
65
NONE_BASE_IMAGE="ubuntu"
NONE_BASE_IMAGE_TAG="24.04"

66
NIXL_COMMIT=f35faf8ba4e725f1724177d0772200481d1d3446
67
68
NIXL_REPO=ai-dynamo/nixl.git

69
70
71
72
73
74
75
get_options() {
    while :; do
        case $1 in
        -h | -\? | --help)
            show_help
            exit
            ;;
76
        --platform)
77
78
79
80
            if [ "$2" ]; then
                PLATFORM=$2
                shift
            else
81
                missing_requirement $1
82
83
            fi
            ;;
84
        --framework)
85
86
87
88
            if [ "$2" ]; then
                FRAMEWORK=$2
                shift
            else
89
                missing_requirement $1
90
91
            fi
            ;;
92
        --tensorrtllm-pip-wheel-path)
93
            if [ "$2" ]; then
94
                TENSORRTLLM_PIP_WHEEL_PATH=$2
95
96
97
98
99
                shift
            else
                missing_requirement $1
            fi
            ;;
100
101
102
103
104
        --base-image)
            if [ "$2" ]; then
                BASE_IMAGE=$2
                shift
            else
105
                missing_requirement $1
106
107
            fi
            ;;
108
        --base-image-tag)
109
110
111
112
            if [ "$2" ]; then
                BASE_IMAGE_TAG=$2
                shift
            else
113
114
115
116
117
118
119
120
121
                missing_requirement $1
            fi
            ;;
        --target)
            if [ "$2" ]; then
                TARGET=$2
                shift
            else
                missing_requirement $1
122
123
124
125
126
127
128
            fi
            ;;
        --build-arg)
            if [ "$2" ]; then
                BUILD_ARGS+="--build-arg $2 "
                shift
            else
129
                missing_requirement $1
130
131
132
133
            fi
            ;;
        --tag)
            if [ "$2" ]; then
134
                TAG="--tag $2"
135
136
                shift
            else
137
                missing_requirement $1
138
139
140
141
142
143
144
145
146
147
            fi
            ;;
        --dry-run)
            RUN_PREFIX="echo"
            echo ""
            echo "=============================="
            echo "DRY RUN: COMMANDS PRINTED ONLY"
            echo "=============================="
            echo ""
            ;;
148
149
        --no-cache)
            NO_CACHE=" --no-cache"
150
            ;;
151
152
        --cache-from)
            if [ "$2" ]; then
153
154
155
                CACHE_FROM="--cache-from $2"
                shift
            else
156
                missing_requirement $1
157
158
            fi
            ;;
159
160
161
162
163
164
165
166
        --cache-to)
            if [ "$2" ]; then
                CACHE_TO="--cache-to $2"
                shift
            else
                missing_requirement $1
            fi
            ;;
ptarasiewiczNV's avatar
ptarasiewiczNV committed
167
168
169
170
171
172
173
174
        --build-context)
            if [ "$2" ]; then
                BUILD_CONTEXT_ARG="--build-context $2"
                shift
            else
                missing_requirement $1
            fi
            ;;
175
176
177
178
179
        --)
            shift
            break
            ;;
         -?*)
180
            error 'ERROR: Unknown option: ' $1
181
            ;;
182
183
         ?*)
            error 'ERROR: Unknown option: ' $1
184
185
186
187
188
189
190
191
192
            ;;
        *)
            break
            ;;
        esac
        shift
    done

    if [ -z "$FRAMEWORK" ]; then
193
        FRAMEWORK=$DEFAULT_FRAMEWORK
194
195
196
    fi

    if [ ! -z "$FRAMEWORK" ]; then
197
        FRAMEWORK=${FRAMEWORK^^}
198

199
200
201
        if [[ ! -n "${FRAMEWORKS[$FRAMEWORK]}" ]]; then
            error 'ERROR: Unknown framework: ' $FRAMEWORK
        fi
202

203
204
205
206
        if [ -z $BASE_IMAGE_TAG ]; then
            BASE_IMAGE_TAG=${FRAMEWORK}_BASE_IMAGE_TAG
            BASE_IMAGE_TAG=${!BASE_IMAGE_TAG}
        fi
207

208
209
210
211
        if [ -z $BASE_IMAGE ]; then
            BASE_IMAGE=${FRAMEWORK}_BASE_IMAGE
            BASE_IMAGE=${!BASE_IMAGE}
        fi
212

213
214
215
        if [ -z $BASE_IMAGE ]; then
            error "ERROR: Framework $FRAMEWORK without BASE_IMAGE"
        fi
216

217
218
        BASE_VERSION=${FRAMEWORK}_BASE_VERSION
        BASE_VERSION=${!BASE_VERSION}
219
220
221
222

    fi

    if [ -z "$TAG" ]; then
223
        TAG="--tag dynamo:${VERSION}-${FRAMEWORK,,}"
224
        if [ ! -z "${TARGET}" ]; then
225
226
            TAG="${TAG}-${TARGET}"
        fi
227
228
229
230
231
232
    fi

    if [ ! -z "$PLATFORM" ]; then
        PLATFORM="--platform ${PLATFORM}"
    fi

233
234
    if [ ! -z "$TARGET" ]; then
        TARGET_STR="--target ${TARGET}"
235
    else
236
        TARGET_STR="--target dev"
237
    fi
238
239
240
241
242
}


show_image_options() {
    echo ""
243
    echo "Building Dynamo Image: '${TAG}'"
244
245
246
247
    echo ""
    echo "   Base: '${BASE_IMAGE}'"
    echo "   Base_Image_Tag: '${BASE_IMAGE_TAG}'"
    if [[ $FRAMEWORK == "TENSORRTLLM" ]]; then
248
        echo "   Tensorrtllm_Pip_Wheel_Path: '${TENSORRTLLM_PIP_WHEEL_PATH}'"
249
250
251
252
253
254
255
256
257
258
259
260
261
    fi
    echo "   Build Context: '${BUILD_CONTEXT}'"
    echo "   Build Arguments: '${BUILD_ARGS}'"
    echo "   Framework: '${FRAMEWORK}'"
    echo ""
}

show_help() {
    echo "usage: build.sh"
    echo "  [--base base image]"
    echo "  [--base-imge-tag base image tag]"
    echo "  [--platform platform for docker build"
    echo "  [--framework framework one of ${!FRAMEWORKS[@]}]"
262
    echo "  [--tensorrtllm-pip-wheel-path path to tensorrtllm pip wheel]"
263
    echo "  [--build-arg additional build args to pass to docker build]"
264
265
    echo "  [--cache-from cache location to start from]"
    echo "  [--cache-to location where to cache the build output]"
266
267
268
    echo "  [--tag tag for image]"
    echo "  [--no-cache disable docker build cache]"
    echo "  [--dry-run print docker commands without running]"
ptarasiewiczNV's avatar
ptarasiewiczNV committed
269
    echo "  [--build-context name=path to add build context]"
270
271
272
273
274
275
276
277
278
279
280
281
282
283
    exit 0
}

missing_requirement() {
    error "ERROR: $1 requires an argument."
}

error() {
    printf '%s %s\n' "$1" "$2" >&2
    exit 1
}

get_options "$@"

284
285
286
# Update DOCKERFILE if framework is VLLM
if [[ $FRAMEWORK == "VLLM" ]]; then
    DOCKERFILE=${SOURCE_DIR}/Dockerfile.vllm
287
288
elif [[ $FRAMEWORK == "TENSORRTLLM" ]]; then
    DOCKERFILE=${SOURCE_DIR}/Dockerfile.tensorrt_llm
289
290
elif [[ $FRAMEWORK == "NONE" ]]; then
    DOCKERFILE=${SOURCE_DIR}/Dockerfile.none
291
292
fi

293
if [[ $FRAMEWORK == "VLLM" ]]; then
294
    NIXL_DIR="/tmp/nixl/nixl_src"
295
296

    # Clone original NIXL to temp directory
297
298
    if [ -d "$NIXL_DIR" ]; then
        echo "Warning: $NIXL_DIR already exists, skipping clone"
299
    else
300
301
302
303
304
305
306
307
        if [ ! -z ${GITHUB_TOKEN} ]; then
            git clone https://oauth2:${GITHUB_TOKEN}@github.com/${NIXL_REPO} "$NIXL_DIR"
        else
            # Try HTTPS first with credential prompting disabled, fall back to SSH if it fails
            if ! GIT_TERMINAL_PROMPT=0 git clone https://github.com/${NIXL_REPO} "$NIXL_DIR"; then
                echo "HTTPS clone failed, falling back to SSH..."
                git clone git@github.com:${NIXL_REPO} "$NIXL_DIR"
            fi
308
309
310
        fi
    fi

311
312
313
314
315
316
    cd "$NIXL_DIR"
    if ! git checkout ${NIXL_COMMIT}; then
        echo "ERROR: Failed to checkout NIXL commit ${NIXL_COMMIT}. The cached directory may be out of date."
        echo "Please delete $NIXL_DIR and re-run the build script."
        exit 1
    fi
317

318
    BUILD_CONTEXT_ARG+=" --build-context nixl=$NIXL_DIR"
319

320
321
    # Add NIXL_COMMIT as a build argument to enable caching
    BUILD_ARGS+=" --build-arg NIXL_COMMIT=${NIXL_COMMIT} "
322
323
fi

324
325
# BUILD DEV IMAGE

326
BUILD_ARGS+=" --build-arg BASE_IMAGE=$BASE_IMAGE --build-arg BASE_IMAGE_TAG=$BASE_IMAGE_TAG --build-arg FRAMEWORK=$FRAMEWORK --build-arg ${FRAMEWORK}_FRAMEWORK=1 --build-arg VERSION=$VERSION --build-arg PYTHON_PACKAGE_VERSION=$PYTHON_PACKAGE_VERSION"
327
328
329
330
331
332
333
334
335

if [ ! -z ${GITHUB_TOKEN} ]; then
    BUILD_ARGS+=" --build-arg GITHUB_TOKEN=${GITHUB_TOKEN} "
fi

if [ ! -z ${GITLAB_TOKEN} ]; then
    BUILD_ARGS+=" --build-arg GITLAB_TOKEN=${GITLAB_TOKEN} "
fi

336
337
338
339
if [[ $FRAMEWORK == "TENSORRTLLM" ]]; then
    if [ ! -z ${TENSORRTLLM_PIP_WHEEL_PATH} ]; then
        BUILD_ARGS+=" --build-arg TENSORRTLLM_PIP_WHEEL_PATH=${TENSORRTLLM_PIP_WHEEL_PATH} "
    fi
340
341
342
343
344
345
fi

if [ ! -z ${HF_TOKEN} ]; then
    BUILD_ARGS+=" --build-arg HF_TOKEN=${HF_TOKEN} "
fi

346
LATEST_TAG="--tag dynamo:latest-${FRAMEWORK,,}"
347
348
349
if [ ! -z ${TARGET} ]; then
    LATEST_TAG="${LATEST_TAG}-${TARGET}"
fi
350

351
352
353
354
355
356
show_image_options

if [ -z "$RUN_PREFIX" ]; then
    set -x
fi

357
$RUN_PREFIX docker build -f $DOCKERFILE $TARGET_STR $PLATFORM $BUILD_ARGS $CACHE_FROM $CACHE_TO $TAG $LATEST_TAG $BUILD_CONTEXT_ARG $BUILD_CONTEXT $NO_CACHE
358
359
360
361
362
363
364

{ set +x; } 2>/dev/null

if [ -z "$RUN_PREFIX" ]; then
    set -x
fi

365
{ set +x; } 2>/dev/null