Multiple errors/inconsistencies in curtin network documentation

Bug #1948559 reported by klausfiend
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
curtin
New
Undecided
Unassigned

Bug Description

The documentation for the "network" section of curtin has several discrepancies with the actual implementation, specifically:

- the keyword `xmit_hash_policy` should actually be `transmit_hash_policy`
- the documentation references `mode` and `bond-mode` interchangeably (although there is no mention of `bond_mode` but presumably it can be used identically to `bond-mode`)

I'm assuming some of this disagreement stems from the kernel documentation for bonding itself, which references `xmit_hash_policy`, but this configuration does not work:

```
# This is the network config written by 'subiquity'
network:
  bonds:
    bond0:
      addresses:
      - <redacted>
      gateway4: <redacted>
      interfaces:
      - eth0
      - eth1
      macaddress: <redacted>
      nameservers:
        addresses:
        - <redacted>
        - <redacted>
        search:
        - <redacted>
      parameters:
        xmit-hash-policy: layer3+4
        lacp-rate: fast
        mii-monitor-interval: 100
        mode: 802.3ad
  ethernets:
    eth0: {}
    eth1: {}
  version: 2
```

whereas this nearly identical configuration works as expected:

```
# This is the network config written by 'subiquity'
network:
  bonds:
    bond0:
      addresses:
      - <redacted>
      gateway4: <redacted>
      interfaces:
      - eth0
      - eth1
      macaddress: <redacted>
      nameservers:
        addresses:
        - <redacted>
        - <redacted>
        search:
        - <redacted>
      parameters:
        transmit-hash-policy: layer3+4
        lacp-rate: fast
        mii-monitor-interval: 100
        mode: 802.3ad
  ethernets:
    eth0: {}
    eth1: {}
  version: 2
```

The attached patch normalizes parameter keyword usage and corrects the hash policy keyword to agree with the underlying implementation.

Revision history for this message
klausfiend (klausfiend) wrote :
klausfiend (klausfiend)
description: updated
description: updated
description: updated
description: updated
description: updated
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.