Skip to content

README.md

Latest commit

 

History

History
77 lines (54 loc) · 2.7 KB

README.md

File metadata and controls

77 lines (54 loc) · 2.7 KB

Proxystore Images

This repo contains Dockerfiles used for testing Proxystore's code. "Nightly" image builds are created on the 1st and 15th of the month or when the corresponding Dockerfile is changed.

Dockerfile Location Details
Dockerfile-dim ghcr.io/proxystore/proxystore-dim:nightly Details
Dockerfile-relay ghcr.io/proxystore/proxystore-relay:nightly Details

Adding Dockerfiles

  1. Add the Dockerfile to dockerfiles/.
  2. Add a section in this README with any instructions.
  3. Update the table in this README with the links.
  4. Add a new matrix entry in .github/workflows/check.yml.
  5. Add a new matrix entry in .github/workflows/publish.yml.

Dockerfile-dim

Usage

To effectively work on a system, the Dockerfile-dim image needs to be compiled on the machine it will be used on.

For usage with Github Actions CI, a prebuilt image is provided.

Pull and Run

$ docker run --rm -it --network host -v <local_path_to_proxystore_dir>:/proxystore ghcr.io/proxystore/proxystore-dim

Build and Run

$ docker build -t proxystore-dim -f dockerfiles/Dockerfile-dim .
$ docker run --rm -it --network host -v <local_path_to_proxystore_dir>:/proxystore proxystore-dim

Executing test cases

This can be done as usual using tox: $ tox -e py39. All Python versions are available and tox is pre-added to the $PATH.

Dockerfile-relay

Relay (signaling) server runner image for testing p2p communication. This image installs the latest release of ProxyStore from PyPI.

Pull and Run

The container defaults to exposing port 8700 and starting the relay using a configuration file mounted at /data/config.toml. The configuration file location can be overridden via the CONFIG environment variable passed to docker run. E.g., -e CONFIG=/path/in/container/to/config.toml. Update the -v $(pwd)/data:/data mount depending on the location of your configuration file.

$ docker run --rm -it -p 8700:8700 -v $(pwd)/data:/data --name relay ghcr.io/proxystore/proxystore-relay

All configuration of the relay server should be done via the configuration file.

Build and Run

When building the container, the following build arguments can be specified (listed are the default values).

  • --build-arg PYTHON_VERSION=3.11
  • --build-arg CONFIG=/data/config.toml
  • --build-arg PORT=8700
$ docker build -t proxystore-relay -f dockerfiles/Dockerfile-relay .
$ docker run --rm -it -p 8700:8700 -v $(pwd)/data:/data --name relay proxystore-relay