Skip to content

Commit dcb4ce3

Browse files
committed
Update resource-hook.md
1 parent 3b0fe3a commit dcb4ce3

File tree

1 file changed

+13
-16
lines changed

1 file changed

+13
-16
lines changed

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

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -130,10 +130,9 @@ Container hooks let you customize container behavior to fit system-specific need
130130
On most vClusters, the CXI hook for Slingshot connectivity is enabled implicitly by default or by other hooks.
131131
Therefore, entering the enabling annotation in the EDF is unnecessary in many cases.
132132

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

138137
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.
139138
This component is commonly referred to as the "CXI hook", taking its name from the CXI libfabric provider required to interface with Slingshot 11.
@@ -227,13 +226,12 @@ The hook is activated by setting the `com.hooks.cxi.enabled` annotation, which
227226
[](){#ref-ce-aws-ofi-hook}
228227
### AWS OFI NCCL Hook 
229228

230-
!!! note "Required annotation"
231-
```console
232-
com.hooks.aws_ofi_nccl.enabled = "true"
233-
com.hooks.aws_ofi_nccl.variant = "cuda12" # (1)
234-
```
229+
```bash title="Required annotation"
230+
com.hooks.aws_ofi_nccl.enabled = "true"
231+
com.hooks.aws_ofi_nccl.variant = "cuda12" # (1)
232+
```
235233

236-
1. `com.hooks.aws_ofi_nccl.variant` may vary depending on vClusters. Details below.
234+
1. `com.hooks.aws_ofi_nccl.variant` may vary depending on vClusters. Details below.
237235

238236
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.
239237
Also see [NCCL][ref-communication-nccl] and [libfabric][ref-communication-libfabric] for more information on using the libraries on Alps.
@@ -260,13 +258,12 @@ At the moment of writing, 4 plugin variants are configured: `cuda11`, `cuda12`
260258
[](){#ref-ce-ssh-hook}
261259
### SSH Hook
262260

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

269-
1. Replace `<public-key>` with your SSH public key.
266+
1. Replace `<public-key>` with your SSH public key.
270267

271268
!!! warning
272269
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)