build.sh 10.1 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

ptarasiewiczNV's avatar
ptarasiewiczNV committed
46
declare -A FRAMEWORKS=(["STANDARD"]=1 ["TENSORRTLLM"]=2 ["VLLM"]=3 ["VLLM_NIXL"]=4)
47
48
49
50
51
52
53
54
DEFAULT_FRAMEWORK=STANDARD

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

# Base Images

55
STANDARD_BASE_VERSION=25.01
56
57
58
STANDARD_BASE_IMAGE=nvcr.io/nvidia/tritonserver
STANDARD_BASE_IMAGE_TAG=${STANDARD_BASE_VERSION}-py3

59
TENSORRTLLM_BASE_VERSION=25.01
60
61
62
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=""
63

64
65
VLLM_BASE_IMAGE="nvcr.io/nvidia/cuda-dl-base"
VLLM_BASE_IMAGE_TAG="25.01-cuda12.8-devel-ubuntu24.04"
66

ptarasiewiczNV's avatar
ptarasiewiczNV committed
67
68
69
VLLM_NIXL_BASE_IMAGE="nvcr.io/nvidia/cuda-dl-base"
VLLM_NIXL_BASE_IMAGE_TAG="25.01-cuda12.8-devel-ubuntu24.04"

70
71
72
NIXL_COMMIT=3ce6a673b266b4f293909ceb17ca7975f1ba5cd7
NIXL_REPO=ai-dynamo/nixl.git

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

    if [ -z "$FRAMEWORK" ]; then
197
        FRAMEWORK=$DEFAULT_FRAMEWORK
198
199
200
    fi

    if [ ! -z "$FRAMEWORK" ]; then
201
        FRAMEWORK=${FRAMEWORK^^}
202

203
204
205
        if [[ ! -n "${FRAMEWORKS[$FRAMEWORK]}" ]]; then
            error 'ERROR: Unknown framework: ' $FRAMEWORK
        fi
206

207
208
209
210
        if [ -z $BASE_IMAGE_TAG ]; then
            BASE_IMAGE_TAG=${FRAMEWORK}_BASE_IMAGE_TAG
            BASE_IMAGE_TAG=${!BASE_IMAGE_TAG}
        fi
211

212
213
214
215
        if [ -z $BASE_IMAGE ]; then
            BASE_IMAGE=${FRAMEWORK}_BASE_IMAGE
            BASE_IMAGE=${!BASE_IMAGE}
        fi
216

217
218
219
        if [ -z $BASE_IMAGE ]; then
            error "ERROR: Framework $FRAMEWORK without BASE_IMAGE"
        fi
220

221
222
        BASE_VERSION=${FRAMEWORK}_BASE_VERSION
        BASE_VERSION=${!BASE_VERSION}
223
224
225
226

    fi

    if [ -z "$TAG" ]; then
227
        TAG="--tag dynamo:${VERSION}-${FRAMEWORK,,}"
228
229
230
        if [ ! -z ${TARGET} ]; then
            TAG="${TAG}-${TARGET}"
        fi
231
232
233
234
235
236
    fi

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

237
238
239
    if [ ! -z "$TARGET" ]; then
        TARGET_STR="--target ${TARGET}"
    fi
240
241
242
243
244
}


show_image_options() {
    echo ""
245
    echo "Building Dynamo Image: '${TAG}'"
246
247
248
249
    echo ""
    echo "   Base: '${BASE_IMAGE}'"
    echo "   Base_Image_Tag: '${BASE_IMAGE_TAG}'"
    if [[ $FRAMEWORK == "TENSORRTLLM" ]]; then
250
        echo "   Tensorrtllm_Pip_Wheel_Path: '${TENSORRTLLM_PIP_WHEEL_PATH}'"
251
252
253
254
255
256
257
258
259
260
261
262
263
    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[@]}]"
264
    echo "  [--tensorrtllm-pip-wheel-path path to tensorrtllm pip wheel]"
265
    echo "  [--build-arg additional build args to pass to docker build]"
266
267
    echo "  [--cache-from cache location to start from]"
    echo "  [--cache-to location where to cache the build output]"
268
269
270
    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
271
    echo "  [--build-context name=path to add build context]"
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
    exit 0
}

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

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

get_options "$@"


287
288
289
# Update DOCKERFILE if framework is VLLM
if [[ $FRAMEWORK == "VLLM" ]]; then
    DOCKERFILE=${SOURCE_DIR}/Dockerfile.vllm
ptarasiewiczNV's avatar
ptarasiewiczNV committed
290
291
elif [[ $FRAMEWORK == "VLLM_NIXL" ]]; then
    DOCKERFILE=${SOURCE_DIR}/Dockerfile.vllm_nixl
292
293
elif [[ $FRAMEWORK == "TENSORRTLLM" ]]; then
    DOCKERFILE=${SOURCE_DIR}/Dockerfile.tensorrt_llm
294
295
fi

296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
if [[ $FRAMEWORK == "VLLM_NIXL" ]]; then
    TEMP_DIR=$(mktemp -d)

    # Clean up temp directory on script exit
    trap 'rm -rf "$TEMP_DIR"' EXIT

    # Clone original NIXL to temp directory

    if [ ! -z ${GITHUB_TOKEN} ]; then
        git clone https://oauth2:${GITHUB_TOKEN}@github.com/${NIXL_REPO} "$TEMP_DIR/nixl_src"
    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} "$TEMP_DIR/nixl_src"; then
            echo "HTTPS clone failed, falling back to SSH..."
            git clone git@github.com:${NIXL_REPO} "$TEMP_DIR/nixl_src"
        fi
    fi

    cd "$TEMP_DIR/nixl_src"

    git checkout ${NIXL_COMMIT}

    BUILD_CONTEXT_ARG+=" --build-context nixl=$TEMP_DIR/nixl_src"
fi

321
322
# BUILD DEV IMAGE

323
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"
324
325
326
327
328
329
330
331
332

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

333
334
335
336
337
338
if [[ $FRAMEWORK == "TENSORRTLLM" ]]; then
    if [ ! -z ${TENSORRTLLM_PIP_WHEEL_PATH} ]; then
        BUILD_ARGS+=" --build-arg TENSORRTLLM_PIP_WHEEL_PATH=${TENSORRTLLM_PIP_WHEEL_PATH} "
    else
        error "ERROR: --tensorrtllm-pip-wheel-path is not provided"
    fi
339
340
341
342
343
344
fi

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

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

350
351
352
353
354
355
show_image_options

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

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

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

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

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