-
Notifications
You must be signed in to change notification settings - Fork 39
CE: Added pages with guidelines for images on Alps #272
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Madeeks
wants to merge
10
commits into
eth-cscs:main
Choose a base branch
from
Madeeks:ce-image-guidelines
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
77c5f2f
CE: Added pages with guidelines for images on Alps
Madeeks 5d22873
Fixed mkdocs table of contents
Madeeks 9504522
Fixed typos
Madeeks 713f8b4
Fixed typo
Madeeks b10b99f
Improved content organization for CE image guidelines
Madeeks 5d74d59
Fixed code blocks
Madeeks 0bab4b2
Updated allowed words in spelling checker
Madeeks 7236858
Apply suggestions from code review
Madeeks ca271ed
CE image guidelines: add links to subpages
Madeeks 1e91952
CE image guidelines: add code block notes for PMIx settings
Madeeks File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
105 changes: 105 additions & 0 deletions
105
docs/software/container-engine/guidelines-images/image-comm-fwk.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,105 @@ | ||
[](){#ref-ce-guidelines-images-commfwk} | ||
# Communication frameworks image | ||
|
||
This page describes a container image providing foundational software components for achieving efficient execution on Alps nodes with NVIDIA GPUs. | ||
|
||
The most important aspect to consider for performance of containerized applications is related to use of high-speed networks, | ||
therefore this image mainly installs communication frameworks and libraries, besides general utility tools. | ||
In particular, the [libfabric](https://ofiwg.github.io/libfabric/) framework (also known as Open Fabrics Interfaces - OFI) is required to interface applications with the Slingshot high-speed network. | ||
|
||
At runtime, the container engine [CXI hook][ref-ce-cxi-hook] will replace the libfabric libraries inside the container with the corresponding libraries on the host system. | ||
This will ensure access to the Slingshot interconnect. | ||
|
||
This image is not intended to be used on its own, but to serve as a base to build higher-level software (e.g. MPI implementations) and application stacks. | ||
For this reason, no performance results are provided in this page. | ||
|
||
A build of this image is currently hosted on the [Quay.io](https://quay.io/) registry at the following reference: | ||
`quay.io/ethcscs/comm-fwk:ofi1.22-ucx1.19-cuda12.8`. | ||
The image name `comm-fwk` is a shortened form of "communication frameworks". | ||
|
||
## Contents | ||
|
||
- Ubuntu 24.04 | ||
- CUDA 12.8.1 | ||
- GDRCopy 2.5.1 | ||
- Libfabric 1.22.0 | ||
- UCX 1.19.0 | ||
|
||
## Containerfile | ||
```Dockerfile | ||
ARG ubuntu_version=24.04 | ||
ARG cuda_version=12.8.1 | ||
FROM docker.io/nvidia/cuda:${cuda_version}-cudnn-devel-ubuntu${ubuntu_version} | ||
|
||
RUN apt-get update \ | ||
&& DEBIAN_FRONTEND=noninteractive \ | ||
apt-get install -y \ | ||
build-essential \ | ||
ca-certificates \ | ||
pkg-config \ | ||
automake \ | ||
autoconf \ | ||
libtool \ | ||
cmake \ | ||
gdb \ | ||
strace \ | ||
wget \ | ||
git \ | ||
bzip2 \ | ||
python3 \ | ||
gfortran \ | ||
rdma-core \ | ||
numactl \ | ||
libconfig-dev \ | ||
libuv1-dev \ | ||
libfuse-dev \ | ||
libfuse3-dev \ | ||
libyaml-dev \ | ||
libnl-3-dev \ | ||
libnuma-dev \ | ||
libsensors-dev \ | ||
libcurl4-openssl-dev \ | ||
libjson-c-dev \ | ||
libibverbs-dev \ | ||
--no-install-recommends \ | ||
&& rm -rf /var/lib/apt/lists/* | ||
|
||
ARG gdrcopy_version=2.5.1 | ||
RUN git clone --depth 1 --branch v${gdrcopy_version} https://github.com/NVIDIA/gdrcopy.git \ | ||
&& cd gdrcopy \ | ||
&& export CUDA_PATH=${CUDA_HOME:-$(echo $(which nvcc) | grep -o '.*cuda')} \ | ||
&& make CC=gcc CUDA=$CUDA_PATH lib \ | ||
&& make lib_install \ | ||
&& cd ../ && rm -rf gdrcopy | ||
|
||
# Install libfabric | ||
ARG libfabric_version=1.22.0 | ||
RUN git clone --branch v${libfabric_version} --depth 1 https://github.com/ofiwg/libfabric.git \ | ||
&& cd libfabric \ | ||
&& ./autogen.sh \ | ||
&& ./configure --prefix=/usr --with-cuda=/usr/local/cuda --enable-cuda-dlopen --enable-gdrcopy-dlopen --enable-efa \ | ||
&& make -j$(nproc) \ | ||
&& make install \ | ||
&& ldconfig \ | ||
&& cd .. \ | ||
&& rm -rf libfabric | ||
|
||
# Install UCX | ||
ARG UCX_VERSION=1.19.0 | ||
RUN wget https://github.com/openucx/ucx/releases/download/v${UCX_VERSION}/ucx-${UCX_VERSION}.tar.gz \ | ||
&& tar xzf ucx-${UCX_VERSION}.tar.gz \ | ||
&& cd ucx-${UCX_VERSION} \ | ||
&& mkdir build \ | ||
&& cd build \ | ||
&& ../configure --prefix=/usr --with-cuda=/usr/local/cuda --with-gdrcopy=/usr/local --enable-mt --enable-devel-headers \ | ||
&& make -j$(nproc) \ | ||
&& make install \ | ||
&& cd ../.. \ | ||
&& rm -rf ucx-${UCX_VERSION}.tar.gz ucx-${UCX_VERSION} | ||
``` | ||
|
||
## Notes | ||
- The image is based on an official NVIDIA CUDA image, and therefore already provides the NCCL library, alongside a complete CUDA installation. | ||
- Communication frameworks are built with explicit support for CUDA and GDRCopy. | ||
- The libfabric [EFA](https://aws.amazon.com/hpc/efa/) provider is included to leave open the possibility to experiment with derived images on AWS infrastructure as well. | ||
- Although only the libfabric framework is required to support Alps' Slingshot network, this image also packages the UCX communication framework to allow building a broader set of software (e.g. some OpenSHMEM implementations) and supporting optimized Infiniband communication as well. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is bound out of date, at least temporarily. Should we provide some instructions to the user on how to retrieve this information from the container or registry instead?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is also a bit redundant with versions explicitly set below.