Skip to content

Commit a4f7b44

Browse files
committed
updating links
1 parent 7845e41 commit a4f7b44

8 files changed

Lines changed: 9 additions & 9 deletions

File tree

_posts/releases/2017-10-02-release-2.4.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Building an image is now more intuitive with the introduction of our `build` com
1717
sudo singularity build container.simg Singularity
1818
```
1919

20-
If you are tired of needing to estimate your image size, that issue goes away with build. The default format for a Singularity image base is now a smaller, compressed file format called **SquashFS**. This format is also a much better fit for reproducible containers, as it is immutable. For more details, see our [build](/docs-build) documentation.
20+
If you are tired of needing to estimate your image size, that issue goes away with build. The default format for a Singularity image base is now a smaller, compressed file format called **SquashFS**. This format is also a much better fit for reproducible containers, as it is immutable. For more details, see our [build](/docs-build-container) documentation.
2121

2222
**Build Bases**
2323
We originally supported just using an existing distribution package or docker as a base for building images. With 2.4, we have extended that set to include another Singularity image (`localimage`), a Singularity Hub or Registry image (`shub`) or the host operating system (`self`).

pages/docs/user-docs/action-run.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ When you first create a container, the runscript is defined using the following
5959
4. If the user has not defined a runscript and the Docker container doesn't have an `ENTRYPOINT`, we look for `CMD`, even if the user hasn't asked for it.
6060
5. If the user has not deifned a runscript, and there is no `ENTRYPOINT` or `CMD` (or we aren't importing Docker at all) then we default to `/bin/bash`
6161

62-
Here is how you would define the runscript section when you [build](/docs-build) an image:
62+
Here is how you would define the runscript section when you [build](/docs-build-container) an image:
6363

6464
```bash
6565
Bootstrap: docker

pages/docs/user-docs/docs-flow.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The diagram below is a visual depiction of how you can use Singularity to build
2626
<img style="max-width:900px" src="/assets/img/diagram/singularity-2.4-flow.png">
2727
</a>
2828

29-
Singularity production images are immutable. This is a feature added as of Singularity 2.4, and it ensures a higher level of reproducibility and verification of images. To read more about the details, check out the [build](docs-build) docs. However, immutability is not so great when you are testing, debugging, or otherwise want to quickly change your image. We will proceed by describing a typical workflow of developing first, building a final image, and using in production.
29+
Singularity production images are immutable. This is a feature added as of Singularity 2.4, and it ensures a higher level of reproducibility and verification of images. To read more about the details, check out the [build](docs-build-container) docs. However, immutability is not so great when you are testing, debugging, or otherwise want to quickly change your image. We will proceed by describing a typical workflow of developing first, building a final image, and using in production.
3030

3131
### 1. Development Commands
3232
If you want a writable image or folder for developing, you have two options:

pages/docs/user-docs/docs-quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ $ singularity help --app foo container.img # See the help for foo, if provided
102102
```
103103

104104
## Download pre-built images
105-
You can use the [`pull`](docs-pull) and [`build`](docs-build) commands to download pre-built images from an external resource like [Singularity Hub](https://singularity-hub.org/) or [Docker Hub](https://hub.docker.com/). When called on a native Singularity images like those provided on Singularity Hub, `pull` simply downloads the image file to your system.
105+
You can use the [`pull`](docs-pull) and [`build`](docs-build-container) commands to download pre-built images from an external resource like [Singularity Hub](https://singularity-hub.org/) or [Docker Hub](https://hub.docker.com/). When called on a native Singularity images like those provided on Singularity Hub, `pull` simply downloads the image file to your system.
106106

107107

108108
```

pages/docs/user-docs/docs-recipes.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Please see the [examples](https://github.com/singularityware/singularity/tree/ma
2222
### Header
2323
The header is at the top of the file, and tells Singularity the base Operating System that it should use to build the container. It is composed of several keywords. Specifically:
2424

25-
- `Bootstrap:` references the kind of base you want to use (e.g., docker, debootstrap, shub). For example, a shub bootstrap will pull containers for shub as bases. A Docker bootstrap will pull docker layers to start your image. For a full list see [build](docs-build)
25+
- `Bootstrap:` references the kind of base you want to use (e.g., docker, debootstrap, shub). For example, a shub bootstrap will pull containers for shub as bases. A Docker bootstrap will pull docker layers to start your image. For a full list see [build](docs-build-container)
2626
- `From:` is the named container (shub) or reference to layers (Docker) that you want to use (e.g., vsoch/hello-world)
2727

2828
Depending on the value assigned to `Bootstrap:`, other keywords may also be valid in the header.
@@ -468,4 +468,4 @@ When crafting your recipe, it is best to consider the following:
468468
6. Ensure that the container's `/etc/passwd`, `/etc/group`, `/etc/shadow`, and no other sensitive files have anything but the bare essentials within them.
469469
7. It is encouraged to build containers from a recipe instead of a sandbox that has been manually changed. This ensures greatest possibility of reproducibility and mitigates the *black box effect*.
470470

471-
Are you a recipe pro and now ready to build? Take a look at the [build](docs-build) documentation.
471+
Are you a recipe pro and now ready to build? Take a look at the [build](docs-build-container) documentation.

pages/docs/user-docs/docs-usage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ If you type `singularity` without any arguments, you will see a high level help
1818

1919
**Container Actions**
2020

21-
- [build](/docs-build): Build a container on your user endpoint or build environment
21+
- [build](/docs-build-container): Build a container on your user endpoint or build environment
2222
- [exec](/docs-exec): Execute a command to your container
2323
- [inspect](/docs-inspect): See labels, run and test scripts, and environment variables
2424
- [pull](/docs-pull): pull an image from Docker or Singularity Hub

pages/docs/user-docs/image-create.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ permalink: /docs-create
55
folder: docs
66
---
77

8-
A Singularity image, which can be referred to as a "container," is a single file that contains a virtual file system. As of Singularity 2.4, we strongly recommend that you build (create and install) an image using <a href="/docs-build">build</a>. If you have reason to create an empty image, or use creat for any other reason, the original `create` command is replaced with a more specific `image.create`. After creating an image you can install an operating system, applications, and save meta-data with it.
8+
A Singularity image, which can be referred to as a "container," is a single file that contains a virtual file system. As of Singularity 2.4, we strongly recommend that you build (create and install) an image using <a href="/docs-build-container">build</a>. If you have reason to create an empty image, or use creat for any other reason, the original `create` command is replaced with a more specific `image.create`. After creating an image you can install an operating system, applications, and save meta-data with it.
99

1010
Whereas Docker assembles images from layers that are stored on your computer (viewed with the `docker history` command), a Singularity image is just one file that can sit on your Desktop, in a folder on your cluster, or anywhere. Having Singularity containers housed within a single image file greatly simplifies management tasks such as sharing, copying, and branching your containers. It also means that standard Linux file system concepts like permissions, ownership, and ACLs apply to the container (e.g. I can give read only access to a colleague, or block access completely with a simple `chmod` command).
1111

pages/docs/user-docs/user-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ Once you have the container with the necessary applications, libraries and data
165165
### Singularity Commands
166166
How do the commands work? Here is where to look for more information:
167167

168-
- [build](/docs-build): Build a container on your user endpoint or build environment
168+
- [build](/docs-build-container): Build a container on your user endpoint or build environment
169169
- [exec](/docs-exec): Execute a command to your container
170170
- [inspect](/docs-inspect): See labels, run and test scripts, and environment variables
171171
- [pull](/docs-pull): pull an image from Docker or Singularity Hub

0 commit comments

Comments
 (0)