Teghan/build one dockerfile

.github/workflows/docker-build.yml

@@ -0,0 +1,55 @@
+name: Build and Push Docker Images
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - 'v*'
+  pull_request:
+    branches:
+      - main
+
+env:
+  IMAGE: ${{ github.repository }} # eg. unitycatalog/unitycatalog
+
+jobs:
+  build-and-push:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Apply metadata and tags
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: ${{ env.IMAGE }}
+
+      # TODO: Agree on a strategy for publishing to DockerHub
+      # - name: Login to Docker Hub
+      #   uses: docker/login-action@v3
+      #   with:
+      #     username: ${{ vars.DOCKERHUB_USERNAME }}
+      #     password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          push: false # TODO: When we are ready to publish, change this to: ${{ github.event_name != 'pull_request' }}
+          platforms: linux/amd64,linux/arm64
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+
+          # TODO: Agree on a caching strategy
+          # NOTE: See here for an explanation of registry caching: https://tinyurl.com/4b8mfexr
+          # cache-from: type=registry,ref=${{ env.IMAGE }}:buildcache
+          # cache-to: type=registry,ref=${{ env.IMAGE }}:buildcache,mode=max

Dockerfile

@@ -1,147 +1,60 @@
-ARG unitycatalog_uid=185
-ARG unitycatalog_home="/opt/unitycatalog"
-ARG unitycatalog_repo="${unitycatalog_home}/repo"
-ARG unitycatalog_jar="server/target"
-ARG unitycatalog_jars="${unitycatalog_home}/jars"
-ARG unitycatalog_etc="etc"
-ARG unitycatalog_bin="bin"
-ARG unitycatalog_user_name="unitycatalog"
-ARG unitycatalog_user_home="home"
-ARG unitycatalog_user_basedir="${unitycatalog_home}/${unitycatalog_user_home}"
-# Specify any custom parameters necessary to generate
-# the Uber-Jar by SBT. 
-# Note: The default allocated heam memory size is too small
-# and will cause the process to fail when attempting to compile
-# and generate the Uber-Jar. Therefore it is important to choose
-# a size large enough for the compiler to run. 
-ARG sbt_args="-J-Xmx2G"
-# FIXME Pass it from the outside
-ARG unitycatalog_version="0.2.0-SNAPSHOT"
-ARG jars_directory="server/target/jars"
+# syntax=docker.io/docker/dockerfile:1.7-labs
+ARG HOME="/opt/unitycatalog"
+ARG ALPINE_VERSION="3.20"
 
-FROM eclipse-temurin:17-jdk-alpine AS package_server
+# Build stage, using Amazon Corretto jdk 17 on alpine with arm64 support
+FROM amazoncorretto:17-alpine${ALPINE_VERSION}-jdk as base
 
-ARG unitycatalog_repo
-ARG sbt_args
-ARG jars_directory
+# Dependencies are installed in $HOME/.cache by sbt
+ARG HOME
+ENV HOME=$HOME
 
-# Install required packages
-RUN <<EOF
-    set -ex;
-    apk update;
-    apk upgrade; 
-    apk add bash git;
-    rm -R /var/cache/apk/*;
-EOF
+WORKDIR $HOME
 
-WORKDIR "${unitycatalog_repo}"
+COPY --parents build/ project/ examples/ server/ api/ version.sbt build.sbt ./
 
-COPY . .
+RUN apk add --no-cache bash && ./build/sbt -info clean package
 
-# Builds server/target/unitycatalog-server-0.2.0-SNAPSHOT.jar
-RUN build/sbt ${sbt_args} server/package
+# Small runtime image
+FROM alpine:${ALPINE_VERSION} as runtime
 
-# As a side effect all the required jars to build the UC server
-# are listed in server/target/classpath that is generated at build time
-# Copy the jar files into a single directory
-RUN ./docker/copy_jars_from_classpath.sh ${jars_directory}
+# Specific JAVA_HOME from Amazon Corretto
+ARG JAVA_HOME="/usr/lib/jvm/default-jvm"
+ARG USER="unitycatalog"
+ARG HOME
 
-FROM eclipse-temurin:17-jdk-alpine AS build_uc
+# Copy Java from base
+COPY --from=base $JAVA_HOME $JAVA_HOME
 
-ARG unitycatalog_uid
-ARG unitycatalog_home
-ARG unitycatalog_repo
-ARG unitycatalog_jar
-ARG unitycatalog_jars
-ARG unitycatalog_etc
-ARG unitycatalog_bin
-ARG unitycatalog_user_name
-ARG unitycatalog_user_home
-ARG unitycatalog_user_basedir
-ARG sbt_args
-ARG unitycatalog_version
-ARG jars_directory
+ENV HOME=$HOME \
+    JAVA_HOME=$JAVA_HOME \
+    PATH="${JAVA_HOME}/bin:${PATH}"
 
-EXPOSE 8080 8081
+# Copy build artifacts from base stage
+COPY --from=base --parents \
+    $HOME/examples/ \
+    $HOME/server/ \
+    $HOME/api/ \
+    $HOME/target/ \
+    $HOME/.cache/ \
+    /
 
+# Create a service user with read and execute permissions and write permissions of the ./etc directory
 RUN <<EOF
-    set -ex;
-    apk update;
-    apk upgrade; 
-    apk add bash;
-    rm -R /var/cache/apk/*;
-EOF
-
-# Define the shell used within the container
-SHELL ["/bin/bash", "-i", "-c", "-o", "pipefail"]
-
-ENV UC_SERVER_BIN="${unitycatalog_home}/${unitycatalog_bin}/start-uc-server"
-
-RUN <<-EOF
-    set -ex;
-    mkdir -p "${unitycatalog_jars}";
-    mkdir -p "${unitycatalog_home}/${unitycatalog_etc}";
-    mkdir -p "${unitycatalog_home}/${unitycatalog_bin}";
-    mkdir -p "${unitycatalog_home}/${unitycatalog_user_home}";
-EOF
-
-# Create system group and user for Unity Catalog
-# Ensure the user created has their HOME pointing to the volume
-# created to persist user data and the sbt cached files that 
-# are created as a result of compiling the unity catalog.
-# This also ensures that the container can run independently from
-# the storage, so we can have ephemeral docker instances with --rm
-# and still be able to run the unity catalog each time without problems.
-RUN <<-EOF
-    #!/usr/bin/env bash
-    set -ex;
-    addgroup --system --gid "${unitycatalog_uid}" "${unitycatalog_user_name}";
-    adduser --system --uid "${unitycatalog_uid}" \
-            --ingroup "${unitycatalog_user_name}" \
-            --home "${unitycatalog_user_basedir}" \
-            --shell "$(/usr/bin/env bash)" \
-            "${unitycatalog_user_name}";
+apk add --no-cache bash
+addgroup -S $USER
+adduser -S -G $USER $USER
+chmod -R 550 $HOME
+mkdir -p $HOME/etc/
+chmod -R 770 $HOME/etc/
+chown -R $USER:$USER $HOME
 EOF
 
-# Define volume to persist Unity Catalog data
-VOLUME  "${unitycatalog_home}"
-
-WORKDIR "$unitycatalog_home"
-
-COPY --from=package_server "${server_jar}" "${unitycatalog_jars}/"
+USER $USER
 
-# Copy the etc folder which contains the config files and the data folder
-COPY --from=package_server "${unitycatalog_repo}/${unitycatalog_etc}" "${unitycatalog_home}/${unitycatalog_etc}/"
-
-COPY --from=package_server "${unitycatalog_repo}/${jars_directory}" "${unitycatalog_jars}/"
-
-# Create the script that executes the server
-# FIXME It could be already created and simply copied over
-COPY <<-"EOF" "${UC_SERVER_BIN}"
-    #!/usr/bin/env bash
-
-    SCRIPT_DIR="$(dirname "$(readlink -f "$0")")"
-    ROOT_DIR="$(dirname "$SCRIPT_DIR")"
-
-    SERVER_CLASS_NAME="io.unitycatalog.server.UnityCatalogServer"
-    # A classpath entry consisting simply of * expands to a list of all the jar files in the current directory.
-    # A class path entry that contains * will not match class files.
-    SERVER_JAVA_COMMAND="java -cp "jars/classes:jars/*" ${SERVER_CLASS_NAME} $@"
-
-    cd ${ROOT_DIR}
-
-    exec ${SERVER_JAVA_COMMAND}
-EOF
-
-# Set ownership of directories and Unity Catalog home directory to a less
-# priviledged user
-RUN <<-"EOF"
-    #!/usr/bin/env bash
-    set -ex;
-    chown -R "${unitycatalog_user_name}":"${unitycatalog_user_name}" "$unitycatalog_home";
-    chmod u+x "$UC_SERVER_BIN";
-EOF
+# Copy remaining directories here for caching optimization
+COPY --chown=$USER:$USER --parents bin/ etc/ $HOME/
 
-USER "${unitycatalog_user_name}"
+WORKDIR $HOME
 
-ENTRYPOINT ["/bin/bash", "bin/start-uc-server"]
+CMD ["./bin/start-uc-server"]

README.md

@@ -57,6 +57,9 @@ Let's take Unity Catalog for spin. In this guide, we are going to do the followi
   An example project is provided to demonstrate how to use the UC SDK for various assets
   as well as provide a convenient way to explore the content of any UC server implementation.
 
+> If you prefer to run Unity Catalog in Docker use `docker
+> compose up`. See the [Docker Quickstart](./docs/docker_quickstart.md) for more details.
+
 ### Prerequisites
 
 You have to ensure that your local environment has the following:
@@ -65,7 +68,6 @@ You have to ensure that your local environment has the following:
 - Ensure the `JAVA_HOME` environment variable your terminal is configured to point to JDK17.
 - Compile the project using `build/sbt package`
 
-> If you prefer to run this using the Unity Catalog Dockerized Environment, please refer to the Docker [README.md](./docker/README.md)
 
 ### Run the UC Server
 

api/Models/UpdateModelVersion.md

@@ -3,8 +3,6 @@
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-| **full\_name** | **String** | The full name of the registered model to update. | [optional] [default to null] |
-| **version** | **Long** | Version number of the version to update. | [optional] [default to null] |
 | **comment** | **String** | User-provided free-form text description. | [optional] [default to null] |
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

api/Models/UpdateRegisteredModel.md

@@ -3,7 +3,6 @@
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-| **full\_name** | **String** | The full name of the registered model to update. | [optional] [default to null] |
 | **comment** | **String** | User-provided free-form text description. | [optional] [default to null] |
 | **new\_name** | **String** | New name for the model. | [optional] [default to null] |
 

api/all.yaml

@@ -2083,9 +2083,6 @@ components:
     UpdateRegisteredModel:
       type: object
       properties:
-        full_name:
-          description: The full name of the registered model to update.
-          type: string
         comment:
           description: User-provided free-form text description.
           type: string
@@ -2133,13 +2130,6 @@ components:
     UpdateModelVersion:
       type: object
       properties:
-        full_name:
-          description: The full name of the registered model to update.
-          type: string
-        version:
-          description: Version number of the version to update.
-          type: integer
-          format:  int64
         comment:
           description: User-provided free-form text description.
           type: string

compose.yaml

@@ -0,0 +1,29 @@
+name: unitycatalog
+
+services:
+
+  server:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    ports:
+      - "8080:8080"
+    volumes:
+      - type: bind
+        source: ./etc/conf
+        target: /opt/unitycatalog/etc/conf
+      - type: volume
+        source: unitycatalog_data
+        target: /opt/unitycatalog/etc/data
+  ui:
+    build:
+      context: ui/
+      dockerfile: Dockerfile
+    ports:
+      - "3000:3000"
+    depends_on:
+      - server
+
+volumes:
+  # Persist docker volume across container restarts
+  unitycatalog_data: