You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: pages/docs/user-docs/action-build.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ folder: docs
6
6
toc: false
7
7
---
8
8
9
-
`build` is the "Swiss army knife" of container creation. You can use it to download and assemble existing containers from external resources like [Singularity Hub](https://singularity-hub.org/) and [Docker Hub](https://hub.docker.com/). You can use it to convert containers between the various formats supported by Singularity. And you can use it in conjunction with a [Singularity Recipe](/docs-recipes) file to create a container from scratch and customized it to fit your needs.
9
+
`build` is the "Swiss army knife" of container creation. You can use it to download and assemble existing containers from external resources like [Singularity Hub](https://singularity-hub.org/) and [Docker Hub](https://hub.docker.com/). You can use it to convert containers between the various formats supported by Singularity. And you can use it in conjunction with a [Singularity recipe](/docs-recipes) file to create a container from scratch and customized it to fit your needs.
10
10
11
11
{% include toc.html %}
12
12
@@ -20,7 +20,7 @@ The target defines the method that `build` uses to create the container. It can
20
20
- path to a **existing container** on your local machine
21
21
- path to a **directory** to build from a sandbox
22
22
- path to an **archive** in .tar or compressed .tar.gz format
23
-
- path to a **[Recipe file](docs-recipes)**
23
+
- path to a **[Singularity recipe file](docs-recipes)**
24
24
25
25
In addition `build` can produce containers in three different formats. Formats types can be specified by passing the following options to build.
You can convert the three supported container formats using any combination.
113
113
114
-
Use care when converting writable ext3 images or sandbox directories to the default squashfs file format. If changes were made to the writable container before conversion, there is no record of those changes in the Recipe file rendering your container non-reproducible. It is a best practice to build your immutable production containers directly from a Recipe file instead.
114
+
Use care when converting writable ext3 images or sandbox directories to the default squashfs file format. If changes were made to the writable container before conversion, there is no record of those changes in the Singularity recipe file rendering your container non-reproducible. It is a best practice to build your immutable production containers directly from a Singularity recipe file instead.
115
115
116
-
## Building containers from Recipe files
117
-
Of course, Recipe files can be used as the target when building a container. For detailed information on writing Recipe files, please see [the Container Recipes docs](docs-recipes).
116
+
## Building containers from Singularit recipe files
117
+
Of course, Singularity recipe files can be used as the target when building a container. For detailed information on writing Singularity recipe files, please see [the Container Recipes docs](docs-recipes).
118
118
119
-
Let's say you already have the following Recipe file called `Singularity`, and you want to use it to build a container.
119
+
Let's say you already have the following container recipe file called `Singularity`, and you want to use it to build a container.
120
120
121
121
```
122
122
BootStrap: docker
@@ -150,13 +150,13 @@ By default if you build into an existing container, the `build` command will ski
150
150
Use care with this option: you may get results that you did not expect.
151
151
152
152
### `--section`
153
-
If you only want to build a single section of your Recipe file use the `--section` option. For instance, if you have edited the `%environment` section of a long Recipe and don't want to completely re-build the container, you could re-build only the `%environment` section like so:
153
+
If you only want to build a single section of your Singularity recipe file use the `--section` option. For instance, if you have edited the `%environment` section of a long Singularity recipe and don't want to completely re-build the container, you could re-build only the `%environment` section like so:
Under normal build conditions, the Recipe file is saved into a container's meta-data so that there is a record showing how the container was built. Using the `--section` option may render this meta-data useless, so use care if you value reproducibility.
159
+
Under normal build conditions, the Singularity recipe file is saved into a container's meta-data so that there is a record showing how the container was built. Using the `--section` option may render this meta-data useless, so use care if you value reproducibility.
160
160
161
161
### `--notest`
162
162
If you don't want to run the `%test` section during the container build, you can skip it with the `--notest` option. For instance, maybe you are building a container intended to run in a production environment with GPUs. But perhaps your local build resource does not have GPUs. You want to include a `%test` section that runs a short validation but you don't want your build to exit with an error because it cannot find a GPU on your system.
0 commit comments