From ef2eb080ff180976b3abe5c9b84cef65bfa77201 Mon Sep 17 00:00:00 2001 From: Carlos Yanez Date: Wed, 22 May 2024 10:57:29 -0400 Subject: [PATCH] Fix lab3 broken example, and many minor issues --- build-noroot.md | 6 +++--- building.md | 3 +++ gettingstarted.md | 2 +- introduction.md | 2 +- lab2.1.md | 3 +-- lab3.md | 7 +++++-- runcontainer.md | 2 +- workflow.md | 8 ++++---- 8 files changed, 19 insertions(+), 14 deletions(-) diff --git a/build-noroot.md b/build-noroot.md index d061896..f469473 100644 --- a/build-noroot.md +++ b/build-noroot.md @@ -3,7 +3,7 @@ There are situations where root access is not given, however, do not worry, there are 3 options to choose from: -* Use --fakeroot. +* Use `--fakeroot`. * Use proot. * Use Singularity Container Services. @@ -87,8 +87,8 @@ your kernel is older, then your next option is to use proot. ## Using proot SingularityCE 3.11 introduces the ability to run some definition file builds -without --fakeroot or sudo. This is useful on systems where you cannot sudo, and -the administrator cannot perform the configurations necessary for --fakeroot +without `--fakeroot` or sudo. This is useful on systems where you cannot sudo, and +the administrator cannot perform the configurations necessary for `--fakeroot` support. Unprivileged proot builds are automatically performed when proot is available on diff --git a/building.md b/building.md index fbea7f1..e80febb 100644 --- a/building.md +++ b/building.md @@ -44,6 +44,9 @@ INFO: Starting build... INFO: Downloading library image 28.4MiB / 28.4MiB [=====================================] 100 % 3.4 MiB/s 0s INFO: Verifying bootstrap image /root/.singularity/cache/library/sha256.7a63c...98b +INFO: Running post scriptlet ++ echo “Display any message during build!” +“Display any message during build!” INFO: Creating SIF file... INFO: Build complete: demo.sif ``` diff --git a/gettingstarted.md b/gettingstarted.md index 5e9acf3..864952f 100644 --- a/gettingstarted.md +++ b/gettingstarted.md @@ -27,7 +27,7 @@ $ sudo dnf update $ sudo dnf install singularity-ce ``` -If your operating system is Debian based, please follow the [SingularityCE installation guide](https://docs.sylabs.io/guides/3.10/admin-guide/installation.html#install-from-provided-rpm-deb-packages). +If your operating system is Debian based, please follow the [SingularityCE installation guide](https://docs.sylabs.io/guides/latest/admin-guide/installation.html#install-from-provided-rpm-deb-packages). Once you’ve installed SingularityCE, you can issue the following command to run a container: diff --git a/introduction.md b/introduction.md index 371a09b..59c7a96 100644 --- a/introduction.md +++ b/introduction.md @@ -19,7 +19,7 @@ container technologies that allow containers to run with root privileges, SingularityCE is rootless, reducing the risk of privilege escalation and unauthorized access in supercomputing and commercial environments. -[Read more](https://docs.sylabs.io/guides/3.11/user-guide/introduction.html) +[Read more](https://docs.sylabs.io/guides/latest/user-guide/introduction.html) about why containers are needed and SingularityCE containers and their use cases on our documentation site. diff --git a/lab2.1.md b/lab2.1.md index b4325f5..ca4f094 100644 --- a/lab2.1.md +++ b/lab2.1.md @@ -10,8 +10,7 @@ Next, let’s build a very simple image. We will create a file and name it lab2.def. Simply add the following text. ````{note} -Note -Note This tutorial assumes that you are familiar with the vi editor. However, +This tutorial assumes that you are familiar with the vi editor. However, this is not a mandatory requisite, feel free to substitute your preferred editor instead. ````` diff --git a/lab3.md b/lab3.md index 784e746..8da624e 100644 --- a/lab3.md +++ b/lab3.md @@ -20,6 +20,7 @@ From: golang:1.20.2-alpine Stage: compiler %post + apk add git git clone https://github.com/golang/example cd example/hello go build @@ -29,7 +30,7 @@ From: alpine:3.17 Stage: final %files from compiler - /root/hello /bin/hello + example/hello/hello /bin/hello ``` ```bash @@ -70,7 +71,7 @@ INFO: Build complete: lab3.sif ```bash $ singularity exec lab3.sif hello -Hello, Go examples! +Hello, world! ``` The names of the stages are up to you, and each of the sections will be executed @@ -82,7 +83,9 @@ Let’s create a file named lab3-wrong.def and then build it as shown below: ```bash $ vi lab3-wrong.def +``` +``` Bootstrap: docker From: alpine:3.17 Stage: final diff --git a/runcontainer.md b/runcontainer.md index 8f20f93..2f5f6cc 100644 --- a/runcontainer.md +++ b/runcontainer.md @@ -21,7 +21,7 @@ engine and let it go its way. Next, let’s grab a shell and get into the container. ```bash -singularity shell library://josue-sylabs/demo/wttr:latest +$ singularity shell library://josue-sylabs/demo/wttr:latest INFO: Using cached image Singularity> _ ``` diff --git a/workflow.md b/workflow.md index 7237347..32ededa 100644 --- a/workflow.md +++ b/workflow.md @@ -73,10 +73,6 @@ have many options to choose from, including the Singularity Container Library (library), Docker Hub, OCI Registry as Storage (ORAS), yum, localimage, debootstrap, Open Container Initiative (OCI), BusyBox, and others. -For more information, please see our official -[definition file](https://docs.sylabs.io/guides/latest/user-guide/definition_files.html) -documentation. - The `From` keyword depends on the bootstrap value, in this case, when using the library, the From keyword becomes valid and is used to specify the name and tag of the base OS. @@ -110,3 +106,7 @@ be displayed while executing the `singularity inspect` command. The text in the `%help` section is transferred to a metadata file inside the container. It can be displayed using the `singularity run-help` command. + +For more information, please see our official +[definition file](https://docs.sylabs.io/guides/latest/user-guide/definition_files.html) +documentation. \ No newline at end of file