[DPE-3457] Add description to OCI image to be rendered on GitHub Cont… (#73)

Author: deusebio

.github/workflows/publish.yaml

@@ -93,6 +93,12 @@ jobs:
           sudo make import TARGET=docker REPOSITORY=${REPOSITORY} TAG=${TAG}\
             -o ${{ steps.artifact.outputs.name }} 
 
+          # Add relevant labels
+          COMMIT_ID=$(git log -1 --format=%H)
+          DESCRIPTION=$(yq .description rockcraft.yaml | xargs)
+          
+          echo "FROM ${IMAGE_NAME}:${TAG}" | docker build --label org.opencontainers.image.description="${DESCRIPTION}" --label org.opencontainers.image.revision="${COMMIT_ID}" --label org.opencontainers.image.source="${{ github.repositoryUrl }}" -t "${IMAGE_NAME}:${TAG}" -
+
           echo "Publishing ${IMAGE_NAME}:${TAG}"          
           docker push ${IMAGE_NAME}:${TAG}
           
@@ -119,6 +125,10 @@ jobs:
             -o $(find .make_cache -name "*.tag")
 
           IMAGE_NAME=$(make help FLAVOUR=jupyter REPOSITORY=${REPOSITORY} TAG=${TAG} help | grep "Image\:" | cut -d ":" -f2  | xargs)
+
+          DESCRIPTION=$(sed -n '/^#\ \-/,/^#\ \-/  p' build/Dockerfile.jupyter | sed 's/^\#\ //g' | sed '$ d' | tail -n+2 | xargs)
+          
+          echo "FROM ${IMAGE_NAME}:${TAG}" | docker build --label org.opencontainers.image.description="${DESCRIPTION}" --label org.opencontainers.image.revision="${COMMIT_ID}" --label org.opencontainers.image.source="${{ github.repositoryUrl }}" -t "${IMAGE_NAME}:${TAG}" -
 
           echo "Publishing ${IMAGE_NAME}:${TAG}"
           docker push ${IMAGE_NAME}:${TAG}

build/Dockerfile.jupyter

@@ -1,3 +1,12 @@
+# ---------------------------------------------------------------------------
+# This is an OCI image to deploy JupyterLab server instances on K8s, fully
+# integrated with Charmed Spark ecosystem and utilities. The image provides an
+# automated and seamless user-experience to deploy, operate, manage and monitor
+# SparkJob running on K8s cluster.
+# It is an open source, end-to-end, production ready data platform on top of
+# cloud native technologies.
+# ---------------------------------------------------------------------------
+
 ARG BASE_IMAGE=base-charmed-spark:latest
 ARG JUPYTERLAB_VERSION=4.0.0
 FROM $BASE_IMAGE

rockcraft.yaml

@@ -1,6 +1,13 @@
 name: charmed-spark
-summary: Spark ROCK
-description: Spark ROCK
+summary: Charmed Apache Spark ROCK
+description: |
+  This is an OCI image that bundles Apache Spark binaries together with other
+  tools of its ecosystem in order to be used in Charmed Operators, providing
+  an automated and seamless experience to deploy, operate, manage and monitor
+  SparkJob on K8s cluster.
+  It is an open source, end-to-end, production ready data platform on top of
+  cloud native technologies.
+
 license: Apache-2.0
 
 version: "3.4.2"