doc: Sync Docker Hub description with README

.github/workflows/docker-extra.yaml

@@ -99,3 +99,12 @@ jobs:
             subject-name: ${{ env.REGISTRY }}/${{ env.DOCKER_IMAGE_NAME }}
             subject-digest: ${{ steps.build_and_push_mlflow_ui.outputs.digest }}
             push-to-registry: true
+
+      - name: Update Docker Hub description
+        if: github.ref == 'refs/heads/main' && github.event_name != 'pull_request'
+        uses: peter-evans/dockerhub-description@v4
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+          repository: ${{ env.DOCKER_IMAGE_NAME }}
+          readme-filepath: ./docker/mlflow/server/README.md

.github/workflows/docker.yaml

@@ -87,3 +87,12 @@ jobs:
           subject-name: ${{ env.REGISTRY }}/${{ env.DOCKER_IMAGE_NAME }}
           subject-digest: ${{ steps.build_and_push_cms.outputs.digest }}
           push-to-registry: true
+
+      - name: Update Docker Hub description
+        if: github.ref == 'refs/heads/main' && github.event_name != 'pull_request'
+        uses: peter-evans/dockerhub-description@v4
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+          repository: ${{ env.DOCKER_IMAGE_NAME }}
+          readme-filepath: ./README.md

docker/Dockerfile

@@ -2,6 +2,12 @@ FROM python:3.10
 
 ARG CMS_UID=1000
 ARG CMS_GID=1000
+ARG CMS_MODEL_NAME
+ARG CMS_MODEL_TYPE
+ARG CMS_STREAMABLE
+ARG HTTP_PROXY
+ARG HTTPS_PROXY
+ARG NO_PROXY
 
 ENV CMS_MODEL_NAME=$CMS_MODEL_NAME
 ENV CMS_MODEL_TYPE=$CMS_MODEL_TYPE

docker/mlflow/server/README.md

@@ -0,0 +1,2 @@
+## cogstack-mlflow-ui
+A customised MLflow server configured for experiment tracking in CogStack projects.