Skip to content
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

Fix lab3 broken example, and many minor issues #7

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions build-noroot.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions building.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand Down
2 changes: 1 addition & 1 deletion gettingstarted.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
3 changes: 1 addition & 2 deletions lab2.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
`````
Expand Down
7 changes: 5 additions & 2 deletions lab3.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -29,7 +30,7 @@ From: alpine:3.17
Stage: final

%files from compiler
/root/hello /bin/hello
example/hello/hello /bin/hello
```

```bash
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion runcontainer.md
Original file line number Diff line number Diff line change
Expand Up @@ -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> _
```
Expand Down
8 changes: 4 additions & 4 deletions workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.