feat(docker): provide a Debian-based slim image

nejch · JohnVillalovos · commit 384031c530e8 · 2022-06-12T09:33:05.000-07:00
diff --git a/.dockerignore b/.dockerignore
@@ -1,5 +1,9 @@
+.tox/
+.venv/
 venv/
 dist/
 build/
 *.egg-info
+.coverage
 .github/
+coverage.xml
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
@@ -2,26 +2,30 @@ image: python:3.10
 
 stages:
   - deploy
-  - deploy-latest
+  - promote
 
-deploy_image:
+deploy-images:
   stage: deploy
   image:
     name: gcr.io/kaniko-project/executor:debug
     entrypoint: [""]
   script:
     - echo "{\"auths\":{\"$CI_REGISTRY\":{\"username\":\"$CI_REGISTRY_USER\",\"password\":\"$CI_REGISTRY_PASSWORD\"}}}" > /kaniko/.docker/config.json
-    - /kaniko/executor --context $CI_PROJECT_DIR --dockerfile $CI_PROJECT_DIR/Dockerfile --destination $CI_REGISTRY_IMAGE:$CI_COMMIT_TAG
-  only:
-    - tags
+    - executor --context $CI_PROJECT_DIR --dockerfile $CI_PROJECT_DIR/Dockerfile --destination $CI_REGISTRY_IMAGE:$CI_COMMIT_TAG-alpine
+    - executor --context $CI_PROJECT_DIR --dockerfile $CI_PROJECT_DIR/Dockerfile --destination $CI_REGISTRY_IMAGE:$CI_COMMIT_TAG-slim-bullseye --build-arg PYTHON_FLAVOR=slim-bullseye
+  rules:
+    - if: $CI_COMMIT_TAG
 
-deploy-latest:
-  stage: deploy-latest
+tag-latest:
+  stage: promote
   image:
     name: gcr.io/go-containerregistry/crane:debug
     entrypoint: [""]
   script:
-    - mkdir /root/.docker && echo "{\"auths\":{\"$CI_REGISTRY\":{\"username\":\"$CI_REGISTRY_USER\",\"password\":\"$CI_REGISTRY_PASSWORD\"}}}" > /root/.docker/config.json
-    - /ko-app/crane cp $CI_REGISTRY_IMAGE:$CI_COMMIT_TAG $CI_REGISTRY_IMAGE:latest
-  only:
-    - tags
+    - crane auth login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY
+    - crane tag $CI_REGISTRY_IMAGE:$CI_COMMIT_TAG-alpine ${CI_COMMIT_TAG}       # /python-gitlab:v1.2.3
+    - crane tag $CI_REGISTRY_IMAGE:$CI_COMMIT_TAG-alpine latest                 # /python-gitlab:latest
+    - crane tag $CI_REGISTRY_IMAGE:$CI_COMMIT_TAG-alpine alpine                 # /python-gitlab:alpine
+    - crane tag $CI_REGISTRY_IMAGE:$CI_COMMIT_TAG-slim-bullseye slim-bullseye   # /python-gitlab:slim-bullseye
+  rules:
+    - if: $CI_COMMIT_TAG
diff --git a/Dockerfile b/Dockerfile
@@ -1,10 +1,11 @@
-FROM python:3.10-alpine AS build
+ARG PYTHON_FLAVOR=alpine
+FROM python:3.10-${PYTHON_FLAVOR} AS build
 
 WORKDIR /opt/python-gitlab
 COPY . .
 RUN python setup.py bdist_wheel
 
-FROM python:3.10-alpine
+FROM python:3.10-${PYTHON_FLAVOR}
 
 WORKDIR /opt/python-gitlab
 COPY --from=build /opt/python-gitlab/dist dist/
diff --git a/README.rst b/README.rst
@@ -53,8 +53,25 @@ From GitLab:
    $ pip install git+https://gitlab.com/python-gitlab/python-gitlab.git
 
 
-Using the docker image
-----------------------
+Using the docker images
+-----------------------
+
+``python-gitlab`` provides Docker images in two flavors, based on the Alpine and Debian slim
+python `base images <https://hub.docker.com/_/python>`__. The default tag is ``alpine``,
+but you can explicitly use the alias (see below).
+
+The alpine image is smaller, but you may want to use the Debian-based slim tag (currently 
+based on ``-slim-bullseye``) if you are running into issues or need a more complete environment
+with a bash shell, such as in CI jobs.
+
+The images are published on the GitLab registry, for example:
+
+* ``registry.gitlab.com/python-gitlab/python-gitlab:latest`` (latest, alpine alias)
+* ``registry.gitlab.com/python-gitlab/python-gitlab:alpine`` (latest alpine)
+* ``registry.gitlab.com/python-gitlab/python-gitlab:slim-bullseye`` (latest slim-bullseye)
+* ``registry.gitlab.com/python-gitlab/python-gitlab:v3.2.0`` (alpine alias)
+* ``registry.gitlab.com/python-gitlab/python-gitlab:v3.2.0-alpine``
+* ``registry.gitlab.com/python-gitlab/python-gitlab:v3.2.0-slim-bullseye``
 
 You can run the Docker image directly from the GitLab registry:
 
@@ -89,6 +106,12 @@ Run your own image:
 
    $ docker run -it --rm -v python-gitlab:latest <command> ...
 
+Build a Debian slim-based image:
+
+.. code-block:: console
+
+   $ docker build -t python-gitlab:latest --build-arg PYTHON_FLAVOR=slim-bullseye .
+
 Bug reports
 -----------
 
