dockerfiles: Use same default image name as DockerHub

To simplify usage of build.sh on CI, use the same image names for local
development as on the Docker hub (i.e. labgrid/client instead of
labgrid-client).

Allow both the prefix and the tag to be overridden using environment
variables.

Use the same prefix in docker-compose.yml, customizable using the same
environment variable.

Adjust the documentation to reflect the new prefix. It is no longer
necessary to build the images locally before running docker-compose so
remove this part of the staging instructions.

Signed-off-by: Peter Hoyes <Peter.Hoyes@arm.com>

Author: hoyes

dockerfiles/README.rst

@@ -22,7 +22,7 @@ Example showing how to build labgrid-client image:
 
 .. code-block:: bash
 
-   $ docker build --target labgrid-client -t labgrid-client -f dockerfiles/Dockerfile .
+   $ docker build --target labgrid-client -t docker.io/labgrid/client -f dockerfiles/Dockerfile .
 
 Using `BuildKit <https://docs.docker.com/develop/develop-images/build_enhancements/>`_
 is recommended to reduce build times.
@@ -76,7 +76,7 @@ so you can restart the service without loosing state.
 .. code-block:: bash
 
    $ docker run -t -p 20408:20408 -v $HOME/crossbar:/opt/crossbar \
-	 labgrid-coordinator
+	 docker.io/labgrid/coordinator
 
 
 labgrid-client usage
@@ -89,14 +89,14 @@ ws://192.168.1.42:20408/ws
 
 .. code-block:: bash
 
-   $ docker run -e LG_CROSSBAR=ws://192.168.1.42:20408/ws labgrid-client \
+   $ docker run -e LG_CROSSBAR=ws://192.168.1.42:20408/ws docker.io/labgrid/client \
 	 labgrid-client places
 
 Or running all pytest/labgrid tests at current directory:
 
 .. code-block:: bash
 
-   $ docker run -e LG_CROSSBAR=ws://192.168.1.42:20408/ws labgrid-client \
+   $ docker run -e LG_CROSSBAR=ws://192.168.1.42:20408/ws docker.io/labgrid/client \
 	 pytest
 
 
@@ -115,7 +115,7 @@ Start it with something like:
 
    $ docker run -e LG_CROSSBAR=ws://192.168.1.42:20408/ws \
        -v $HOME/exporter-conf:/opt/conf \
-	 labgrid-exporter
+	 docker.io/labgrid/exporter
 
 If using ser2net or if "exporting" e.g. a serial device, the devices needed must be added to Docker container
 (``docker run --device`` option).
@@ -135,14 +135,8 @@ create a setup with the following instances
 The environment serves both to allow checking if the environment still function after changes, and can act as an example
 how to configure the docker images needed to run a minimal setup.
 
-To use the staging environment to conduct a smoke test first build the images as instructed below:
-
-.. code-block:: bash
-
-   $ pip install --upgrade setuptools_scm
-   $ ./dockerfiles/build.sh
-
-Then use docker compose to start all services except the client:
+To use the staging environment to conduct a smoke test, first run docker compose to start all services except the
+client:
 
 .. code-block:: bash
 

dockerfiles/build.sh

@@ -1,6 +1,8 @@
 #!/bin/bash
 
 export DOCKER_BUILDKIT=1
+: "${IMAGE_PREFIX:=docker.io/labgrid/}"
+: "${IMAGE_TAG:=latest}"
 
 die () {
     local msg
@@ -59,7 +61,7 @@ perform_regular_build() {
 
     for t in client exporter coordinator; do
         "${docker_cmd}" build --build-arg VERSION="${version}" \
-            --target labgrid-${t} -t labgrid-${t}:latest -f "${script_dir}/Dockerfile" \
+            --target labgrid-${t} -t "${IMAGE_PREFIX}${t}:${IMAGE_TAG}" -f "${script_dir}/Dockerfile" \
             "${extra_args[@]}" .
     done
 }
@@ -73,7 +75,7 @@ perform_docker_buildx_build() {
 
     for t in client exporter coordinator; do
         "${docker_cmd}" buildx build --build-arg VERSION="${version}" \
-            --target labgrid-${t} -t labgrid-${t}:latest -f "${script_dir}/Dockerfile" \
+            --target labgrid-${t} -t "${IMAGE_PREFIX}${t}:${IMAGE_TAG}" -f "${script_dir}/Dockerfile" \
             "${extra_args[@]}" .
     done
 }

dockerfiles/staging/docker-compose.yml

@@ -1,15 +1,15 @@
 version: '3.3'
 services:
   coordinator:
-    image: "labgrid-coordinator"
+    image: "${IMAGE_PREFIX:-docker.io/labgrid/}coordinator"
     volumes:
       - "./crossbar:/home/root/crossbar"
     tty: true
     network_mode: "host"
     command: bash -c "cp /home/root/crossbar/places_example.yaml /opt/crossbar/places.yaml &&
       /opt/labgrid/crossbar-venv/bin/crossbar start --config /opt/labgrid/.crossbar/config-anonymous.yaml"
   client:
-    image: "labgrid-client"
+    image: "${IMAGE_PREFIX:-docker.io/labgrid/}client"
     volumes:
       - "./client/simple-test:/simple-test"
       - "./client/.ssh:/root/.ssh"
@@ -33,7 +33,7 @@ services:
       - exporter
       - dut
   exporter:
-    image: "labgrid-exporter"
+    image: "${IMAGE_PREFIX:-docker.io/labgrid/}exporter"
     volumes:
       - "./exporter-conf:/opt/conf"
       - "/run/udev:/run/udev:ro"