Docker Hub and README.md tweaking

Author: palves

README.md

@@ -2,33 +2,30 @@
 
 Run commands or a shell, with only given GPU devices visible.
 
-This script uses a thin Docker container under the hood that exposes
-the host filesystem and OS inside the container, and restricts the
-available GPUs within the spawned shell environment to the ones you
-specify.
+`isolate-gpu` is a script that is useful when you have more than one
+GPU in your machine, and you want to restrict the access of
+applications to a subset of GPUs, aka isolating GPUs.
 
-This is useful when you have more than one GPU in your machine, and
-you want to restrict the access of applications to a subset of GPUs,
-aka isolating GPUs.
-
-The ROCm documentation teaches you how to do that with Docker, see
-here:
-
-https://rocm.docs.amd.com/projects/install-on-linux/en/latest/how-to/docker.html#docker-restrict-gpus
+The ROCm documentation teaches you how to do that with Docker,
+[here](https://rocm.docs.amd.com/projects/install-on-linux/en/latest/how-to/docker.html#docker-restrict-gpus).
 
 However, that leaves open the question of what OS to run within the
 container?
 
-isolate-gpu answers that question with "none".  Its container image is
-practically empty; it is mostly a wrapper around the host's
-filesystem.  I.e., there is no separate distribution inside the
-container.  The idea is to be able to work inside the container mostly
-as if you were outside.
+`isolate-gpu` answers that question with "none".  It uses a thin
+Docker container under the hood that exposes the host filesystem and
+OS inside the container, and restricts the available GPUs within the
+spawned shell environment to the ones you specify.
+
+The container image is practically empty; it is mostly a wrapper
+around the host's filesystem.  I.e., there is no separate distribution
+inside the container.  The idea is to be able to work inside the
+container mostly as if you were outside.
 
 The non-user-data OS directories are mounted readonly within the
-container.  That is, /usr/, /etc, /var/, etc.  This is to avoid the
-possibility of the container corrupting the host.  /home, /net, and
-/mnt, are mounted read-write.
+container.  That is, `/usr/`, `/etc`, `/var/`, etc.  This is to avoid
+the possibility of the container corrupting the host.  `/home`,
+`/net`, and `/mnt`, are mounted read-write.
 
 ## Features
 
@@ -48,58 +45,60 @@ possibility of the container corrupting the host.  /home, /net, and
 - Can be run with arguments, which are passed as commands to the
   non-interative shell inside the container.
 
-## Building the image
+## Installation
+
+To install the `isolate-gpu` script, simply copy or symlink it to some
+directory found in your `$PATH`.  E.g., you can download it directly
+from github, like so:
 
 ```bash
-git clone https://github.com/palves/isolate-gpu.git
-cd isolate-gpu
-./build-docker
+$ cd ~/bin
+$ wget https://raw.githubusercontent.com/palves/isolate-gpu/refs/heads/main/isolate-gpu
+$ chmod u+x isolate-gpu
 ```
 
-## Installation
-
-This image is not meant to be run directly.  Instead, there is a
-**isolate-gpu** helper script you use to enter the container
-environment and/or execute build commands on build directories that
-exist on the local host filesystem.
+When you run `isolate-gpu` for the first time, it downloads the Docker
+image from Docker Hub automatically, you don't need to build it
+yourself.
 
-To install the helper script, simply copy or symlink it to some
-directory found in your \$PATH.  E.g.:
+## Usage
 
 ```bash
-ln -s /path/to/isolate-gpu-git/isolate-gpu ~/bin/
+$ isolate-gpu [opts...] [command] [args...]
 ```
 
-## Examples
+If a command is not specified, then `isolate-gpu` spawns an
+interactive shell within the isolated environment.  Exiting the shell
+exits the container.
 
-1. `isolate-gpu --device 1`: Run an interactive shell inside the
-   container, exposing GPU 1, preserving current directory.
+If a command is specified, then `isolate-gpu` executes the command
+inside the container, and exits the container when the command exits.
 
-2. `isolate-gpu --device 1 make`: Invoke make with the *Makefile*
-   found in the current directory.
+See `isolate-gpu --help` for more details.
 
-## Usage
+## Examples
 
-For example, here\'s how to run the ROCm-specific tests in GDB's
-testsuite, on GPU 1:
+1. Run an interactive shell inside the container, exposing GPU 1,
+   preserving current directory:
 
 ```bash
-cd /path/to/gdb/build/gdb/
-isolate-gpu --device 1
-# You're now inside the container, in the same directory as you were.
- make check -j32 RUNTESTFLAGS="gdb.rocm/*.exp"
+$ isolate-gpu --device 1
 ```
 
-Alternatively, you can invoke any command inside the container by
-prepending the **isolate-gpu** script on the commandline.  Assuming
-**isolate-gpu** can be found in your PATH, you can run:
+2. Invoke make with the *Makefile* found in the current directory:
 
 ```bash
-$ isolate-gpu [opts...] [command] [args...]
+$ isolate-gpu --device 1 make
 ```
 
-For example:
+## Rebuilding the image
+
+This isn't normally needed, because the image is available on [docker
+hub](https://hub.docker.com/r/palves79/isolate-gpu), but if you want
+to, you can rebuild it with:
 
 ```bash
-$ isolate-gpu --device 1 make check -j32 RUNTESTFLAGS="gdb.rocm/*.exp"
+git clone https://github.com/palves/isolate-gpu.git
+cd isolate-gpu
+./build-docker
 ```

build-docker

@@ -2,4 +2,4 @@
 # SPDX-License-Identifier: GPL-3.0-or-later
 # Author  : Pedro Alves (pedro@palves.net)
 
-docker build -t isolate-gpu .
+docker build -t palves79/isolate-gpu .

isolate-gpu

@@ -212,4 +212,4 @@ docker run --rm \
        -e ISOLATE_GPU_CWD="$(pwd)" \
        -h "$CONTAINER_HOSTNAME" \
        "${VOLS[@]}" \
-       isolate-gpu "$@"
+       palves79/isolate-gpu "$@"

push-docker-hub

@@ -0,0 +1,23 @@
+#!/bin/bash
+
+set -e
+
+VERSION=$(git describe --tags --abbrev=0)
+
+# Check if the current commit is tagged with VERSION.
+CURRENT_COMMIT_TAG=$(git describe --tags --exact-match 2>/dev/null \
+			 || echo "none")
+if [ "$CURRENT_COMMIT_TAG" != "$VERSION" ]; then
+    echo "Error: The current commit is not tagged with the latest tag ($VERSION)."
+    echo "Ensure you have checked out the commit matching the latest tag."
+    exit 1
+fi
+
+./build-docker
+
+# Tag and push with the specific version.
+docker tag palves79/isolate-gpu palves79/isolate-gpu:$VERSION
+docker push palves79/isolate-gpu:$VERSION
+
+# Push the "latest" tag.
+docker push palves79/isolate-gpu:latest