Skip to content

Commit 8e3ad89

Browse files
committed
Update hooks
1 parent 44d9019 commit 8e3ad89

File tree

1 file changed

+16
-8
lines changed

1 file changed

+16
-8
lines changed

docs/software/container-engine.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -405,10 +405,14 @@ Container hooks let you customize container behavior to fit system-specific need
405405
[](){#ref-ce-cxi-hook}
406406
### HPE Slingshot interconnect 
407407

408-
```bash
409-
[annotations]
410-
com.hooks.cxi.enabled = "true"
411-
```
408+
!!! tip
409+
On most vClusters, the CXI hook for Slingshot connectivity is enabled implicitly by default or by other hooks.
410+
Therefore, entering the enabling annotation in the EDF is unnecessary in many cases.
411+
412+
!!! note "Required annotation"
413+
```bash
414+
com.hooks.cxi.enabled = "true"
415+
```
412416

413417
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.
414418
This component is commonly referred to as the "CXI hook", taking its name from the CXI libfabric provider required to interface with Slingshot 11.
@@ -498,13 +502,17 @@ The hook is activated by setting the `com.hooks.cxi.enabled` annotation, which
498502
4194304 23925.61
499503
```
500504

501-
!!! tip
502-
On most vClusters, the CXI hook for Slingshot connectivity is enabled implicitly by default or by other hooks.
503-
Therefore, entering the enabling annotation in the EDF is unnecessary in many cases.
504-
505505
[](){#ref-ce-aws-ofi-hook}
506506
### AWS OFI NCCL Hook 
507507

508+
!!! note "Required annotation"
509+
```bash
510+
com.hooks.aws_ofi_nccl.enabled = "true"
511+
com.hooks.aws_ofi_nccl.variant = "cuda12" # (1)
512+
```
513+
514+
1. `com.hooks.aws_ofi_nccl.variant` may vary depending on vClusters.
515+
508516
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.
509517
Also see [NCCL][ref-communication-nccl] and [libfabric][ref-communication-libfabric] for more information on using the libraries on Alps.
510518

0 commit comments

Comments
 (0)