Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Justfile improvements #274

Open
wants to merge 27 commits into
base: main
Choose a base branch
from
Open
Changes from 23 commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
5308c0d
+ docker login ngc to setup ; image exists short-circut option for build
malcolmgreaves Oct 7, 2024
283a152
wip
malcolmgreaves Oct 7, 2024
e6773ba
must use string??
malcolmgreaves Oct 7, 2024
a61e81d
wip -- adding --all flag for download_all_resources
malcolmgreaves Oct 7, 2024
d3017e2
refactor, don't reference args.
malcolmgreaves Oct 7, 2024
f608be5
improve: no separate function
malcolmgreaves Oct 7, 2024
7dd80f3
revert name change
malcolmgreaves Oct 7, 2024
e6dc2aa
print absolute path
malcolmgreaves Oct 7, 2024
264e49a
make API keys not print to output
malcolmgreaves Oct 8, 2024
ce57b24
show info
malcolmgreaves Oct 8, 2024
7a7556d
wip
malcolmgreaves Oct 8, 2024
5acf3dc
Merge branch 'main' into mg/just++
malcolmgreaves Oct 8, 2024
0a16785
Merge branch 'main' into mg/just++
malcolmgreaves Oct 9, 2024
60d2059
Merge branch 'main' into mg/just++
malcolmgreaves Oct 15, 2024
49c5ca7
or plain docker login nvcr.io to reuse existing creds
malcolmgreaves Oct 15, 2024
9d95506
Merge branch 'main' into mg/just++
malcolmgreaves Oct 17, 2024
ed3242b
Merge branch 'main' into mg/just++
malcolmgreaves Oct 23, 2024
50318bb
Merge branch 'main' into mg/just++
malcolmgreaves Oct 23, 2024
5089bf5
moved to https://github.com/NVIDIA/bionemo-framework/pull/358
malcolmgreaves Oct 23, 2024
25cb1d8
Merge branch 'main' into mg/just++
malcolmgreaves Oct 23, 2024
7ec5af8
Merge branch 'main' into mg/just++
malcolmgreaves Oct 25, 2024
0cac6f2
Merge branch 'main' into mg/just++
malcolmgreaves Oct 28, 2024
91d4dcf
Merge branch 'main' into mg/just++
malcolmgreaves Oct 28, 2024
0cb3c25
peter's suggestion -- ask git for repo root
malcolmgreaves Oct 28, 2024
9934f2f
Merge branch 'main' into mg/just++
malcolmgreaves Oct 29, 2024
effadac
Merge branch 'main' into mg/just++
malcolmgreaves Oct 29, 2024
60e2bc3
Merge branch 'main' into mg/just++
malcolmgreaves Nov 1, 2024
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
126 changes: 107 additions & 19 deletions justfile
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,94 @@ set dotenv-load
set export

# don't fail fast here --> the `setup` command will check this!
LOCAL_REPO_PATH := `realpath $(pwd)`
DOCKER_REPO_PATH := '/workspace/bionemo2'
COMMIT := `git rev-parse HEAD || true`
IMAGE_TAG := "bionemo2-" + COMMIT
DEV_IMAGE_TAG := "dev-" + IMAGE_TAG
DATE := `date --iso-8601=seconds -u`
LOCAL_ENV := '.env'
DOCKER_REPO_PATH := '/workspace/bionemo2'
LOCAL_REPO_PATH := `realpath $(pwd)`
DATE := if os() == "macos" {
shell('date -u +"%Y-%m-%dT%H:%M:%SZ"')
} else if os_family() == "unix" {
shell('date --iso-8601=seconds -u')
} else {
error("Unrecognized operating system! os: {{os()}} | os_family: {{os_family()}}")
}


#
# MAKE SURE default IS THE FIRST RECIPE
#

[private]
default:
@just --list

###############################################################################

# Prints known in-use environment & justfile variables. Use to check what variable values are used.
env:
#!/usr/bin/env bash

set -eo pipefail

# Hide sensitive information !!
#
# Do not display passwords, api keys, etc. Replace with '*' tokens.

# w&b
if [[ "${WANDB_API_KEY}" != "" && "${WANDB_API_KEY}" != "NotSpecified" ]]; then
display_wandb="************************************"
fi
# ngc
if [[ "${NGC_CLI_API_KEY}" != "" && "${NGC_CLI_API_KEY}" != "NotSpecified" ]]; then
display_ngc="************************************"
fi
# aws
if [[ "${AWS_ACCESS_KEY_ID}" != "" && "${AWS_ACCESS_KEY_ID}" != "NotSpecified" ]]; then
display_aws_access="************************************"
fi
if [[ "${AWS_SECRET_ACCESS_KEY}" != "" && "${AWS_SECRET_ACCESS_KEY}" != "NotSpecified" ]]; then
display_aws_secret="************************************"
fi

# Print out all of the known used environment variables.
# This is best-effort, but it is driven by looking at the:
# - .env file
# - variables defined in this justfile
#
# Any unset variable will display and error instead of an empty string.
#
# NOTE: this relies on `set dotenv-load` & `set export` being enabled in this justfile!

# from justfile
echo "COMMIT: ${COMMIT:=!! ERROR - not set !!}"
echo "DATE: ${DATE:=!! ERROR - not set !!}"
echo "IMAGE_TAG: ${IMAGE_TAG:=!! ERROR - not set !!}"
echo "DEV_IMAGE_TAG: ${DEV_IMAGE_TAG:=!! ERROR - not set !!}"
echo "LOCAL_REPO_PATH: ${LOCAL_REPO_PATH:=!! ERROR - not set !!}"
echo "DOCKER_REPO_PATH: ${DOCKER_REPO_PATH:=!! ERROR - not set !!}"
# from .env file
echo "LOCAL_RESULTS_PATH: ${LOCAL_RESULTS_PATH:=!! ERROR - not set !!}"
echo "DOCKER_RESULTS_PATH: ${DOCKER_RESULTS_PATH:=!! ERROR - not set !!}"
echo "LOCAL_DATA_PATH: ${LOCAL_DATA_PATH:=!! ERROR - not set !!}"
echo "DOCKER_DATA_PATH: ${DOCKER_DATA_PATH:=!! ERROR - not set !!}"
echo "LOCAL_MODELS_PATH: ${LOCAL_MODELS_PATH:=!! ERROR - not set !!}"
echo "DOCKER_MODELS_PATH: ${DOCKER_MODELS_PATH:=!! ERROR - not set !!}"
echo "WANDB_API_KEY: ${display_wandb:=!! ERROR - not set !!}"
echo "JUPYTER_PORT: ${JUPYTER_PORT:=!! ERROR - not set !!}"
echo "REGISTRY: ${REGISTRY:=!! ERROR - not set !!}"
echo "REGISTRY_USER: ${REGISTRY_USER:=!! ERROR - not set !!}"
echo "DEV_CONT_NAME: ${DEV_CONT_NAME:=!! ERROR - not set !!}"
echo "NGC_CLI_API_KEY: ${display_ngc:=!! ERROR - not set !!}"
echo "NGC_CLI_ORG: ${NGC_CLI_ORG:=!! ERROR - not set !!}"
echo "NGC_CLI_TEAM: ${NGC_CLI_TEAM:=!! ERROR - not set !!}"
echo "NGC_CLI_FORMAT_TYPE: ${NGC_CLI_FORMAT_TYPE:=!! ERROR - not set !!}"
echo "AWS_ENDPOINT_URL: ${AWS_ENDPOINT_URL:=!! ERROR - not set !!}"
echo "AWS_ACCESS_KEY_ID: ${display_aws_access:=!! ERROR - not set !!}"
echo "AWS_SECRET_ACCESS_KEY: ${display_aws_secret:=!! ERROR - not set !!}"
echo "AWS_REGION: ${AWS_REGION:=!! ERROR - not set !!}"


[private]
check_preconditions:
#!/usr/bin/env bash
Expand Down Expand Up @@ -54,10 +128,14 @@ check_preconditions:
exit 1
fi

# WARNING! Do not show the user's ** PRIVATE API KEY ** on the CLI!
# WARNING! Make sure the login command is prefixed with '@' -- this prevents `just` from echoing the command out!

# Checks for installed programs (docker, git, etc.), their versions, and grabs the latest cache image.
setup: check_preconditions
./internal/scripts/setup_env_file.sh
@echo "Authenticating with NGC registry: nvcr.io"
@docker login nvcr.io --username '$oauthtoken' --password ${NGC_CLI_API_KEY} || docker login nvcr.io
@echo "Pulling updated cache..."
docker pull ${IMAGE_REPO}:${CACHE_TAG} || true

Expand Down Expand Up @@ -87,26 +165,36 @@ assert_clean_git_repo:

###############################################################################

# General image build command. Assumes executation @ repo. root and use with the Dockerfile's targets.
[private]
build image_tag target: setup assert_clean_git_repo
DOCKER_BUILDKIT=1 docker buildx build \
-t ${IMAGE_REPO}:{{image_tag}} \
--target={{target}} \
--load \
--cache-to type=inline \
--cache-from ${IMAGE_REPO}:${CACHE_TAG} \
--label com.nvidia.bionemo.git_sha=${COMMIT} \
--label com.nvidia.bionemo.created_at=${DATE} \
-f ./Dockerfile \
.
build image_tag target skip_if_exists='false': setup assert_clean_git_repo
#!/usr/bin/env bash

IMAGE_NAME="${IMAGE_REPO}:{{image_tag}}"
if [[ "{{skip_if_exists}}" == "true" && -z "$(docker images -q ${IMAGE_NAME} 2> /dev/null)" ]]; then
echo "Image already exists, skipping build for: ${IMAGE_NAME}"
else
set -euo pipefail
set -x
DOCKER_BUILDKIT=1 docker buildx build \
-t ${IMAGE_NAME} \
--target={{target}} \
--load \
--cache-to type=inline \
--cache-from ${IMAGE_REPO}:${CACHE_TAG} \
--label com.nvidia.bionemo.git_sha=${COMMIT} \
--label com.nvidia.bionemo.created_at=${DATE} \
-f ./Dockerfile \
.
fi

# Builds the release image.
build-release:
@just build ${IMAGE_TAG} release
@just build ${IMAGE_TAG} release skip_if_exists=true

# Builds the development image.
build-dev:
@just build ${DEV_IMAGE_TAG} development
@just build ${DEV_IMAGE_TAG} development skip_if_exists=true

###############################################################################

Expand All @@ -131,8 +219,8 @@ run is_dev is_interactive image_tag cmd: setup
-e TMPDIR=/tmp/ \
-e NUMBA_CACHE_DIR=/tmp/ \
-e BIONEMO_HOME=$DOCKER_REPO_PATH \
-e WANDB_API_KEY=$WANDB_API_KEY \
-e NGC_CLI_API_KEY=$NGC_CLI_API_KEY \
-e WANDB_API_KEY \
-e NGC_CLI_API_KEY \
-e NGC_CLI_ORG=$NGC_CLI_ORG \
-e NGC_CLI_TEAM=$NGC_CLI_TEAM \
-e NGC_CLI_FORMAT_TYPE=$NGC_CLI_FORMAT_TYPE \
Expand Down
Loading