Skip to content

Commit 62e6324

Browse files
committed
Update resource-hook.md
1 parent 7ad8fba commit 62e6324

File tree

1 file changed

+19
-16
lines changed

1 file changed

+19
-16
lines changed

docs/software/container-engine/resource-hook.md

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ This can be done in multiple ways in TOML: for example, both of the following us
3131

3232
* 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.
3333

34-
* 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. See the [TOML format](https://toml.io/en/) spec for more details.
34+
* 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.
3535

3636
```bash title="Valid"
3737
[annotations.com.hooks.ssh]
@@ -49,12 +49,10 @@ This can be done in multiple ways in TOML: for example, both of the following us
4949
[annotations]
5050
com.hooks.ssh.authorize_ssh_key = "${SCRATCH}/tests/edf/authorized_keys"
5151

52-
[annotations.com.hooks.ssh] # (1)
52+
[annotations.com.hooks.ssh]
5353
enabled = "true"
5454
```
5555

56-
1. The `ssh` table was doubly defined both in the `[annotations]` and in the `[annotations.com.hooks.ssh]` sections.
57-
5856
## Accessing native resources
5957

6058
### NVIDIA GPUs
@@ -130,9 +128,10 @@ Container hooks let you customize container behavior to fit system-specific need
130128
On most vClusters, the CXI hook for Slingshot connectivity is enabled implicitly by default or by other hooks.
131129
Therefore, entering the enabling annotation in the EDF is unnecessary in many cases.
132130

133-
```bash title"Required annotation"
134-
com.hooks.cxi.enabled = "true"
135-
```
131+
!!! note "Required annotation"
132+
```console
133+
com.hooks.cxi.enabled = "true"
134+
```
136135

137136
The Container Engine provides a hook to allow containers relying on [libfabric](https://ofiwg.github.io/libfabric/) to leverage the HPE Slingshot 11 high-speed interconnect.
138137
This component is commonly referred to as the "CXI hook", taking its name from the CXI libfabric provider required to interface with Slingshot 11.
@@ -226,10 +225,13 @@ The hook is activated by setting the `com.hooks.cxi.enabled` annotation, which
226225
[](){#ref-ce-aws-ofi-hook}
227226
### AWS OFI NCCL Hook 
228227

229-
```bash title="Required annotation"
230-
com.hooks.aws_ofi_nccl.enabled = "true"
231-
com.hooks.aws_ofi_nccl.variant = "cuda12"
232-
```
228+
!!! note "Required annotation"
229+
```console
230+
com.hooks.aws_ofi_nccl.enabled = "true"
231+
com.hooks.aws_ofi_nccl.variant = "cuda12" # (1)
232+
```
233+
234+
1. `com.hooks.aws_ofi_nccl.variant` may vary depending on vClusters. Details below.
233235

234236
The [AWS OFI NCCL plugin](https://github.com/aws/aws-ofi-nccl) is a software extension that allows the [NCCL](https://developer.nvidia.com/nccl) and [RCCL](https://rocm.docs.amd.com/projects/rccl/en/latest/) libraries to use libfabric as a network provider and, through libfabric, to access the Slingshot high-speed interconnect.
235237
Also see [NCCL][ref-communication-nccl] and [libfabric][ref-communication-libfabric] for more information on using the libraries on Alps.
@@ -256,12 +258,13 @@ At the moment of writing, 4 plugin variants are configured: `cuda11`, `cuda12`
256258
[](){#ref-ce-ssh-hook}
257259
### SSH Hook
258260

259-
```bash title="Required annotation"
260-
com.hooks.ssh.enabled = "true"
261-
com.hooks.ssh.authorize_ssh_key = "<public-key>" # (1)
262-
```
261+
!!! note "Required annotation"
262+
```console
263+
com.hooks.ssh.enabled = "true"
264+
com.hooks.ssh.authorize_ssh_key = "<public-key>" # (1)
265+
```
263266

264-
1. Replace `<public-key>` with your SSH public key.
267+
1. Replace `<public-key>` with your SSH public key.
265268

266269
!!! warning
267270
The `srun` command launching an SSH-connectable container **should set the `--pty` option** in order for the hook to initialize properly.

0 commit comments

Comments
 (0)