Skip to content

Commit dfb602d

Browse files
committed
Divide container doc
1 parent 36a866b commit dfb602d

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ If you cannot find the information that you need in the documentation, help is a
127127

128128
[:octicons-arrow-right-24: uenv][ref-uenv]
129129

130-
[:octicons-arrow-right-24: Container engine](software/container-engine.md)
130+
[:octicons-arrow-right-24: Container engine](software/container-engine/index.md)
131131

132132

133133
- :fontawesome-solid-screwdriver-wrench: __Data management and storage__

docs/software/container-engine/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ To simplify this process, the Container Engine (CE) toolset supports the specifi
1111
An Environment Definition File (EDF) is a text file in the [TOML format](https://toml.io/en/) that declaratively and prescriptively represents the creation of a computing environment based on a container image.
1212
Users can create their own custom environments and share, edit, or build upon already existing environments.
1313

14-
The Container Engine (CE) toolset leverages its tight integration with the Slurm workload manager to parse EDFs directly from the command line or batch script and instantiate containerized user environments seamlessly and transparently.
14+
The Container Engine (CE) toolset leverages its tight integration with the Slurm workload manager to parse Fs directly from the command line or batch script and instantiate containerized user environments seamlessly and transparently.
1515

1616
Through the EDF, container use cases can be abstracted to the point where end users perform their workflows as if they were operating natively on the computing system.
1717

@@ -26,7 +26,7 @@ Through the EDF, container use cases can be abstracted to the point where end us
2626

2727
Let's set up a containerized Ubuntu 24.04 environment on the scratch folder (`${SCRATCH}`).
2828
Save this file below as `ubuntu.toml` in `${HOME}/.edf` directory (the default location of EDF files).
29-
A more detailed explanation of each entry for the EDF can be seen in the [EDF reference][./edf.md].
29+
A more detailed explanation of each entry for the EDF can be seen in the [EDF reference][software/container-engine/edf.md].
3030

3131
```bash
3232
image = "library/ubuntu:24.04"

docs/software/container-engine/known-issue.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Notice the section `[annotations]` disabling Slurm and CXI hooks.
3636
3737
### Using NCCL from remote SSH terminals
3838
39-
We are aware of an issue when enabling both [the AWS OFI NCCL hook][ref-ce-aws-ofi-hook] and [the SSH hook][ref-ce-ssh-hook], and launching programs using NCCL from Bash sessions connected via SSH.
39+
We are aware of an issue when enabling both [the AWS OFI NCCL hook][software/container-engine/resource-hook.md#ref-ce-aws-ofi-hook] and [the SSH hook][software/container-engine/resource-hook.md#ref-ce-ssh-hook], and launching programs using NCCL from Bash sessions connected via SSH.
4040
The issue manifests with messages reporting `Error: network 'AWS Libfabric' not found`.
4141
4242
In addition to setting up a server for remote connections, the SSH hook also performs actions intended to improve the user experience. One of these is creating a script to be loaded by Bash in order to propagate the container job environment variables when connecting through SSH.

0 commit comments

Comments
 (0)