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
Copy file name to clipboardExpand all lines: docs/software/container-engine/resource-hook.md
+19-16Lines changed: 19 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,7 +31,7 @@ This can be done in multiple ways in TOML: for example, both of the following us
31
31
32
32
* 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.
33
33
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.
35
35
36
36
```bash title="Valid"
37
37
[annotations.com.hooks.ssh]
@@ -49,12 +49,10 @@ This can be done in multiple ways in TOML: for example, both of the following us
1. The `ssh` table was doubly defined both in the `[annotations]` and in the `[annotations.com.hooks.ssh]` sections.
57
-
58
56
## Accessing native resources
59
57
60
58
### NVIDIA GPUs
@@ -130,9 +128,10 @@ Container hooks let you customize container behavior to fit system-specific need
130
128
On most vClusters, the CXI hook for Slingshot connectivity is enabled implicitly by default or by other hooks.
131
129
Therefore, entering the enabling annotation in the EDF is unnecessary in many cases.
132
130
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
+
```
136
135
137
136
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.
138
137
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
226
225
[](){#ref-ce-aws-ofi-hook}
227
226
### AWS OFI NCCL Hook
228
227
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.
233
235
234
236
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.
235
237
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`
0 commit comments