Skip to content

Commit 9dcb41c

Browse files
committed
Add infiniband feature document
Signed-off-by: Gris Ge <fge@redhat.com>
1 parent ab74965 commit 9dcb41c

File tree

2 files changed

+59
-0
lines changed

2 files changed

+59
-0
lines changed

features/infiniband.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
<!-- vim-markdown-toc GFM -->
2+
3+
* [Infiniband Over IP](#infiniband-over-ip)
4+
* [Bond Over Infiniband](#bond-over-infiniband)
5+
6+
<!-- vim-markdown-toc -->
7+
8+
# Infiniband Over IP
9+
10+
This is the example YAML for creating PKEY Infiniband over IP
11+
12+
```yml
13+
---
14+
interfaces:
15+
- name: mlx5_ib0.80fe
16+
type: infiniband
17+
state: up
18+
infiniband:
19+
base-iface: mlx5_ib0
20+
mode: datagram
21+
pkey: '0x80fe'
22+
```
23+
24+
Pleas refer to [YAML API document][1] for detail meaning of each property.
25+
26+
# Bond Over Infiniband
27+
28+
Only the `active-backup` mode of bond is supported when attaching infiniband
29+
over IP to bond. Example YAML:
30+
31+
```yml
32+
---
33+
interfaces:
34+
- name: mlx5_ib0.80ff
35+
type: infiniband
36+
state: up
37+
infiniband:
38+
base-iface: mlx5_ib0
39+
mode: datagram
40+
pkey: '0x80ff'
41+
- name: mlx5_ib0.80fe
42+
type: infiniband
43+
state: up
44+
infiniband:
45+
base-iface: mlx5_ib0
46+
mode: datagram
47+
pkey: '0x80fe'
48+
- name: bond0
49+
type: bond
50+
state: up
51+
bond:
52+
mode: active-backup
53+
port:
54+
- mlx5_ib0.80fe
55+
- mlx5_ib0.80ff
56+
```
57+
58+
[1]: https://nmstate.io/devel/yaml_api.html#ip-over-infiniband-interface

index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ NetworkManager acts as the main (and currently the only) provider supported.
3535
- [Refer Interface using PCI Address](./features/pci_identifier.md)
3636
- [IPsec](./features/ipsec.md)
3737
- [DNS](./features/dns.md)
38+
- [Infiniband](./features/infiniband.md)
3839

3940
## Example output
4041

0 commit comments

Comments
 (0)