Various bugfixes to Dockerfiles and new matrix style workflows to build and publish containers for all dockerfiles for 4 releases of MATLAB

Author: Prabhakar Kumar

.github/actions/build-and-push-notebook/action.yml

@@ -0,0 +1,22 @@
+runs:
+  using: "composite"
+  steps:
+    - uses: actions/checkout@v2
+
+    - uses: docker/setup-buildx-action@v1
+
+    - uses: docker/login-action@v1 
+      with:
+        registry: ${{ inputs.registry }}
+        username: ${{ github.repository_owner }}
+        password: ${{ inputs.github_token }}
+
+    - uses: docker/build-push-action@v2
+      with:
+        context: ${{ inputs.context }}
+        platforms: linux/amd64
+        file: ${{ inputs.dockerfile }}
+        tags: ${{ inputs.registry }}/${{ inputs.github_repo }}/${{ inputs.image }}:${{ inputs.matlab_release }}
+        build-args: MATLAB_RELEASE=${{ inputs.matlab_release }}
+        push: true
+

.github/workflows/build-and-publish-dockerfiles.yml

@@ -0,0 +1,63 @@
+# Build & Publish all Dockerfiles in the repository, for pre-defined set of MATLAB version.
+name: Build MIFJ Dockerfiles
+
+# Define when builds will occur:
+on:
+  # Run workflow when there is a push to the 'main' branch & push includes changes to any Dockerfile or YML files
+  push:
+    branches:
+      - 'main'
+    paths:
+      - '**Dockerfile*'
+      - '**.yml'
+  
+  # Run workflow when there is a release
+  release:
+    types:
+      - 'created'
+
+  # Run at 00:00 on every Monday (1st Day of the Week) (See: crontab.guru)
+  schedule:
+    - cron: '0 0 * * 1'
+
+jobs:
+  docker:
+    # Each job needs a runner environment
+    runs-on: ubuntu-latest
+    continue-on-error: True
+    strategy:
+      matrix:
+        matlab_release: [r2022a, r2021b, r2021a, r2020b]
+        dockerfile: ["./matlab/Dockerfile", "./matlab/Dockerfile.byoi", "./matlab/Dockerfile.mounted", "./matlab-vnc/Dockerfile", "./matlab-vnc/Dockerfile.mounted"]
+        include:
+        - image: "jupyter-matlab-notebook"
+          dockerfile: "./matlab/Dockerfile"
+          context: "./matlab"
+
+        - image: "jupyter-byoi-matlab-notebook"
+          dockerfile: "./matlab/Dockerfile.byoi"
+          context: "./matlab"
+
+        - image: "jupyter-mounted-matlab-notebook"
+          dockerfile: "./matlab/Dockerfile.mounted"
+          context: "./matlab"
+
+        - image: "jupyter-matlab-vnc-notebook"
+          dockerfile: "./matlab-vnc/Dockerfile"
+          context: "./matlab-vnc"
+
+        - image: "jupyter-mounted-matlab-vnc-notebook"
+          dockerfile: "./matlab-vnc/Dockerfile.mounted"
+          context: "./matlab-vnc"
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ./.github/actions/build-and-push-notebook
+        with:
+          dockerfile: ${{ matrix.dockerfile }}
+          context: ${{ matrix.context }}
+          matlab_release: ${{ matrix.matlab_release }}
+          image: ${{ matrix.image }}
+          registry: ghcr.io
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          github_repo: ${{ github.repository }}

.github/workflows/build-and-publish-notebook.yml

@@ -1,109 +1,62 @@
-# Copyright 2021 The MathWorks, Inc.
-
-# Argument shared across multi-stage build to hold location of installed MATLAB 
-ARG BASE_ML_INSTALL_LOC=/tmp/matlab-install-location
-
-# Replace "mathworks/matlab:r2021b" with the Docker image that contains MATLAB
-# MATLAB should be available on the path in the Docker image
-FROM mathworks/matlab:r2021b AS matlab-install-stage
-ARG BASE_ML_INSTALL_LOC
-
-# Run code to locate a MATLAB install in the base image and softlink
-# to BASE_ML_INSTALL_LOC for a latter stage to copy 
-RUN export ML_INSTALL_LOC=$(which matlab) \
-    && if [ ! -z "$ML_INSTALL_LOC" ]; then \
-        ML_INSTALL_LOC=$(dirname $(dirname $(readlink -f ${ML_INSTALL_LOC}))); \
-        echo "soft linking: " $ML_INSTALL_LOC " to" ${BASE_ML_INSTALL_LOC}; \
-        ln -s ${ML_INSTALL_LOC} ${BASE_ML_INSTALL_LOC}; \
-    elif [ $BASE_ML_INSTALL_LOC = '/tmp/matlab-install-location' ]; then \
-        echo "MATLAB was not found in your image."; exit 1; \
-    else \
-        echo "Proceeding with user provided path to MATLAB installation: ${BASE_ML_INSTALL_LOC}"; \
-    fi
-
-FROM jupyter/base-notebook
-ARG BASE_ML_INSTALL_LOC
+# Copyright 2021-2022 The MathWorks, Inc.
+# Builds Docker image with 
+# 1. MATLAB - Using MPM
+# 2. MATLAB Integration for Jupyter (VNC)
+# on a base image of jupyter/base-notebook.
+
+## Sample Build Command:
+# docker build --build-arg MATLAB_RELEASE=r2022a \
+#              --build-arg MATLAB_PRODUCT_LIST="MATLAB Deep_Learning_Toolbox Symbolic_Math_Toolbox"\
+#              --build-arg [email protected] \
+#              -t my_matlab_image_name .
+
+# Specify release of MATLAB to build. (use lowercase, default is r2022a)
+ARG MATLAB_RELEASE=r2022a
+
+# Specify the list of products to install into MATLAB, 
+ARG MATLAB_PRODUCT_LIST="MATLAB"
+
+# Optional Network License Server information
+ARG LICENSE_SERVER
+
+# If LICENSE_SERVER is provided then SHOULD_USE_LICENSE_SERVER will be set to "_use_lm"
+ARG SHOULD_USE_LICENSE_SERVER=${LICENSE_SERVER:+"_with_lm"}
+
+# Default DDUX information
+ARG MW_CONTEXT_TAGS=MATLAB_PROXY:JUPYTER:MPM:V1
+
+# Base Jupyter image without LICENSE_SERVER, using python-3.9.12 as websockify only supports upto 3.9
+FROM jupyter/base-notebook:python-3.9.12 AS base_jupyter_image
+
+# Base Jupyter image with LICENSE_SERVER
+FROM jupyter/base-notebook:python-3.9.12 AS base_jupyter_image_with_lm
+ARG LICENSE_SERVER
+# If license server information is available, then use it to set environment variable
+ENV MLM_LICENSE_FILE=${LICENSE_SERVER}
+
+# Select base Jupyter image based on whether LICENSE_SERVER is provided
+FROM base_jupyter_image${SHOULD_USE_LICENSE_SERVER}
+ARG MW_CONTEXT_TAGS
+ARG MATLAB_RELEASE
+ARG MATLAB_PRODUCT_LIST
 
 # Switch to root user
 USER root
+ENV DEBIAN_FRONTEND="noninteractive" TZ="Etc/UTC"
 
-# Copy MATLAB install from Docker image
-COPY --from=matlab-install-stage ${BASE_ML_INSTALL_LOC} /usr/local/MATLAB
-
-# Add MATLAB to the path
-RUN ln -s /usr/local/MATLAB/bin/matlab /usr/local/bin/matlab
-
-## Install MATLAB dependencies
-# Please update this list for the version of MATLAB you are using.
-# Listed below are the dependencies of R2021b for Ubuntu 20.04
-# Reference: https://github.com/mathworks-ref-arch/container-images/tree/master/matlab-deps/r2021b
-RUN export DEBIAN_FRONTEND=noninteractive && apt-get update && apt-get install --no-install-recommends -y \
-    ca-certificates \
-    libasound2 \
-    libatk-bridge2.0-0 \
-    libatk1.0-0 \
-    libatspi2.0-0 \
-    libc6 \
-    libcairo-gobject2 \
-    libcairo2 \
-    libcap2 \
-    libcrypt1 \
-    libcups2 \
-    libdbus-1-3 \
-    libdrm2 \
-    libfontconfig1 \
-    libgbm1 \
-    libgdk-pixbuf2.0-0 \
-    libglib2.0-0 \
-    libgomp1 \
-    libgstreamer-plugins-base1.0-0 \
-    libgstreamer1.0-0 \
-    libgtk-3-0 \
-    libnspr4 \
-    libnss3 \
-    libodbc1 \
-    libpam0g \
-    libpango-1.0-0 \
-    libpangocairo-1.0-0 \
-    libpangoft2-1.0-0 \
-    libpython3.9 \
-    libsm6 \
-    libsndfile1 \
-    libssl1.1 \
-    libuuid1 \
-    libx11-6 \
-    libx11-xcb1 \
-    libxcb-dri3-0 \
-    libxcb1 \
-    libxcomposite1 \
-    libxcursor1 \
-    libxdamage1 \
-    libxext6 \
-    libxfixes3 \
-    libxft2 \
-    libxi6 \
-    libxinerama1 \
-    libxrandr2 \
-    libxrender1 \
-    libxt6 \
-    libxtst6 \
-    libxxf86vm1 \
-    locales \
-    locales-all \
-    make \
-    net-tools \
-    procps \
-    sudo \
-    unzip \
-    zlib1g \
-    && apt-get clean \
-    && apt-get -y autoremove \
-    && rm -rf /var/lib/apt/lists/*
+## Installing Dependencies for Ubuntu 20.04
+# For MATLAB : Get base-dependencies.txt from matlab-deps repository on GitHub
+# For mpm : wget, unzip, ca-certificates
+# For MATLAB Integration for Jupyter (VNC): xvfb dbus-x11 firefox xfce4 xfce4-panel xfce4-session xfce4-settings xorg xubuntu-icon-theme curl xscreensaver
 
-# Install jupyter-matlab-vnc dependencies
-RUN export DEBIAN_FRONTEND=noninteractive \
-    && apt-get -y update \
-    && apt-get install -y \
+# List of MATLAB Dependencies for Ubuntu 20.04 and specified MATLAB_RELEASE
+ARG MATLAB_DEPS_REQUIREMENTS_FILE="https://raw.githubusercontent.com/mathworks-ref-arch/container-images/main/matlab-deps/${MATLAB_RELEASE}/ubuntu20.04/base-dependencies.txt"
+ARG MATLAB_DEPS_REQUIREMENTS_FILE_NAME="matlab-deps-${MATLAB_RELEASE}-base-dependencies.txt"
+
+# Install dependencies
+RUN wget ${MATLAB_DEPS_REQUIREMENTS_FILE} -O ${MATLAB_DEPS_REQUIREMENTS_FILE_NAME} && \
+    export DEBIAN_FRONTEND=noninteractive && apt-get update && \
+    xargs -a ${MATLAB_DEPS_REQUIREMENTS_FILE_NAME} -r apt-get install --no-install-recommends -y \
     dbus-x11 \
     firefox \
     xfce4 \
@@ -119,6 +72,28 @@ RUN export DEBIAN_FRONTEND=noninteractive \
     && apt-get -y autoremove \
     && rm -rf /var/lib/apt/lists/*
 
+# Run mpm to install MATLAB in the target location and delete the mpm installation afterwards
+RUN wget -q https://www.mathworks.com/mpm/glnxa64/mpm && \ 
+    chmod +x mpm && \
+    ./mpm install \
+    --release=${MATLAB_RELEASE} \
+    --destination=/opt/matlab \
+    --products ${MATLAB_PRODUCT_LIST} && \
+    rm -f mpm /tmp/mathworks_root.log && \
+    ln -s /opt/matlab/bin/matlab /usr/local/bin/matlab
+
+# Install patched glibc - See https://github.com/mathworks/build-glibc-bz-19329-patch
+WORKDIR /packages
+RUN export DEBIAN_FRONTEND=noninteractive && \
+    apt-get update && apt-get clean && apt-get autoremove && \
+    wget -q https://github.com/mathworks/build-glibc-bz-19329-patch/releases/download/ubuntu-focal/all-packages.tar.gz && \
+    tar -x -f all-packages.tar.gz \
+    --exclude glibc-*.deb \
+    --exclude libc6-dbg*.deb && \
+    apt-get install --yes --no-install-recommends --allow-downgrades ./*.deb && \
+    rm -fr /packages
+WORKDIR /
+
 # Install tigervnc to /usr/local
 RUN curl -sSfL 'https://sourceforge.net/projects/tigervnc/files/stable/1.10.1/tigervnc-1.10.1.x86_64.tar.gz/download' \
     | tar -zxf - -C /usr/local --strip=2
@@ -129,9 +104,9 @@ ARG NOVNC_PATH=/opt/noVNC
 
 # Get noVNC
 RUN mkdir -p ${NOVNC_PATH} \
-     && curl -sSfL 'https://github.com/novnc/noVNC/archive/v1.2.0.tar.gz' \
-     | tar -zxf - -C ${NOVNC_PATH} --strip=1 \
-     && chown -R ${NB_USER}:users ${NOVNC_PATH}
+    && curl -sSfL 'https://github.com/novnc/noVNC/archive/v1.2.0.tar.gz' \
+    | tar -zxf - -C ${NOVNC_PATH} --strip=1 \
+    && chown -R ${NB_USER}:users ${NOVNC_PATH}
 
 # JOVYAN is the default user in jupyter/base-notebook.
 # JOVYAN is being set to be passwordless. 
@@ -146,23 +121,21 @@ RUN conda install -y -q websockify=0.9.0
 
 # Set environment variable for python package jupyter-matlab-vnc-proxy
 ENV NOVNC_PATH=${NOVNC_PATH}
-# Pip install the integration
-RUN python -m pip install https://github.com/mathworks/jupyter-matlab-vnc-proxy/archive/0.1.0.tar.gz
+
+# Pip install the latest version of the integration
+RUN curl -s https://api.github.com/repos/mathworks/jupyter-matlab-vnc-proxy/releases/latest | grep tarball_url | cut -d '"' -f 4 | xargs python -m pip install
 
 # Ensure jupyter-server-proxy JupyterLab extension is installed
 RUN jupyter labextension install @jupyterlab/server-proxy
 
 # Move MATLAB resource files to the expected locations
 RUN export RESOURCES_LOC=$(python -c "import jupyter_matlab_vnc_proxy as pkg; print(pkg.__path__[0])")/resources \
-  && mkdir -p ${HOME}/.local/share/applications ${HOME}/Desktop ${HOME}/.local/share/ ${HOME}/.icons \
-  && cp ${RESOURCES_LOC}/MATLAB.desktop ${HOME}/Desktop/ \
-  && cp ${RESOURCES_LOC}/MATLAB.desktop ${HOME}/.local/share/applications\
-  && ln -s ${RESOURCES_LOC}/matlab_icon.png ${HOME}/.icons/matlab_icon.png \
-  && cp ${RESOURCES_LOC}/matlab_launcher.py ${HOME}/.local/share/ \
-  && cp ${RESOURCES_LOC}/mw_lite.html ${NOVNC_PATH}
+    && mkdir -p ${HOME}/.local/share/applications ${HOME}/Desktop ${HOME}/.local/share/ ${HOME}/.icons \
+    && cp ${RESOURCES_LOC}/MATLAB.desktop ${HOME}/Desktop/ \
+    && cp ${RESOURCES_LOC}/MATLAB.desktop ${HOME}/.local/share/applications\
+    && ln -s ${RESOURCES_LOC}/matlab_icon.png ${HOME}/.icons/matlab_icon.png \
+    && cp ${RESOURCES_LOC}/matlab_launcher.py ${HOME}/.local/share/ \
+    && cp ${RESOURCES_LOC}/mw_lite.html ${NOVNC_PATH}
 
 # Fixes occasional failure to start VNC desktop, which requires a reloading of the webpage to fix.
-RUN touch ${HOME}/.Xauthority
-
-# Uncomment and set the port and hostname to configure a network license manager for all users
-# ENV MLM_LICENSE_FILE port@hostname
+RUN touch ${HOME}/.Xauthority