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
@@ -90,7 +90,7 @@ Specifying the `--environment` option to the Slurm command (e.g., `srun` or `sal
90
90
`--environment` can be a relative path from the current working directory (i.e., where the Slurm command is executed).
91
91
A relative path should be prepended by `./`:
92
92
93
-
!!! example
93
+
!!! example "Specifying EDF with a relative path"
94
94
```bash
95
95
$ ls
96
96
debian.toml
@@ -104,7 +104,7 @@ A relative path should be prepended by `./`:
104
104
105
105
If an EDF is located in the [EDF search path][ref-ce-edf-search-path], `--environment` also accepts the EDF filename without the `.toml` extension:
106
106
107
-
!!! example
107
+
!!! example "Specifying EDF in the default search path"
108
108
```bash
109
109
$ srun --environment=debian cat /etc/os-release
110
110
PRETTY_NAME="Debian GNU/Linux 12 (bookworm)"
@@ -117,7 +117,7 @@ If an EDF is located in the [EDF search path][ref-ce-edf-search-path], `--enviro
117
117
118
118
The recommended approach is to use `--environment` as part of the Slurm command (e.g., `srun` or `salloc`):
119
119
120
-
!!! example
120
+
!!! example "Adding `--environment` to `srun`"
121
121
```bash
122
122
#!/bin/bash
123
123
#SBATCH --job-name=edf-example
@@ -142,7 +142,7 @@ The default EDF search path can be changed through the `EDF_PATH` environment va
142
142
`EDF_PATH` must be a colon-separated list of absolute paths to directories, where the CE searches each directory in order.
143
143
If an EDF is located in the search path, its name can be used in the `--environment` option without the `.toml` extension.
144
144
145
-
!!! example
145
+
!!! example "Using `EDF_PATH` to control the default search path"
146
146
```bash
147
147
$ ls ~/.edf
148
148
debian.toml
@@ -220,13 +220,16 @@ After the import is complete, images are available in Squashfs format in the cur
220
220
221
221
To use an image from a different registry, the corresponding registry URL has to be prepended to the image reference, using a hash character (#) as a separator:
222
222
223
-
!!! example
223
+
!!! example "Using a third-party registry within an EDF"
@@ -295,27 +298,30 @@ This can be done in multiple ways in TOML: for example, both of the following us
295
298
enabled = "true"
296
299
```
297
300
298
-
To avoid mistakes, notice a few key features of TOML:
301
+
??? note "Relevant details of the TOML format"
302
+
* All property assignments belong to the section immediately preceding them (the statement in square brackets), which defines the table they refer to.
303
+
304
+
* Tables, on the other hand, do not automatically belong to the tables declared before them; to nest tables, their name has to list their parents using the dot notations (so the previous example defines the table `ssh` inside `hooks`, which in turn is inside `com`, which is inside `annotations`).
305
+
306
+
* An assignment can implicitly define subtables if the key you assign is a dotted list. As a reference, see the examples made earlier in this section, where assigning a string to the `com.hooks.ssh.enabled` attribute within the `[annotations]` table is exactly equivalent to assigning to the `enabled` attribute within the `[annotations.com.hooks.ssh]` subtable.
307
+
308
+
* Attributes can be added to a table only in one place in the TOML file. In other words, each table must be defined in a single square bracket section. For example, Case 3 in the example below is invalid because the `ssh` table was doubly defined both in the `[annotations]` and in the `[annotations.com.hooks.ssh]` sections. See the [TOML format](https://toml.io/en/) spec for more details.
299
309
300
-
* All property assignments belong to the section immediately preceding them (the statement in square brackets), which defines the table they refer to.
301
-
* Tables, on the other hand, do not automatically belong to the tables declared before them; to nest tables, their name has to list their parents using the dot notations (so the previous example defines the table `ssh` inside `hooks`, which in turn is inside `com`, which is inside `annotations`).
302
-
* An assignment can implicitly define subtables if the key you assign is a dotted list. As a reference, see the examples made earlier in this section, where assigning a string to the `com.hooks.ssh.enabled` attribute within the `[annotations]` table is exactly equivalent to assigning to the `enabled` attribute within the `[annotations.com.hooks.ssh]` subtable.
303
-
* Attributes can be added to a table only in one place in the TOML file. In other words, each table must be defined in a single square bracket section. For example, Case 3 in the example below is invalid because the `ssh` table was doubly defined both in the `[annotations]` and in the `[annotations.com.hooks.ssh]` sections. See the [TOML format](https://toml.io/en/) spec for more details.
0 commit comments