singularity v4.1.2のインストール

はじめに

大規模データに対して複雑な演算処理を高速に実行可能なHPC(ハイパフォーマンスコンピューティング)クラスターにおいては、移植性の高さやシンプルに実行できることが一つ重要な要素となってくる。

SingularityCEはコンテナプラットフォームで、移植可能かつ再現可能な方法でソフトウェアをパッケージ化するコンテナを作成・実行できる。

https://github.com/apptainer/singularity

類似するコンテナシステムとしてDockerコンテナがあるが、Singularityは基本的に実行において追加の権限を要求せず、ホストと同一のストレージやCPUを直接利用できるといった特徴を持つ。

要は、管理者権限を必要としないので、ゲストでも使いたいツールのコンテナを用意すれば気軽に高性能PCで解析ができる。

このような優れた点も多く、繰り返しの検討や本解析の再現性・保守性の面でコンテナシステムは重要なツールであることは明らかなので導入してみる。

なお、私はそれとなく理解できて、ツールとして使えればいい主義なのであまり深堀はしない。

環境

cat /etc/os-release

PRETTY_NAME="Ubuntu 22.04.4 LTS"
NAME="Ubuntu"
VERSION_ID="22.04"
VERSION="22.04.4 LTS (Jammy Jellyfish)"
VERSION_CODENAME=jammy
ID=ubuntu
ID_LIKE=debian
HOME_URL="https://www.ubuntu.com/"
SUPPORT_URL="https://help.ubuntu.com/"
BUG_REPORT_URL="https://bugs.launchpad.net/ubuntu/"
PRIVACY_POLICY_URL="https://www.ubuntu.com/legal/terms-and-policies/privacy-policy"
UBUNTU_CODENAME=jammy

lscpu

Architecture:            x86_64
  CPU op-mode(s):        32-bit, 64-bit
  Address sizes:         48 bits physical, 48 bits virtual
  Byte Order:            Little Endian
CPU(s):                  32
  On-line CPU(s) list:   0-31
Vendor ID:               AuthenticAMD
  Model name:            AMD Ryzen 9 5950X 16-Core Processor
    CPU family:          25
    Model:               33
    Thread(s) per core:  2
    Core(s) per socket:  16
    Socket(s):           1
    Stepping:            0
    Frequency boost:     enabled
    CPU max MHz:         5083.3979
    CPU min MHz:         2200.0000
    BogoMIPS:            6787.18
    Flags:               fpu vme de pse tsc msr pae mce cx8 apic sep mtrr pge mca cmov pat pse36 clflush mmx fxsr sse sse2 ht 
                         syscall nx mmxext fxsr_opt pdpe1gb rdtscp lm constant_tsc rep_good nopl nonstop_tsc cpuid extd_apicid
                          aperfmperf rapl pni pclmulqdq monitor ssse3 fma cx16 sse4_1 sse4_2 movbe popcnt aes xsave avx f16c r
                         drand lahf_lm cmp_legacy svm extapic cr8_legacy abm sse4a misalignsse 3dnowprefetch osvw ibs skinit w
                         dt tce topoext perfctr_core perfctr_nb bpext perfctr_llc mwaitx cpb cat_l3 cdp_l3 hw_pstate ssbd mba 
                         ibrs ibpb stibp vmmcall fsgsbase bmi1 avx2 smep bmi2 erms invpcid cqm rdt_a rdseed adx smap clflushop
                         t clwb sha_ni xsaveopt xsavec xgetbv1 xsaves cqm_llc cqm_occup_llc cqm_mbm_total cqm_mbm_local clzero
                          irperf xsaveerptr rdpru wbnoinvd arat npt lbrv svm_lock nrip_save tsc_scale vmcb_clean flushbyasid d
                         ecodeassists pausefilter pfthreshold avic v_vmsave_vmload vgif v_spec_ctrl umip pku ospke vaes vpclmu
                         lqdq rdpid overflow_recov succor smca fsrm
Virtualization features: 
  Virtualization:        AMD-V
Caches (sum of all):     
  L1d:                   512 KiB (16 instances)
  L1i:                   512 KiB (16 instances)
  L2:                    8 MiB (16 instances)
  L3:                    64 MiB (2 instances)
NUMA:                    
  NUMA node(s):          1
  NUMA node0 CPU(s):     0-31
Vulnerabilities:         
  Gather data sampling:  Not affected
  Itlb multihit:         Not affected
  L1tf:                  Not affected
  Mds:                   Not affected
  Meltdown:              Not affected
  Mmio stale data:       Not affected
  Retbleed:              Not affected
  Spec rstack overflow:  Vulnerable: Safe RET, no microcode
  Spec store bypass:     Mitigation; Speculative Store Bypass disabled via prctl
  Spectre v1:            Mitigation; usercopy/swapgs barriers and __user pointer sanitization
  Spectre v2:            Mitigation; Retpolines, IBPB conditional, IBRS_FW, STIBP always-on, RSB filling, PBRSB-eIBRS Not affe
                         cted
  Srbds:                 Not affected
  Tsx async abort:       Not affected

ソースからSingularityをインストールする

出オチ感あるが、まずsingularity自体を使えるようにするには管理者権限が必要となる。

また、コンテナファイルの作成(別記事で説明予定)でも、環境依存かもしれないが基本的に管理者権限が必要となる。

よって、共通計算リソースのHPC上でコンテナを使って解析したい場合は、まずここで解説するように、個人PCにsingularityをインストールする。

次に、使いたいツールのコンテナを作成 & そのコンテナをHPCにコピーするなどして使用する必要があることに留意して頂きたい。

以降、基本的に公式Documentに沿ってインストールの作業を進める。

まずは依存関係のあるツールのインストール。

# Ensure repositories are up-to-date
sudo apt update

# Install debian packages for dependencies
sudo apt install -y \
   autoconf \
   automake \
   cryptsetup \
   fuse \
   fuse2fs \
   git \
   libfuse-dev \
   libglib2.0-dev \
   libseccomp-dev \
   libtool \
   pkg-config \
   runc \
   squashfs-tools \
   squashfs-tools-ng \
   uidmap \
   wget \
   zlib1g-dev

goのインストール

ここでのGoはGo言語のことを指す。GoはGoogleが開発したオープンソースプログラミング言語で、シンプルな構文でありながら軽量で高速に動作するといった特徴がある。

https://go.dev/

以前にGoをインストールしている場合、削除してからインストールを進める。

which go

上記コマンドで何も表示されなければ、lscpuから進める。

基本的なGoのチュートリアルどおりにインストールしてれば、/usr/local/goを含むパスが表示されるはずなのでフォルダごと削除する。

rm -rf /usr/local/go

次に、ここで最新のgoのバージョンを確認する。2024/04/13現在ではgo1.22.2が最新バージョンだったので実行ファイルを含むtarファイルをダウンロードする。

Architectureの確認

lscpu | grep -i "Architecture"

Architecture:                       x86_64

以下をダウンロードした。

File name	Kind	OS	Arch	Size	SHA256 Checksum
go1.22.2.linux-amd64.tar.gz	Archive	Linux	x86-64	66MB	5901c52b7a78002aeff14a21f93e0f064f74ce1360fce51c6ee68cd471216a17

# Download
wget https://go.dev/dl/go1.22.2.linux-amd64.tar.gz
# Decompress
sudo tar -C /usr/local -xzf go1.22.2.linux-amd64.tar.gz

Goのパスを通す

echo 'export PATH=/usr/local/go/bin:$PATH' >> ~/.bashrc && \
source ~/.bashrc

versionの確認

go version
# go version go1.22.2 linux/amd64

不要なファイルは削除する

rm go1.22.2.linux-amd64.tar.gz

github releaseからSingularityCEをダウンロードする

SingularityCEのgithubのreleaseより対象バージョンの実行ファイルをダウンロードする。

export VERSION=4.1.2
wget https://github.com/sylabs/singularity/releases/download/v${VERSION}/singularity-ce-${VERSION}.tar.gz 

解凍する

tar -xzf singularity-ce-${VERSION}.tar.gz && \
cd singularity-ce-${VERSION}

mconfigを使用してbuild用のファイルを生成した後に、makeでビルドする。

./mconfig

make -C ./builddir -j 32
sudo make -j 32 -C ./builddir install

versionの確認

singularity --version

singularity-ce version 4.1.2

version 4.1.2が無事インストールできた。

次はなにかゲノム解析に必要なツール群をまとめたコンテナを作ってみる予定。