feat: example of docker labels REFS #64

adds labels that are displayed by the github container registry
there are various other labels that the open container spec outlines
https://github.com/opencontainers/image-spec/blob/main/annotations.md\#pre-defined-annotation-keys

we should consider specifying values for the ones we think are useful
note that this is pending update on documentation

Dockerfile

@@ -34,3 +34,7 @@ RUN poetry install --no-root
 # uvicorn at this level so it sees the package
 WORKDIR /opt/
 
+# Labels are used to identify the image
+LABEL org.opencontainers.image.source="https://github.com/anomaly/${PROJ_NAME}"
+LABEL org.opencontainers.image.description="A Python web server using FastAPI and Uvicorn"
+LABEL org.opencontainers.image.licenses="Apache-2.0"

Dockerfile.prod

@@ -73,5 +73,7 @@ COPY ./src/. .
 # Expose ports which is proxied via traefik
 EXPOSE 80
 
-# ENTRYPOINT ["gunicorn", "--worker-tmp-dir=/dev/shm", "--worker-class=uvicorn.workers.UvicornWorker", "--bind=0.0.0.0:80", "labs.api:app"]
-# CMD []
+# Labels are used to identify the image
+LABEL org.opencontainers.image.source="https://github.com/anomaly/${PROJ_NAME}"
+LABEL org.opencontainers.image.description="A Python web server using FastAPI and Uvicorn"
+LABEL org.opencontainers.image.licenses="Apache-2.0"