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.

Sign up for GitHub

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

Jump to bottom

add EXTRA_INDEX_URL support to makefiles and fix issue with DOCKER_IM… #53

Merged
merged 2 commits into from
May 7, 2024
Merged

add EXTRA_INDEX_URL support to makefiles and fix issue with DOCKER_IM… #53

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
03ee01d
add EXTRA_INDEX_URL support to makefiles and fix issue with DOCKER_IM…
daw3rd May 1, 2024
e9384a8
Doc on EXTRA_INDEX_URL
daw3rd May 3, 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
30 changes: 23 additions & 7 deletions .make.defaults
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,15 @@
# Before including, the following must be defined:
# REPOROOT points to the top of the git repository.
# For example REPOROOT=../../..

# DOCKER_NAME - defines the name of the docker image
# For example DOCKER_NAME=noop
# EXTRA_INDEX_URL - can define an additional pipy index for use
# in creating venv and images. This will be used on pip installs
# when building the venv and will be made available as
# a docker build argument when building the docker image.
# This is useful when the repo is used in conjunction with an
# inhouse or private pypi.
#
# Targets defined here use double colon so can be overriden
#
# Reusable rules begin with '.'. To reuse without modification, for example,
Expand All @@ -25,13 +33,14 @@ PYTEST=pytest -s
PYTHON_VERSION=$(shell $(PYTHON) --version)
ABS_REPOROOT=$(shell (cd $(REPOROOT); pwd))
DOCKER_FILE?=Dockerfile
DOCKER_NAME?=data-prep-lab
#DOCKER_NAME?=xyzzy # Must be defined by the includeing makefile
DOCKER?=docker
DOCKER_HOSTNAME?=quay.io
DOCKER_NAMESPACE ?= dataprep1
DOCKER_REGISTRY_USER?=$(DPL_DOCKER_REGISTRY_USER)
DOCKER_REGISTRY_KEY?=$(DPL_DOCKER_REGISTRY_KEY)
DOCKER_REGISTRY_ENDPOINT?=$(DOCKER_HOSTNAME)/$(DOCKER_NAMESPACE)/$(DOCKER_NAME)
DOCKER_REGISTRY_ENDPOINT?=$(DOCKER_HOSTNAME)/$(DOCKER_NAMESPACE)
DOCKER_IMAGE?=${DOCKER_REGISTRY_ENDPOINT}/$(DOCKER_NAME):$(DOCKER_IMAGE_VERSION)
include $(REPOROOT)/.make.versions

#######################################################################################
Expand Down Expand Up @@ -151,8 +160,9 @@ __check_defined = \
.PHONY: .defaults.image
.defaults.image:: # Must be called with a DOCKER_IMAGE= settings.
@# Help: Create the docker image $(DOCKER_IMAGE)
$(DOCKER) build -t $(DOCKER_IMAGE) \
--build-arg BUILD_DATE=$(shell date -u +'%Y-%m-%dT%H:%M:%SZ') \
$(DOCKER) build -t $(DOCKER_IMAGE) \
--build-arg EXTRA_INDEX_URL=$(EXTRA_INDEX_URL) \
--build-arg BUILD_DATE=$(shell date -u +'%Y-%m-%dT%H:%M:%SZ') \
--build-arg GIT_COMMIT=$(shell git log -1 --format=%h) .

.PHONY: .defaults.lib-src-image
Expand All @@ -175,7 +185,10 @@ __check_defined = \
source venv/bin/activate; \
pip install pytest; \
pip uninstall -y data-prep-lab; \
pip install -e $(REPOROOT)/data-processing-lib/; \
if [ ! -z "$(EXTRA_INDEX_URL)" ]; then \
extra_url='--extra-index-url $(EXTRA_INDEX_URL)'; \
fi; \
pip install $${extra_url} -e $(REPOROOT)/data-processing-lib/; \
if [ $$? -eq 0 ]; then \
echo Installed source from data processing library for `which $(PYTHON)`; \
else \
Expand Down Expand Up @@ -232,7 +245,10 @@ __check_defined = \
@source venv/bin/activate; \
pip install --upgrade pip; \
pip install wheel; \
pip install -r requirements.txt; \
if [ ! -z "$(EXTRA_INDEX_URL)" ]; then \
extra_url='--extra-index-url $(EXTRA_INDEX_URL)'; \
fi; \
pip install $$extra_url -r requirements.txt;

.PHONY: .defaults.check.installed
.defaults.check.installed::
Expand Down
9 changes: 4 additions & 5 deletions transforms/.make.transforms
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
# REPOROOT points to the top of the git repository.
# For example REPOROOT=../../..
# TRANSFORM_NAME defines the name of the transform and is used to derive
# DOCKER_IMAGE_NAME and TRANSFORM_SRC_FILE if not already defined.
# DOCKER_NAME and TRANSFORM_SRC_FILE if not already defined.

# Optional inputs (that have defaults)
# TRANSFORM_SRC_FILE is the base name of the python source file containing the main()
# that is used to launch the transform in Ray.
# By convention this name defaults to $(TRANSFORM_NAME)_transform.py.
# This file is then assumed to be in the home dir of the docker image and
# can be run with "python $(TRANSFORM_SRC_FILE) --help"
# DOCKER_IMAGE_NAME is the name of the docker image.
# DOCKER_NAME is the name of the docker image.
# By default its value is $(TRANSFORM_NAME).
#
# Targets defined here use double colon so can be overriden
Expand All @@ -28,8 +28,8 @@
#######################################################################################
include $(REPOROOT)/.make.defaults

DOCKER_IMAGE_NAME?=$(TRANSFORM_NAME)
DOCKER_IMAGE=${DOCKER_REGISTRY_ENDPOINT}/$(DOCKER_IMAGE_NAME):$(DOCKER_IMAGE_VERSION)
DOCKER_NAME?=$(TRANSFORM_NAME)
#DOCKER_IMAGE=${DOCKER_REGISTRY_ENDPOINT}/$(DOCKER_NAME):$(DOCKER_IMAGE_VERSION)
# By convention the name of the python file is as follows and contains a main to start the ray-based transform
# This file is used when starting the transformers in the Docker image.
TRANSFORM_SRC_FILE?=$(TRANSFORM_NAME)_transform.py
Expand All @@ -51,7 +51,6 @@ extra-help:
@echo DOCKER_REGISTRY_USER - the docker user to use. DOCKER_REGISTRY_USER=$(DOCKER_REGISTRY_USER)
@echo DOCKER_REGISTRY_KEY - the docker user to use. DOCKER_REGISTRY_KEY=secret
@echo PYTHON - the python executable to use. PYTHON=$(PYTHON)
@echo DOCKER_IMAGE_NAME - the name of the docker image to produce. DOCKER_IMAGE_NAME=$(DOCKER_IMAGE_NAME)
@echo "TRANSFORM_SRC_FILE is the base name of the python source file containing the main() (e.g. noop_local_ray.py)"
@echo ""

Expand Down