From 10f553417ddf2f75b96ea0d495b1fc2777b1f16b Mon Sep 17 00:00:00 2001 From: Josef Hrabal <josef.hrabal@vsb.cz> Date: Wed, 20 Dec 2017 10:03:06 +0100 Subject: [PATCH] typo --- docs.it4i/software/tools/singularity.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs.it4i/software/tools/singularity.md b/docs.it4i/software/tools/singularity.md index 73c8144c5..288f420a0 100644 --- a/docs.it4i/software/tools/singularity.md +++ b/docs.it4i/software/tools/singularity.md @@ -9,11 +9,11 @@ Singularity also allows you to leverage the resources of whatever host you are o * No user contextual changes or root escalation allowed * No root owned daemon processes -These documentation are for Singularity Version 2.4 and newer. +This documentation is for Singularity version 2.4 and newer. ## Using Docker Images -Singularity can import, bootstrap, and even run Docker images directly from [Docker Hub](https://hub.docker.com/). You can easily run RHEL7 like this: +Singularity can import, bootstrap, and even run Docker images directly from [Docker Hub](https://hub.docker.com/). You can easily run RHEL7 container like this: ```console hra0031@login4:~$ cat /etc/redhat-release @@ -30,9 +30,9 @@ Singularity centos:latest:~> cat /etc/redhat-release CentOS Linux release 7.4.1708 (Core) ``` -In this case, Image is downloaded from Docker Hub, extracted to a temporary directory and singularity interactive shell is invoked. This procedure can take a lot of time, especially for larger images. +In this case, image is downloaded from Docker Hub, extracted to a temporary directory and Singularity interactive shell is invoked. This procedure can take a lot of time, especially with large images. -## Creating Own Image From Docker Image +## Importing Docker Image Singularity containers can be in three different formats: @@ -40,7 +40,7 @@ Singularity containers can be in three different formats: * writable **ext3** (--writable option) * writable **(ch)root directory** (--sandbox option) - best for development -Squashfs and (ch)root directory image can be built from docker source directly on the cluster, no root privileges are needed. Creating native singularity image is strongly recommended due to the speed of launching the container. +Squashfs and (ch)root directory images can be built from Docker source directly on the cluster, no root privileges are needed. It is strongly recomended to create native Singularity image to speed up the launch of the container. ```console hra0031@login4:~$ ml Singularity @@ -63,7 +63,7 @@ Cleaning up... ## Launching the Container -The interactive shell can be invoked by the `singularity shell` command. This is useful for development purposes. To make changes inside the container permanent use `-w | --writable` option. +The interactive shell can be invoked by the `singularity shell` command. This is useful for development purposes. Use the `-w | --writable` option to make changes inside the container permanent. ```console hra0031@login4:~$ singularity shell -w ubuntu.img @@ -76,7 +76,7 @@ DISTRIB_CODENAME=xenial DISTRIB_DESCRIPTION="Ubuntu 16.04.3 LTS" ``` -To execute command inside container (without interactive shell) use `singularity exec` command. +A command can be run inside the container (without interactive shell) by invoking `singularity exec` command. ``` hra0031@login4:~$ singularity exec ubuntu.img cat /etc/lsb-release @@ -86,7 +86,7 @@ DISTRIB_CODENAME=xenial DISTRIB_DESCRIPTION="Ubuntu 16.04.3 LTS" ``` -Singularity image can contain a runscript. This script is executed inside container after the `singularity run` command is used. The runscript is mostly used to run an application for which is the container build, in the following example it is `fortune | cowsay` command. +Singularity image can contain a runscript. This script is executed inside the container after the `singularity run` command is used. The runscript is mostly used to run an application for which the container is built. In the following example it is `fortune | cowsay` command. ``` hra0031@login4:~$ singularity run ubuntu.img @@ -102,10 +102,10 @@ hra0031@login4:~$ singularity run ubuntu.img ## Accessing /HOME and /SCRATCH Within Container -By default, user home directory is mounted inside the container, therefore you can access your files directly. If you need access to **/SCRATCH** storage for your computation, this must be mounted by `-B | --bind` option. +User home directory is mounted inside the container automatically. If you need access to **/SCRATCH** storage for your computation, this must be mounted by `-B | --bind` option. !!!Warning - Be aware, that the mounted folder has to exist inside the container or the container image has to be writable! + The mounted folder has to exist inside the container or the container image has to be writable! ```console hra0031@login4:~$ singularity shell -B /scratch -w ubuntu.img -- GitLab