From 0b735563470d39b1f874d439367564b9a71d6a5c Mon Sep 17 00:00:00 2001
From: Martin Schroschk <martin.schroschk@tu-dresden.de>
Date: Mon, 7 Feb 2022 13:55:56 +0100
Subject: [PATCH] Rename file and heading
---
doc.zih.tu-dresden.de/docs/software/containers.md | 8 ++++----
.../{virtual_machines_tools.md => singularity_power9.md} | 6 +++---
doc.zih.tu-dresden.de/docs/software/virtual_machines.md | 4 ++--
doc.zih.tu-dresden.de/mkdocs.yml | 2 +-
4 files changed, 10 insertions(+), 10 deletions(-)
rename doc.zih.tu-dresden.de/docs/software/{virtual_machines_tools.md => singularity_power9.md} (97%)
diff --git a/doc.zih.tu-dresden.de/docs/software/containers.md b/doc.zih.tu-dresden.de/docs/software/containers.md
index d15535933..0d96479e3 100644
--- a/doc.zih.tu-dresden.de/docs/software/containers.md
+++ b/doc.zih.tu-dresden.de/docs/software/containers.md
@@ -1,4 +1,4 @@
-# Use of Containers
+# Singularity
[Containerization](https://www.ibm.com/cloud/learn/containerization) encapsulating or packaging up
software code and all its dependencies to run uniformly and consistently on any infrastructure. On
@@ -15,11 +15,11 @@ systems cannot be granted root permissions. A solution is a Virtual Machine (VM)
`ml` which allows users to gain root permissions in an isolated environment. There are two main
options on how to work with Virtual Machines on ZIH systems:
-1. [VM tools](virtual_machines_tools.md): Automated algorithms for using virtual machines;
+1. [VM tools](singularity_power9.md): Automated algorithms for using virtual machines;
1. [Manual method](virtual_machines.md): It requires more operations but gives you more flexibility
and reliability.
-## Singularity
+## Usage of Singularity
If you wish to containerize your workflow and/or applications, you can use Singularity containers on
ZIH systems. As opposed to Docker, this solution is much more suited to being used in an HPC
@@ -101,7 +101,7 @@ You can create a new custom container on your workstation, if you have root righ
You cannot create containers for the partition `ml`, as it bases on Power9 micro-architecture
which is different to the x86 architecture in common computers/laptops. For that you can use
- the [VM Tools](virtual_machines_tools.md).
+ the [VM Tools](singularity_power9.md).
Creating a container is done by writing a **definition file** and passing it to
diff --git a/doc.zih.tu-dresden.de/docs/software/virtual_machines_tools.md b/doc.zih.tu-dresden.de/docs/software/singularity_power9.md
similarity index 97%
rename from doc.zih.tu-dresden.de/docs/software/virtual_machines_tools.md
rename to doc.zih.tu-dresden.de/docs/software/singularity_power9.md
index fbec2e51b..5daf70465 100644
--- a/doc.zih.tu-dresden.de/docs/software/virtual_machines_tools.md
+++ b/doc.zih.tu-dresden.de/docs/software/singularity_power9.md
@@ -1,4 +1,4 @@
-# Singularity on Partition `ml`
+# Singularity for Power 9 Architecture
!!! note "Root privileges"
@@ -35,7 +35,7 @@ in which case you'd need to change that when moving to ZIH systems.
## Build a Singularity Container in a Job
-To build a Singularity container for the power9-architecture on ZIH systems simply run:
+To build a Singularity container for the Power9 architecture on ZIH systems simply run:
```console
marie@login$ buildSingularityImage --arch=power9 myContainer.sif myDefinition.def
@@ -105,7 +105,7 @@ needs to be re-generated on every script run.
## Start a Job in a VM
Especially when developing a Singularity definition file, it might be useful to get a shell directly
-on a VM. To do so on the power9-architecture, simply run:
+on a VM. To do so on the Power9 architecture, simply run:
```console
startInVM --arch=power9
diff --git a/doc.zih.tu-dresden.de/docs/software/virtual_machines.md b/doc.zih.tu-dresden.de/docs/software/virtual_machines.md
index 2527bbe91..69b5c3798 100644
--- a/doc.zih.tu-dresden.de/docs/software/virtual_machines.md
+++ b/doc.zih.tu-dresden.de/docs/software/virtual_machines.md
@@ -61,7 +61,7 @@ Last login: Fri Jul 24 13:53:48 2020 from gateway
## Automation
-We provide [tools](virtual_machines_tools.md) to automate these steps. You may just type `startInVM
+We provide [tools](singularity_power9.md) to automate these steps. You may just type `startInVM
--arch=power9` on a login node and you will be inside the VM with everything mounted.
## Known Issues
@@ -79,7 +79,7 @@ rm -rf /tmp/sbuild-*
```
If that does not help, e.g., because one build alone needs more than the available disk memory, then
-it will be necessary to use the tmp folder on scratch. In order to ensure that the files in the
+it will be necessary to use the `tmp` folder on `scratch`. In order to ensure that the files in the
temporary folder will be owned by root, it is necessary to set up an image inside `/scratch/tmp`
instead of using it directly. E.g., to create a 25 GB of temporary memory image:
diff --git a/doc.zih.tu-dresden.de/mkdocs.yml b/doc.zih.tu-dresden.de/mkdocs.yml
index 8b06cb976..a795b86c9 100644
--- a/doc.zih.tu-dresden.de/mkdocs.yml
+++ b/doc.zih.tu-dresden.de/mkdocs.yml
@@ -31,7 +31,7 @@ nav:
- Containers:
- Singularity: software/containers.md
- Singularity Recipes and Hints: software/singularity_recipe_hints.md
- - Virtual Machines Tools: software/virtual_machines_tools.md
+ - Singularity for Power9: software/singularity_power9.md
- Virtual Machines: software/virtual_machines.md
- GPU-accelerated Containers for Deep Learning (NGC Containers): software/ngc_containers.md
- Applications:
--
GitLab