Dockerfile

# syntax=docker/dockerfile:1.4
# Copyright 2021 Agnostiq Inc.
#
# This file is part of Covalent.
#
# Licensed under the Apache License 2.0 (the "License"). A copy of the
# License may be obtained with this software package or at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Use of this file is prohibited except in compliance with the License.
# 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.

#######################
# Docker Build Options
#######################

# Options are local,pypi,sha
ARG COVALENT_SOURCE=local
# Options are sdk,server
ARG COVALENT_INSTALL_TYPE=server
# Must include a compatible version of Python
ARG COVALENT_BASE_IMAGE=docker.io/python:3.8-slim-bullseye

###################
# Covalent Options
###################

# Installation path
ARG COVALENT_ROOT=/var/lib/covalent
# Configuration file path
ARG COVALENT_CONFIG_DIR=/etc/covalent
# Service port for dispatcher / UI
ARG COVALENT_SVC_PORT=48008
# Local plugins path
ARG COVALENT_PLUGINS_DIR=/etc/covalent/plugins
# SQLite database path (do not use in production)
ARG COVALENT_DATABASE=/var/lib/covalent/dispatch.db
# Remote database path (overrides SQLite database if defined)
ARG COVALENT_DATABASE_URL=""
# Local object storage path
ARG COVALENT_DATA_DIR=/var/lib/covalent/data
# Log file path
ARG COVALENT_LOGDIR=/var/log/covalent
# Cache path
ARG COVALENT_CACHE_DIR=/var/cache/covalent
# Debug mode
ARG COVALENT_DEBUG_MODE=1

########################
# Covalent Dask Options
########################

# Disable Dask inside the container
ARG COVALENT_DISABLE_DASK=1
# Number of Dask workers used by dispatcher
ARG COVALENT_NUM_WORKERS=1
# Number of threads per Dask worker
ARG COVALENT_THREADS_PER_WORKER=1
# Memory per worker (in GB)
ARG COVALENT_MEM_PER_WORKER=1GB

##################
# Global Settings
##################

FROM ${COVALENT_BASE_IMAGE} as base

ARG COVALENT_ROOT
ARG COVALENT_CONFIG_DIR
ARG COVALENT_PLUGINS_DIR
ARG COVALENT_LOGDIR
ARG COVALENT_CACHE_DIR

ENV PYTHONHASHSEED=random \
    PYTHONUNBUFFERED=1 \
    DEBIAN_FRONTEND=noninteractive \
    BUILDROOT=/build \
    INSTALLROOT=${COVALENT_ROOT} \
    USER=covalent \
    COVALENT_ROOT=${COVALENT_ROOT} \
    COVALENT_CONFIG_DIR=${COVALENT_CONFIG_DIR} \
    COVALENT_PLUGINS_DIR=${COVALENT_PLUGINS_DIR} \
    COVALENT_LOGDIR=${COVALENT_LOGDIR} \
    COVALENT_CACHE_DIR=${COVALENT_CACHE_DIR}

USER root

RUN <<EOL
  mkdir -p \
    ${COVALENT_CONFIG_DIR} \
    ${COVALENT_PLUGINS_DIR} \
    ${COVALENT_LOGDIR} \
    ${COVALENT_CACHE_DIR} \
    ${INSTALLROOT}
EOL

WORKDIR ${BUILDROOT}

#########################
# Base Build Environment
#########################

FROM base AS build_base

RUN <<EOL
  apt-get update
  apt-get install -y --no-install-recommends \
    git \
    rsync \
    unzip \
    vim \
    wget
  rm -rf /var/lib/apt/lists/*
  python -m venv --copies $INSTALLROOT/.venv
  python -m pip install --upgrade pip
EOL

ENV PATH=$INSTALLROOT/.venv/bin:$PATH

ENTRYPOINT [ "/bin/bash" ]

########################
# SDK Build Environment
########################

FROM build_base as build_sdk

ENV COVALENT_SDK_ONLY=1

###########################
# Server Build Environment
###########################

FROM build_base as build_server

RUN <<EOL
  apt-get update
  apt-get install -y --no-install-recommends \
    curl \
    gcc
  curl -sL https://deb.nodesource.com/setup_16.x | bash -
  apt-get install -y nodejs
  npm install --global yarn
  rm -rf /var/lib/apt/lists/*
EOL

################################
# Obtain Local Copy of Covalent
################################

FROM build_base as covalent_local_src

COPY . $BUILDROOT

###########################
# Fetch Covalent from PyPI
###########################

FROM build_base as covalent_pypi_src

ARG COVALENT_RELEASE

RUN python -m pip download --no-deps -d $BUILDROOT/dist covalent==${COVALENT_RELEASE}

#################################
# Fetch Covalent from GitHub SHA
#################################

FROM build_base as covalent_sha_src

ARG COVALENT_COMMIT_SHA

RUN <<EOL
  wget https://github.com/AgnostiqHQ/covalent/archive/${COVALENT_COMMIT_SHA}.zip
  unzip -d $BUILDROOT ${COVALENT_COMMIT_SHA}.zip
  mv $BUILDROOT/covalent-${COVALENT_COMMIT_SHA}/* $BUILDROOT/
EOL

############################
# Alias the Covalent Source
############################

FROM covalent_${COVALENT_SOURCE}_src as covalent_src

#####################
# Build Covalent SDK
#####################

FROM build_sdk as covalent_sdk

COPY --from=covalent_src $BUILDROOT/ $BUILDROOT

RUN <<EOL
  if [ ! -d $BUILDROOT/dist ] ; then
    python setup.py sdist
  fi
  python -m pip install dist/covalent-*.tar.gz
  # The following line can be removed once covalent#1489 is merged
  python -m pip install dask[distributed]==2022.9.0
EOL

########################
# Build Covalent Server
########################

FROM build_server as covalent_server

ARG COVALENT_BASE_IMAGE

LABEL org.opencontainers.image.title="Covalent Build Environment"
LABEL org.opencontainers.image.vendor="Agnostiq"
LABEL org.opencontainers.image.url="https://covalent.xyz"
LABEL org.opencontainers.image.documentation="https://covalent.readthedocs.io"
LABEL org.opencontainers.image.licenses="Apache License 2.0"
LABEL org.opencontainers.image.base.name="${COVALENT_BASE_IMAGE}"

COPY --from=covalent_src $BUILDROOT/ $BUILDROOT

RUN <<EOL
  if [ ! -d $BUILDROOT/dist ] ; then
    cd $BUILDROOT/covalent_ui/webapp
    yarn install --network-timeout 100000
    yarn build --network-timeout 100000
    cd $BUILDROOT
    python setup.py sdist
  fi
  python -m pip install dist/covalent-*.tar.gz
EOL

##############################
# Alias Covalent Installation
##############################

FROM covalent_${COVALENT_INSTALL_TYPE} as covalent_install

#############################
# Production SDK Environment
#############################

FROM base AS prod_sdk

ARG COVALENT_DISABLE_DASK
ARG COVALENT_COMMIT_SHA
ARG COVALENT_BASE_IMAGE
ARG COVALENT_BUILD_DATE=""
ARG COVALENT_BUILD_VERSION=""

LABEL org.opencontainers.image.title="Covalent SDK"
LABEL org.opencontainers.image.vendor="Agnostiq"
LABEL org.opencontainers.image.url="https://covalent.xyz"
LABEL org.opencontainers.image.documentation="https://covalent.readthedocs.io"
LABEL org.opencontainers.image.source="https://github.com/AgnostiqHQ/covalent"
LABEL org.opencontainers.image.licenses="Apache License 2.0"
LABEL org.opencontainers.image.created="${COVALENT_BUILD_DATE}"
LABEL org.opencontainers.image.version="${COVALENT_BUILD_VERSION}"
LABEL org.opencontainers.image.revision="${COVALENT_COMMIT_SHA}"
LABEL org.opencontainers.image.base.name="${COVALENT_BASE_IMAGE}"

COPY --from=build_base /usr/bin/rsync /usr/bin/rsync
COPY --from=build_base /usr/lib/x86_64-linux-gnu/libpopt.so.0 /usr/lib/x86_64-linux-gnu/libpopt.so.0

COPY --from=covalent_install $INSTALLROOT/.venv/ $INSTALLROOT/.venv

RUN <<EOL
  /usr/sbin/adduser --shell /bin/bash --disabled-password --gecos "" ${USER}
  chown -R $USER:$USER $INSTALLROOT
  chown -R ${USER}:${USER} \
    ${COVALENT_CONFIG_DIR} \
    ${COVALENT_PLUGINS_DIR} \
    ${COVALENT_LOGDIR} \
    ${COVALENT_CACHE_DIR} \
    ${INSTALLROOT}
EOL

WORKDIR $INSTALLROOT
USER $USER
ENV PATH=$INSTALLROOT/.venv/bin:$PATH \
    COVALENT_DISABLE_DASK=${COVALENT_DISABLE_DASK}

ENTRYPOINT [ "python" ]

################################
# Production Server Environment
################################

FROM prod_sdk as prod_server

ARG COVALENT_SVC_PORT
ARG COVALENT_DATABASE_DIR
ARG COVALENT_DATABASE_URL
ARG COVALENT_DATA_DIR
ARG COVALENT_DEBUG_MODE
ARG COVALENT_DISABLE_DASK
ARG COVALENT_NUM_WORKERS
ARG COVALENT_THREADS_PER_WORKER
ARG COVALENT_MEM_PER_WORKER

LABEL org.opencontainers.image.title="Covalent Server"

COPY --from=build_base /usr/bin/wget /usr/bin/wget
COPY --from=build_base /usr/lib/x86_64-linux-gnu/libpcre2-8.so.0 /usr/lib/x86_64-linux-gnu/libpcre2-8.so.0
COPY --from=build_base /usr/lib/x86_64-linux-gnu/libpsl.so.5 /usr/lib/x86_64-linux-gnu/libpsl.so.5

USER root

RUN <<EOL
  mkdir -p ${COVALENT_DATA_DIR}
  chown -R ${USER}:${USER} ${COVALENT_DATA_DIR}
EOL

USER $USER

ENV COVALENT_SVC_PORT=${COVALENT_SVC_PORT} \
    COVALENT_DATABASE_DIR=${COVALENT_DATABASE_DIR} \
    COVALENT_DATABASE_URL=${COVALENT_DATABASE_URL} \
    COVALENT_DATA_DIR=${COVALENT_DATA_DIR} \
    COVALENT_DEBUG_MODE=${COVALENT_DEBUG_MODE} \
    COVALENT_NUM_WORKERS=${COVALENT_NUM_WORKERS} \
    COVALENT_THREADS_PER_WORKER=${COVALENT_THREADS_PER_WORKER} \
    COVALENT_MEM_PER_WORKER=${COVALENT_MEM_PER_WORKER} \
    COVALENT_DISABLE_DASK=${COVALENT_DISABLE_DASK} \
    COVALENT_SERVER_IFACE_ANY=1

EXPOSE ${COVALENT_SVC_PORT}

HEALTHCHECK CMD wget --no-verbose --tries=1 --spider http://localhost:${COVALENT_SVC_PORT} || exit 1

ENTRYPOINT [ "/bin/bash" ]

CMD [ "-c", "covalent start --workers ${COVALENT_NUM_WORKERS} --threads-per-worker ${COVALENT_THREADS_PER_WORKER} --mem-per-worker ${COVALENT_MEM_PER_WORKER} --port ${COVALENT_SVC_PORT} && tail -f ${COVALENT_LOGDIR}/covalent_ui.log" ]

#########################
# Alias Production Image
#########################

FROM prod_${COVALENT_INSTALL_TYPE} as prod